Skip to content

Update translation/translators.rst #1576

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

StanFromIreland
Copy link
Contributor

@StanFromIreland StanFromIreland commented Jun 16, 2025

This is a very rough draft that has been opened for the purpose of asking some questions and is subject to a lot of change, some of which I have already done locally.

There are some small changes to coordinating.rst in this pull request which came up as I was working on this.

cc @willingc


📚 Documentation preview 📚: https://cpython-devguide--1576.org.readthedocs.build/documentation/translations


.. _translation-coordinators:

.. XXX Add explicit links to README/CONTRIBUTING?
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would be nice, it will make it easier for people to start contributing though it will expand the already large table.

Comment on lines 35 to 36
- `AFPy/python-docs-fr <https://git.afpy.org/AFPy/python-docs-fr/>`_
:github:`Mirror <python/python-docs-fr>`
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cc @JulienPalard Is this correct, it is what I gathered from the repositories though it is in French so I may be wrong?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is correct. French translation happens at AFPy's Gitea and are simply mirrored to GitHub.

Instead of "GitHub" or "AFPy", there could be "repo" or "repository" text which links to the proper translation repository (for all rows in the table). Please add a comma before "Mirror"

- :github:`GitHub <CuriousLearner/python-docs-hi-in>`
* - Hungarian (hu)
- :github:`GitHub <CuriousLearner/python-docs-hi-in>` XXX Message user in issue tracker https://github.com/CuriousLearner/python-docs-hi-in/issues/5
* - `Hungarian (hu) <https://docs.python.org/hu/>`__ XXX This should probably be added
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

EB/@gbtami, do we want to add Hungarian to docsbuild-scripts since it is already under the python org?

- Alessandro Cucci (`email <mailto:alessandro.cucci@gmail.com>`__)
- :github:`GitHub <python/python-docs-it>`,
`original mail <https://mail.python.org/pipermail/doc-sig/2019-April/004114.html>`__
`Original announcement <https://mail.python.org/pipermail/doc-sig/2019-April/004114.html>`__
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note: I chose this since it is more self explanatory, and we can use the same term if an announcement is made on Discourse instead.

Translation FAQ
===============

Which version of the Python documentation should be translated?
---------------------------------------------------------------
Which version of the Python documentation should I work on?
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I updated this to be more translator focused and moved the old one to coordinating.

:doc:`coordinating` and open an issue in the
`EB issue tracker <https://github.com/python/editorial-board/issues>`_.

.. XXX Ask EB if this is ok
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

EB, are these steps correct?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would have them open an issue on the Dev Guide requesting to be added to the translation chart. I think it is fine to have the person @-mention the EB @editorial-board in the devguide issue to review the PR. I don't think we need a PR on the editorial board repo each time. Thoughts, @nedbat?

Starting a new translation
==========================

First subscribe to the `translation mailing list <translation_ml_>`_,
and introduce yourself and the translation you're starting. Translations
fall under the aegis of the `PSF Translation Workgroup <translation_wg_>`_

.. https://github.com/python/editorial-board/issues/32
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Requested clarification for Translation WG: python/editorial-board#32


Ask on the `translation mailing list <translation_ml_>`_, or better, make a PR on the `devguide
<https://github.com/python/devguide/>`__.


Is there a Weblate instance we can translate on?
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@m-aciek how does this look to you?

Comment on lines 35 to 36
- `AFPy/python-docs-fr <https://git.afpy.org/AFPy/python-docs-fr/>`_
:github:`Mirror <python/python-docs-fr>`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is correct. French translation happens at AFPy's Gitea and are simply mirrored to GitHub.

Instead of "GitHub" or "AFPy", there could be "repo" or "repository" text which links to the proper translation repository (for all rows in the table). Please add a comma before "Mirror"

Comment on lines +125 to +126
mailing list <translation_ml_>`_, and the `translations subsection <_discourse>`_
of the Python Discourse.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since some may not use a proprietary tool like Discourse, maybe keeping a instant messaging room would be interesting. But I'd suggest to migrate to Matrix instead of Libera Chat considering that there is no bridge between them anymore, and Matrix has great adoption.

Comment on lines +159 to +161
There is currently no Weblate instance for use by Python translations because of
certain limitations, these include word count limits and organization of
translation source.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
There is currently no Weblate instance for use by Python translations because of
certain limitations, these include word count limits and organization of
translation source.
`There is currently no Weblate instance for use by Python translations at the moment. <https://discuss.python.org/t/docs-translation-platform/29940>`__

@@ -372,4 +372,7 @@ version control merwok, ezio-melotti
Documentation translations
==========================

For a list of translators, see :ref:`this table about translations <translating>`.
Translations fall under the aegis of the
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"aegis" is esoteric. How about "Translations are within the charter of..."

@@ -73,7 +95,8 @@ __ https://github.com/python-docs-translations
How is a coordinator elected?
-----------------------------

There is no election. Each translation will sort out the number of coordinators. We recommend 2 or 3 coordinators, though you may begin with one. Here are some general suggestions.
There is no election. Each translation will sort out the number of coordinators.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of "sort out", how about "Each translation team will decide on the number of coordinators."

@@ -73,7 +95,8 @@ __ https://github.com/python-docs-translations
How is a coordinator elected?
-----------------------------

There is no election. Each translation will sort out the number of coordinators. We recommend 2 or 3 coordinators, though you may begin with one. Here are some general suggestions.
There is no election. Each translation will sort out the number of coordinators.
We recommend 2 or 3 coordinators, though you may begin with one. Here are some general suggestions.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Numbers less than ten should be spelled out. "two or three coordinators"

details.
There are several documentation translations already
in production; others are works in progress. To get started read your
repositories contributing guide, which is generally the ``README``
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
repositories contributing guide, which is generally the ``README``
repository's contributing guide, which is generally the ``README``

Discussions about translations occur on the Python Docs Discord
If there is already a repository for your language team (there may be links to
Telegrams/Discords in the ``README``), join and introduce
yourself, your fellow translators will be more than happy to help! XXX sounds off
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
yourself, your fellow translators will be more than happy to help! XXX sounds off
yourself. Your fellow translators will be more than happy to help!

===========

Before translating, you should familiarize yourself with the general
documentation :doc:`style guide<../style-guide>`. Some translation specific
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
documentation :doc:`style guide<../style-guide>`. Some translation specific
documentation :doc:`style guide<../style-guide>`. Some translation-specific

translation from one branch to another using :pypi:`pomerge`.


The entry for my translation is missing/not up to date
Copy link
Collaborator

@willingc willingc Jun 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The entry for my translation is missing/not up to date
The entry for my translation is missing or out of date.

@@ -2,12 +2,17 @@
Coordinating
============

Python documentation translations are governed by :PEP:`545`.
Copy link
Collaborator

@willingc willingc Jun 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Python documentation translations are governed by :PEP:`545`.
Current information about the Python documentation translation processes is found in this devguide, and Process :PEP:`545`, adopted in 2018.

Which version of the Python documentation should be translated?
---------------------------------------------------------------

Consensus is to work on the current stable version. You can then propagate your
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Consensus is to work on the current stable version. You can then propagate your
It's best to work on Python's current stable version. You can then propagate your

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants