From 211fbfe54e922189dbc866ec97647e2fcbd6387b Mon Sep 17 00:00:00 2001 From: c0ffeeca7 Date: Thu, 16 Nov 2023 10:49:54 +0100 Subject: [PATCH 1/3] Docs: apply sentence-style capitalization --- source/_docs/authentication/providers.markdown | 4 ++-- source/_docs/automation/modes.markdown | 2 +- source/_docs/automation/templating.markdown | 6 +++--- source/_docs/automation/trigger.markdown | 12 ++++++------ source/_docs/automation/yaml.markdown | 6 +++--- source/_docs/blueprint/selectors.markdown | 14 +++++++------- source/_docs/blueprint/tutorial.markdown | 2 +- .../configuration/customizing-devices.markdown | 2 +- source/_docs/configuration/remote.markdown | 2 +- source/_docs/configuration/securing.markdown | 2 +- .../configuration/splitting_configuration.markdown | 2 +- source/_docs/configuration/templating.markdown | 6 +++--- .../_docs/configuration/troubleshooting.markdown | 2 +- source/_docs/configuration/yaml.markdown | 2 +- source/_docs/energy/electricity-grid.markdown | 2 +- source/_docs/energy/faq.markdown | 2 +- source/_docs/energy/individual-devices.markdown | 2 +- source/_docs/frontend/icons.markdown | 6 +++--- source/_docs/locked_out.md | 4 ++-- source/_docs/scripts.markdown | 10 +++++----- source/_docs/tools/dev-tools.markdown | 2 +- source/_docs/tools/quick-bar.markdown | 6 +++--- source/_docs/z-wave/controllers.markdown | 4 ++-- 23 files changed, 51 insertions(+), 51 deletions(-) diff --git a/source/_docs/authentication/providers.markdown b/source/_docs/authentication/providers.markdown index d6ef3e715905..04920ebb4a94 100644 --- a/source/_docs/authentication/providers.markdown +++ b/source/_docs/authentication/providers.markdown @@ -53,7 +53,7 @@ homeassistant: If you don't specify any `auth_providers` section in the `configuration.yaml` file then this provider will be set up automatically. -### Trusted Networks +### Trusted networks The Trusted Networks auth provider defines a range of IP addresses for which no authentication will be required (also known as "allowlisting"). For example, you can allowlist your local network so you won't be prompted for a password if you access Home Assistant from inside your home. @@ -152,7 +152,7 @@ homeassistant: Assuming you have only the owner created though onboarding process, no other users ever created. The above example configuration will allow you directly access Home Assistant main page if you access from your internal network (192.168.0.0/24) or from localhost (127.0.0.1). If you get a login abort error, then you can change to use Home Assistant Authentication Provider to login, if you access your Home Assistant instance from outside network. -### Command Line +### Command line The Command Line auth provider executes a configurable shell command to perform user authentication. Two environment variables, `username` and `password`, are passed to the command. Access is granted when the command exits successfully (with exit code 0). diff --git a/source/_docs/automation/modes.markdown b/source/_docs/automation/modes.markdown index 7ae86536bc7e..4864784a1757 100644 --- a/source/_docs/automation/modes.markdown +++ b/source/_docs/automation/modes.markdown @@ -38,7 +38,7 @@ automation: - delay: 300 # seconds (=5 minutes) ``` -## Example Queued +## Example queued Sometimes an automation is doing an action on a device that does not support multiple simultaneous actions. In such cases, a queue can be used. In that case, the automation will be executed once it's current invocation and queue are done. diff --git a/source/_docs/automation/templating.markdown b/source/_docs/automation/templating.markdown index dc2c2d777236..2fef062f41d2 100644 --- a/source/_docs/automation/templating.markdown +++ b/source/_docs/automation/templating.markdown @@ -78,7 +78,7 @@ These are the properties available for a [MQTT trigger](/docs/automation/trigger | `trigger.payload_json` | Dictionary of the JSON parsed payload. | `trigger.qos` | QOS of payload. -### Numeric State +### Numeric state These are the properties available for a [Numeric State trigger](/docs/automation/trigger/#numeric-state-trigger). @@ -146,7 +146,7 @@ These are the properties available for a [Time trigger](/docs/automation/trigger | `trigger.platform` | Hardcoded: `time` | `trigger.now` | DateTime object that triggered the time trigger. -### Time Pattern +### Time pattern These are the properties available for a [Time Pattern trigger](/docs/automation/trigger/#time-pattern-trigger). @@ -155,7 +155,7 @@ These are the properties available for a [Time Pattern trigger](/docs/automation | `trigger.platform` | Hardcoded: `time_pattern` | `trigger.now` | DateTime object that triggered the time_pattern trigger. -### Persistent Notification +### Persistent notification These properties are available for a [Persistent Notification trigger](/docs/automation/trigger/#persistent-notification-trigger). diff --git a/source/_docs/automation/trigger.markdown b/source/_docs/automation/trigger.markdown index 049bc8ca85e7..c346b75a71a6 100644 --- a/source/_docs/automation/trigger.markdown +++ b/source/_docs/automation/trigger.markdown @@ -33,7 +33,7 @@ An automation can be triggered by an event, a certain entity state, at a given t All triggers can be assigned an optional `id`. If the ID is omitted, it will instead be set to the index of the trigger. The `id` can be referenced from [trigger conditions and actions](/docs/scripts/conditions/#trigger-condition). The `id` does not have to be unique for each trigger, and it can be used to group similar triggers for use later in the automation (i.e., several triggers of different types that should all turn some entity on). -### Video Tutorial +### Video tutorial This video tutorial explains how trigger IDs work. @@ -673,7 +673,7 @@ If for your use case this is undesired, you could consider using the automation The time trigger is configured to fire once a day at a specific time, or at a specific time on a specific date. There are three allowed formats: -### Time String +### Time string A string that represents a time to fire on each day. Can be specified as `HH:MM` or `HH:MM:SS`. If the seconds are not specified, `:00` will be used. @@ -685,7 +685,7 @@ automation: at: "15:32:00" ``` -### Input Datetime +### Input datetime The Entity ID of an [Input Datetime](/integrations/input_datetime/). @@ -740,7 +740,7 @@ automation: entity_id: light.bedroom ``` -### Multiple Times +### Multiple times Multiple times can be provided in a list. Both formats can be intermixed. @@ -939,7 +939,7 @@ The sentences matched by this trigger will be: Punctuation and casing are ignored, so "It's PARTY TIME!!!" will also match. -### Sentence Wildcards +### Sentence wildcards Adding one or more `{lists}` to your trigger sentences will capture any text at that point in the sentence. A `slots` object will be [available in the trigger data](/docs/automation/templating#sentence). This allows you to match sentences with variable parts, such as album/artist names or a description of a picture. @@ -971,7 +971,7 @@ automation: event: sunset ``` -## Multiple Entity IDs for the same Trigger +## Multiple entity IDs for the same Trigger It is possible to specify multiple entities for the same trigger. To do so add multiple entities using a nested list. The trigger will fire and start, processing your automation each time the trigger is true for any entity listed. diff --git a/source/_docs/automation/yaml.markdown b/source/_docs/automation/yaml.markdown index c56865cbb836..48d9fd9ee28e 100644 --- a/source/_docs/automation/yaml.markdown +++ b/source/_docs/automation/yaml.markdown @@ -112,7 +112,7 @@ action: type: list {% endconfiguration %} -### Automation Modes +### Automation modes Mode | Description -|- @@ -127,7 +127,7 @@ Mode | Description -## YAML Example +## YAML example Example of a YAML based automation that you can add to `configuration.yaml`. @@ -262,7 +262,7 @@ If you want to migrate your manual automations to use the editor, you'll have to {% endraw %} -### Deleting Automations +### Deleting automations When automations remain visible in the Home Assistant Dashboard, even after having deleted in the YAML file, you have to delete them in the UI. diff --git a/source/_docs/blueprint/selectors.markdown b/source/_docs/blueprint/selectors.markdown index 41e0353b130c..382b9b2a8bf7 100644 --- a/source/_docs/blueprint/selectors.markdown +++ b/source/_docs/blueprint/selectors.markdown @@ -75,7 +75,7 @@ action: The output of this selector is a list of actions. For example: ```yaml -# Example Action selector output result +# Example action selector output result - service: scene.turn_on target: entity_id: scene.watching_movies @@ -96,7 +96,7 @@ selected add-on. This selector does not have any other options; therefore, it only has its key. ```yaml -# Example Add-on selector +# Example add-on selector addon: ``` @@ -201,10 +201,10 @@ The output of this selector is the area ID, or (in case `multiple` is set to `true`) a list of area IDs. ```yaml -# Example Area selector output result, when multiple is set to false +# Example area selector output result, when multiple is set to false living_room -# Example Area selector output result, when multiple is set to true +# Example area selector output result, when multiple is set to true - living_room - kitchen ``` @@ -346,7 +346,7 @@ condition: The output of this selector is a list of conditions. For example: ```yaml -# Example Condition selector output result +# Example condition selector output result - condition: numeric_state entity_id: "sensor.outside_temperature" below: 20 @@ -567,10 +567,10 @@ The output of this selector is the device ID, or (in case `multiple` is set to `true`) a list of devices IDs. ```yaml -# Example Device selector output result, when multiple is set to false +# Example device selector output result, when multiple is set to false faadde5365842003e8ca55267fe9d1f4 -# Example Device selector output result, when multiple is set to true +# Example device selector output result, when multiple is set to true - faadde5365842003e8ca55267fe9d1f4 - 3da77cb054352848b9544d40e19de562 ``` diff --git a/source/_docs/blueprint/tutorial.markdown b/source/_docs/blueprint/tutorial.markdown index 512efe3d2620..e4c2fddfcd55 100644 --- a/source/_docs/blueprint/tutorial.markdown +++ b/source/_docs/blueprint/tutorial.markdown @@ -248,7 +248,7 @@ Don't forget to reload automations after you make changes to your blueprint to h ![Screenshot of the blueprint UI](/images/blueprints/tutorial-ui.png) -## Video Tutorial +## Video tutorial This video tutorial explains how to create a blueprint that toggles a light on motion when the lux value is below a certain threshold. diff --git a/source/_docs/configuration/customizing-devices.markdown b/source/_docs/configuration/customizing-devices.markdown index 880e5a658dc2..f5121eefa097 100644 --- a/source/_docs/configuration/customizing-devices.markdown +++ b/source/_docs/configuration/customizing-devices.markdown @@ -57,7 +57,7 @@ initial_state: default: None {% endconfiguration %} -### Device Class +### Device class Device class is currently supported by the following platforms: diff --git a/source/_docs/configuration/remote.markdown b/source/_docs/configuration/remote.markdown index 010514553c8f..ca8e06d94c55 100644 --- a/source/_docs/configuration/remote.markdown +++ b/source/_docs/configuration/remote.markdown @@ -23,7 +23,7 @@ A secure way to remotely access your Home Assistant is to use a Virtual Private A VPN connection needs to be established before you can connect to your Home Assistant from outside your local network. The VPN makes this connection secure. When using the Home Assistant Companion app (such as on a mobile device), without this connection, your sensors will not update in Home Assistant. -## Port Forwarding +## Port forwarding Set up port forwarding (for any port) from your router to port 8123 on the computer that is hosting Home Assistant. General instructions on how to do this can be found by searching ` port forwarding instructions`. You can use any free port on your router and forward that to port 8123. diff --git a/source/_docs/configuration/securing.markdown b/source/_docs/configuration/securing.markdown index 5b73326e0be6..1af616185883 100644 --- a/source/_docs/configuration/securing.markdown +++ b/source/_docs/configuration/securing.markdown @@ -13,7 +13,7 @@ Here's the summary of what you *must* do to secure your Home Assistant system: - **Note**: Storing secrets in `secrets.yaml` does not encrypt them. - Regularly keep the system up to date -## Remote Access +## Remote access If you want secure remote access, the easiest option is to use [Home Assistant cloud](/cloud/) by which you also [support](https://www.nabucasa.com/about/) the founders of Home Assistant. diff --git a/source/_docs/configuration/splitting_configuration.markdown b/source/_docs/configuration/splitting_configuration.markdown index e3bf2de1db3f..2f3e7bd30c10 100644 --- a/source/_docs/configuration/splitting_configuration.markdown +++ b/source/_docs/configuration/splitting_configuration.markdown @@ -200,7 +200,7 @@ If you have many configuration files, Home Assistant provides a CLI that allows - [Core](/common-tasks/core/#configuration-check) - [Supervised](/common-tasks/supervised/#configuration-check) -## Advanced Usage +## Advanced usage We offer four advanced options to include whole directories at once. Please note that your files must have the `.yaml` file extension; `.yml` is not supported. diff --git a/source/_docs/configuration/templating.markdown b/source/_docs/configuration/templating.markdown index 31639b822866..9394540f72c2 100644 --- a/source/_docs/configuration/templating.markdown +++ b/source/_docs/configuration/templating.markdown @@ -65,7 +65,7 @@ extensions: - [Loop Controls](https://jinja.palletsprojects.com/en/3.0.x/extensions/#loop-controls) (`break` and `continue`) -### Reusing Templates +### Reusing templates You can write reusable Jinja templates by adding them to a `custom_templates` folder under your configuration directory. All template files must have the `.jinja` extension and be less than 5MiB. @@ -102,7 +102,7 @@ In your automations, you could then reuse this macro by importing it: Extensions allow templates to access all of the Home Assistant specific states and adds other convenience functions and filters. -### Limited Templates +### Limited templates Templates for some [triggers](/docs/automation/trigger/) as well as `trigger_variables` only support a subset of the Home Assistant template extensions. This subset is referred to as "Limited Templates". @@ -418,7 +418,7 @@ The same thing can also be expressed as a test: {% endraw %} -### Config Entries +### Config entries - `config_entry_id(entity_id)` returns the config entry ID for a given entity ID. Can also be used as a filter. diff --git a/source/_docs/configuration/troubleshooting.markdown b/source/_docs/configuration/troubleshooting.markdown index 566ffc1eb594..3eb666e3a19f 100644 --- a/source/_docs/configuration/troubleshooting.markdown +++ b/source/_docs/configuration/troubleshooting.markdown @@ -115,7 +115,7 @@ To enable debug logging for an integration, go to **Settings** > **Devices & Ser Once you enable debug logging, you ideally need to make the error happen. Run your automation, change up your device or whatever was giving you an error and then come back and disable the debug logging. Disabling the debug logging is the same as enabling, but now the button says **Disable Debug Logging**. After you disable it, you will be automatically prompted you to download your log file. Save this to a safe location to upload later. -### Download Diagnostics +### Download diagnostics After you download logs, you will also want to download the diagnostics for the integration giving you trouble. If the integration provides diagnostics, it will appear in the three dot menu next to the integration configuration. diff --git a/source/_docs/configuration/yaml.markdown b/source/_docs/configuration/yaml.markdown index 5c37425ee0cd..d3f2adda2262 100644 --- a/source/_docs/configuration/yaml.markdown +++ b/source/_docs/configuration/yaml.markdown @@ -93,7 +93,7 @@ light: !include lights.yaml More information about this feature can also be found at [splitting configuration](/docs/configuration/splitting_configuration/). -## Common Issues +## Common issues ### found character '\t' diff --git a/source/_docs/energy/electricity-grid.markdown b/source/_docs/energy/electricity-grid.markdown index af5b09aaadad..e3dde9876d74 100644 --- a/source/_docs/energy/electricity-grid.markdown +++ b/source/_docs/energy/electricity-grid.markdown @@ -69,7 +69,7 @@ _Attention! Installing CT clamp sensor devices requires opening your electrical Some energy providers will provide you real-time information about your usage and have this data integrated into Home Assistant. -### Manual Integration +### Manual integration If you manually integrate your sensors, for example, using the [MQTT](/integrations/mqtt) or [Template](/integrations/template) integrations: Make sure you set and provide the `device_class`, `state_class`, and `unit_of_measurement` for those sensors. diff --git a/source/_docs/energy/faq.markdown b/source/_docs/energy/faq.markdown index dffa7d097656..b9e589c20ee8 100644 --- a/source/_docs/energy/faq.markdown +++ b/source/_docs/energy/faq.markdown @@ -29,7 +29,7 @@ If you are using a 3rd party device (e.g. not reading directly from your utility To accomplish such, you can use the [utility_meter integration](/integrations/utility_meter/). With this integration, you define as many tariffs as required (in accordance with your utility provider contract) and HA will be able to differentiate energy consumptions in each of the tariffs. Please note that each utility provider has its own time schedules for peak and off-peak and you are required to create an automation that switches the utility_meter entity from one tariff to the other. -## The Energy panel is not visible +## The energy panel is not visible If you do not see the Energy panel in the sidebar, make sure you have not removed [`default_config:`](/integrations/default_config/) from your `configuration.yaml`. If you have, you will need to add the `energy:` integration manually. diff --git a/source/_docs/energy/individual-devices.markdown b/source/_docs/energy/individual-devices.markdown index 1e0f1751968d..6e17a2516a54 100644 --- a/source/_docs/energy/individual-devices.markdown +++ b/source/_docs/energy/individual-devices.markdown @@ -13,7 +13,7 @@ Smart plugs sit between the device and the outlet and measure the energy flowing Depending on what protocols you use at home, you can use Zigbee, Z-Wave or Wi-Fi based plugs. -### Smart Relays +### Smart relays Smart relays sit behind your "normal" switches and make them smart. It allows you to control the devices via Home Assistant and via the connected buttons/switches. diff --git a/source/_docs/frontend/icons.markdown b/source/_docs/frontend/icons.markdown index 0d394792e713..eebac52093a1 100644 --- a/source/_docs/frontend/icons.markdown +++ b/source/_docs/frontend/icons.markdown @@ -9,13 +9,13 @@ description: "Material Design Icons in the Home Assistant frontend" Home Assistant utilizes the community-driven [Material Design Icons](https://pictogrammers.com/library/mdi/) (MDI) project for icons in the frontend. The icon library is a superset of the base icon library provided by Google and contains thousands of community-made icons for very specific applications, industries, and use-cases. -## Default Icons +## Default icons Every entity in Home Assistant has a default icon assigned to it. There are way too many to list out here, but you'll see them in your dashboard. You can [customize any of your entities](/docs/configuration/customizing-devices/#icon) to change the icons displayed to you. -## Finding Icons +## Finding icons -### Icon Picker +### Icon picker The most common way you can find icons is by using the icon picker built right into Home Assistant. Click into the "Icon" field when customizing an entity and start typing. The list will filter to icons that match your search criteria. You can also scroll through all available icons when the field is empty. diff --git a/source/_docs/locked_out.md b/source/_docs/locked_out.md index 1c6562553640..dcdc9031def2 100644 --- a/source/_docs/locked_out.md +++ b/source/_docs/locked_out.md @@ -78,7 +78,7 @@ If you lose the password associated with the owner account and the steps above d - `hassio` - `cloud` -## Recovering Data for Home Assistant (including Supervised) +## Recovering data for Home Assistant (including Supervised) Unless your SD card/data is corrupted, you can still get to your files or troubleshoot further. There are a few routes: @@ -101,7 +101,7 @@ You will then be at the Home Assistant CLI, where you can run the custom command - `dns logs` for checking DNS - etc (typing `help` will show more) -## Accessing Files from the SD/HDD +## Accessing files from the SD/HDD ### Remove the SD and access the files from another computer diff --git a/source/_docs/scripts.markdown b/source/_docs/scripts.markdown index 804849270f19..7eb231f31434 100644 --- a/source/_docs/scripts.markdown +++ b/source/_docs/scripts.markdown @@ -241,7 +241,7 @@ This action can use the same triggers that are available in an automation's `tri {% endraw %} -### Wait Timeout +### Wait timeout With both types of waits it is possible to set a timeout after which the script will continue its execution if the condition/event is not satisfied. Timeout has the same syntax as `delay`, and like `delay`, also accepts templates. @@ -275,7 +275,7 @@ You can also get the script to abort after the timeout by using optional `contin Without `continue_on_timeout: false` the script will always continue since the default for `continue_on_timeout` is `true`. -### Wait Variable +### Wait variable After each time a wait completes, either because the condition was met, the event happened, or the timeout expired, the variable `wait` will be created/updated to indicate the result. @@ -392,7 +392,7 @@ The following automation example shows how to capture the custom event `event_li This action allows you to repeat a sequence of other actions. Nesting is fully supported. There are three ways to control how many times the sequence will be run. -### Counted Repeat +### Counted repeat This form accepts a count value. The value may be specified by a template, in which case the template is rendered when the repeat step is reached. @@ -473,7 +473,7 @@ repeat: {% endraw %} -### While Loop +### While loop This form accepts a list of conditions (see [conditions page] for available options) that are evaluated _before_ each time the sequence is run. The sequence will be run _as long as_ the condition(s) evaluate to true. @@ -514,7 +514,7 @@ For example: {% endraw %} -### Repeat Until +### Repeat until This form accepts a list of conditions that are evaluated _after_ each time the sequence is run. Therefore the sequence will always run at least once. The sequence will be run diff --git a/source/_docs/tools/dev-tools.markdown b/source/_docs/tools/dev-tools.markdown index 3852cdf4a53c..c6635e33e144 100644 --- a/source/_docs/tools/dev-tools.markdown +++ b/source/_docs/tools/dev-tools.markdown @@ -58,7 +58,7 @@ brightness: 255 rgb_color: [255, 0, 0] ``` -## Template Editor +## Template editor The Template Editor provides a way to quickly test templates prior to placing them into automations and scripts. A code editor is on the left side and your real-time output is displayed in the preview on the right side. diff --git a/source/_docs/tools/quick-bar.markdown b/source/_docs/tools/quick-bar.markdown index 603f7444809a..a2e57d77e61e 100644 --- a/source/_docs/tools/quick-bar.markdown +++ b/source/_docs/tools/quick-bar.markdown @@ -26,7 +26,7 @@ Type these from anywhere in the application to launch the dialog. The application must have focus for the hotkey to register. If the dialog doesn't launch, try clicking into an empty part of the main content area of Home Assistant and type it again. -## Entity Filter +## Entity filter *Hotkey: `e`* @@ -41,7 +41,7 @@ Once launched, start typing your entity id (or ["bits and pieces" of your entity This is helpful when, say, you are in the middle of writing an automation and need some quick insight about an entity but don't want to navigate away to Developer Tools. -## Command Palette +## Command palette *Hotkey: `c`* @@ -66,7 +66,7 @@ Type | Available | Create [`my`](/integrations/my) links from any supported page in the user interface, when invoked on a supported page it will open a new tab that will allow you to share the link in different formats. -## Disabling Shortcuts +## Disabling shortcuts You can enable or disable all of Home Assistant's keyboard shortcuts by going to your User Profile and clicking the "Keyboard Shortcuts" toggle button. diff --git a/source/_docs/z-wave/controllers.markdown b/source/_docs/z-wave/controllers.markdown index 0479530b7acc..edcf56f94017 100644 --- a/source/_docs/z-wave/controllers.markdown +++ b/source/_docs/z-wave/controllers.markdown @@ -52,7 +52,7 @@ If you are just starting out, we recommend that you purchase a 700 series contro If you're using Home Assistant OS, Supervised, or Container, it's recommended to use a USB stick, not a module. Passing a module through Docker is more complicated than passing a USB stick through. -## Stick Alternatives +## Stick alternatives The alternative to a stick is a hub that supports Z-Wave. Home Assistant supports the following hubs with Z-Wave support: @@ -61,7 +61,7 @@ The alternative to a stick is a hub that supports Z-Wave. Home Assistant support - [SmartThings](/integrations/smartthings/) - [Z-Wave.Me Z-Way](/integrations/zwave_me) -## Controller Notes +## Controller notes ### 800 Series Controllers From c7638f98e56bc5ebb0d1519dbab2c69895a6c20a Mon Sep 17 00:00:00 2001 From: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> Date: Sat, 18 Nov 2023 10:13:48 +0100 Subject: [PATCH 2/3] Update source/_docs/automation/trigger.markdown --- source/_docs/automation/trigger.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_docs/automation/trigger.markdown b/source/_docs/automation/trigger.markdown index c346b75a71a6..b56874587f43 100644 --- a/source/_docs/automation/trigger.markdown +++ b/source/_docs/automation/trigger.markdown @@ -971,7 +971,7 @@ automation: event: sunset ``` -## Multiple entity IDs for the same Trigger +## Multiple entity IDs for the same trigger It is possible to specify multiple entities for the same trigger. To do so add multiple entities using a nested list. The trigger will fire and start, processing your automation each time the trigger is true for any entity listed. From ffe3514c746d62ae2bd0dd57c85540f133755e84 Mon Sep 17 00:00:00 2001 From: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> Date: Sat, 18 Nov 2023 11:24:02 +0100 Subject: [PATCH 3/3] Apply suggestions from code review MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Joakim Sørensen --- source/_docs/authentication/providers.markdown | 4 ++-- source/_docs/automation/templating.markdown | 6 +++--- source/_docs/automation/trigger.markdown | 2 +- source/_docs/automation/yaml.markdown | 2 +- source/_docs/configuration/securing.markdown | 2 +- source/_docs/frontend/icons.markdown | 2 +- 6 files changed, 9 insertions(+), 9 deletions(-) diff --git a/source/_docs/authentication/providers.markdown b/source/_docs/authentication/providers.markdown index 04920ebb4a94..35329f4e9706 100644 --- a/source/_docs/authentication/providers.markdown +++ b/source/_docs/authentication/providers.markdown @@ -55,7 +55,7 @@ If you don't specify any `auth_providers` section in the `configuration.yaml` fi ### Trusted networks -The Trusted Networks auth provider defines a range of IP addresses for which no authentication will be required (also known as "allowlisting"). For example, you can allowlist your local network so you won't be prompted for a password if you access Home Assistant from inside your home. +The trusted networks auth provider defines a range of IP addresses for which no authentication will be required (also known as "allowlisting"). For example, you can allowlist your local network so you won't be prompted for a password if you access Home Assistant from inside your home. When you log in from one of these networks, you will be asked which user account to use and won't need to enter a password. @@ -154,7 +154,7 @@ Assuming you have only the owner created though onboarding process, no other use ### Command line -The Command Line auth provider executes a configurable shell command to perform user authentication. Two environment variables, `username` and `password`, are passed to the command. Access is granted when the command exits successfully (with exit code 0). +The command line auth provider executes a configurable shell command to perform user authentication. Two environment variables, `username` and `password`, are passed to the command. Access is granted when the command exits successfully (with exit code 0). This provider can be used to integrate Home Assistant with arbitrary external authentication services, from plaintext databases over LDAP to RADIUS. A compatible script for LDAP authentication is [this one](https://github.com/bob1de/ldap-auth-sh), for instance. Please note, this will only work when using the Home Assistant Core installation type. diff --git a/source/_docs/automation/templating.markdown b/source/_docs/automation/templating.markdown index 2fef062f41d2..692ad2f6d689 100644 --- a/source/_docs/automation/templating.markdown +++ b/source/_docs/automation/templating.markdown @@ -80,7 +80,7 @@ These are the properties available for a [MQTT trigger](/docs/automation/trigger ### Numeric state -These are the properties available for a [Numeric State trigger](/docs/automation/trigger/#numeric-state-trigger). +These are the properties available for a [numeric state trigger](/docs/automation/trigger/#numeric-state-trigger). | Template variable | Data | | ---- | ---- | @@ -148,7 +148,7 @@ These are the properties available for a [Time trigger](/docs/automation/trigger ### Time pattern -These are the properties available for a [Time Pattern trigger](/docs/automation/trigger/#time-pattern-trigger). +These are the properties available for a [time pattern trigger](/docs/automation/trigger/#time-pattern-trigger). | Template variable | Data | | ---- | ---- | @@ -157,7 +157,7 @@ These are the properties available for a [Time Pattern trigger](/docs/automation ### Persistent notification -These properties are available for a [Persistent Notification trigger](/docs/automation/trigger/#persistent-notification-trigger). +These properties are available for a [persistent notification trigger](/docs/automation/trigger/#persistent-notification-trigger). | Template variable | Data | | ---- | ---- | diff --git a/source/_docs/automation/trigger.markdown b/source/_docs/automation/trigger.markdown index b56874587f43..89becc5c24f9 100644 --- a/source/_docs/automation/trigger.markdown +++ b/source/_docs/automation/trigger.markdown @@ -687,7 +687,7 @@ automation: ### Input datetime -The Entity ID of an [Input Datetime](/integrations/input_datetime/). +The entity ID of an [input datetime](/integrations/input_datetime/). | has_date | has_time | Description | | -------- | -------- | ---------------------------------------- | diff --git a/source/_docs/automation/yaml.markdown b/source/_docs/automation/yaml.markdown index 48d9fd9ee28e..e26907af3e9b 100644 --- a/source/_docs/automation/yaml.markdown +++ b/source/_docs/automation/yaml.markdown @@ -264,7 +264,7 @@ If you want to migrate your manual automations to use the editor, you'll have to ### Deleting automations -When automations remain visible in the Home Assistant Dashboard, even after having deleted in the YAML file, you have to delete them in the UI. +When automations remain visible in the Home Assistant dashboard, even after having deleted in the YAML file, you have to delete them in the UI. To delete them completely, go to UI **{% my entities title="Settings -> Devices & Services -> Entities" %}** and find the automation in the search field or by scrolling down. diff --git a/source/_docs/configuration/securing.markdown b/source/_docs/configuration/securing.markdown index 1af616185883..18e5a015e9dc 100644 --- a/source/_docs/configuration/securing.markdown +++ b/source/_docs/configuration/securing.markdown @@ -15,7 +15,7 @@ Here's the summary of what you *must* do to secure your Home Assistant system: ## Remote access -If you want secure remote access, the easiest option is to use [Home Assistant cloud](/cloud/) by which you also [support](https://www.nabucasa.com/about/) the founders of Home Assistant. +If you want secure remote access, the easiest option is to use [Home Assistant Cloud](/cloud/) by which you also [support](https://www.nabucasa.com/about/) the founders of Home Assistant. Another option is to use TLS/SSL via the add-on [Duck DNS](/integrations/duckdns/) integrating Let's Encrypt. diff --git a/source/_docs/frontend/icons.markdown b/source/_docs/frontend/icons.markdown index eebac52093a1..7e1e2fb8f79c 100644 --- a/source/_docs/frontend/icons.markdown +++ b/source/_docs/frontend/icons.markdown @@ -17,7 +17,7 @@ Every entity in Home Assistant has a default icon assigned to it. There are way ### Icon picker -The most common way you can find icons is by using the icon picker built right into Home Assistant. Click into the "Icon" field when customizing an entity and start typing. The list will filter to icons that match your search criteria. You can also scroll through all available icons when the field is empty. +The most common way you can find icons is by using the icon picker built right into Home Assistant. Select the "Icon" field when customizing an entity and start typing. The list will filter to icons that match your search criteria. You can also scroll through all available icons when the field is empty.

Icon Picker in Home Assistant