Skip to content

Commit 3a8b71e

Browse files
StanFromIrelandwillingchugovk
authored
Update translation/translators.rst to add pages and detail for Coordinators and Translators (#1576)
* Initial * Rafael's feedback * Further updates and amendments * Rafael's review * Carol’s suggestion Co-authored-by: Carol Willing <carolcode@willingconsulting.com> * Maciek's review * Reviews * Maciek's review + comma * Hugo’s suggestions Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> --------- Co-authored-by: Carol Willing <carolcode@willingconsulting.com> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
1 parent e5637b7 commit 3a8b71e

File tree

5 files changed

+256
-63
lines changed

5 files changed

+256
-63
lines changed

contrib/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ major section at the top of each column.]*
7575
* :ref:`documenting`
7676
* :ref:`style-guide`
7777
* :ref:`rst-primer`
78-
* :ref:`translating`
78+
* :doc:`documentation/translations`
7979
* :ref:`devguide`
8080
-
8181
* :ref:`setup`

core-developers/experts.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -372,4 +372,7 @@ version control merwok, ezio-melotti
372372
Documentation translations
373373
==========================
374374

375-
For a list of translators, see :ref:`this table about translations <translating>`.
375+
Translations are within the charter of
376+
`Editorial Board <https://python.github.io/editorial-board/>`_.
377+
For a list of translations and their coordinators, see
378+
:ref:`this table of translations <translation-coordinators>`.

documentation/translations/coordinating.rst

Lines changed: 54 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,21 @@
22
Coordinating
33
============
44

5+
Information about the Python documentation translation processes is
6+
found in this devguide and :PEP:`545`.
7+
Translations are built by `docsbuild-scripts
8+
<https://github.com/python/docsbuild-scripts/>`__ and hosted on
9+
docs.python.org. Translations
10+
are overseen by the `Editorial Board <EB_>`_
11+
512
Starting a new translation
613
==========================
714

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

12-
Then you can bootstrap your new translation by using `cookiecutter
13-
<https://github.com/JulienPalard/python-docs-cookiecutter>`__ or
18+
Then you can bootstrap your new translation by using the `cookiecutter
19+
<https://github.com/python-docs-translations/python-docs-cookiecutter>`__ or
1420
`bootstrapper <https://github.com/python-docs-translations/python-docs-bootstrapper>`__.
1521
You can also start your translation using `Transifex <https://explore.transifex.com/python-doc/python-newest/>`_
1622
following this `guide <https://python-docs-transifex-automation.readthedocs.io/commands.html>`_.
@@ -30,6 +36,16 @@ The important steps look like this:
3036
your language to be added in the language switcher on docs.python.org.
3137

3238

39+
How to get help
40+
===============
41+
42+
Discussions about translations occur on the Python Docs Discord
43+
`#translations channel <https://discord.gg/h3qDwgyzga>`_, `translation
44+
mailing list <translation_ml_>`_, and the
45+
`translations category <https://discuss.python.org/c/documentation/translations/>`_
46+
of the Python Discourse.
47+
48+
3349
PEP 545 summary
3450
===============
3551

@@ -52,6 +68,13 @@ Here are the essential points of :PEP:`545`:
5268
``https://docs.python.org/{LANGUAGE_TAG}/{VERSION_TAG}/``.
5369

5470

71+
Transifex
72+
=========
73+
74+
If you need help from a Transifex administrator, open an issue on the
75+
`tracker <https://github.com/python-docs-translations/transifex-automations/issues>`_.
76+
77+
5578
Coordinating FAQ
5679
================
5780

@@ -76,7 +99,9 @@ __ https://github.com/python-docs-translations
7699
How is a coordinator elected?
77100
-----------------------------
78101

79-
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.
102+
Each translation team will decide on the number of coordinators.
103+
We recommend two or three coordinators, though you may begin with one.
104+
Here are some general suggestions.
80105

81106
- Coordinator requests are to be public on the `translation mailing list <translation_ml_>`_.
82107
- If the given language has a native core dev, the core dev has input
@@ -116,11 +141,30 @@ files in the root of the repository using the ``gettext_compact=0``
116141
style.
117142

118143

119-
The entry for my translation is missing/not up to date on this page
120-
-------------------------------------------------------------------
144+
.. XXX Explain necessary folder structure
145+
146+
147+
Which version of the Python documentation should be translated?
148+
---------------------------------------------------------------
149+
150+
It's best to work on Python's current stable or beta version. You can then
151+
propagate your translation from one branch to another using :pypi:`pomerge`.
152+
153+
154+
The entry for my translation is missing or not up to date
155+
---------------------------------------------------------
156+
157+
Ask on the `translation mailing list <translation_ml_>`_, or better, make a PR
158+
on the `devguide <https://github.com/python/devguide/>`__.
159+
160+
161+
Is there a Weblate instance we can translate on?
162+
------------------------------------------------
163+
164+
There is currently no Weblate instance for Python translations.
165+
See this `Discourse thread <https://discuss.python.org/t/docs-translation-platform/29940>`_
166+
for updates.
121167

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

125-
.. _translation_wg: https://wiki.python.org/psf/TranslationWG/Charter
169+
.. _EB: https://python.github.io/editorial-board/
126170
.. _translation_ml: https://mail.python.org/mailman3/lists/translation.python.org/

documentation/translations/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Translations
33
============
44

55
.. toctree::
6-
:maxdepth: 2
6+
:maxdepth: 3
77

88
translating
99
coordinating

0 commit comments

Comments
 (0)