Skip to content

Commit 04d3761

Browse files
Ezio's review
1 parent acdfd0a commit 04d3761

File tree

2 files changed

+24
-11
lines changed

2 files changed

+24
-11
lines changed

documentation/translations/coordinating.rst

Lines changed: 23 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -73,15 +73,23 @@ To start your translation create a GitHub repository, under any
7373
account, with the correct Git hierarchy and folder structure. This can be done
7474
in several ways, and will dictate the translation process you use.
7575

76-
The branch name should be the version, for example, ``3.14``, and the files
77-
should be structured like the source files in `CPython/Doc <https://github.com/python/cpython/tree/main/Doc>`_.
78-
A correctly set up repository looks like this: `python-docs-pl <https://github.com/python/python-docs-pl/>`_
76+
Each translation is assigned an appropriate lowercase
77+
`IETF language tag <https://datatracker.ietf.org/doc/html/rfc5646.html>`_.
78+
The tag may have an optional region subtag, joined with a dash.
79+
For example, ``pt`` (Portuguese) or ``pt-br`` (Brazilian Portuguese).
80+
The repository name is then: ``python-docs-TAG``
81+
82+
The name of each branch should be the Python version it holds translations
83+
for, for example, ``3.14``. The files should be structured like the source files
84+
in `CPython/Doc <https://github.com/python/cpython/tree/main/Doc>`_.
85+
A correctly set up repository looks like this:
86+
`python-docs-pl <https://github.com/python/python-docs-pl/>`_
7987

8088

8189
Cookiecutter/bootstrapper
8290
~~~~~~~~~~~~~~~~~~~~~~~~~
8391

84-
Then you can bootstrap your new translation by using the `cookiecutter
92+
You can bootstrap your new translation by using the `cookiecutter
8593
<https://github.com/python-docs-translations/python-docs-cookiecutter>`__ or
8694
`bootstrapper <https://github.com/python-docs-translations/python-docs-bootstrapper>`__.
8795
The repository can then be used with a pull-request based translation process.
@@ -90,13 +98,17 @@ The repository can then be used with a pull-request based translation process.
9098
Transifex
9199
~~~~~~~~~
92100

93-
You can also start your translation using `Transifex <https://explore.transifex.com/python-doc/python-newest/>`_.
101+
You can also start your translation using
102+
`Transifex <https://explore.transifex.com/python-doc/python-newest/>`_.
94103
This will automate updating translations, and will allow you to translate via
95104
the web interface.
96105

97106
This is best done with a workflow that periodically checks for translations,
98-
a sample one with instructions can be found `here <https://python-docs-transifex-automation.readthedocs.io/workflows.html>`__.
99-
An in depth guide for manually doing this can also be found `here <https://python-docs-transifex-automation.readthedocs.io/commands.html>`__.
107+
a sample one with instructions can be found in the
108+
`python-docs-tx-automations documentation <https://python-docs-transifex-automation.readthedocs.io/workflows.html>`__.
109+
An in depth guide for manually doing this can also be found
110+
python-docs-tx-automations documentation's
111+
`commands page <https://python-docs-transifex-automation.readthedocs.io/commands.html>`__.
100112

101113
To be added as the coordinator(s) on Transifex for your language, open an issue
102114
in the `tracker <https://github.com/python-docs-translations/transifex-automations/issues>`__.
@@ -119,8 +131,8 @@ consistency. This is often done with a glossary. More information about the use
119131
of glossaries can be found in the :ref:`translation-style-guide`.
120132

121133

122-
Moving the repo to the python org
123-
---------------------------------
134+
Moving the repo to the ``python`` org
135+
-------------------------------------
124136

125137
This will allow you to plug your translation into docsbuild-scripts_, and it
126138
will be found at ``docs.python.org/LANG/``, but not in the switcher.
@@ -194,7 +206,8 @@ If you need assistance from a Transifex administrator, open an issue on the
194206

195207
.. seealso::
196208

197-
`python-docs-transifex-automations: documentation <https://python-docs-transifex-automation.readthedocs.io/index.html>`_
209+
`python-docs-transifex-automations: documentation
210+
<https://python-docs-transifex-automation.readthedocs.io/index.html>`_
198211

199212

200213
Coordination FAQ

documentation/translations/translating.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@ The Python docs contain many roles (``:role:`target```) that link to other parts
158158
of the documentation.
159159
Do not translate reStructuredText roles targets, such as ``:func:`print``` or
160160
``:ref:`some-section``` because it will break the link.
161-
If alternate text (``:role:`text <target>``` is provided, it generally
161+
If alternate text (``:role:`text <target>```) is provided, it generally
162162
should be translated. You can also introduce alternate text for translation if
163163
the target is not a name or term.
164164

0 commit comments

Comments
 (0)