With the 2.0 release out the door, we’re looking for help to translate the index page and the “using regolith” section into languages other than English. In the past we’ve used a translation system, but it turned out to be too complex for many people to understand. For the Regolith 2.0 site we’ll rely on Hugo’s multilingual support.
For a given language translation the following files must be translated:
content/_index.md content/docs/using-regolith/basics.md content/docs/using-regolith/configuration.md content/docs/using-regolith/first-launch.md
To provide a translation, simply copy the English file and add the two-letter language code to the end of the filename. Once the translation is complete, create a pull request and we’ll merge your translation. This allows other people to read about Regolith with your language translation.
As an example, if a Japanese translation was provided, the following new files would be added to the PR:
content/_index.ja.md content/docs/using-regolith/basics.ja.md content/docs/using-regolith/configuration.ja.md content/docs/using-regolith/first-launch.ja.md
There is some additional Hugo configuration before the translation will be available, but we can take care of that. Feel free to open an issue or reach out on GitHub Discussions with any questions, and thanks in advance!
Translation Workflow #
Here are some step-by-step instructions for creating a translation:
- Create a fork of the GitHub repo that contains the Regolith Desktop website. (learn more)
- Clone the fork to your local computer.
- Determine the two-letter designation for your language.
- Copy the following files to new files with the two-letter language designation (see example above).
- Translate the content to your language.
- Commit and push the changes to your fork of the website repository.
- Create and submit a pull request.
By creating the pull request, Regolith project members will be notified to review and push your changes.