chore: How to contribute translations (#3689)

* fix: more typos

* contribute internationalization section and updated docs

* Apply suggestions from code review

Co-authored-by: Florian Forster <florian@caos.ch>

Co-authored-by: Florian Forster <florian@caos.ch>
This commit is contained in:
mffap 2022-05-24 09:47:38 +02:00 committed by GitHub
parent eb2db28bbc
commit f32e69e5f1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 20 additions and 11 deletions

View File

@ -16,7 +16,7 @@ For people who are new to ZITADEL: We flag issues which are a good starting poin
Make ZITADEL more popular and give it a ⭐
Help shaping the future of ZITADEL by
Help shaping the future of ZITADEL:
- Join our [chat](https://zitadel.com/chat) and discuss with us or others.
- Ask or answer questions in the [issues section](https://github.com/zitadel/zitadel/issues)
@ -24,8 +24,9 @@ Help shaping the future of ZITADEL by
[Contribute](#how-to-contribute)
- [Code](#contribute-code)
- [Contribute code](#contribute)
- If you found a mistake on our [docs page](https://docs.zitadel.com) or something is missing please read [the docs section](#contribute-docs)
- [Translate](#contribute-internationalization) and improve texts
Follow [@zitadel](https://twitter.com/zitadel) on twitter
@ -89,6 +90,17 @@ We add the label "good first issue" for problems we think are a good starting po
- [Issues for first time contributors](https://github.com/zitadel/zitadel/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
- [All issues](https://github.com/zitadel/zitadel/issues)
## Contribute Internationalization
ZITADEL loads translations from four files:
- [Console texts](./console/src/assets/i18n)
- [Login interface](./internal/ui/login/static/i18n)
- [Email notification](./internal/notification/static/i18n)
- [Common texts](./internal/static/i18n) for success or error toasts
You may edit the texts in these files or create a new file for additional language support. Make sure you set the locale (ISO 639-1 code) as the name of the new language file.
### Make a PR
If you like to contribute fork the ZITADEL repository. After you implemented the new feature create a PullRequest in the ZITADEL repository.

View File

@ -31,15 +31,12 @@ All your settings will be removed and the default settings of the system will tr
## Internationalization
ZITADELs support for languages will be extended with time.
If you need support for a specific language we highly recommend you to write translation files for the missing language.
ZITADEL is available in the following languages
ZITADEL loads translations from three files:
- English (en)
- German (de)
- Italian (it)
- [Console translations](https://github.com/zitadel/zitadel/tree/main/console/src/assets/i18n)
- [Login interface texts](https://github.com/zitadel/zitadel/tree/main/internal/ui/login/static/i18n)
- [Email Notifcation texts](https://github.com/zitadel/zitadel/tree/main/internal/notification/static/i18n)
- [Common translations](https://github.com/zitadel/zitadel/tree/main/internal/static/i18n) for success or error toasts
Make sure you set the locale as the name. Later on, language header will determine which file gets displayed.
A language is displayed based on your agent's language header. The default language is English.
If you need support for a specific language we highly encourage you to [contribute translation files](/CONTRIBUTING.md) for the missing language.