Skip to content

Commit 2da111f

Browse files
Backport PR jupyterlab#11357: Recommend providing screenshots for translators (jupyterlab#11361)
Co-authored-by: Michał Krassowski <[email protected]>
1 parent 4b275b2 commit 2da111f

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

docs/source/developer/internationalization.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,15 @@ file in *language-packs* repository. The workflow to trigger an update is as fol
4545
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.
4646
4. That workflow will open a new pull request that will update the source strings and optionally the Crowdin configuration.
4747
5. Once that pull request is merged, Crowdin will upload the new source strings automatically.
48+
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
49+
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.
50+
51+
.. note::
52+
Translating on Crowdin can be difficult when no sufficient context information is present, especially for Jupyter-specific terms.
53+
While some technically skilled translators will navigate to the codebase to check the context of a string, it is not an efficient workflow
54+
and prevents other translators from contributing. To enable more translators to contribute, and achieve higher accuracy of translations
55+
we should provide translators with annotated screenshots of the relevant usage of specific translatable strings
56+
(see `Crowdin guide on screenshots <https://support.crowdin.com/adding-screenshots/>`).
4857

4958
.. note::
5059

0 commit comments

Comments
 (0)