Configuration: Move related topics to meta data (#32409)

This commit is contained in:
c0ffeeca7 2024-04-22 14:42:24 +02:00 committed by GitHub
parent 0ddb576344
commit e6448f68dc
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
7 changed files with 51 additions and 50 deletions

View File

@ -1,6 +1,9 @@
---
title: "Automation Trigger"
description: "All the different ways how automations can be triggered."
related:
- docs: /voice_control/custom_sentences/#adding-a-custom-sentence-to-trigger-an-automation
title: Adding a custom sentence to trigger an automation
---
Triggers are what starts the processing of an {% term automation %} rule. When _any_ of the automation's triggers becomes true (trigger _fires_), Home Assistant will validate the [conditions](/docs/automation/condition/), if any, and call the [action](/docs/automation/action/).

View File

@ -1,6 +1,15 @@
---
title: "Configuration.yaml"
description: "Configuring Home Assistant via text files."
related:
- docs: /docs/configuration/yaml/
title: YAML syntax
- docs: /docs/configuration/secrets
title: Storing credentials in `secrets.yaml` file
- docs: /common-tasks/os/#backups
title: Creating and restoring backups
- docs: /integrations/backup
title: Creating backups for Home Assistant Container and Core
---
While you can configure most of Home Assistant directly from the user interface under {% my config %}, some parts need you to edit `configuration.yaml`. This file contains {% term integrations %} to be loaded along with their configurations. Throughout the documentation you will find snippets that you can add to your configuration file to enable specific functionality.
@ -49,14 +58,3 @@ The method for running a configuration check depends on your [installation type]
- [Configuration check on Supervised](/common-tasks/supervised/#configuration-check)
- [Configuration check on Container](/common-tasks/container/#configuration-check)
- [Configuration check on Core](/common-tasks/core/#configuration-check)
## Related topics
- [YAML syntax](/docs/configuration/yaml/)
- [Configuration check on Operating System](/common-tasks/os/#configuration-check)
- [Storing credentials in `secrets.yaml` file](/docs/configuration/secrets)
### Backups
- [Creating and restoring backups](/common-tasks/os/#backups)
- [Creating backups for Home Assistant Container and Core](/integrations/backup)

View File

@ -1,6 +1,11 @@
---
title: "Storing secrets"
description: "Storing secrets outside of your configuration.yaml."
related:
- docs: /docs/configuration/
title: `configuration.yaml` file
- docs: /docs/configuration/splitting_configuration/
title: Splitting the configuration
---
The `configuration.yaml` file is a plain-text file, thus it is readable by anyone who has access to the file. The file contains passwords and API tokens which need to be redacted if you want to share your configuration. By using `!secret` you can remove any private information from your configuration files. This separation can also help you to keep easier track of your passwords and API keys, as they are all stored at one place and no longer spread across the `configuration.yaml` file or even multiple YAML files if you [split up your configuration](/docs/configuration/splitting_configuration/).
@ -59,8 +64,3 @@ hass --script check_config --secrets
```
This will print all your secrets.
### Related topics
- [`configuration.yaml` file](/docs/configuration/)
- [Splitting the configuration](/docs/configuration/splitting_configuration/)

View File

@ -1,6 +1,13 @@
---
title: "Splitting up the configuration"
description: "Splitting the configuration.yaml into several files."
related:
- docs: /docs/configuration/
title: `configuration.yaml` file
- docs: /examples/#example-configurationyaml
title: Example configuration files by the community
- docs: /docs/configuration/packages
title: Using packages to organize configuration files
---
So you've been using Home Assistant for a while now and your `configuration.yaml` file brings people to tears because it has become so large. Or, you simply want to start off with the distributed approach. Here's how to split the `configuration.yaml` into more manageable (read: human-readable) pieces.
@ -536,8 +543,3 @@ automation ui: !include automations.yaml
```
[discord]: https://discord.gg/c5DvZ4e
## Related topics
- [Example configuration files by the community](/examples/#example-configurationyaml)
- [Using packages to organize configuration files](/docs/configuration/packages)

View File

@ -1,6 +1,19 @@
---
title: "YAML syntax"
description: "Details about the YAML syntax used to configure Home Assistant."
related:
- docs: /docs/configuration/
title: `configuration.yaml` file
- docs: /docs/configuration/secrets/
title: Storing private data in separate file
- docs: /docs/automation/yaml/
title: Automation.yaml
- docs: /docs/configuration/troubleshooting/
title: Troubleshooting the configuration files
- docs: /docs/configuration/#validating-the-configuration
title: Validating the configuration
- url: https://developers.home-assistant.io/docs/documenting/yaml-style-guide/
title: YAML Style Guide for Home Assistant developers
---
Home Assistant uses the [YAML](https://yaml.org/) syntax for configuration. While most integrations can be configured through the UI, some integrations require you to edit your [`configuration.yaml`](/docs/configuration/) file to specify its settings.
@ -130,20 +143,3 @@ not a valid value for dictionary value @ data
With all these indents and rules, it is easy to make a mistake. The best way to check if your YAML syntax is correct (validate) depends on the editor you use. We can't list them all here.
- If you edit the files directly in Home Assistant, refer to the section: [Validating the configuration](/docs/configuration/#validating-the-configuration)
## Related topics
### YAML
- [YAML Style Guide for Home Assistant developers](https://developers.home-assistant.io/docs/documenting/yaml-style-guide/)
- [Validating the configuration](/docs/configuration/#validating-the-configuration)
### Related configuration topics
- [`configuration.yaml` file](/docs/configuration/)
- [Troubleshooting the configuration files](/docs/configuration/troubleshooting/)
- [Storing private data in separate file](/docs/configuration/secrets/)
### Automation
- [Automation.yaml](/docs/automation/yaml/)

View File

@ -1,6 +1,13 @@
---
title: "I'm locked out!"
description: "Options for regaining access"
related:
- docs: /common-tasks/os/#listing-all-users-from-the-command-line
title: Listing all user names via command line
- url: https://yellow.home-assistant.io/guides/factory-reset/
title: Reset the Yellow
- url: https://green.home-assistant.io/guides/reset/
title: Reset the Green
---
The sections below deal with recovering from a situation where you are not able to sign in,
@ -131,9 +138,3 @@ For Windows or macOS you will need third party software. Below are some options.
- Windows: <https://www.diskinternals.com/linux-reader/> (read-only access to the SD)
- macOS: <https://osxfuse.github.io/>
## Related topics
- [Reset the Green](https://green.home-assistant.io/guides/reset/)
- [Reset the Yellow](https://yellow.home-assistant.io/guides/factory-reset/)
- [Listing all user names via command line](/common-tasks/os/#listing-all-users-from-the-command-line)

View File

@ -1,6 +1,13 @@
---
title: "General troubleshooting"
description: "General troubleshooting information"
related:
- docs: /docs/configuration/#editing-configurationyaml
title: Editing your configuration
- docs: /integrations/recovery_mode/
title: Recovery mode integration
- docs: /docs/locked_out/
title: Resetting your password
---
This page provides some information about more generic troubleshooting topics.
@ -35,9 +42,3 @@ If your Home Assistant is acting up and you cannot identify a root cause, you ca
Safe mode loads Home Assistant Core, but no custom integrations, no custom cards, and no custom themes. If the issue does not persist in Safe mode, the issue is not with Home Assistant Core. Before reporting an issue, check if the issue persists in Safe mode.
To enable Safe mode, go to **Settings** > **System** > **Restart Home Assistant** (top right) > **Restart Home Assistant in safe mode**.
## Related topics
- [Editing your configuration](/docs/configuration/#editing-configurationyaml)
- [Recovery mode integration](/integrations/recovery_mode/)
- [Resetting your password](/docs/locked_out/)