2. BeeWare

Navigate to a component that is showing an incomplete translation; click on Translate, and update strings as required. Any string marked as "Needs editing" needs to be reviewed. Anything marked with green sidebar has been translated previously - but any string can be modified if you think a translation can be improved.

Pay close attention to markup. We use Restructured Text and Sphinx markup; at present, Weblate won't identify or correct markup errors.

Try to keep the tone consistent. The BeeWare tutorial is deliberately written in a casual, friendly tone; try to preserve that tone in translations.

We also avoid phrasing that the could leave the reader feeling "stupid". We avoid saying that things are "simple", or that you "just" need to do X; if a user has a problem doing a "simple" thing, or can't "just" do the thing you ask, they might conclude that the problem is with them. Avoid comparable phrasing in translations.

Once you've modified a translation, click on "Save and continue" to move to the next string. There's nothing else you need to do to make translations go live. Weblate will wait a few hours to make sure changes are combined together, and then commit changes to the upstream repository. When the commit happens, you’ll see a new commit in the Github repository that you're translating; a few minutes after that, a build should start on ReadTheDocs. Each language project has its own ReadTheDocs project, formed by adding the language suffix to the end of the base BeeWare ReadTheDocs URL.

For example, the BeeWare tutorial will show additional commits in the Github repository, and each language has it's own ReadTheDocs page (e.g., French, Chinese etc)

As soon as the ReadTheDocs build completes, the changes will be made live. If the ReadTheDocs build fails (usually due to a markup error) no changes will be published until the error is corrected. The build log will show the line in the source document that is causing a problem (e.g., "tutorial-1:16" is line 16 of the Tutorial 1 translation). The translations are sorted by line number in the Weblate interface; the right hand side bar shows the source string location for each translated string.