4.9 KiB
Title: Python Documentation Translation Date: 2017-05-29
This is an overview of what is done, what we're doing, and what's needs work about the translation of Python documentation.
Historical context
The first step to ensure every other steps are worth it was to officialize the translations. This is now done with the PEP 545.
PEP 545: TL;DR
The PEP 545 may be long to read, so here are the interesting points:
-
Each translation is assigned an appropriate lowercased language tag, with an optional region subtag (if needed), glued with a dash, like
pt-br
orfr
. -
Translations files are hosted on
https://github.com/python/python-docs-{LANGUAGE_TAG}
-
Translations are hosted on
https://docs.python.org/{LANGUAGE_TAG}/{VERSION_TAG}/
.
Current status
Globally
- The Documentation Contribution Agreement has been written by the PSF.
- docsbuild-scripts have its
pull request
to start building translations on
docs.python.org
. - The doc-sig mailing list is back on tracks.
Per language
-
fr
- Coordinator: Julien Palard (mdk)
- Translated: ~25%
- Repository: github.com/python/python-docs-fr/
-
ja
- Coordinator: Inada Naoki
- Translated: ~90%
github.com/python/python-docs-ja/
to be created.
-
zh-cn
- Coordinator: Xiang Zhang
- Translated: ?
github.com/python/python-docs-zh-cn/
to be created.
-
pt-br
- Coordinator: Marco Rougeth volunteered.
- Translated: Unknown, working on transifex.
github.com/python/python-docs-pt-br/
to be created.
-
es
- Coordinator: To be designated.
- Translated: Tutorial, working on github.com/PyAr/tutorial/.
-
zh-tw
- Coordinator: To be designated.
- Translated: ? (See github.com/python-doc-tw/.)
-
hu
- Corrdinator: Tamás Bajusz
- Translated: ? (See their translation their mailing list.)
-
ru
- Coordinator: To be designated.
- Translated: ? (see python-lab.ru.)
-
bn_IN
- Coordinator: Kushal Das
- Translated: ?
-
bn_BD
- Coordinator: To be designated.
- Translated: ?
- see: https://twitter.com/auvipy/status/867370828408569856
FAQ
I want to translate, where do I start?
Step one may be to subscribe to the
Doc-SIG mailing
list, and maybe join the #python-doc
channel on freenode.
You should present yourself on the doc-sig mailing list explain what you have and from here we'll help you through the steps of the PEP.
How a coordinator is elected?
There is no election per se, but some basic rules:
- Coordinator requests are to be public on doc-sig mailing list.
- If the given language have a native core dev, the core dev have its word on the choice.
- If one want to become coordinator for its native language, and shows motivation by translating and building a community, it will be named coordinator.
- In case of concurrency between two persons, no one will sort this out for you, it's open to you to organize a local election or whatever needed to sort this out.
- In case a coordinator become inactive or unreachable for a long period of time, someone else can ask for a takeover on doc-sig.
The entry for my translation is missing/not up to date on this page
Tell me, I'm mdk
on #python-doc
and I'm Julien Palard on the
mailing lists.
I have a translation, but not on git, what should I do?
Just ask for help on the doc-sig mailing list and our python-fu, git-fu and bash-fu combined will help you create an appropriate repository. If you use a tool like transifex don't worry keeping them in sync is not that hard.
My git hierarchy does not match yours, can I keep it?
No, inside the github.com/python
organization we'll all have the
exact same hierarchy so bots will be able to build all of our
translations. So you may have to convert from one hierarchy to
another. Ask for help on the doc-sig mailing list if you're not sure
on how to do it.
What hierarchy should I use in my github repository?
As for every projects we have a branch per version, we store po
files in the root of the repository using the gettext_compact=0
style.