Skip to content

Documentation/Translating: note new GitHub organisation #1507

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.

Sign up for GitHub

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 7 commits into from
Feb 27, 2025
Merged

Documentation/Translating: note new GitHub organisation #1507

Changes from 6 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
04b5f4c
Update the link to the translations dashboard
m-aciek Feb 4, 2025
ad362aa
Mention Ege Eakman's bootstrapper project
m-aciek Feb 13, 2025
bbdbf28
Remove suffix from chapter name in PEP 545 section
m-aciek Feb 13, 2025
2f787b0
Add a mention about the new organisation in tools FAQ section
m-aciek Feb 13, 2025
9b2d033
Improve the mention about the new organisation in tools FAQ section
m-aciek Feb 13, 2025
9e552af
Update documentation/translating.rst: improve wording
m-aciek Feb 18, 2025
b2e9a38
Narrow down translations organisation link text
m-aciek Feb 27, 2025
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
15 changes: 9 additions & 6 deletions documentation/translating.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ 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; others are works in progress. See `the dashboard
<https://m-aciek.github.io/pydocs-translation-dashboard/>`__ for
<https://python-docs-translations.github.io/dashboard/>`__ for
details.

.. list-table::
Expand Down Expand Up @@ -112,20 +112,21 @@ 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_>`_

Then you can bootstrap your new translation by using our `cookiecutter
<https://github.com/JulienPalard/python-docs-cookiecutter>`__.
Then you can bootstrap your new translation by using `cookiecutter
<https://github.com/JulienPalard/python-docs-cookiecutter>`__ or
`bootstrapper <https://github.com/python-docs-translations/python-docs-bootstrapper>`__.

The important steps look like this:

- Create the GitHub repo (anywhere) with the right hierarchy (using the
cookiecutter).
- Create the GitHub repo (anywhere) with the right hierarchy (using one
of the bootstrappers).
- 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 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 ``bugs.html``, ``tutorial``, and ``library/functions`` are 100%
- When ``bugs``, ``tutorial``, and ``library/functions`` are 100%

This comment was marked as resolved.

Sign in to view

completed, ask on the `translation mailing list <translation_ml_>`_ for
your language to be added in the language switcher on docs.python.org.

Expand Down Expand Up @@ -183,6 +184,8 @@ Here's what we're using:
- :pypi:`potodo` to list what needs to be translated.
- :pypi:`sphinx-lint` to validate reST syntax in translation files.

More related tools and projects can be found in
`python-docs-translations organisation on GitHub <https://github.com/python-docs-translations>`__.

How is a coordinator elected?
-----------------------------
Expand Down