3diy
/
klipper
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Update CONTRIBUTING.md with new repo location; minor wording changes 

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
This commit is contained in:
Kevin O'Connor 2021-09-29 21:12:14 -04:00
parent b3b597a215
commit e4089e846e
1 changed files with 12 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
docs/CONTRIBUTING.md
View File

@ -37,7 +37,7 @@ contributions) and contain a current email address.
## Contributing to Klipper Translations ## Contributing to Klipper Translations
[Klipper-translations Project](https://github.com/KevinOConnor/klipper-translations) [Klipper-translations Project](https://github.com/Klipper3d/klipper-translations)
is a project dedicated to translating Klipper to different languages. is a project dedicated to translating Klipper to different languages.
[Weblate](https://hosted.weblate.org/projects/klipper/) hosts all the [Weblate](https://hosted.weblate.org/projects/klipper/) hosts all the
Gettext strings for translating and reviewing. Locales can merge into Gettext strings for translating and reviewing. Locales can merge into
@ -45,19 +45,20 @@ the Klipper project once they satisfy the following requirements:
- [ ] 75% Total coverage - [ ] 75% Total coverage
- [ ] All titles (H1) are covered - [ ] All titles (H1) are covered
- [ ] An updated navigation hierarchy PR into klipper-translations. - [ ] An updated navigation hierarchy PR in klipper-translations.
The navigation hierarchy is in `docs\_klipper3d\mkdocs.yml`. The navigation hierarchy is in `docs\_klipper3d\mkdocs.yml`.
To reduce the frustration of translating domain-specific terms To reduce the frustration of translating domain-specific terms and
and gain awareness of the ongoing translations, you can submit a PR gain awareness of the ongoing translations, you can submit a PR
modifying the [Klipper-translations Project](https://github.com/KevinOConnor/klipper-translations) modifying the
's `readme.md`. Once a translation is ready, we can pull the [Klipper-translations Project](https://github.com/Klipper3d/klipper-translations)
corresponding modification into the Klipper project with some changes. `readme.md`. Once a translation is ready, the corresponding
modification to the Klipper project can be made.
If a translation already exists in the Klipper repository and no If a translation already exists in the Klipper repository and no
longer meets the checklist above, we will mark it out-of-date longer meets the checklist above, it will be marked out-of-date after
after a month without updating. a month without updates.
Please follow the following format for `mkdocs.yml` navigation Please follow the following format for `mkdocs.yml` navigation
hierarchy: hierarchy:
@ -69,5 +70,5 @@ nav:
- locales/<language code>/md file - locales/<language code>/md file
``` ```
Note: Currently, there isn't a method for correctly displaying Note: Currently, there isn't a method for correctly translating
photos in the translated documents. pictures in the documentation.