From 4d7f6d14801c60a5005cc3107e4458b7c3f8c3b7 Mon Sep 17 00:00:00 2001 From: Sven Serlier <85389871+wrt54g@users.noreply.github.com> Date: Sun, 26 Mar 2023 11:50:04 +0200 Subject: [PATCH] Small documentation improvements (4) (#26702) Co-authored-by: Marc Randolph --- source/_docs/scripts.markdown | 16 ++++++++-------- source/_docs/scripts/service-calls.markdown | 2 +- source/_integrations/apple_tv.markdown | 2 +- source/_integrations/zeroconf.markdown | 2 +- 4 files changed, 11 insertions(+), 11 deletions(-) diff --git a/source/_docs/scripts.markdown b/source/_docs/scripts.markdown index 37c6c66c57f..a6164301a14 100644 --- a/source/_docs/scripts.markdown +++ b/source/_docs/scripts.markdown @@ -5,7 +5,7 @@ toc: true no_toc: true --- -Scripts are a sequence of {% term actions %} that Home Assistant will execute. Scripts are available as an entity through the standalone [Script component] but can also be embedded in {% term automations %} and [Alexa/Amazon Echo] configurations. +Scripts are a sequence of {% term actions %} that Home Assistant will execute. Scripts are available as an entity through the standalone [Script integration] but can also be embedded in {% term automations %} and [Alexa/Amazon Echo] configurations. When the script is executed within an automation the `trigger` variable is available. See [Available-Trigger-Data](/docs/automation/templating/#available-trigger-data). @@ -210,7 +210,7 @@ These actions allow a script to wait for entities in the system to be in a certa This action evaluates the template, and if true, the script will continue. If not, then it will wait until it is true. -The template is re-evaluated whenever an entity ID that it references changes state. If you use non-deterministic functions like `now()` in the template it will not be continuously re-evaluated, but only when an entity ID that is referenced is changed. If you need to periodically re-evaluate the template, reference a sensor from the [Time and Date](/integrations/time_date/) component that will update minutely or daily. +The template is re-evaluated whenever an entity ID that it references changes state. If you use non-deterministic functions like `now()` in the template it will not be continuously re-evaluated, but only when an entity ID that is referenced is changed. If you need to periodically re-evaluate the template, reference a sensor from the [Time and Date](/integrations/time_date/) integration that will update minutely or daily. {% raw %} ```yaml @@ -892,22 +892,22 @@ script: # This action will not run, as it is disabled. # The message will not be sent. - enabled: false - alias: "Notify that ceiling light is being turned on" + alias: "Notify that the ceiling light is being turned on" service: notify.notify data: message: "Turning on the ceiling light!" # This action will run, as it is not disabled - - alias: "Turn on ceiling light" + - alias: "Turn on the ceiling light" service: light.turn_on target: entity_id: light.ceiling ``` -[Script component]: /integrations/script/ -[automations]: /getting-started/automation-action/ +[Script integration]: /integrations/script/ +[automations]: /docs/automation/action/ [Alexa/Amazon Echo]: /integrations/alexa/ -[service calls page]: /getting-started/scripts-service-calls/ -[conditions page]: /getting-started/scripts-conditions/ +[service calls page]: /docs/scripts/service-calls/ +[conditions page]: /docs/scripts/conditions/ [shorthand-template]: /docs/scripts/conditions/#template-condition-shorthand-notation [script variables]: /integrations/script/#configuration-variables diff --git a/source/_docs/scripts/service-calls.markdown b/source/_docs/scripts/service-calls.markdown index 9db2bc754de..04f2e613c3e 100644 --- a/source/_docs/scripts/service-calls.markdown +++ b/source/_docs/scripts/service-calls.markdown @@ -57,7 +57,7 @@ data: rgb_color: [255, 0, 0] ``` -A full list of the parameters for a service can be found on the documentation page of each component, in the same way as it's done for the `light.turn_on` [service](/integrations/light/#service-lightturn_on). +A full list of the parameters for a service can be found on the documentation page of each integration, in the same way as it's done for the `light.turn_on` [service](/integrations/light/#service-lightturn_on). ### Use templates to decide which service to call diff --git a/source/_integrations/apple_tv.markdown b/source/_integrations/apple_tv.markdown index ca3911c85e6..4ae314c13ce 100644 --- a/source/_integrations/apple_tv.markdown +++ b/source/_integrations/apple_tv.markdown @@ -143,7 +143,7 @@ The tvOS apps themselves decide what commands they support and when they support them. Likely, the app you are using does not support the action you are trying to perform. Before writing an issue about this, verify if the same action is possible with the Remote app in iOS. If that is the case, please write a bug in -[pyatv](https://github.com/postlund/pyatv/issues/new?assignees=&labels=bug&template=bug_report.md&title=) +[pyatv](https://github.com/postlund/pyatv/issues/new?assignees=&labels=bug&template=bug_report.yml) and include logs (see Debugging below). ### I'm trying to play a stream via AirPlay, but it doesn't work diff --git a/source/_integrations/zeroconf.markdown b/source/_integrations/zeroconf.markdown index bd269a9d337..4bcb7d5fc1a 100644 --- a/source/_integrations/zeroconf.markdown +++ b/source/_integrations/zeroconf.markdown @@ -14,7 +14,7 @@ ha_integration_type: system The `zeroconf` integration will scan the network for supported devices and services. Discovered integrations will show up in the discovered section on the integrations page in the configuration panel. It will also make Home Assistant discoverable for other services in the network. Zeroconf is also sometimes known as Bonjour, Rendezvous, and Avahi. -Integrations can opt-in to be found by adding either [a Zeroconf section](https://developers.home-assistant.io/docs/en/next/creating_integration_manifest.html#zeroconf) or [a HomeKit section](https://developers.home-assistant.io/docs/en/next/creating_integration_manifest.html#homekit) to their `manifest.json`. +Integrations can opt-in to be found by adding either [a Zeroconf section](https://developers.home-assistant.io/docs/creating_integration_manifest/#zeroconf) or [a HomeKit section](https://developers.home-assistant.io/docs/creating_integration_manifest/#homekit) to their `manifest.json`. ## Configuration