This document lists the responsibilities and resources available to maintainers of blitzjs.com translation forks.
As repo maintainers and members of the Blitz community, your responsibilities are as follows:
- Keep the Progress issue up to date as people volunteer to translate pages.
- Review pull requests made by contributors promptly.
- Review pull requests generated by blitzjs-bot in order to make sure translations remain up to date with the source repo.
- Set up a process in order to get your translation published. See the tips below for suggestions.
- Act as point of contact for your language and answer questions from both contributors to your language and the core Blitz team.
Create a glossary of the translations of technical and React-specific terms. Put this in a highly visible location (the README or a pinned issue). For examples of glossaries, see:
- Dutch: https://github.com/blitz-js/nl.blitzjs.com/blob/main/TRANSLATION.md#woordenlijst
- Japanese: https://github.com/blitz-js/ja.blitzjs.com/wiki/%E7%94%A8%E8%AA%9E%E9%9B%86
- Spanish: https://github.com/blitz-js/es.blitzjs.com/wiki/Glosario
Also, create a style guide to define additional rules to follow in translation. See the universal style guide for rules that should apply to all translations.
Some pages (like the tutorial) are very long. Instead of assigning a long page to one translator, you can create a "Work In Progress" (WIP) branch and assign different sections to different translators.
Decide how many reviewers you want to review each translated page before it can be merged in. If your team is small and busy, you may only be able to have one reviewer so that translators don't get blocked. If your team is bigger, consider having two reviewers so you have a stronger guarantee that the page is correct.
Another useful tool is using GitHub tags to show what step in the review process a PR is in.
You are encouraged to use the integration tools of your choice to test and deploy your translations. We recommend using GitHub Actions, but you can use anything you want.
If you have a question that isn't addressed here, you can go to the #lang-[your lang] or #contributor-website-docs channel in the Blitz Discord Server and ask your fellow translators for help!