Browse Source

Backport PR #11357: Recommend providing screenshots for translators (#11361)

Co-authored-by: Michał Krassowski <5832902+krassowski@users.noreply.github.com>
MeeseeksMachine 3 years ago
parent
commit
2da111fef2
1 changed files with 9 additions and 0 deletions
  1. 9 0
      docs/source/developer/internationalization.rst

+ 9 - 0
docs/source/developer/internationalization.rst

@@ -45,6 +45,15 @@ file in *language-packs* repository. The workflow to trigger an update is as fol
 3. Once the pull request is merged, the workflow `Update source strings <https://github.com/jupyterlab/language-packs/blob/master/.github/workflows/update_pot.yml>`_ will automatically be triggered.
 4. That workflow will open a new pull request that will update the source strings and optionally the Crowdin configuration.
 5. Once that pull request is merged, Crowdin will upload the new source strings automatically.
+6. If the placement of strings in the user interface changed (or new interface components were added) consider preparing new screenshots for Crowdin (see note below) and either
+   upload them directly to Crowdin (filename should include the version number), or open an issue in the `language-packs <https://github.com/jupyterlab/language-packs>` repository.
+
+.. note::
+   Translating on Crowdin can be difficult when no sufficient context information is present, especially for Jupyter-specific terms.
+   While some technically skilled translators will navigate to the codebase to check the context of a string, it is not an efficient workflow
+   and prevents other translators from contributing. To enable more translators to contribute, and achieve higher accuracy of translations
+   we should provide translators with annotated screenshots of the relevant usage of specific translatable strings
+   (see `Crowdin guide on screenshots <https://support.crowdin.com/adding-screenshots/>`).
 
 .. note::