From 8e5309705e4698f1c0fd5b3eafd189e3291fdfc3 Mon Sep 17 00:00:00 2001 From: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> Date: Tue, 14 May 2024 16:45:09 +0200 Subject: [PATCH] t-integrations: add glossary reference to config file (#32763) --- source/_integrations/telegram_broadcast.markdown | 2 +- source/_integrations/telegram_polling.markdown | 2 +- source/_integrations/telegram_webhooks.markdown | 2 +- source/_integrations/tellstick.markdown | 8 ++++---- source/_integrations/template.markdown | 2 +- source/_integrations/text.mqtt.markdown | 2 +- source/_integrations/thermoworks_smoke.markdown | 2 +- source/_integrations/thethingsnetwork.markdown | 4 ++-- source/_integrations/thingspeak.markdown | 2 +- source/_integrations/thinkingcleaner.markdown | 4 ++-- source/_integrations/thomson.markdown | 2 +- source/_integrations/threshold.markdown | 2 +- source/_integrations/tikteck.markdown | 2 +- source/_integrations/timer.markdown | 4 ++-- source/_integrations/tmb.markdown | 2 +- source/_integrations/tod.markdown | 2 +- source/_integrations/todoist.markdown | 4 ++-- source/_integrations/tomato.markdown | 2 +- source/_integrations/toon.markdown | 2 +- source/_integrations/torque.markdown | 2 +- source/_integrations/touchline.markdown | 2 +- source/_integrations/tplink_lte.markdown | 2 +- source/_integrations/tradfri.markdown | 2 +- source/_integrations/transport_nsw.markdown | 2 +- source/_integrations/travisci.markdown | 2 +- source/_integrations/trend.markdown | 2 +- source/_integrations/twilio.markdown | 2 +- source/_integrations/twilio_call.markdown | 2 +- source/_integrations/twilio_sms.markdown | 2 +- source/_integrations/twitter.markdown | 2 +- 30 files changed, 37 insertions(+), 37 deletions(-) diff --git a/source/_integrations/telegram_broadcast.markdown b/source/_integrations/telegram_broadcast.markdown index 5b62eeffd2a..483b75a94f3 100644 --- a/source/_integrations/telegram_broadcast.markdown +++ b/source/_integrations/telegram_broadcast.markdown @@ -13,7 +13,7 @@ Information on how to send a message via the service `telegram_bot.send_message` ## Configuration -To integrate this into Home Assistant, add the following section to your `configuration.yaml` file: +To integrate this into Home Assistant, add the following section to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/telegram_polling.markdown b/source/_integrations/telegram_polling.markdown index cd847e40a46..b4a206369c9 100644 --- a/source/_integrations/telegram_polling.markdown +++ b/source/_integrations/telegram_polling.markdown @@ -15,7 +15,7 @@ The other implementation method is [Telegram webhooks](/integrations/telegram_we ## Configuration -To integrate this into Home Assistant, add the following section to your `configuration.yaml` file: +To integrate this into Home Assistant, add the following section to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/telegram_webhooks.markdown b/source/_integrations/telegram_webhooks.markdown index befeaa8a0b8..6e47730e7c2 100644 --- a/source/_integrations/telegram_webhooks.markdown +++ b/source/_integrations/telegram_webhooks.markdown @@ -17,7 +17,7 @@ The other implementation method is [Telegram polling](/integrations/telegram_pol ## Configuration -To integrate this into Home Assistant, add the following section to your `configuration.yaml` file: +To integrate this into Home Assistant, add the following section to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/tellstick.markdown b/source/_integrations/tellstick.markdown index f98ac852a61..7b2303e9fbd 100644 --- a/source/_integrations/tellstick.markdown +++ b/source/_integrations/tellstick.markdown @@ -72,7 +72,7 @@ port: This `tellstick` cover platform allows you to control your [TellStick][tellstick-gateway] covers. -To use your TellStick device, you first have to set up your [Tellstick hub](#configuration) and then add the following to your `configuration.yaml` file: +To use your TellStick device, you first have to set up your [Tellstick hub](#configuration) and then add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry @@ -84,7 +84,7 @@ cover: This `tellstick` light platform allows you to control your [TellStick][tellstick-gateway] dimmers. -To use your TellStick device, you first have to set up your [Tellstick hub](#configuration) and then add the following to your `configuration.yaml` file: +To use your TellStick device, you first have to set up your [Tellstick hub](#configuration) and then add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry @@ -96,7 +96,7 @@ light: The `tellstick` sensor platform allows you to get current meteorological data from a [TellStick][tellstick-gateway] device. -To use your TellStick device, you first have to set up your [Tellstick hub](#configuration) and then add the following to your `configuration.yaml` file: +To use your TellStick device, you first have to set up your [Tellstick hub](#configuration) and then add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry @@ -171,7 +171,7 @@ sensor: This `tellstick` switch platform allows you to control [TellStick][tellstick-gateway] devices. -To use your TellStick device, you first have to set up your [Tellstick hub](#configuration) and then add the following to your `configuration.yaml` file: +To use your TellStick device, you first have to set up your [Tellstick hub](#configuration) and then add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/template.markdown b/source/_integrations/template.markdown index 1ed54346405..570377f2a6d 100644 --- a/source/_integrations/template.markdown +++ b/source/_integrations/template.markdown @@ -59,7 +59,7 @@ _For old sensor/binary sensor configuration format, [see below](#legacy-binary-s Sensor template and binary sensor template can be configured using the user interface at **{% my helpers title="Settings > Devices & Services > Helpers" %}**. Select the **+ Add helper** button and then select the **{% my config_flow_start domain=page.ha_domain title=page.title %}** helper. -To be able to add **{% my helpers title="Helpers" %}** via the user interface, you should have `default_config:` in your `configuration.yaml`. It should already be there by default unless you removed it. +To be able to add **{% my helpers title="Helpers" %}** via the user interface, you should have `default_config:` in your {% term "`configuration.yaml`" %}. It should already be there by default unless you removed it. ## YAML configuration diff --git a/source/_integrations/text.mqtt.markdown b/source/_integrations/text.mqtt.markdown index 06c8b0a8a20..28154b23ab7 100644 --- a/source/_integrations/text.mqtt.markdown +++ b/source/_integrations/text.mqtt.markdown @@ -12,7 +12,7 @@ The `mqtt` Text platform allows you to integrate devices that show text that can ## Configuration -To enable MQTT text platform in your installation, add the following to your `configuration.yaml` file: +To enable MQTT text platform in your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/thermoworks_smoke.markdown b/source/_integrations/thermoworks_smoke.markdown index 7c274bc538f..1661f1ec629 100644 --- a/source/_integrations/thermoworks_smoke.markdown +++ b/source/_integrations/thermoworks_smoke.markdown @@ -19,7 +19,7 @@ the email and password you used to in the configuration for this sensor in order ## Configuration -To add the sensors to your installation, add the following to your `configuration.yaml` file: +To add the sensors to your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/thethingsnetwork.markdown b/source/_integrations/thethingsnetwork.markdown index 16ecca77052..b7e055d5f9b 100644 --- a/source/_integrations/thethingsnetwork.markdown +++ b/source/_integrations/thethingsnetwork.markdown @@ -53,7 +53,7 @@ Access keys ## Configuration -To enable this integration, add the following lines to your `configuration.yaml`: +To enable this integration, add the following lines to your {% term "`configuration.yaml`" %}: ```yaml # Example configuration.yaml entry @@ -120,7 +120,7 @@ Devices overview ### Configuration -To enable this platform, add the following lines to your `configuration.yaml`: +To enable this platform, add the following lines to your {% term "`configuration.yaml`" %}: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/thingspeak.markdown b/source/_integrations/thingspeak.markdown index df5b0b5d95c..e8171cbf885 100644 --- a/source/_integrations/thingspeak.markdown +++ b/source/_integrations/thingspeak.markdown @@ -16,7 +16,7 @@ For now, it records exactly one entity at once, which is great for testing purpo You will have to create a [new channel](https://thingspeak.com/channels/new) on ThingSpeak and grab your Write API Key from the "API Keys" tab of the channel you want to use. -To setup the ThingSpeak integration in your installation, add the following to your `configuration.yaml` file: +To setup the ThingSpeak integration in your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/thinkingcleaner.markdown b/source/_integrations/thinkingcleaner.markdown index f049c8f2d3c..e008060e9d3 100644 --- a/source/_integrations/thinkingcleaner.markdown +++ b/source/_integrations/thinkingcleaner.markdown @@ -22,7 +22,7 @@ There is currently support for the following device types within Home Assistant: The `thinkingcleaner` sensor platform simple displays information about your [Thinking Cleaner (archived website)](https://web.archive.org/web/20220802042114/https://www.thinkingcleaner.com/) add-on. -To enable this sensor in your installation, add the following to your `configuration.yaml` file: +To enable this sensor in your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml sensor: @@ -43,7 +43,7 @@ This will automatically add sensors for each Thinking Cleaner in your network. The `thinkingcleaner` switch platform allows you to control your [Thinking Cleaner (archived website)](https://web.archive.org/web/20220802042114/https://www.thinkingcleaner.com/) add-on. -To enable this switch in your installation, add the following to your `configuration.yaml` file: +To enable this switch in your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml switch: diff --git a/source/_integrations/thomson.markdown b/source/_integrations/thomson.markdown index 85305376800..d7009388d8f 100644 --- a/source/_integrations/thomson.markdown +++ b/source/_integrations/thomson.markdown @@ -15,7 +15,7 @@ Thomson produced networking equipment (under the brand name SpeedTouch) till 201 This platform allows you to detect presence by looking at connected devices to a [Thomson](https://www.technicolor.com/) device. -To use this device tracker in your installation, add the following to your `configuration.yaml` file: +To use this device tracker in your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/threshold.markdown b/source/_integrations/threshold.markdown index 5e880d62806..10fd2092f39 100644 --- a/source/_integrations/threshold.markdown +++ b/source/_integrations/threshold.markdown @@ -37,7 +37,7 @@ Upper limit: Alternatively, this integration can be configured and set up manually via YAML instead. To enable the Integration sensor in your installation, add the -following to your `configuration.yaml` file: +following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/tikteck.markdown b/source/_integrations/tikteck.markdown index b78090d7fed..1234327ea0b 100644 --- a/source/_integrations/tikteck.markdown +++ b/source/_integrations/tikteck.markdown @@ -11,7 +11,7 @@ ha_platforms: ha_integration_type: integration --- -Support for the Bluetooth smart bulb from [Tikteck](https://www.tikteck.com/). To enable these lights, add the following lines to your `configuration.yaml` file: +Support for the Bluetooth smart bulb from [Tikteck](https://www.tikteck.com/). To enable these lights, add the following lines to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/timer.markdown b/source/_integrations/timer.markdown index 60acde7ac07..cefa8f42d82 100644 --- a/source/_integrations/timer.markdown +++ b/source/_integrations/timer.markdown @@ -26,10 +26,10 @@ However, automations using the `timer.finished` event **will not** trigger if th The preferred way to configure timer helpers is via the user interface at **{% my helpers title="Settings > Devices & Services > Helpers" %}** and click the add button; next choose the {% my config_flow_start domain=page.ha_domain title=page.title %} option. -To be able to add Helpers via the user interface you should have `default_config:` in your `configuration.yaml`, it should already be there by default unless you removed it. If you removed `default_config:` from your configuration, you must add `timer:` to your `configuration.yaml` first, then you can use the UI. +To be able to add Helpers via the user interface you should have `default_config:` in your {% term "`configuration.yaml`" %}, it should already be there by default unless you removed it. If you removed `default_config:` from your configuration, you must add `timer:` to your `configuration.yaml` first, then you can use the UI. Timers can also be configured via configuration.yaml: -To add a timer to your installation, add the following to your `configuration.yaml` file: +To add a timer to your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/tmb.markdown b/source/_integrations/tmb.markdown index dcc5767f0c0..1b70653784d 100644 --- a/source/_integrations/tmb.markdown +++ b/source/_integrations/tmb.markdown @@ -17,7 +17,7 @@ This sensor will provide you the remaining time, in minutes, for the next bus in You must create an application on [developer.tmb.cat](https://developer.tmb.cat/account/applications/public/new) to obtain the `app_id` and `app_key` values that you will need. -Add the data to your `configuration.yaml` file as shown in the example: +Add the data to your {% term "`configuration.yaml`" %} file as shown in the example: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/tod.markdown b/source/_integrations/tod.markdown index d7a193c03b3..57e458ef019 100644 --- a/source/_integrations/tod.markdown +++ b/source/_integrations/tod.markdown @@ -35,7 +35,7 @@ The time ranges can be provided as absolute local time or using the `sunrise` or In addition for sun position based ranges, the negative or positive offset can be configured. To enable the Times of Day binary sensor in your installation, add the -following to your `configuration.yaml` file: +following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/todoist.markdown b/source/_integrations/todoist.markdown index 127d9401328..6c50a7b9c59 100644 --- a/source/_integrations/todoist.markdown +++ b/source/_integrations/todoist.markdown @@ -42,7 +42,7 @@ You need to determine your Todoist API token. Go to the [**Integrations** > **De ## Custom projects -You can manually configure the Todoist calendar (only) integration using `configuration.yaml` which can specify "custom" projects which match against criteria you set. You should +You can manually configure the Todoist calendar (only) integration using {% term "`configuration.yaml`" %} which can specify "custom" projects which match against criteria you set. You should prefer the above instructions for configuring Todoist from the UI. {% details "Manual custom projects configuration" %} @@ -75,7 +75,7 @@ custom_projects: type: list {% endconfiguration %} -Here's an example of a more advanced `configuration.yaml`: +Here's an example of a more advanced {% term "`configuration.yaml`" %}: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/tomato.markdown b/source/_integrations/tomato.markdown index 81582046bbc..300986e4005 100644 --- a/source/_integrations/tomato.markdown +++ b/source/_integrations/tomato.markdown @@ -28,7 +28,7 @@ value can be obtained by logging in to the Tomato admin interface and search for ## Configuration To use this device tracker in your installation, -add the following to your `configuration.yaml` file: +add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/toon.markdown b/source/_integrations/toon.markdown index 57d91555332..298ed953961 100644 --- a/source/_integrations/toon.markdown +++ b/source/_integrations/toon.markdown @@ -56,7 +56,7 @@ In order to be able to use this integration, you'll need to sign up for a free T 4. Click on "Create App" to complete the creation process. 5. Open the "[My Apps](https://developer.toon.eu/user/me/apps)" page again and click on the app that you've just created. 6. You need the codes now shown: "Consumer Key" and "Consumer Secret". -7. Add the following Toon configuration to your `configuration.yaml` and restart Home Assistant. +7. Add the following Toon configuration to your {% term "`configuration.yaml`" %} and restart Home Assistant. ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/torque.markdown b/source/_integrations/torque.markdown index 0315b754782..f446f1db1b6 100644 --- a/source/_integrations/torque.markdown +++ b/source/_integrations/torque.markdown @@ -37,7 +37,7 @@ Under the **Realtime Web Upload** header: ### Configuration -Add the following to your `configuration.yaml` file: +Add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/touchline.markdown b/source/_integrations/touchline.markdown index 1dcf6aa8b69..0f2dc45df46 100644 --- a/source/_integrations/touchline.markdown +++ b/source/_integrations/touchline.markdown @@ -13,7 +13,7 @@ ha_integration_type: integration The `touchline` climate platform let you control [ROTH Touchline](https://www.roth-uk.com/en/roth-touchline.htm) floor heating thermostats from Roth. -To set it up, add the following information to your `configuration.yaml` file: +To set it up, add the following information to your {% term "`configuration.yaml`" %} file: ```yaml climate: diff --git a/source/_integrations/tplink_lte.markdown b/source/_integrations/tplink_lte.markdown index cf063e03057..68cae3a7c4e 100644 --- a/source/_integrations/tplink_lte.markdown +++ b/source/_integrations/tplink_lte.markdown @@ -18,7 +18,7 @@ The integration provides a notification service that will send an SMS. ## Configuration -To enable the integration, add the following lines to your `configuration.yaml` file: +To enable the integration, add the following lines to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/tradfri.markdown b/source/_integrations/tradfri.markdown index c2dc09c22e8..e3ffea13499 100644 --- a/source/_integrations/tradfri.markdown +++ b/source/_integrations/tradfri.markdown @@ -23,7 +23,7 @@ ha_platforms: ha_integration_type: integration --- -The IKEA TRÅDFRI integration allows you to connect your IKEA Trådfri Gateway to Home Assistant. The gateway can control compatible Zigbee-based lights (certified Zigbee Light Link products) connected to it. Home Assistant will automatically discover the gateway's presence on your local network if `discovery:` is present in your `configuration.yaml` file. +The IKEA TRÅDFRI integration allows you to connect your IKEA Trådfri Gateway to Home Assistant. The gateway can control compatible Zigbee-based lights (certified Zigbee Light Link products) connected to it. Home Assistant will automatically discover the gateway's presence on your local network if `discovery:` is present in your {% term "`configuration.yaml`" %} file. {% include integrations/config_flow.md %} diff --git a/source/_integrations/transport_nsw.markdown b/source/_integrations/transport_nsw.markdown index 29abd108826..399165b7f57 100644 --- a/source/_integrations/transport_nsw.markdown +++ b/source/_integrations/transport_nsw.markdown @@ -25,7 +25,7 @@ As a default the sensor picks up the next mode of transport leaving from a stop ## Configuration -To enable the sensor, add the following lines to your `configuration.yaml` file: +To enable the sensor, add the following lines to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/travisci.markdown b/source/_integrations/travisci.markdown index ae48238c9d5..7886cb21906 100644 --- a/source/_integrations/travisci.markdown +++ b/source/_integrations/travisci.markdown @@ -25,7 +25,7 @@ Create a GitHub [access token](https://github.com/settings/tokens) with the foll ## Configuration -To enable this platform, please add the following to your `configuration.yaml` file: +To enable this platform, please add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/trend.markdown b/source/_integrations/trend.markdown index 776db5da820..dca6ef56421 100644 --- a/source/_integrations/trend.markdown +++ b/source/_integrations/trend.markdown @@ -38,7 +38,7 @@ Invert the result: ### YAML Configuration To enable Trend binary sensors in your installation, -add the following to your `configuration.yaml` file: +add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/twilio.markdown b/source/_integrations/twilio.markdown index 22e8cdf8afe..b9966083c34 100644 --- a/source/_integrations/twilio.markdown +++ b/source/_integrations/twilio.markdown @@ -17,7 +17,7 @@ Calls are limited to 10 minutes and will play a short trial message before your ## Configuration -To use this notification integration in your installation, add the following to your `configuration.yaml` file: +To use this notification integration in your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/twilio_call.markdown b/source/_integrations/twilio_call.markdown index 38cee1467fc..5c5a12516f2 100644 --- a/source/_integrations/twilio_call.markdown +++ b/source/_integrations/twilio_call.markdown @@ -18,7 +18,7 @@ The requirement is that you have setup [Twilio](/integrations/twilio/). ## Configuration -To use this notification platform in your installation, add the following to your `configuration.yaml` file: +To use this notification platform in your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/twilio_sms.markdown b/source/_integrations/twilio_sms.markdown index f896c924a12..bcfadebe646 100644 --- a/source/_integrations/twilio_sms.markdown +++ b/source/_integrations/twilio_sms.markdown @@ -17,7 +17,7 @@ The requirement is that you have setup [Twilio](/integrations/twilio/). ## Configuration -To use this notification platform in your installation, add the following to your `configuration.yaml` file: +To use this notification platform in your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/twitter.markdown b/source/_integrations/twitter.markdown index 1e728e841b5..9d58565e48e 100644 --- a/source/_integrations/twitter.markdown +++ b/source/_integrations/twitter.markdown @@ -37,7 +37,7 @@ It does not matter for the integration what you enter as a callback or website U ## Configuration -To add X to your installation, add the following to your `configuration.yaml` file: +To add X to your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry