Skip to content

Update translation/translators.rst #1576

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Jun 20, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion contrib/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ major section at the top of each column.]*
* :ref:`documenting`
* :ref:`style-guide`
* :ref:`rst-primer`
* :ref:`translating`
* :doc:`documentation/translations`
* :ref:`devguide`
-
* :ref:`setup`
Expand Down
5 changes: 4 additions & 1 deletion core-developers/experts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -372,4 +372,7 @@ version control merwok, ezio-melotti
Documentation translations
==========================

For a list of translators, see :ref:`this table about translations <translating>`.
Translations are within the charter of
`Editorial Board <https://python.github.io/editorial-board/>`_.
For a list of translations and their coordinators, see
:ref:`this table of translations <translation-coordinators>`.
64 changes: 54 additions & 10 deletions documentation/translations/coordinating.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,21 @@
Coordinating
============

Information about the Python documentation translation processes is
found in this devguide and :PEP:`545`.
Translations are built by `docsbuild-scripts
<https://github.com/python/docsbuild-scripts/>`__ and hosted on
docs.python.org. Translations
are overseen by the `Editorial Board <EB_>`_

Starting a new translation
==========================

First subscribe to the `translation mailing list <translation_ml_>`_,
and introduce yourself and the translation you're starting. Translations
fall under the aegis of the `PSF Translation Workgroup <translation_wg_>`_
and introduce yourself and the translation you're starting.

Then you can bootstrap your new translation by using `cookiecutter
<https://github.com/JulienPalard/python-docs-cookiecutter>`__ or
Then you can bootstrap your new translation by using the `cookiecutter
<https://github.com/python-docs-translations/python-docs-cookiecutter>`__ or
`bootstrapper <https://github.com/python-docs-translations/python-docs-bootstrapper>`__.

The important steps look like this:
Expand All @@ -28,6 +34,16 @@ The important steps look like this:
your language to be added in the language switcher on docs.python.org.


How to get help
===============

Discussions about translations occur on the Python Docs Discord
`#translations channel <https://discord.gg/h3qDwgyzga>`_, `translation
mailing list <translation_ml_>`_, and the
`translations category <https://discuss.python.org/c/documentation/translations/>`_
of the Python Discourse.


PEP 545 summary
===============

Expand All @@ -50,6 +66,13 @@ Here are the essential points of :PEP:`545`:
``https://docs.python.org/{LANGUAGE_TAG}/{VERSION_TAG}/``.


Transifex
=========

If you need help from a Transifex administrator, open an issue on the
`tracker <https://github.com/python-docs-translations/transifex-automations/issues>`_.


Coordinating FAQ
================

Expand All @@ -73,7 +96,9 @@ __ https://github.com/python-docs-translations
How is a coordinator elected?
-----------------------------

There is no election. Each translation will sort out the number of coordinators. We recommend 2 or 3 coordinators, though you may begin with one. Here are some general suggestions.
Each translation team will decide on the number of coordinators.
We recommend two or three coordinators, though you may begin with one.
Here are some general suggestions.

- Coordinator requests are to be public on the `translation mailing list <translation_ml_>`_.
- If the given language has a native core dev, the core dev has input
Expand Down Expand Up @@ -113,11 +138,30 @@ files in the root of the repository using the ``gettext_compact=0``
style.


The entry for my translation is missing/not up to date on this page
-------------------------------------------------------------------
.. XXX Explain necessary folder structure


Which version of the Python documentation should be translated?
---------------------------------------------------------------

It's best to work on Python's current stable or beta version. You can then
propagate your translation from one branch to another using :pypi:`pomerge`.


The entry for my translation is missing or not up to date
---------------------------------------------------------

Ask on the `translation mailing list <translation_ml_>`_, or better, make a PR
on the `devguide <https://github.com/python/devguide/>`__.


Is there a Weblate instance we can translate on?
------------------------------------------------

There is currently no Weblate instance for Python translations.
See this `Discourse thread <https://discuss.python.org/t/docs-translation-platform/29940>`_
for updates.

Ask on the `translation mailing list <translation_ml_>`_, or better, make a PR on the `devguide
<https://github.com/python/devguide/>`__.

.. _translation_wg: https://wiki.python.org/psf/TranslationWG/Charter
.. _EB: https://python.github.io/editorial-board/
.. _translation_ml: https://mail.python.org/mailman3/lists/translation.python.org/
2 changes: 1 addition & 1 deletion documentation/translations/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Translations
============

.. toctree::
:maxdepth: 2
:maxdepth: 3

translating
coordinating
Loading
Loading