diff --git a/docs/config_entries_config_flow_handler.md b/docs/config_entries_config_flow_handler.md index 37c12064..90f14326 100644 --- a/docs/config_entries_config_flow_handler.md +++ b/docs/config_entries_config_flow_handler.md @@ -142,4 +142,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. 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) +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 `python3 -m script.translations develop` to see changes made to `strings.json` [More info on translating Home Assistant.](internationalization_translation.md) diff --git a/docs/internationalization_backend_localization.md b/docs/internationalization_backend_localization.md index 0f0d49dd..bb72892e 100644 --- a/docs/internationalization_backend_localization.md +++ b/docs/internationalization_backend_localization.md @@ -3,20 +3,23 @@ title: "Backend Localization" --- ## Translation Strings + Platform translation strings are stored as JSON in the [home-assistant](https://github.com/home-assistant/home-assistant) repository. These files must be located adjacent to the component/platform they belong to. Components must have their own directory, and the file is simply named `strings.json` in that directory. For platforms, they are named `strings..json` in the platform directory. This file will contain the different strings that will be translatable. In order to test changes to translation files, the translation strings must be compiled into Home Assistant’s translation directories by running the following script: ```shell -$ script/translations_develop +$ python3 -m script.translations develop ``` After the pull request with the strings file is merged into the `dev` branch, the strings will be automatically uploaded to Lokalise, where contributors can submit translations. The translated strings in Lokalise will be periodically pulled in to the home-assistant repository. ## States Localization + The first step when localizing platform states is to ensure that the states defined in the actual platform code are defined in `snake_case`. The states should not contain capital letters or spaces. Next, the strings file needs to be created. The states should exist under the `state` key, and map the backend state keys to their English translations. [The season sensor localization](https://github.com/home-assistant/home-assistant/pull/12453/commits/bb2f328ce10c3867990e34a88da64e2f8dc7a5c4) is a good example. ## Configuration Flow Localization + The translation strings for the configuration flow handler are defined under the `config` key. An example strings file below describes the different supported keys: ```json