From 36cba79f66824c3b0f4acf9c71f696c324436cb0 Mon Sep 17 00:00:00 2001
From: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
Date: Tue, 14 May 2024 11:09:49 +0200
Subject: [PATCH] a-integrations: add glossary reference to Configuration file
 (#32749)

---
 source/_integrations/ads.markdown              | 10 +++++-----
 .../alarm_control_panel.ifttt.markdown         | 10 +++++++---
 .../alarm_control_panel.mqtt.markdown          | 12 ++++++++----
 .../alarm_control_panel.template.markdown      | 10 +++++++---
 .../alexa.flash_briefings.markdown             |  2 +-
 source/_integrations/alexa.intent.markdown     |  6 +++++-
 source/_integrations/alexa.smart_home.markdown | 18 +++++++++---------
 source/_integrations/aqualogic.markdown        |  4 ++--
 source/_integrations/arest.markdown            |  6 +++---
 source/_integrations/assist_pipeline.markdown  | 11 ++++++++---
 source/_integrations/aten_pe.markdown          |  8 ++++++--
 source/_integrations/aws.markdown              |  2 +-
 source/_integrations/azure_event_hub.markdown  |  5 ++++-
 13 files changed, 66 insertions(+), 38 deletions(-)

diff --git a/source/_integrations/ads.markdown b/source/_integrations/ads.markdown
index d2174b8d6f1..772d7e61440 100644
--- a/source/_integrations/ads.markdown
+++ b/source/_integrations/ads.markdown
@@ -82,7 +82,7 @@ Service parameters:
 
 The `ads` binary sensor platform can be used to monitor a boolean value on your ADS device.
 
-To use your ADS device, you first have to set up your [ADS hub](#configuration) and then add the following to your `configuration.yaml`
+To use your ADS device, you first have to set up your [ADS hub](#configuration) and then add the following to your {% term "`configuration.yaml`" %}
 file:
 
 ```yaml
@@ -111,7 +111,7 @@ device_class:
 
 The `ads` light platform allows you to control your connected ADS lights.
 
-To use your ADS device, you first have to set up your [ADS hub](#configuration) and then add the following to your `configuration.yaml`
+To use your ADS device, you first have to set up your [ADS hub](#configuration) and then add the following to your {% term "`configuration.yaml`" %}
 file:
 
 ```yaml
@@ -141,7 +141,7 @@ name:
 
 The `ads` sensor platform allows reading the value of a numeric variable on your ADS device. The variable can be of type *INT*, *UINT*,  *BYTE*, *DINT* or *UDINT*.
 
-To use your ADS device, you first have to set up your [ADS hub](#configuration) and then add the following to your `configuration.yaml`
+To use your ADS device, you first have to set up your [ADS hub](#configuration) and then add the following to your {% term "`configuration.yaml`" %}
 file:
 
 ```yaml
@@ -180,7 +180,7 @@ The *factor* can be used to implement fixed decimals. E.g., set *factor* to 100
 
 The `ads` switch platform accesses a boolean variable on the connected ADS device. The variable is identified by its name.
 
-To use your ADS device, you first have to set up your [ADS hub](#configuration) and then add the following to your `configuration.yaml`
+To use your ADS device, you first have to set up your [ADS hub](#configuration) and then add the following to your {% term "`configuration.yaml`" %}
 file:
 
 ```yaml
@@ -205,7 +205,7 @@ name:
 
 The `ads` cover platform allows you to control your connected ADS covers.
 
-To use your ADS device, you first have to set up your [ADS hub](#configuration) and then add the following to your `configuration.yaml`
+To use your ADS device, you first have to set up your [ADS hub](#configuration) and then add the following to your {% term "`configuration.yaml`" %}
 file:
 
 ```yaml
diff --git a/source/_integrations/alarm_control_panel.ifttt.markdown b/source/_integrations/alarm_control_panel.ifttt.markdown
index f058f4c4b33..609a4358de4 100644
--- a/source/_integrations/alarm_control_panel.ifttt.markdown
+++ b/source/_integrations/alarm_control_panel.ifttt.markdown
@@ -5,11 +5,14 @@ ha_category:
   - Alarm
 ha_release: 0.66
 ha_domain: ifttt
+related:
+  - docs: /docs/configuration/
+    title: Configuration file
 ---
 
-The `ifttt` platform allows you to integrate security systems that have no open API but can be controlled through [IFTTT](https://ifttt.com/explore).
+The `ifttt` {% term integration %} allows you to integrate security systems that have no open API but can be controlled through [IFTTT](https://ifttt.com/explore).
 
-This platform depends on the [IFTTT](/integrations/ifttt/) Home Assistant integration. See the integrations documentation to set it up.
+This {% term integration %} depends on the [IFTTT](/integrations/ifttt/) Home Assistant integration. See the integrations documentation to set it up.
 
 <div class='note'>
 It is important to note that this platform fully relies on IFTTT to receive updates when the security system's state changes. Therefore, this platform shows an assumed state.
@@ -17,7 +20,8 @@ It is important to note that this platform fully relies on IFTTT to receive upda
 
 ## Configuration
 
-To enable this, add the following lines to your `configuration.yaml` file:
+To enable this, add the following lines to your {% term "`configuration.yaml`" %} file.
+{% include integrations/restart_ha_after_config_inclusion.md %}
 
 ```yaml
 # Example configuration.yaml entry
diff --git a/source/_integrations/alarm_control_panel.mqtt.markdown b/source/_integrations/alarm_control_panel.mqtt.markdown
index 9be9fda1f83..4625ef66062 100644
--- a/source/_integrations/alarm_control_panel.mqtt.markdown
+++ b/source/_integrations/alarm_control_panel.mqtt.markdown
@@ -6,11 +6,14 @@ ha_category:
 ha_release: 0.7.4
 ha_iot_class: Configurable
 ha_domain: mqtt
+related:
+  - docs: /docs/configuration/
+    title: Configuration file
 ---
 
-The `mqtt` alarm panel platform enables the possibility to control MQTT capable alarm panels. The Alarm icon will change state after receiving a new state from `state_topic`. If these messages are published with *RETAIN* flag, the MQTT alarm panel will receive an instant state update after subscription and will start with the correct state. Otherwise, the initial state will be `unknown`.
+The `mqtt` alarm panel {% term integration %} enables the possibility to control MQTT capable alarm panels. The Alarm icon will change state after receiving a new state from `state_topic`. If these messages are published with *RETAIN* flag, the MQTT alarm panel will receive an instant state update after subscription and will start with the correct state. Otherwise, the initial state will be `unknown`.
 
-The integration will accept the following states from your Alarm Panel (in lower case):
+The {% term integration %} will accept the following states from your Alarm Panel (in lower case):
 
 - `disarmed`
 - `armed_home`
@@ -23,11 +26,12 @@ The integration will accept the following states from your Alarm Panel (in lower
 - `arming`
 - `disarming`
 
-The integration can control your Alarm Panel by publishing to the `command_topic` when a user interacts with the Home Assistant frontend.
+The {% term integration %} can control your Alarm Panel by publishing to the `command_topic` when a user interacts with the Home Assistant frontend.
 
 ## Configuration
 
-To enable this platform, add the following lines to your `configuration.yaml`:
+To enable this {% term integration %}, add the following lines to your {% term "`configuration.yaml`" %} file.
+{% include integrations/restart_ha_after_config_inclusion.md %}
 
 ```yaml
 # Example configuration.yaml entry
diff --git a/source/_integrations/alarm_control_panel.template.markdown b/source/_integrations/alarm_control_panel.template.markdown
index 6994c03fdf0..c438d6204e6 100644
--- a/source/_integrations/alarm_control_panel.template.markdown
+++ b/source/_integrations/alarm_control_panel.template.markdown
@@ -7,11 +7,14 @@ ha_release: 0.105
 ha_iot_class: "Local Push"
 ha_qa_scale: internal
 ha_domain: template
+related:
+  - docs: /docs/configuration/
+    title: Configuration file
 ---
 
-The `template` integrations creates alarm control panels that combine integrations or adds preprocessing logic to actions.
+The `template` {% term integration %} creates alarm control panels that combine integrations or adds preprocessing logic to actions.
 
-There are several powerful ways to use this integration, including grouping existing integrations into a simpler integrations, or adding logic that Home Assistant will execute when accessed.
+There are several powerful ways to use this {% term integration %}, including grouping existing integrations into a simpler integrations, or adding logic that Home Assistant will execute when accessed.
 
 For example, if you want to expose a true alarm panel to Google Home, Alexa, or HomeKit - but limit its ability to disarm when there's no one home, you can do that using a template.
 
@@ -23,7 +26,8 @@ In optimistic mode, the alarm control panel will immediately change state after
 
 ## Configuration
 
-To enable a template alarm control panel in your installation, add the following to your `configuration.yaml` file:
+To enable a template alarm control panel in your installation, add the following to your {% term "`configuration.yaml`" %} file.
+{% include integrations/restart_ha_after_config_inclusion.md %}
 
 {% raw %}
 
diff --git a/source/_integrations/alexa.flash_briefings.markdown b/source/_integrations/alexa.flash_briefings.markdown
index eefe896b9c8..a539530bb76 100644
--- a/source/_integrations/alexa.flash_briefings.markdown
+++ b/source/_integrations/alexa.flash_briefings.markdown
@@ -19,7 +19,7 @@ Additionally, note that at the time of this writing, your Alexa skill endpoint *
 
   1. In your router, forward external 443 to your Home Assistant serving port (defaults to 8123)
   OR
-  2. Change your Home Assistant serving port to 443 this is done in the [`http`](/integrations/http/) section with the `server_port` entry in your `configuration.yaml` file
+  2. Change your Home Assistant serving port to 443 this is done in the [`http`](/integrations/http/) section with the `server_port` entry in your {% term "`configuration.yaml`" %} file
 
 [blog-lets-encrypt]: /blog/2015/12/13/setup-encryption-using-lets-encrypt/
 
diff --git a/source/_integrations/alexa.intent.markdown b/source/_integrations/alexa.intent.markdown
index 8312e935bc4..549be1331e6 100644
--- a/source/_integrations/alexa.intent.markdown
+++ b/source/_integrations/alexa.intent.markdown
@@ -5,6 +5,9 @@ ha_category:
   - Voice
 ha_release: "0.10"
 ha_domain: alexa
+related:
+  - docs: /docs/configuration/
+    title: Configuration file
 ---
 
 ## I want to build custom commands to use with Echo
@@ -159,7 +162,8 @@ This means that we can now ask Alexa things like:
 
 When activated, the Alexa integration will have Home Assistant's native intent support handle the incoming intents. If you want to run actions based on intents, use the [`intent_script`](/integrations/intent_script) integration.
 
-To enable Alexa, add the following entry to your `configuration.yaml` file:
+To enable Alexa, add the following entry to your {% term "`configuration.yaml`" %} file.
+{% include integrations/restart_ha_after_config_inclusion.md %}
 
 ```yaml
 alexa:
diff --git a/source/_integrations/alexa.smart_home.markdown b/source/_integrations/alexa.smart_home.markdown
index 39bd72964a9..ee92110be1d 100644
--- a/source/_integrations/alexa.smart_home.markdown
+++ b/source/_integrations/alexa.smart_home.markdown
@@ -178,7 +178,7 @@ Next you need create a Lambda function.
 
 ### Test the Lambda Function
 
-Now, you have created the Lambda function, but before you can test it, you have to set up the necessary aspects of your Home Assistant configuration. Put the following minimal configuration into your `configuration.yaml` file. It will expose all of your supported devices and automations to Alexa. It is strongly recommended to check the [configuration section](#alexa-smart-home-integration-configuration) and setup control of which devices and entities are exposed.
+Now, you have created the Lambda function, but before you can test it, you have to set up the necessary aspects of your Home Assistant configuration. Put the following minimal configuration into your {% term "`configuration.yaml`" %} file. It will expose all of your supported devices and automations to Alexa. It is strongly recommended to check the [configuration section](#alexa-smart-home-integration-configuration) and setup control of which devices and entities are exposed.
 
 ```yaml
 alexa:
@@ -869,13 +869,13 @@ Adjust lights that support color temperature using the following friendly names:
 
 The following table lists the possible friendly name synonyms available to lights that support color temperature.
 
-| Color Temperature in Kelvin | Friendly Name Synonyms  |
-| -----| ---------------------------------------------- |
-| 2200 | _"warm"_, _"warm white"_                       |
-| 2700 | _"incandescent"_, _"soft white"_               |
-| 4000 | _"white"_                                      |
-| 5500 | _"daylight"_, _"daylight white"_               |
-| 7000 | _"cool"_, _"cool white"_                       |
+| Color Temperature in Kelvin | Friendly Name Synonyms           |
+| --------------------------- | -------------------------------- |
+| 2200                        | _"warm"_, _"warm white"_         |
+| 2700                        | _"incandescent"_, _"soft white"_ |
+| 4000                        | _"white"_                        |
+| 5500                        | _"daylight"_, _"daylight white"_ |
+| 7000                        | _"cool"_, _"cool white"_         |
 
 Use _"warmer"_, _"softer"_, _"cooler_, _"whiter"_ utterances to adjust color temperature by 50 `mired` (approximately 300-500 degree kelvin change).
 
@@ -1090,7 +1090,7 @@ Disable and re-enable the skill using the Alexa App; then restart Home Assistant
 
 ## Debugging
 
-The Alexa integration will log additional information about state updates and other messages when the log level is set to `debug`. Add the relevant line below to the `configuration.yaml`:
+The Alexa integration will log additional information about state updates and other messages when the log level is set to `debug`. Add the relevant line below to the {% term "`configuration.yaml`" %}:
 
 If using Alexa with an Alexa Smart Home Skill and Lambda function such as haaska:
 
diff --git a/source/_integrations/aqualogic.markdown b/source/_integrations/aqualogic.markdown
index f6ddb149032..ac195df9f6d 100644
--- a/source/_integrations/aqualogic.markdown
+++ b/source/_integrations/aqualogic.markdown
@@ -49,7 +49,7 @@ port:
 
 ## Sensor
 
-Once you have enabled the AquaLogic integration, add the following to your `configuration.yaml` file:
+Once you have enabled the AquaLogic integration, add the following to your {% term "`configuration.yaml`" %} file:
 
 ```yaml
 # Example configuration.yaml entry
@@ -88,7 +88,7 @@ monitored_conditions:
 
 ## Switch
 
-Once you have enabled the AquaLogic integration, add the following to your `configuration.yaml` file:
+Once you have enabled the AquaLogic integration, add the following to your {% term "`configuration.yaml`" %} file:
 
 ```yaml
 # Example configuration.yaml entry
diff --git a/source/_integrations/arest.markdown b/source/_integrations/arest.markdown
index e7e18cda45e..8e45619eb14 100644
--- a/source/_integrations/arest.markdown
+++ b/source/_integrations/arest.markdown
@@ -81,7 +81,7 @@ This sensor is not suitable for fast state changes because there is a high possi
 
 The `arest` sensor platform allows you to get all data from your devices (like Arduinos with a Ethernet/Wi-Fi connection, the ESP8266, and the Raspberry Pi) running the [aREST](https://arest.io/) RESTful framework.
 
-To use your aREST enabled device in your installation, add the following to your `configuration.yaml` file:
+To use your aREST enabled device in your installation, add the following to your {% term "`configuration.yaml`" %} file:
 
 ```yaml
 # Example configuration.yaml entry
@@ -184,7 +184,7 @@ The root will give you a JSON response that contains all variables and their cur
 
 The `arest` switch platform allows you to toggle pins of your devices (like Arduino boards with an Ethernet/Wi-Fi connection, ESP8266 based devices, and the Raspberry Pi) running the [aREST](https://arest.io/) RESTful framework.
 
-To use your aREST enabled device with pins in your installation, add the following to your `configuration.yaml` file:
+To use your aREST enabled device with pins in your installation, add the following to your {% term "`configuration.yaml`" %} file:
 
 ```yaml
 # Example configuration.yaml entry
@@ -199,7 +199,7 @@ switch:
         invert: true
 ```
 
-If you want to use custom functions, then add the following to your `configuration.yaml` file:
+If you want to use custom functions, then add the following to your {% term "`configuration.yaml`" %} file:
 
 ```yaml
 # Example configuration.yaml entry
diff --git a/source/_integrations/assist_pipeline.markdown b/source/_integrations/assist_pipeline.markdown
index e0fc55f3225..34f5984e315 100644
--- a/source/_integrations/assist_pipeline.markdown
+++ b/source/_integrations/assist_pipeline.markdown
@@ -16,12 +16,17 @@ ha_platforms:
 related:
   - docs: /docs/configuration/
     title: Configuration file
+  - docs: /voice_control/voice_remote_local_assistant/
+    title: Configuring a voice pipeline
+  - docs: /voice_control/
+    title: Assist
 ---
 
-The Assist pipeline integration provides the foundation for the [Assist](/voice_control/) voice assistant in Home Assistant. 
+The Assist pipeline {% term integration %} provides the foundation for the [Assist](/voice_control/) voice assistant in Home Assistant.
 
-For most users, there is no need to install this integration manually. The Assist pipeline integration is part of the default configuration and is set up automatically if needed by other integrations. 
-If you are not using the default integration, you need to add the following to your `configuration.yaml` file:
+For most users, there is no need to install this integration manually. The Assist pipeline integration is part of the default configuration and is set up automatically if needed by other integrations.
+If you are not using the default {% term integration %}, you need to add the following to your {% term "`configuration.yaml`" %} file.
+{% include integrations/restart_ha_after_config_inclusion.md %}
 
 ```yaml
 # Example configuration.yaml entry
diff --git a/source/_integrations/aten_pe.markdown b/source/_integrations/aten_pe.markdown
index 43437995cc5..71d508be66d 100644
--- a/source/_integrations/aten_pe.markdown
+++ b/source/_integrations/aten_pe.markdown
@@ -11,9 +11,12 @@ ha_domain: aten_pe
 ha_platforms:
   - switch
 ha_integration_type: integration
+related:
+  - docs: /docs/configuration/
+    title: Configuration file
 ---
 
-The `aten_pe` integration lets you control [ATEN Rack PDUs](https://www.aten.com/eu/en/products/energy-intelligence-pduupsracks/rack-pdu/) from Home Assistant.
+The `aten_pe` {% term integration %} lets you control [ATEN Rack PDUs](https://www.aten.com/eu/en/products/energy-intelligence-pduupsracks/rack-pdu/) from Home Assistant.
 
 In order to use it, SNMP must be enabled on your PDU. It is recommended to use SNMPv3 to protect your credentials from eavesdropping.
 
@@ -21,7 +24,8 @@ Tested devices:
 
 - [PE8324G](https://www.aten.com/eu/en/products/energy-intelligence-pduupsracks/rack-pdu/pe8324/)
 
-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.
+{% include integrations/restart_ha_after_config_inclusion.md %} file:
 
 ```yaml
 switch:
diff --git a/source/_integrations/aws.markdown b/source/_integrations/aws.markdown
index 1bef62a569c..a2edad54af1 100644
--- a/source/_integrations/aws.markdown
+++ b/source/_integrations/aws.markdown
@@ -150,7 +150,7 @@ If one exists, the SNS Subject will be set to the title. All attributes from the
 If you do not download them, you will lose them and will have to recreate a new user.
 </div>
 
-- Copy/Paste the two keys that are shown here in your `configuration.yaml` file.
+- Copy/Paste the two keys that are shown here in your {% term "`configuration.yaml`" %} file.
 - On the left-hand side of the screen go back to "Users" and select the user you just created. On the "Permissions" tab click the "Attach Policy" icon. Search for "SNS" and attach the policy "AmazonSNSFullAccess".
 - Back to the AWS Console you now need to find "SNS" and click in to that service. It is under the Mobile Services group.
 - On the left-hand side, select "Topics" then "Create new topic".
diff --git a/source/_integrations/azure_event_hub.markdown b/source/_integrations/azure_event_hub.markdown
index 0db74eeca38..612b6169242 100644
--- a/source/_integrations/azure_event_hub.markdown
+++ b/source/_integrations/azure_event_hub.markdown
@@ -10,6 +10,9 @@ ha_codeowners:
 ha_domain: azure_event_hub
 ha_config_flow: true
 ha_integration_type: integration
+related:
+  - docs: /docs/configuration/
+    title: Configuration file
 ---
 
 The `Azure Event Hub` integration allows you to hook into the Home Assistant event bus and send events to [Azure Event Hub](https://azure.microsoft.com/products/event-hubs/) or to an [Azure IoT Hub](https://learn.microsoft.com/azure/iot-hub/iot-hub-devguide-messages-read-builtin).
@@ -30,7 +33,7 @@ The final thing to consider is how often you want the integration to send messag
 
 {% include integrations/config_flow.md %}
 
-You can setup [filters](#filter-configuration) through the `configuration.yaml`.
+You can setup [filters](#filter-configuration) through the {% term "`configuration.yaml`" %}.
 
 <div class='note warning'>
 Not filtering domains or entities will send every event to Azure Event Hub, thus taking up a lot of space and bandwidth.