From e5db5ba0f3c4ff971ecb856073f7c57fa9fe6d06 Mon Sep 17 00:00:00 2001 From: Antoni K Date: Mon, 4 Nov 2019 17:35:43 +0800 Subject: [PATCH] Slightly restructure page and improve grammar (#11011) --- source/_docs/configuration/yaml.markdown | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/source/_docs/configuration/yaml.markdown b/source/_docs/configuration/yaml.markdown index ea218828c3b..435e9f38fef 100644 --- a/source/_docs/configuration/yaml.markdown +++ b/source/_docs/configuration/yaml.markdown @@ -6,8 +6,9 @@ redirect_from: /getting-started/yaml/ Home Assistant uses the [YAML](https://yaml.org/) syntax for configuration. YAML might take a while to get used to but is really powerful in allowing you to express complex configurations. -For each integration that you want to use in Home Assistant, you add code in your `configuration.yaml` file to specify its settings. -The following example entry specifies that you want to use the [notify component](/integrations/notify) with the [pushbullet platform](/integrations/pushbullet). +For integrations that you want to use in Home Assistant, you add code in your `configuration.yaml` file to specify its settings. This especially applies to integrations that are not yet available to configure through the UI. + +The following example entry assumes that you would like to set up the [notify component](/integrations/notify) with the [pushbullet platform](/integrations/pushbullet). ```yaml @@ -30,14 +31,14 @@ You can use the online service [YAMLLint](http://www.yamllint.com/) to check if
-Please pay attention on not storing private data (passwords, API keys, etc.) directly in your `configuration.yaml` file. Private data can be stored in a [separate file](/docs/configuration/secrets/) or in [environmental variables](/docs/configuration/yaml/#using-environment-variables), which circumvents this problem of security. +Please pay attention to not storing private data (passwords, API keys, etc.) directly in your `configuration.yaml` file. Private data can be stored in either a [separate file](/docs/configuration/secrets/) or in [environmental variables](/docs/configuration/yaml/#using-environment-variables), which circumvents this security problem.
-Text following a `#` are comments and are ignored by the system. +Strings of text following a `#` are comments and are ignored by the system. -The next example shows an [input_select](/integrations/input_select) integration that uses a block collection for the options values. -The other properties (like name) are specified using mappings. Note that the second line just has `threat:` with no value on the same line. Here threat is the name of the input_select and the values for it are everything nested below it. +The next example shows an [input_select](/integrations/input_select) integration that uses a block collection for the values of options. +The other properties (like `name:`) are specified using mappings. Note that the second line just has `threat:` with no value on the same line. Here threat is the name of the input_select and the values for it are everything nested below it. ```yaml input_select: @@ -62,16 +63,17 @@ sensor: state_topic: sensor2/topic ``` -## Using Environment Variables +## Including values -You can include values from your system's environment variables with `!env_var`. +### Environmental variables +You can include values from your system's environment variables with `!env_var`. Note that this will only work in a scenario where it is possible to specify these. Hass.io users are recommended to use `!include` statements instead. ```yaml http: api_password: !env_var PASSWORD ``` -### Default Value +#### Default value If an environment variable is not set, you can fallback to a default value. @@ -80,7 +82,7 @@ http: api_password: !env_var PASSWORD default_password ``` -### Including Separate Files +### Including entire files To improve readability, you can source out certain domains from your main configuration file with the `!include`-syntax.