jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-16 05:46:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update instructions for using Check Config Tool (#10619)

Browse Source 
* automation troubleshooting.markdown

Add explanation of making check config visible

* withings.markdown

Add explanation of how to make the check config tool visible

* configuration.markdown

Add explanation to display the check config tool
This commit is contained in:
Tom Brien 2019-10-08 11:55:08 +01:00 committed by Fabian Affolter
parent 083351b990
commit d6c2db6c6a
3 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
source/_docs/automation/troubleshooting.markdown
View File

@ -28,7 +28,7 @@ Please note that if you click on **Trigger** of an automation in the frontend, *
All this makes that Trigger feature pretty limited and nearly useless for debugging purposes so you need to find another way. All this makes that Trigger feature pretty limited and nearly useless for debugging purposes so you need to find another way.
Make sure you check and adapt to your circumstances appropriate examples from Automation Trigger, Conditions and Actions. Make sure you check and adapt to your circumstances appropriate examples from Automation Trigger, Conditions and Actions.
It is also useful to go to **Configuration** -> **Server Control** and click on **Check Config** button in Configuration validation section to make sure there are no syntax errors before restarting Home Assistant. It is also useful to go to **Configuration** -> **Server Control** and click on **Check Config** button in Configuration validation section to make sure there are no syntax errors before restarting Home Assistant. In order for **Check Config** to be visible, you must enable **Advanced Mode** on your user profile.
If your automation uses templates in any part, you can do the following to make sure it works as expected: If your automation uses templates in any part, you can do the following to make sure it works as expected:

4
source/_integrations/withings.markdown
View File

@ -42,7 +42,7 @@ Withings supports multiple profiles per account. Each profile has a person's nam
### Step 3 - Authorize Home Assistant ### Step 3 - Authorize Home Assistant
- Confirm your YAML configuration is valid by using the `Check Config` tool. - Confirm your YAML configuration is valid by using the `Check Config` tool (see note).
- Restart Home Assistant. - Restart Home Assistant.
- Go to the integrations page. - Go to the integrations page.
- Add a Withings integration. - Add a Withings integration.
@ -56,6 +56,8 @@ Withings supports multiple profiles per account. Each profile has a person's nam
Changing the domain will not affect how data is synchronized. Changing the domain will not affect how data is synchronized.
- Data will synchronize immediately and update every 5 minutes. - Data will synchronize immediately and update every 5 minutes.
Note: In order for "Check Config" to be visible, you must enable "Advanced Mode" on your user profile. The "Check Config" tool can be found by clicking "Configuration" from the sidebar (cog icon) and then clicking "Server Control".
## Configuration ## Configuration
```yaml ```yaml

2
source/getting-started/configuration.markdown
View File

@ -31,7 +31,7 @@ Now let's make a small change using the configurator: we are going to change the
- Find the `homeassistant:` configuration block, which should be the first thing in `configuration.yaml`. In this block, update `name`, `latitude`, `longitude`, `unit_system` and `time_zone` to match yours. - Find the `homeassistant:` configuration block, which should be the first thing in `configuration.yaml`. In this block, update `name`, `latitude`, `longitude`, `unit_system` and `time_zone` to match yours.
- Click the save icon in the top right to commit changes. - Click the save icon in the top right to commit changes.
- Most changes in `configuration.yaml` require Home Assistant to be restarted to see the changes. You can verify that your changes are acceptable by running a config check. Do this by clicking on Configuration in the sidebar, click on General and click on the "Check Config" button. When it's valid, it will show the text "Configuration valid!". - Most changes in `configuration.yaml` require Home Assistant to be restarted to see the changes. You can verify that your changes are acceptable by running a config check. Do this by clicking on Configuration in the sidebar, click on General and click on the "Check Config" button. When it's valid, it will show the text "Configuration valid!".
- Now Restart Home Assistant using the "restart" in the Server management section on the same page. - Now Restart Home Assistant using the "restart" in the Server management section on the same page. In order for "Check Config" to be visible, you must enable "Advanced Mode" on your user profile.
<p class='img'> <p class='img'>
<img src='/images/screenshots/configuration-validation.png' /> <img src='/images/screenshots/configuration-validation.png' />