diff options
| author | Yifei Ding <dingyifeiair@gmail.com> | 2022-02-14 08:29:41 -0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-02-14 11:29:41 -0500 |
| commit | 61329049a65fa2526e7b7039cd84bdbc7f9700c5 (patch) | |
| tree | 333cb0fd098c67d875510ca8dbdc7ef3a3d3b234 /docs/CONTRIBUTING.md | |
| parent | f0241d7dec0dc78133befba2b32397ecd72ccbf5 (diff) | |
| download | kutter-61329049a65fa2526e7b7039cd84bdbc7f9700c5.tar.gz kutter-61329049a65fa2526e7b7039cd84bdbc7f9700c5.tar.xz kutter-61329049a65fa2526e7b7039cd84bdbc7f9700c5.zip | |
docs: Mkdocs i18n support (#5072)
Signed-off-by: Yifei DIng <yifeiding@protonmail.com>
Diffstat (limited to 'docs/CONTRIBUTING.md')
| -rw-r--r-- | docs/CONTRIBUTING.md | 28 |
1 files changed, 13 insertions, 15 deletions
diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index e36fc897..53addbff 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -301,15 +301,13 @@ contributions) and contain a current email address. [Klipper-translations Project](https://github.com/Klipper3d/klipper-translations) is a project dedicated to translating Klipper to different languages. [Weblate](https://hosted.weblate.org/projects/klipper/) hosts all the -Gettext strings for translating and reviewing. Locales can merge into -the Klipper project once they satisfy the following requirements: +Gettext strings for translating and reviewing. Locales can be displayed on +[klipper3d.org](https://www.klipper3d.org) once they satisfy the following requirements: - [ ] 75% Total coverage -- [ ] All titles (H1) are covered +- [ ] All titles (H1) are translated - [ ] An updated navigation hierarchy PR in klipper-translations. -The navigation hierarchy is in `docs\_klipper3d\mkdocs.yml`. - To reduce the frustration of translating domain-specific terms and gain awareness of the ongoing translations, you can submit a PR modifying the @@ -321,15 +319,15 @@ If a translation already exists in the Klipper repository and no longer meets the checklist above, it will be marked out-of-date after a month without updates. -Please follow the following format for `mkdocs.yml` navigation -hierarchy: +Once the requirements are met, you need to: -```yml -nav: - - existing hierachy - - <language>: - - locales/<language code>/md file -``` +1. update klipper-tranlations repository +[active_translations](https://github.com/Klipper3d/klipper-translations/blob/translations/active_translations) +2. Optional: add a manual-index.md file in klipper-translations repository's +`docs\locals\<lang>` folder to replace the language specific index.md (generated +index.md does not render correctly). -Note: Currently, there isn't a method for correctly translating -pictures in the documentation. +Known Issues: +1. Currently, there isn't a method for correctly translating pictures in +the documentation +2. It is impossible to translate titles in mkdocs.yml. |