2017-06-09 07:45:29 +00:00
|
|
|
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](https://www.python.org/dev/peps/pep-0545/).
|
|
|
|
|
|
|
|
|
|
|
|
# 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` or `fr`.
|
|
|
|
|
|
|
|
- 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
|
|
|
|
|
|
|
|
- ja
|
|
|
|
|
2017-08-09 22:17:52 +00:00
|
|
|
- https://docs.python.org/ja/3.6/
|
2017-06-15 12:00:14 +00:00
|
|
|
- Coordinator: [Inada Naoki (methane)](http://bugs.python.org/user10371)
|
2017-12-11 13:44:39 +00:00
|
|
|
- Translated: 92.77% (as of 2017-12)
|
2017-06-26 19:22:06 +00:00
|
|
|
- Repository: https://github.com/python/python-docs-ja/
|
2017-06-09 07:45:29 +00:00
|
|
|
|
2017-12-11 13:44:39 +00:00
|
|
|
- fr
|
|
|
|
|
|
|
|
- https://docs.python.org/fr/3.6/
|
|
|
|
- Coordinator: [Julien Palard (mdk)](http://bugs.python.org/user23063)
|
|
|
|
- Translated: 28% (as of 2017-12)
|
|
|
|
- Repository: https://github.com/python/python-docs-fr/
|
|
|
|
|
2018-03-06 20:57:09 +00:00
|
|
|
- ko
|
|
|
|
|
2018-05-04 20:52:52 +00:00
|
|
|
- https://docs.python.org/ko/3.6/
|
2018-03-06 20:57:09 +00:00
|
|
|
- Coordinator: To be designated.
|
|
|
|
- Translated: flowdas is working on it
|
|
|
|
- Repository: https://github.com/python/python-docs-ko
|
|
|
|
|
2017-06-09 07:45:29 +00:00
|
|
|
- zh-cn
|
|
|
|
|
2018-05-04 20:52:52 +00:00
|
|
|
- https://zhsj.github.io/python-docs-zh-cn/
|
2017-06-15 12:00:14 +00:00
|
|
|
- Coordinator: [Xiang Zhang](http://bugs.python.org/user21530)
|
2017-12-11 13:44:39 +00:00
|
|
|
- Translated: 1.37% (as of 2017-12)
|
2017-06-09 07:45:29 +00:00
|
|
|
|
|
|
|
- pt-br
|
|
|
|
|
2017-06-26 19:22:06 +00:00
|
|
|
- Coordinator: [Marco Rougeth](https://mail.python.org/pipermail/doc-sig/2017-June/003975.html)
|
2017-12-11 13:44:39 +00:00
|
|
|
- Translated: 19.6% (as of 2017-12).
|
2017-06-09 07:45:29 +00:00
|
|
|
[transifex](https://www.transifex.com/python-doc/public/).
|
2017-06-26 19:22:06 +00:00
|
|
|
- Repository: https://github.com/python/python-docs-pt-br/
|
2017-06-27 19:39:48 +00:00
|
|
|
- Wiki: http://python.org.br/traducao
|
2017-06-26 19:22:06 +00:00
|
|
|
|
2017-06-27 19:39:48 +00:00
|
|
|
- pt
|
2017-06-26 19:22:06 +00:00
|
|
|
|
2017-12-11 13:44:39 +00:00
|
|
|
- Coordinator: To be designated.
|
|
|
|
- Translator: Gustavo Toffo.
|
|
|
|
- Translated: 0% (as of 2017-12)
|
2017-06-09 07:45:29 +00:00
|
|
|
|
|
|
|
- es
|
|
|
|
|
|
|
|
- Coordinator: To be designated.
|
2017-12-11 13:44:39 +00:00
|
|
|
- Translated: 1.42% (as of 2017-12)
|
2017-06-09 07:45:29 +00:00
|
|
|
[github.com/PyAr/tutorial/](https://github.com/PyAr/tutorial/commits/master).
|
|
|
|
|
|
|
|
- zh-tw
|
|
|
|
|
2018-05-26 13:56:05 +00:00
|
|
|
- Coordinator: 廖偉涵 Adrian Liaw
|
|
|
|
- Translated: 2.8% (as of 2018-05)
|
|
|
|
- Github: [github.com/python-doc-tw/](https://github.com/python-doc-tw/cpython-tw/tree/tw-3.6).
|
|
|
|
- Transifex: https://www.transifex.com/python-tw-doc/python-36-tw
|
2017-06-09 07:45:29 +00:00
|
|
|
|
|
|
|
- hu
|
|
|
|
|
2017-06-15 12:00:14 +00:00
|
|
|
- Corrdinator: [Tamás Bajusz (gbtami)](http://bugs.python.org/user25857)
|
2017-12-11 13:44:39 +00:00
|
|
|
- Translated: 1.82% on transifed as of 2017-12,
|
|
|
|
- [their translation](http://harp.pythonanywhere.com/python_doc/tutorial/index.html)
|
|
|
|
- [their mailing list](https://mail.python.org/pipermail/python-hu/)
|
2017-06-26 19:22:06 +00:00
|
|
|
- Repository: https://github.com/python/python-docs-hu/
|
2017-06-09 07:45:29 +00:00
|
|
|
|
|
|
|
- ru
|
|
|
|
|
|
|
|
- Coordinator: To be designated.
|
2017-12-11 13:44:39 +00:00
|
|
|
- Translated: ?
|
|
|
|
- [python-lab.ru](http://python-lab.ru/documentation/index.html)
|
2017-06-09 07:45:29 +00:00
|
|
|
|
|
|
|
- bn_IN
|
|
|
|
|
2017-06-15 12:00:14 +00:00
|
|
|
- Coordinator: [Kushal Das](http://bugs.python.org/user16382)
|
2017-06-10 05:55:10 +00:00
|
|
|
- Translated: ?
|
2017-06-26 19:22:06 +00:00
|
|
|
- Repository: https://github.com/python/python-docs-bn-in
|
2017-06-10 05:55:10 +00:00
|
|
|
|
2017-06-10 08:13:46 +00:00
|
|
|
- bn_BD
|
2017-06-10 05:55:10 +00:00
|
|
|
|
2017-06-09 07:45:29 +00:00
|
|
|
- Coordinator: To be designated.
|
|
|
|
- Translated: ?
|
2017-06-10 06:19:12 +00:00
|
|
|
- see: [https://twitter.com/auvipy/status/867370828408569856](https://twitter.com/auvipy/status/867370828408569856)
|
2017-06-09 07:45:29 +00:00
|
|
|
|
2018-07-12 12:50:31 +00:00
|
|
|
- ar
|
|
|
|
|
|
|
|
- Coordinator: Abdur-Rahmaan Janhangeer
|
|
|
|
- Repository: https://github.com/Abdur-rahmaanJ/py-docs-ar
|
|
|
|
|
2018-07-31 12:42:27 +00:00
|
|
|
- tr
|
|
|
|
|
|
|
|
- Repository: https://github.com/alaeddingurel/python-docs-tr
|
2018-07-12 12:50:31 +00:00
|
|
|
|
|
|
|
|
2017-06-09 07:45:29 +00:00
|
|
|
|
|
|
|
# FAQ
|
|
|
|
|
|
|
|
## I want to translate, where do I start?
|
|
|
|
|
|
|
|
Step one may be to subscribe to the
|
|
|
|
[Doc-SIG](https://mail.python.org/mailman/listinfo/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.
|