From 6af0f2fc333157ac0929e5c5cbea64e3690f24b8 Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Tue, 10 Jan 2023 14:37:50 +0100 Subject: [PATCH] Remove platform style 'adding devices' page (#25527) --- source/_docs/configuration/devices.markdown | 61 ------------------- source/_docs/configuration/packages.markdown | 2 +- .../configuration/troubleshooting.markdown | 2 +- source/_includes/asides/docs_navigation.html | 3 - source/_redirects | 2 +- 5 files changed, 3 insertions(+), 67 deletions(-) delete mode 100644 source/_docs/configuration/devices.markdown diff --git a/source/_docs/configuration/devices.markdown b/source/_docs/configuration/devices.markdown deleted file mode 100644 index 4a51048b9ee..00000000000 --- a/source/_docs/configuration/devices.markdown +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: "Adding devices to Home Assistant" -description: "Steps to help you get your devices in Home Assistant." ---- - -Home Assistant will be able to automatically discover many devices and services -available on your network. - -See the [integrations overview page](/integrations/) to find installation -instructions for your devices and services. Most integration can be -fully configured via the user interface these days; however, some older or -more complex integrations may need to be configured manually using YAML. - -For some of these integrations, every entity needs its own entry in the -`configuration.yaml` file. There are two styles for multiple entity entries: - -## Style 1: Collect every entity under the "parent" - -```yaml -sensor: - - platform: mqtt - state_topic: "home/bedroom/temperature" - name: "MQTT Sensor 1" - - platform: mqtt - state_topic: "home/kitchen/temperature" - name: "MQTT Sensor 2" - - platform: rest - resource: "http://IP_ADDRESS/ENDPOINT" - name: "Weather" - -switch: - - platform: vera -``` - -## Style 2: List each entity separately - -You need to append numbers or strings to differentiate the entries, as in the -example below. The appended number or string must be unique. - -```yaml -sensor bedroom: - platform: mqtt - state_topic: "home/bedroom/temperature" - name: "MQTT Sensor 1" - -sensor kitchen: - platform: mqtt - state_topic: "home/kitchen/temperature" - name: "MQTT Sensor 2" - -sensor weather: - platform: rest - resource: "http://IP_ADDRESS/ENDPOINT" - name: "Weather" - -switch 1: - platform: vera - -switch 2: - platform: vera -``` diff --git a/source/_docs/configuration/packages.markdown b/source/_docs/configuration/packages.markdown index 9680a6b30e1..08f37938bbc 100644 --- a/source/_docs/configuration/packages.markdown +++ b/source/_docs/configuration/packages.markdown @@ -3,7 +3,7 @@ title: "Packages" description: "Describes all there is to know about configuration packages in Home Assistant." --- -Packages in Home Assistant provide a way to bundle different component's configuration together. We already learned about the two configuration styles (specifying platforms entries together or individually) on the [adding devices](/docs/configuration/devices/) page. Both of these configuration methods require you to create the integration key in the main `configuration.yaml` file. With packages we have a way to include different components, or different configuration parts using any of the `!include` directives introduced in [splitting the configuration](/docs/configuration/splitting_configuration). +Packages in Home Assistant provide a way to bundle different component's configuration together. With packages we have a way to include different components, or different configuration parts using any of the `!include` directives introduced in [splitting the configuration](/docs/configuration/splitting_configuration). Packages are configured under the core `homeassistant/packages` in the configuration and take the format of a package name (no spaces, all lower case) followed by a dictionary with the package configuration. For example, package `pack_1` would be created as: diff --git a/source/_docs/configuration/troubleshooting.markdown b/source/_docs/configuration/troubleshooting.markdown index 2f4d628efc7..47b423abb3e 100644 --- a/source/_docs/configuration/troubleshooting.markdown +++ b/source/_docs/configuration/troubleshooting.markdown @@ -29,7 +29,7 @@ One of the most common problems with Home Assistant is an invalid `configuration - You can verify your configuration's YAML structure using [this online YAML parser](https://yaml-online-parser.appspot.com/) or [YAML Validator](https://codebeautify.org/yaml-validator/). - To learn more about the quirks of YAML, read [YAML IDIOSYNCRASIES](https://docs.saltproject.io/en/latest/topics/troubleshooting/yaml_idiosyncrasies.html) by SaltStack (the examples there are specific to SaltStack, but do explain YAML issues well). -`configuration.yaml` does not allow multiple sections to have the same name. If you want to load multiple platforms for one component, you can append a [number or string](/docs/configuration/devices/#style-2-list-each-entity-separately) to the name or nest them using [this style](/docs/configuration/devices/#style-1-collect-every-entity-under-the-parent): +`configuration.yaml` does not allow multiple sections to have the same name. If you want to load multiple platforms for one component, you can append a number or string to the name or nest them: ```yaml sensor: diff --git a/source/_includes/asides/docs_navigation.html b/source/_includes/asides/docs_navigation.html index d37d9db9f0f..8006ed7863f 100644 --- a/source/_includes/asides/docs_navigation.html +++ b/source/_includes/asides/docs_navigation.html @@ -25,9 +25,6 @@
  • {% active_link /docs/configuration/basic/ Basic information %}
    • -
  • - {% active_link /docs/configuration/devices/ Setting up devices %} -
  • {% active_link /docs/configuration/customizing-devices/ Customizing entities %} diff --git a/source/_redirects b/source/_redirects index 810fcb5c3e8..662e9b27a75 100644 --- a/source/_redirects +++ b/source/_redirects @@ -276,7 +276,6 @@ /getting-started/basic /docs/configuration/basic /getting-started/browsers /docs/frontend/browsers /getting-started/customizing-devices /docs/configuration/customizing-devices -/getting-started/devices /docs/configuration/devices /getting-started/installation /docs/installation /getting-started/installation-docker /docs/installation/docker /getting-started/installation-virtualenv /docs/installation/virtualenv @@ -412,6 +411,7 @@ /docs/tools/keyring/ /docs/configuration/secrets /docs/tools/credstash/ /docs/configuration/secrets /docs/scripts/editor/ /docs/scripts +/getting-started/devices /integrations # Blog /blog/2019/05/29/release-94 /blog/2019/06/05/release-94