Starting a New Translation
⚠️ Note: At the moment our localization efforts are on pause, as we shifted towards a redesign of the docs. Right now, we’re prioritizing a new version of the tutorial. As with all prioritization efforts, we will weigh this, amongst other potential features, fixes, and improvements, and may consider picking up on the internationalization efforts of 2020. The repositories inside the GitHub org will remain. For now we archived the respective language channels on our Discord and the role for language maintainers.
This page lists the steps to take to create a new Gatsby docs translation.
Creating a translation
Read the maintainer guide
Before requesting a new translation, make sure to read the maintainer responsibilities to affirm that you accept the responsibilities of being a translation maintainer.
Check other issues
Before creating a new issue, make sure to check the list of open translation requests. If one already exists for your language, ask to be added to the list of maintainers there.
Create a translation request issue
If you don’t see the language among the issues listed, feel free to create a new translation request issue for it and follow the instructions.
Finding codeowners
For a new translation, open an issue with information about your intended language. If you already have co-contributors to act as fellow code owners and provide checks and balances for PR reviews and quality assurance, that would be very helpful! Otherwise, you can check out other translation request issues people have made and offer to join, or get in touch with us at Gatsby for help in building your translation team.
Criteria for translation approval
The Gatsby team will choose to approve a translation request based on the following criteria:
- Are there at least two maintainers listed?
- Do at least one of the maintainers have previous open-source experience and experience working with GitHub and git?
- Are the maintainers fluent speakers? Maintainers do not need to have experience translating, but must be fluent enough in the language to be able to translate technical writing.
After approval
Once the translation request is approved, a member of the gatsby team will run an automated script to create your repository and set everything up.
At this point, you and your co-maintainers should read the rest of the maintainer guide for more information on how to manage your translation repository. You can also check out the translation contributor guide for information on contributing translations to your own repo, and start working on your translation style guide.