Skip to content

Translations with Crowdin

Jump to bottom
Yhoan Alejandro Guzmán García edited this page Nov 7, 2024 · 1 revision

Translations with Crowdin

This project manages translations with Crowdin, a localization platform that provides a translation engine, an editing interface, and GitHub integration.

How the Setup Works

When changes are made to the English translation files in src/i18n/resources/en (excluding the panEuropean folder) on the development branch, a workflow automatically uploads these files to our Crowdin project. This process uses the GitHub secrets CROWDIN_PROJECT_ID and CROWDIN_PERSONAL_TOKEN.

Once the updated files are in Crowdin, you can either initiate a translation job or manually translate content through Crowdin’s editor.

The "New Crowdin Translations PR" workflow will then open a pull request with the latest approved translations from Crowdin.

Adding New Translations

  1. Add the English source text to the appropriate file. Once committed to the development branch, the text will sync automatically with Crowdin.

  2. Log in to Crowdin.com using the credentials provided by the development team.

In the project dashboard, you will see the translation status for each language. Non-approved translations are highlighted in blue in the progress bars. The percentages indicate the total translated texts and the share that are approved.

3.mp4

  1. Run the Pre-translation job from the project dashboard. Select the target languages and source files for pre-translation.

    Important: Check the option "Apply for untranslated strings only" to prevent overwriting existing translations.

4.mp4

Once the job completes, the new translations will have a status of "Not Approved". To make them available for export, they need to be manually approved.

  1. Review and approve the new translations for each language as needed.
5.mp4

Sometimes, the Pre-translation job may not translate all strings. In such cases, manual translation is required. As an example, in the following case, certain new strings in Chinese remained untranslated after running the job:

missing.translations.mp4
  1. Manually add missing translations:

  • Open the language editor for the file with missing translations.

  • Filter the strings by "Untranslated".

  • Add the translations, save, and then change the filter to "Not Approved."

  • Approve the translations.

    Example for Spanish:

6.mp4
  1. Open a PR by using the "New Crowdin Translations PR" workflow.
PR.mp4

An example of a resulting PR can be found here.

If any changes are requested for the translations, you can update them in Crowdin (like in the previous step, only now replacing the text), and then re-run the workflow. This will update the PR branch with a new commit.

Clone this wiki locally