Skip to content

Translation Maintenance Log #780

Description

@flpm

This issue is for maintainers coordinating translation work. If you are a contributor looking to help translate the guide, this is not the place to start, here are the issues open for contributors.

This issue is long running. It is not a task to finish and close for good: it is where changes to the guide's English text are recorded, so that a maintainer can refresh the translation catalogs.

Why this exists

The .po files under ./locales are generated from the English pages. When the English text changes, those files can end up missing strings, causing translations to be incomplete and the translation stats to report higher numbers than they really are. Without accurate translation stats contributors will not see where work is needed.

Why not automate the generation of the .po files

Automatically updating the translation catalogs can cause merge conflicts when contributors submit their PRs. While the conflicts are easy to solve for a maintainer, they will be scary for a beginner and may be internalized as their fault.

How it works

A GitHub Action watches main. When a change lands that touches English text the guide translates, it comments here with the files that changed and the catalogs affected.

A maintainer has to then choose the best time to update the catalog, considering the circumstance (sprints, open PRs, etc). To update the .po files use:

nox -s update-language -- <locale>

Closing and reopening

This issue can be closed, the action will automatically reopen it the next time the English text changes.

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions