- Getting started
- Development workflow
- Issues and triaging
- Documentation
- Testing and buildbots
- Development tools
- Core team
- CPython’s internals
- Status of Python versions
- Python Contributor’s Guide (draft)
- [Plan for the Contributor’s Guide]
- Introduction
- The CPython project
- Issues and triaging
- Documentation contributions
- Code contributions
- Core team
- Accessibility, design, and user success
- Security and infrastructure contributions
- Workflows
Coordinating¶
Information about the Python documentation translation processes isfound in this devguide andPEP 545.Translations are built bydocsbuild-scripts and hosted ondocs.python.org. Translationsare overseen by theEditorial Board
Starting a new translation¶
First subscribe to thetranslation mailing list,and introduce yourself and the translation you’re starting.
Then you can bootstrap your new translation by using thecookiecutter orbootstrapper.You can also start your translation usingTransifexfollowing thisguide.
The important steps look like this:
Create the GitHub repo (any account) with the correct hierarchy by using oneof the bootstrappers or Transifex.
Gather people to help you translate. You can’t do it alone.
You can use any tool to translate, as long as you can synchronize with Git.Some use Transifex, and some use only GitHub. You can choose anotherway if you like; it’s up to you.
Updatethis page to reflect your work and progress, either via aPR or by asking on thetranslation mailing list.
When
bugs,tutorial, andlibrary/functionsare 100%completed, ask on thetranslation mailing list foryour language to be added in the language switcher on docs.python.org.
How to get help¶
Discussions about translations occur on the Python Docs Discord#translations channel,translationmailing list, and thetranslations categoryof the Python Discourse.
PEP 545 summary¶
Here are the essential points ofPEP 545:
Each translation is assigned an appropriate lowercased language tag,with an optional region subtag, and joined with a dash, like
pt-brorfr.Each translation is under CC0 and marked as such in the README (as inthe cookiecutter).
Translation files are hosted on
https://github.com/python/python-docs-{LANGUAGE_TAG}(notmandatory to start a translation, but mandatory to land ondocs.python.org).Translations having completed
tutorial/,library/stdtypesandlibrary/functionsare hosted onhttps://docs.python.org/{LANGUAGE_TAG}/{VERSION_TAG}/.
Transifex¶
If you need help from a Transifex administrator, open an issue on thetracker.
Coordinating FAQ¶
Are there tools to help in managing the repo?¶
Here’s what we’re using:
poutils which includes:
sphinx-lint to validate reST syntax in translation files.
More related tools and projects can be found in thepython-docs-translations organisation on GitHub.
How is a coordinator elected?¶
Each translation team will decide on the number of coordinators.We recommend two or three coordinators, though you may begin with one.Here are some general suggestions.
Coordinator requests are to be public on thetranslation mailing list.
If the given language has a native core dev, the core dev has inputon the coordinator request.
Anyone who wants to become coordinator for their native language and showsmotivation by translating and building a community will be namedcoordinator.
We expect the local community to self-organize coordinators and contributors.If you have questions, please ask on the mailing list or Discourse.
If a coordinator becomes inactive or unreachable for a longperiod of time, someone else can ask to be added as a primary coordinator on thetranslation mailing list.As a community resource, we aim to keep translations up to date with active contributors, including coordinators.
I have a translation, but it’s not in Git. What should I do?¶
You can ask for help on thetranslation mailing list, andthe team will help you create an appropriate repository. You can still use tools like transifex,if you like.
My Git hierarchy does not match yours. Can I keep it?¶
No, inside thegithub.com/python organization we’ll all have theexact same hierarchy so bots will be able to build all of ourtranslations. So you may have to convert from one hierarchy to another.Ask for help on thetranslation mailing list if you’renot sure on how to do it.
What hierarchy should I use in my GitHub repository?¶
As for every project, we have abranch per version. We store.pofiles in the root of the repository using thegettext_compact=0style.
Which version of the Python documentation should be translated?¶
It’s best to work on Python’s current stable or beta version. You can thenpropagate your translation from one branch to another usingpomerge.
The entry for my translation is missing or not up to date¶
Ask on thetranslation mailing list, or better, make a PRon thedevguide.
Is there a Weblate instance we can translate on?¶
There is currently no Weblate instance for Python translations.See thisDiscourse threadfor updates.
- Coordinating
- Starting a new translation
- How to get help
- PEP 545 summary
- Transifex
- Coordinating FAQ
- Are there tools to help in managing the repo?
- How is a coordinator elected?
- I have a translation, but it’s not in Git. What should I do?
- My Git hierarchy does not match yours. Can I keep it?
- What hierarchy should I use in my GitHub repository?
- Which version of the Python documentation should be translated?
- The entry for my translation is missing or not up to date
- Is there a Weblate instance we can translate on?