From 980996f0f50c3321765edda88fdc819c80130df4 Mon Sep 17 00:00:00 2001 From: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> Date: Tue, 23 Apr 2024 14:49:58 +0200 Subject: [PATCH] Docs: fix markdown in related meta data section (#32431) * Docs: fix markdown in related meta data section * Fix markdown * Update source/_docs/organizing/categories.markdown Co-authored-by: Klaas Schoute --------- Co-authored-by: Klaas Schoute --- source/_docs/automation/trigger.markdown | 4 ++-- source/_docs/configuration.markdown | 16 ++++++------- source/_docs/configuration/secrets.markdown | 8 +++---- .../splitting_configuration.markdown | 12 +++++----- source/_docs/configuration/yaml.markdown | 24 +++++++++---------- source/_docs/locked_out.md | 12 +++++----- source/_docs/organizing.markdown | 16 ++++++------- source/_docs/organizing/areas.markdown | 18 +++++++------- source/_docs/organizing/categories.markdown | 12 +++++----- source/_docs/organizing/filtering.markdown | 24 +++++++++---------- source/_docs/organizing/floors.markdown | 18 +++++++------- source/_docs/organizing/labels.markdown | 16 ++++++------- source/_docs/tools/check_config.markdown | 4 ++-- source/_docs/troubleshooting_general.markdown | 12 +++++----- 14 files changed, 98 insertions(+), 98 deletions(-) diff --git a/source/_docs/automation/trigger.markdown b/source/_docs/automation/trigger.markdown index 30663a158ac..9f7dc28a1f1 100644 --- a/source/_docs/automation/trigger.markdown +++ b/source/_docs/automation/trigger.markdown @@ -2,8 +2,8 @@ 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 + - 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/). diff --git a/source/_docs/configuration.markdown b/source/_docs/configuration.markdown index 5e340df411a..66f388bfcc1 100644 --- a/source/_docs/configuration.markdown +++ b/source/_docs/configuration.markdown @@ -2,14 +2,14 @@ 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 + - 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. diff --git a/source/_docs/configuration/secrets.markdown b/source/_docs/configuration/secrets.markdown index a30ad0b505b..e762db3af80 100644 --- a/source/_docs/configuration/secrets.markdown +++ b/source/_docs/configuration/secrets.markdown @@ -2,10 +2,10 @@ 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 + - 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/). diff --git a/source/_docs/configuration/splitting_configuration.markdown b/source/_docs/configuration/splitting_configuration.markdown index 6cf73ba8e06..7a19080c907 100644 --- a/source/_docs/configuration/splitting_configuration.markdown +++ b/source/_docs/configuration/splitting_configuration.markdown @@ -2,12 +2,12 @@ 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 + - 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. diff --git a/source/_docs/configuration/yaml.markdown b/source/_docs/configuration/yaml.markdown index 2a0b6b6eba3..cb357c55033 100644 --- a/source/_docs/configuration/yaml.markdown +++ b/source/_docs/configuration/yaml.markdown @@ -2,18 +2,18 @@ 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 + - 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. diff --git a/source/_docs/locked_out.md b/source/_docs/locked_out.md index 1b6266c3df4..d8935e29b31 100644 --- a/source/_docs/locked_out.md +++ b/source/_docs/locked_out.md @@ -2,12 +2,12 @@ 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 + - 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, diff --git a/source/_docs/organizing.markdown b/source/_docs/organizing.markdown index cfd1d72acdc..5091baaac10 100644 --- a/source/_docs/organizing.markdown +++ b/source/_docs/organizing.markdown @@ -2,14 +2,14 @@ title: "Grouping your assets" description: "Grouping your assets makes it easier to find them and allows you to target groups in automations." related: -- docs: /docs/organizing/areas/ - title: Areas -- docs: /docs/organizing/floors/ - title: Floors -- docs: /docs/organizing/labels/ - title: Labels -- docs: /docs/organizing/categories/ - title: Categories + - docs: /docs/organizing/areas/ + title: Areas + - docs: /docs/organizing/floors/ + title: Floors + - docs: /docs/organizing/labels/ + title: Labels + - docs: /docs/organizing/categories/ + title: Categories --- Once you have more devices, you may want to target entire groups of devices in automations. It also becomes more challenging to find items in lists. There are a few tools to group your assets: [Areas](#areas), [floors](#floors), [labels](#labels), and [categories](#categories). diff --git a/source/_docs/organizing/areas.markdown b/source/_docs/organizing/areas.markdown index 28f3d364f45..9b132256f52 100644 --- a/source/_docs/organizing/areas.markdown +++ b/source/_docs/organizing/areas.markdown @@ -2,15 +2,15 @@ title: "Areas" description: "Group your devices and entities in areas and group areas in floors." related: -- docs: /docs/organizing/areas/ - title: Areas -- docs: /docs/organizing/ -- docs: /docs/organizing/labels/ - title: Labels -- docs: /docs/organizing/categories/ - title: Categories -- docs: /docs/configuration/templating/#areas - title: Using areas in template + - docs: /docs/organizing/areas/ + title: Areas + - docs: /docs/organizing/ + - docs: /docs/organizing/labels/ + title: Labels + - docs: /docs/organizing/categories/ + title: Categories + - docs: /docs/configuration/templating/#areas + title: Using areas in template --- An area in Home Assistant is a logical grouping of {% term devices %} and {% term entities %} that are meant to match areas (or rooms) in the physical world of your home. For example, the "Living room" area groups devices and entities in your living room. Areas allow you to target an entire group of devices with a service call. For example, turning off all the lights in the living room. diff --git a/source/_docs/organizing/categories.markdown b/source/_docs/organizing/categories.markdown index ee2dd14455b..bb3ff237946 100644 --- a/source/_docs/organizing/categories.markdown +++ b/source/_docs/organizing/categories.markdown @@ -2,12 +2,12 @@ title: "Categories" description: "Use categories to group and filter your table items" related: -- docs: /docs/organizing/areas/ - title: Areas -- docs: /docs/organizing/floors/ - title: Floors -- docs: /docs/organizing/labels/ - title: Labels + - docs: /docs/organizing/areas/ + title: Areas + - docs: /docs/organizing/floors/ + title: Floors + - docs: /docs/organizing/labels/ + title: Labels --- Categories let you group and filter items in a table. Like labels, categories allow grouping irrespective of the items physical location. For example, on the automations page, you can create the categories “Notifications” or “NFC tags” to view your automations grouped or filtered. These categories group automations on the automation page, but have no effect anywhere else. Categories are unique for each table. The automations page can have different categories than the scene, scripts, or helpers settings page. diff --git a/source/_docs/organizing/filtering.markdown b/source/_docs/organizing/filtering.markdown index 2e4d19a1430..97aea10bfbf 100644 --- a/source/_docs/organizing/filtering.markdown +++ b/source/_docs/organizing/filtering.markdown @@ -2,18 +2,18 @@ title: "Filtering your assets" description: "Filter for items in tables." related: -- docs: /docs/organizing/floors/ - title: Floors -- docs: /docs/organizing/labels/ - title: Labels -- docs: /docs/organizing/areas/ - title: Areas -- docs: /docs/organizing/categories/ - title: Categories -- docs: /docs/organizing/ - title: Grouping your assets -- docs: /common-tasks/general/ - title: Enabling or disabling entities and automations + - docs: /docs/organizing/floors/ + title: Floors + - docs: /docs/organizing/labels/ + title: Labels + - docs: /docs/organizing/areas/ + title: Areas + - docs: /docs/organizing/categories/ + title: Categories + - docs: /docs/organizing/ + title: Grouping your assets + - docs: /common-tasks/general/ + title: Enabling or disabling entities and automations --- When working with tables, you can select multiple elements to apply an action on multiple items at once. If you have [grouped](/docs/organizing/) your assets by assigning them to floors, areas, labels, or directories you can also filter your data accordingly. diff --git a/source/_docs/organizing/floors.markdown b/source/_docs/organizing/floors.markdown index e86cb2d7777..d4db0cb84cf 100644 --- a/source/_docs/organizing/floors.markdown +++ b/source/_docs/organizing/floors.markdown @@ -2,15 +2,15 @@ title: "Floors" description: "Group your areas per floor" related: -- docs: /docs/organizing/areas/ - title: Areas -- docs: /docs/organizing/ -- docs: /docs/organizing/labels/ - title: Labels -- docs: /docs/configuration/templating/#floors - title: Using floors in templates -- docs: /voice_control/aliases/ - title: Using floor alias for voice assistants + - docs: /docs/organizing/areas/ + title: Areas + - docs: /docs/organizing/ + - docs: /docs/organizing/labels/ + title: Labels + - docs: /docs/configuration/templating/#floors + title: Using floors in templates + - docs: /voice_control/aliases/ + title: Using floor alias for voice assistants --- A floor in Home Assistant is a logical grouping of areas meant to match your home's physical floors. Devices and entities diff --git a/source/_docs/organizing/labels.markdown b/source/_docs/organizing/labels.markdown index f76f7057de8..fddcb4659bf 100644 --- a/source/_docs/organizing/labels.markdown +++ b/source/_docs/organizing/labels.markdown @@ -2,14 +2,14 @@ title: "Labels" description: "Label your areas, devices, entities, automations, scripts, and helpers. Then, filter by label or run an automation on all entities with that label." related: -- docs: /docs/organizing/areas/ - title: Areas -- docs: /docs/organizing/floors/ - title: Floors -- docs: /docs/organizing/categories/ - title: Categories -- docs: /docs/configuration/templating/#labels - title: Using labels in templates + - docs: /docs/organizing/areas/ + title: Areas + - docs: /docs/organizing/floors/ + title: Floors + - docs: /docs/organizing/categories/ + title: Categories + - docs: /docs/configuration/templating/#labels + title: Using labels in templates --- Labels in Home Assistant allow grouping elements irrespective of their physical location or type. Labels can be assigned to areas, devices, entities, automations, scenes, scripts, and helpers. Labels can be used in automations and scripts as a target for actions and services. Labels can also be used to filter data. For example, you can filter the list of devices to show only devices with the label `heavy energy usage` or turn these devices off when there is not a lot of solar energy available. diff --git a/source/_docs/tools/check_config.markdown b/source/_docs/tools/check_config.markdown index fae27e4d9be..4a805d672cd 100644 --- a/source/_docs/tools/check_config.markdown +++ b/source/_docs/tools/check_config.markdown @@ -2,8 +2,8 @@ title: "check_config" description: "Script to perform a check of the current configuration" related: -- docs: /docs/configuration/#validating-the-configuration - title: Validating the configuration + - docs: /docs/configuration/#validating-the-configuration + title: Validating the configuration --- Test any changes to your `configuration.yaml` file before launching Home Assistant. This script allows you to test changes without the need to restart Home Assistant. diff --git a/source/_docs/troubleshooting_general.markdown b/source/_docs/troubleshooting_general.markdown index 1b3321f51ec..9180465edbd 100644 --- a/source/_docs/troubleshooting_general.markdown +++ b/source/_docs/troubleshooting_general.markdown @@ -2,12 +2,12 @@ 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 + - 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.