@@ -4,7 +4,7 @@ Guidance for New Contributors to Python Documentation Translation on Transifex
4
4
5
5
This guide is intended for language teams working on the Python documentation
6
6
within the python-doc _ organization on Transifex _. Yes: not all teams translate
7
- on Transifex, so using Transifex is optional.
7
+ on Transifex, using Transifex is optional.
8
8
9
9
.. _python-doc : https://app.transifex.com/python-doc
10
10
.. _Transifex : https://www.transifex.com/
@@ -18,11 +18,11 @@ confident in both English and the translation language.
18
18
19
19
If you are new to the translation of Python documentation, we recommend that
20
20
you start by reading the Translating _ on `Python Developer's Guide `_
21
- (a.k.a. devguide), joining the relevant contact channels, and familiarizing
22
- yourself with `PEP 545 `_.
21
+ (a.k.a. devguide), joining the relevant contact channels (such as the ` Docs Community `_
22
+ Discord `` #translations `` channel), and familiarizing yourself with `PEP 545 `_.
23
23
24
24
If there is already a repository for your language team, please join and
25
- introduce yourself to the team .
25
+ introduce yourself.
26
26
27
27
**If there is no existing repository or language team, you will need to create
28
28
one. ** Simply translating on Transifex is not enough to have your language
@@ -32,10 +32,11 @@ a new translation.
32
32
.. _Translating : https://devguide.python.org/documentation/translating/
33
33
.. _Python Developer's Guide : https://devguide.python.org
34
34
.. _PEP 545 : https://peps.python.org/pep-0545/
35
+ .. _Docs Community : https://docs-community.readthedocs.io/
35
36
36
37
37
- Geting to Know Transifex
38
- ~~~~~~~~~~~~~~~~~~~~~~~~
38
+ Getting to Know Transifex
39
+ ~~~~~~~~~~~~~~~~~~~~~~~~~
39
40
40
41
If you are new to Transifex, it is recommended that you take the time to read
41
42
through the following resources from the Transifex documentation:
@@ -50,7 +51,7 @@ Transifex Does Not Update docs.python.org
50
51
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
51
52
52
53
Language teams must download and store the translation files in their VCS
53
- repository, as per instructions from Translating _ on `Python Developer's Guide `_,
54
+ repository, as per instructions from Translating _ in the `Python Developer's Guide `_,
54
55
as it is from this repository that the python-docs infrastructure will fetch
55
56
translations, build the translated docs, and publish them on docs.python.org.
56
57
@@ -80,7 +81,7 @@ you only need to translate once and all versions of the Python documentation
80
81
will receive the contribution *if the string remains unchanged *. If a string has
81
82
changed between versions, the contribution will not be applied to the new version.
82
83
83
- It is recommended to focus your translation efforts on the "Python" project,
84
+ You should focus your translation efforts on the "Python" project,
84
85
which represents the newest version. Keep in mind that the Python documentation
85
86
contains a large number of strings and that translations will be propagated, so
86
87
older versions will receive most contributions. Additionally, translating the
@@ -108,15 +109,15 @@ Final words
108
109
109
110
It is recommended that you also follow the style guide for your language and
110
111
review any existing translations to understand the tone and style of the language
111
- team. Translating the Python documentation can be a large project, and contributions
112
+ team. Translating the Python documentation is a very large project, and contributions
112
113
from many members of the community are appreciated. If you need help or have
113
114
questions, please reach out to the language team or any other contact channel
114
- provided in Translating _ on `Python Developer's Guide `_, or contact the
115
+ provided in Translating _ in the `Python Developer's Guide `_, or contact the
115
116
python-doc project coordinators on Transifex.
116
117
117
- See also
118
- ~~~~~~~~
119
118
120
- - PEP 545: https://peps.python.org/pep-0545/
121
- - Translating: https://devguide.python.org/documentation/translating/
122
- - Sphinx's reStructuredText Primer: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html
119
+ .. seealso ::
120
+
121
+ - `PEP 545 `_
122
+ - `Python Devguide: Translations <https://devguide.python.org/documentation/translating/ >`_
123
+ - `Sphinx's reStructuredText Primer <https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html >`_
0 commit comments