8000 Typo and grammar fixes to documenting.rst "Translating" section by bgrant · Pull Request #698 · python/devguide · GitHub
[go: up one dir, main page]

Skip to content

Typo and grammar fixes to documenting.rst "Translating" section #698

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

Merged
merged 4 commits into from
Mar 3, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 37 additions & 37 deletions documenting.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1586,11 +1586,11 @@ see the make targets above).
Translating
===========

Python documentation translations are governed by the :PEP:`545`,
they are built by `docsbuild-scripts
Python documentation translations are governed by :PEP:`545`.
They are built by `docsbuild-scripts
<https://github.com/python/docsbuild-scripts/>`__ and hosted on
docs.python.org. There are several documentation translations already
in production, other are work in progress:
in production; others are works in progress.

+-----------------+-------------------------------+----------------------------+
| Language | Contact | Links |
Expand Down Expand Up @@ -1701,16 +1701,16 @@ fall under the aegis of the `PSF Translation Workgroup <translation_wg_>`_
Then you can bootstrap your new translation by using our `cookiecutter
<https://github.com/JulienPalard/python-docs-cookiecutter>`__.

The important steps looks like this:
The important steps look like this:

- Create the github repo (anywhere), with the right hierarchy (using the
- Create the GitHub repo (anywhere) with the right hierarchy (using the
cookiecutter).
- Gather people to help you translating, you can't do it alone.
- 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 are using Transifex, some are using only github, or you can choose another
way, it's up to you.
- Ensure we updated this page to reflect your work and progress, either via a
PR, or by asking on the `translation mailing list <translation_ml_>`_.
Some use Transifex, and some use only GitHub. You can choose another
way if you like; it's up to you.
- Ensure we update this page to reflect your work and progress, either via a
PR or by asking on the `translation mailing list <translation_ml_>`_.
- When ``tutorial/``, ``bugs.py`` and ``library/functions``
are complete, ask on the `translation mailing list <translation_ml_>`_ for your language to be added in the
language picker on docs.python.org.
Expand All @@ -1722,13 +1722,13 @@ PEP 545 summary:
Here are the essential points of :PEP:`545`:

- Each translation is assigned an appropriate lowercased language tag,
with an optional region subtag, joined with a dash, like
with an optional region subtag, and joined with a dash, like
``pt-br`` or ``fr``.

- Each translation is under CC0 and marked as so in the README (as in
- Each translation is under CC0 and marked as such in the README (as in
the cookiecutter).

- Translations files are hosted on
- Translation files are hosted on
``https://github.com/python/python-docs-{LANGUAGE_TAG}`` (not
mandatory to start a translation, but mandatory to land on
``docs.python.org``).
Expand All @@ -1749,62 +1749,61 @@ and there's a `Libera.Chat IRC <https://libera.chat/>`_ channel,
Translation FAQ
---------------

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

Consensus is to work on current stable, you can then propagate your
translation from a branch to another using `pomerge
Consensus is to work on current stable. You can then propagate your
translation from one branch to another using `pomerge
<https://pypi.org/project/pomerge/>`__.


Are there some tools to help in managing the repo?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Here's what's we're using:
Here's what we're using:

- `pomerge <https://pypi.org/project/pomerge/>`__ to propagate translation
from a files to others.
- `pospell <https://pypi.org/project/pospell/>`__ to check for typo in po files.
- `pomerge <https://pypi.org/project/pomerge/>`__ to propagate translations
from one file to others.
- `pospell <https://pypi.org/project/pospell/>`__ to check for typos in ``.po`` files.
- `powrap <https://pypi.org/project/powrap/>`__ to rewrap the ``.po`` files
before committing, this helps keeping git diffs short.
before committing. This helps keep git diffs short.
- `potodo <https://pypi.org/project/potodo/>`__ to list what needs to be translated.



How a coordinator is elected?
How is a coordinator elected?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

There is no election, each translation have to sort this out. Here are some suggestions.
There is no election; each translation has to sort this out. Here are some suggestions.

- Coordinator requests are to be public on the `translation mailing list <translation_ml_>`_.
- If the given language have a native core dev, the core dev have its
word on the choice.
- Anyone who wants to become coordinator for its native language, and shows
motivation by translating and building a community, will be named
- If the given language has a native core dev, the core dev has their
say on the choice.
- Anyone who wants to become coordinator for their native language and shows
motivation by translating and building a community will be named
coordinator.
- In case of concurrency between two persons, no one will sort this out
for you. It is up to you two to organize a local election or whatever
for you. It is up to you two to organize a local election or whatever is
needed to sort this out.
- In case a coordinator become inactive or unreachable for a long
- If a coordinator becomes inactive or unreachable for a long
period of time, someone else can ask for a takeover on the `translation mailing list <translation_ml_>`_.


The entry for my translation is missing/not up to date on this page
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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


I have a translation, but not on git, what should I do?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
I have a translation, but it's not in git. What should I do?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

You can ask for help on the `translation mailing list <translation_ml_>`_, and
the 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?
My git hierarchy does not match yours. Can I keep it?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

No, inside the ``github.com/python`` organization we’ll all have the
Expand All @@ -1813,10 +1812,11 @@ translations. So you may have to convert from one hierarchy to another.
Ask for help on the `translation mailing list <translation_ml_>`_ if you’re
not sure on how to do it.

What hierarchy should I use in my github repository?

What hierarchy should I use in my GitHub repository?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

As for every project, we have a *branch* per version. We store ``po``
As for every project, we have a *branch* per version. We store ``.po``
files in the root of the repository using the ``gettext_compact=0``
style.

Expand Down
0