jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-07-12 11:56:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add documentation for local development of config entries (#370)

Browse Source 
* Document the need to run hassfest once

* Document seeing local dev changes to strings.json
This commit is contained in:
Issac 2019-12-18 17:32:59 +02:00 committed by Paulus Schoutsen
parent 40583a4973
commit 7c5e46e743
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/config_entries_config_flow_handler.md
View File

@ -24,6 +24,8 @@ from .const import DOMAIN
class ExampleConfigFlow(config_entries.ConfigFlow, domain=DOMAIN): class ExampleConfigFlow(config_entries.ConfigFlow, domain=DOMAIN):
``` ```
Once you have updated your manifest and created the `config_flow.py`, you will need to run `python3 -m script.hassfest` (one time only) for Home Assistant to activate the config entry for your integration.
## Defining steps ## Defining steps
Your config flow will need to define steps of your configuration flow. The docs for [Data Entry Flow](data_entry_flow_index.md) describe the different return values of a step. Here is an example on how to define the `user` step. Your config flow will need to define steps of your configuration flow. The docs for [Data Entry Flow](data_entry_flow_index.md) describe the different return values of a step. Here is an example on how to define the `user` step.
@ -115,4 +117,4 @@ Translations for the config flow handlers are defined under the `config` key in
} }
``` ```
When the translations are merged into Home Assistant, they will be automatically uploaded to [Lokalise](https://lokalise.co/) where the translation team will help to translate them in other languages. [More info on translating Home Assistant.](internationalization_translation.md) When the translations are merged into Home Assistant, they will be automatically uploaded to [Lokalise](https://lokalise.co/) where the translation team will help to translate them in other languages. While developing locally, you will need to run `script/translations_develop` to see changes made to `strings.json` [More info on translating Home Assistant.](internationalization_translation.md)