Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: apply sentence-style capitalization #29891

Merged
merged 3 commits into from
Nov 18, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions source/_docs/authentication/providers.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,9 @@ 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.
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.

Expand Down Expand Up @@ -152,9 +152,9 @@ 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).
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.

Expand Down
2 changes: 1 addition & 1 deletion source/_docs/automation/modes.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
12 changes: 6 additions & 6 deletions source/_docs/automation/templating.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -78,9 +78,9 @@ 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).
These are the properties available for a [numeric state trigger](/docs/automation/trigger/#numeric-state-trigger).

| Template variable | Data |
| ---- | ---- |
Expand Down Expand Up @@ -146,18 +146,18 @@ 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).
These are the properties available for a [time pattern trigger](/docs/automation/trigger/#time-pattern-trigger).

| Template variable | Data |
| ---- | ---- |
| `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).
These properties are available for a [persistent notification trigger](/docs/automation/trigger/#persistent-notification-trigger).

| Template variable | Data |
| ---- | ---- |
Expand Down
14 changes: 7 additions & 7 deletions source/_docs/automation/trigger.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<lite-youtube videoid="fE_MYcXYwMI" videotitle="How to use Trigger IDs in Home Assistant - Tutorial" posterquality="maxresdefault"></lite-youtube>
Expand Down Expand Up @@ -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.

Expand All @@ -685,9 +685,9 @@ automation:
at: "15:32:00"
```

### Input Datetime
### 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 |
| -------- | -------- | ---------------------------------------- |
Expand Down Expand Up @@ -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.

Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.

Expand Down
8 changes: 4 additions & 4 deletions source/_docs/automation/yaml.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ action:
type: list
{% endconfiguration %}

### Automation Modes
### Automation modes

Mode | Description
-|-
Expand All @@ -127,7 +127,7 @@ Mode | Description



## YAML Example
## YAML example

Example of a YAML based automation that you can add to `configuration.yaml`.

Expand Down Expand Up @@ -262,9 +262,9 @@ 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.
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.

Expand Down
14 changes: 7 additions & 7 deletions source/_docs/blueprint/selectors.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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:
```

Expand Down Expand Up @@ -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
```
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
```
Expand Down
2 changes: 1 addition & 1 deletion source/_docs/blueprint/tutorial.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion source/_docs/configuration/customizing-devices.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ initial_state:
default: None
{% endconfiguration %}

### Device Class
### Device class

Device class is currently supported by the following platforms:

Expand Down
2 changes: 1 addition & 1 deletion source/_docs/configuration/remote.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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 `<router model> port forwarding instructions`. You can use any free port on your router and forward that to port 8123.

Expand Down
4 changes: 2 additions & 2 deletions source/_docs/configuration/securing.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ 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.
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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
6 changes: 3 additions & 3 deletions source/_docs/configuration/templating.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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".

Expand Down Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion source/_docs/configuration/troubleshooting.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion source/_docs/configuration/yaml.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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'

Expand Down
2 changes: 1 addition & 1 deletion source/_docs/energy/electricity-grid.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion source/_docs/energy/faq.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion source/_docs/energy/individual-devices.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
8 changes: 4 additions & 4 deletions source/_docs/frontend/icons.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@ 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.
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.

<p class='img'>
<img src='/images/screenshots/icon-picker.png' alt='Icon Picker in Home Assistant' />
Expand Down
4 changes: 2 additions & 2 deletions source/_docs/locked_out.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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

Expand Down
Loading