From 5e853cf251989636ad9406e5c15aea73dd17ab25 Mon Sep 17 00:00:00 2001 From: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> Date: Tue, 14 May 2024 15:34:09 +0200 Subject: [PATCH] m-integrations: add glossary reference to config file (#32759) --- source/_integrations/matrix.markdown | 2 +- source/_integrations/media_source.markdown | 2 +- source/_integrations/meteoalarm.markdown | 2 +- source/_integrations/mfi.markdown | 2 +- source/_integrations/microsoft_face.markdown | 2 +- source/_integrations/min_max.markdown | 2 +- source/_integrations/minio.markdown | 2 +- source/_integrations/mochad.markdown | 4 ++-- source/_integrations/motioneye.markdown | 2 +- source/_integrations/msteams.markdown | 10 +++++----- source/_integrations/my.markdown | 2 +- source/_integrations/mycroft.markdown | 2 +- 12 files changed, 17 insertions(+), 17 deletions(-) diff --git a/source/_integrations/matrix.markdown b/source/_integrations/matrix.markdown index 278fe2491fe..a94c3500060 100644 --- a/source/_integrations/matrix.markdown +++ b/source/_integrations/matrix.markdown @@ -163,7 +163,7 @@ This configuration will: The `matrix` platform allows you to deliver notifications from Home Assistant to a [Matrix](https://matrix.org/) room. Rooms can be both direct as well as group chats. -To enable Matrix notifications in your installation, you first need to configure the [Matrix integration](#configuration). Then, add the following to your `configuration.yaml` file: +To enable Matrix notifications in your installation, you first need to configure the [Matrix integration](#configuration). Then, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/media_source.markdown b/source/_integrations/media_source.markdown index e00c857c581..fa6260eabb3 100644 --- a/source/_integrations/media_source.markdown +++ b/source/_integrations/media_source.markdown @@ -42,7 +42,7 @@ for example, the Samba add-on. Users of Home Assistant Container can mount a volume of their choice to `/media`. If you are a Home Assistant Core user, the default directory called is called -`media` under the configuration path (where your `configuration.yaml` is located). +`media` under the configuration path (where your {% term "`configuration.yaml`" %} is located). Files served from `media` are protected by Home Assistant authentication unlike those served from `www`. diff --git a/source/_integrations/meteoalarm.markdown b/source/_integrations/meteoalarm.markdown index 10e8a2e4a6c..1f98c75c204 100644 --- a/source/_integrations/meteoalarm.markdown +++ b/source/_integrations/meteoalarm.markdown @@ -19,7 +19,7 @@ The binary sensor state shows the warning message if applicable. The details are ## Configuration -To enable this binary sensor, add the following lines to your `configuration.yaml`: +To enable this binary sensor, add the following lines to your {% term "`configuration.yaml`" %}: ```yaml binary_sensor: diff --git a/source/_integrations/mfi.markdown b/source/_integrations/mfi.markdown index f1083aa5c8b..c243201875f 100644 --- a/source/_integrations/mfi.markdown +++ b/source/_integrations/mfi.markdown @@ -72,7 +72,7 @@ verify_ssl: The `mfi` switch platform to allow you to control [mFi Controllable Power Outlets](https://www.ubnt.com/mfi/mpower/). -To add this platform to your installation, add the following to your `configuration.yaml` file: +To add this platform to your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/microsoft_face.markdown b/source/_integrations/microsoft_face.markdown index a41fb8d96e1..dd2f6a65a2c 100644 --- a/source/_integrations/microsoft_face.markdown +++ b/source/_integrations/microsoft_face.markdown @@ -27,7 +27,7 @@ Please note that all keys on cognitive services must be recreated every 90 days. ## Configuration To enable the Microsoft Face {% term integration %}, -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/min_max.markdown b/source/_integrations/min_max.markdown index 01fbed157ca..43a830e968b 100644 --- a/source/_integrations/min_max.markdown +++ b/source/_integrations/min_max.markdown @@ -39,7 +39,7 @@ Precision: 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/minio.markdown b/source/_integrations/minio.markdown index 20ae31afb3f..6932373dd74 100644 --- a/source/_integrations/minio.markdown +++ b/source/_integrations/minio.markdown @@ -18,7 +18,7 @@ To download or upload files, folders must be added to [allowlist_external_dirs]( ## Configuration -To enable the Minio integration in your installation, add the following to your `configuration.yaml` file: +To enable the Minio integration in your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml minio: diff --git a/source/_integrations/mochad.markdown b/source/_integrations/mochad.markdown index 92a250b71b4..5fafc926e4e 100644 --- a/source/_integrations/mochad.markdown +++ b/source/_integrations/mochad.markdown @@ -62,7 +62,7 @@ mochad: The `mochad` light platform lets you control an X10 enabled dimmer/light device. -To enable this sensor, you first have to set up the [mochad integration](#configuration) and then add the following to your `configuration.yaml` file: +To enable this sensor, you first have to set up the [mochad integration](#configuration) and then add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry @@ -99,7 +99,7 @@ brightness_levels: The `mochad` switch platform lets you control an X10 enabled switch device. -To enable this sensor, you first have to set up the [mochad integration](#configuration) and then add the following to your `configuration.yaml` file: +To enable this sensor, you first have to set up the [mochad integration](#configuration) and then add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/motioneye.markdown b/source/_integrations/motioneye.markdown index 52a32384196..04aca2ec904 100644 --- a/source/_integrations/motioneye.markdown +++ b/source/_integrations/motioneye.markdown @@ -405,7 +405,7 @@ An automation to cast stored movie clips to a TV as they arrive. ### Debug Logging To enable debug logging for both the integration and the underlying client library, -enable the following in your `configuration.yaml` and then restart: +enable the following in your {% term "`configuration.yaml`" %} and then restart: ```yaml logger: diff --git a/source/_integrations/msteams.markdown b/source/_integrations/msteams.markdown index db46b193c49..bbe20e2bef7 100644 --- a/source/_integrations/msteams.markdown +++ b/source/_integrations/msteams.markdown @@ -17,12 +17,12 @@ The `Microsoft Teams` platform allows you to send notifications from Home Assist ## Setup -To send a notification to teams, you need to add the Incoming Webhook app to your team channel. When the app is added, you will receive a webhook URL that needs to be added to your `configuration.yaml`. +To send a notification to teams, you need to add the Incoming Webhook app to your team channel. When the app is added, you will receive a webhook URL that needs to be added to your {% term "`configuration.yaml`" %}. ## Configuration -To add the Microsoft Teams platform to your installation, add the following to your `configuration.yaml` file: +To add the Microsoft Teams platform to your installation, add the following to your {% term "`configuration.yaml`" %} file: ```yaml notify: @@ -46,9 +46,9 @@ url: The following attributes can be placed inside `data` for extended functionality. -| Service data attribute | Optional | Description | -| ---------------------- | -------- | ----------- | -| `image_url` | yes | Attach an image to the message. +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ------------------------------- | +| `image_url` | yes | Attach an image to the message. | The image must be an HTTPS URL, and as outlined by Microsoft in the [Documentation](https://learn.microsoft.com/en-us/microsoftteams/platform/task-modules-and-cards/cards/cards-reference#common-properties-for-all-cards), the picture must be on a publicly available location. diff --git a/source/_integrations/my.markdown b/source/_integrations/my.markdown index fc650ba001b..07fb231a475 100644 --- a/source/_integrations/my.markdown +++ b/source/_integrations/my.markdown @@ -19,7 +19,7 @@ My Home Assistant allows the documentation to link you to specific pages in your This integration is by default enabled, unless you've disabled or removed the [`default_config:`](/integrations/default_config/) line from your configuration. If that is the case, the following example shows you how to enable this integration manually: -Add the following section to your `configuration.yaml` file: +Add the following section to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry diff --git a/source/_integrations/mycroft.markdown b/source/_integrations/mycroft.markdown index d1b230be3d0..33c91b31f58 100644 --- a/source/_integrations/mycroft.markdown +++ b/source/_integrations/mycroft.markdown @@ -41,7 +41,7 @@ host: ## Using notifications -To use Mycroft for sending notifications, add the following to your `configuration.yaml` file: +To use Mycroft for sending notifications, add the following to your {% term "`configuration.yaml`" %} file: ```yaml # Example configuration.yaml entry