m-integrations: add glossary reference to config file (#32759)

This commit is contained in:
c0ffeeca7 2024-05-14 15:34:09 +02:00 committed by GitHub
parent c0c5be1bfd
commit 5e853cf251
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
12 changed files with 17 additions and 17 deletions

View File

@ -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. 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 ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry

View File

@ -42,7 +42,7 @@ for example, the Samba add-on. Users of Home Assistant Container can
mount a volume of their choice to `/media`. mount a volume of their choice to `/media`.
If you are a Home Assistant Core user, the default directory called is called 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 Files served from `media` are protected by Home Assistant authentication
unlike those served from `www`. unlike those served from `www`.

View File

@ -19,7 +19,7 @@ The binary sensor state shows the warning message if applicable. The details are
## Configuration ## 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 ```yaml
binary_sensor: binary_sensor:

View File

@ -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/). 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 ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry

View File

@ -27,7 +27,7 @@ Please note that all keys on cognitive services must be recreated every 90 days.
## Configuration ## Configuration
To enable the Microsoft Face {% term integration %}, 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 ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry

View File

@ -39,7 +39,7 @@ Precision:
Alternatively, this integration can be configured and set up manually via YAML Alternatively, this integration can be configured and set up manually via YAML
instead. To enable the Integration sensor in your installation, add the 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 ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry

View File

@ -18,7 +18,7 @@ To download or upload files, folders must be added to [allowlist_external_dirs](
## Configuration ## 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 ```yaml
minio: minio:

View File

@ -62,7 +62,7 @@ mochad:
The `mochad` light platform lets you control an X10 enabled dimmer/light device. 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 ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
@ -99,7 +99,7 @@ brightness_levels:
The `mochad` switch platform lets you control an X10 enabled switch device. 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 ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry

View File

@ -405,7 +405,7 @@ An automation to cast stored movie clips to a TV as they arrive.
### Debug Logging ### Debug Logging
To enable debug logging for both the integration and the underlying client library, 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 ```yaml
logger: logger:

View File

@ -17,12 +17,12 @@ The `Microsoft Teams` platform allows you to send notifications from Home Assist
## Setup ## 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 ## 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 ```yaml
notify: notify:
@ -47,8 +47,8 @@ url:
The following attributes can be placed inside `data` for extended functionality. The following attributes can be placed inside `data` for extended functionality.
| Service data attribute | Optional | Description | | Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- | | ---------------------- | -------- | ------------------------------- |
| `image_url` | yes | Attach an image to the message. | `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. 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.

View File

@ -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: 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 ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry

View File

@ -41,7 +41,7 @@ host:
## Using notifications ## 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 ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry