Skip to content

Commit 3c75b4c

Browse files
Updates to new-translators.rst (#122)
1 parent 42593ad commit 3c75b4c

File tree

1 file changed

+16
-15
lines changed

1 file changed

+16
-15
lines changed

docs/new-translators.rst

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Guidance for New Contributors to Python Documentation Translation on Transifex
44

55
This guide is intended for language teams working on the Python documentation
66
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.
88

99
.. _python-doc: https://app.transifex.com/python-doc
1010
.. _Transifex: https://www.transifex.com/
@@ -18,11 +18,11 @@ confident in both English and the translation language.
1818

1919
If you are new to the translation of Python documentation, we recommend that
2020
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`_.
2323

2424
If there is already a repository for your language team, please join and
25-
introduce yourself to the team.
25+
introduce yourself.
2626

2727
**If there is no existing repository or language team, you will need to create
2828
one.** Simply translating on Transifex is not enough to have your language
@@ -32,10 +32,11 @@ a new translation.
3232
.. _Translating: https://devguide.python.org/documentation/translating/
3333
.. _Python Developer's Guide: https://devguide.python.org
3434
.. _PEP 545: https://peps.python.org/pep-0545/
35+
.. _Docs Community: https://docs-community.readthedocs.io/
3536

3637

37-
Geting to Know Transifex
38-
~~~~~~~~~~~~~~~~~~~~~~~~
38+
Getting to Know Transifex
39+
~~~~~~~~~~~~~~~~~~~~~~~~~
3940

4041
If you are new to Transifex, it is recommended that you take the time to read
4142
through the following resources from the Transifex documentation:
@@ -50,7 +51,7 @@ Transifex Does Not Update docs.python.org
5051
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5152

5253
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`_,
5455
as it is from this repository that the python-docs infrastructure will fetch
5556
translations, build the translated docs, and publish them on docs.python.org.
5657

@@ -80,7 +81,7 @@ you only need to translate once and all versions of the Python documentation
8081
will receive the contribution *if the string remains unchanged*. If a string has
8182
changed between versions, the contribution will not be applied to the new version.
8283

83-
It is recommended to focus your translation efforts on the "Python" project,
84+
You should focus your translation efforts on the "Python" project,
8485
which represents the newest version. Keep in mind that the Python documentation
8586
contains a large number of strings and that translations will be propagated, so
8687
older versions will receive most contributions. Additionally, translating the
@@ -108,15 +109,15 @@ Final words
108109

109110
It is recommended that you also follow the style guide for your language and
110111
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
112113
from many members of the community are appreciated. If you need help or have
113114
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
115116
python-doc project coordinators on Transifex.
116117

117-
See also
118-
~~~~~~~~
119118

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

Comments
 (0)