diff --git a/source/developers/concepts/oep58.rst b/source/developers/concepts/oep58.rst index 827d90745..501c4b62c 100644 --- a/source/developers/concepts/oep58.rst +++ b/source/developers/concepts/oep58.rst @@ -1,3 +1,5 @@ +.. _OEP-58 Overview: + OEP-58 Overview ############### diff --git a/source/translators/how-tos/how-to-fix-translation-errors.rst b/source/translators/how-tos/how-to-fix-translation-errors.rst index fb84df93d..6d7d3c8bd 100644 --- a/source/translators/how-tos/how-to-fix-translation-errors.rst +++ b/source/translators/how-tos/how-to-fix-translation-errors.rst @@ -1,7 +1,9 @@ +.. _How to fix translation validation errors: + How to fix translation validation errors ######################################## -As part of OEP-58 (:doc:`/developers/concepts/oep58`), automatic translation validation has been added to avoid +As part of OEP-58 (:ref:`OEP-58 Overview`), automatic translation validation has been added to avoid breaking builds and deployments due to invalid translations. As of writing this document, `validation scripts and GitHub Actions`_ checks .po files for compilation errors. diff --git a/source/translators/how-tos/how-to-join-a-review-team.rst b/source/translators/how-tos/how-to-join-a-review-team.rst index ea692972c..37e206f43 100644 --- a/source/translators/how-tos/how-to-join-a-review-team.rst +++ b/source/translators/how-tos/how-to-join-a-review-team.rst @@ -31,7 +31,7 @@ To join a review team, request permission from the project coordinator(s): project page. You can also obtain reviewer and coordinator access by contacting the - Translation Working Group’s Organizer via ``ehuthmacher at axim dot org``. + Translation Working Group's Organizer via ``oscm at axim dot org``. **Maintenance chart** diff --git a/source/translators/how-tos/how-to-join-a-translation-team.rst b/source/translators/how-tos/how-to-join-a-translation-team.rst index fbfe06bf5..e7f64e8f6 100644 --- a/source/translators/how-tos/how-to-join-a-translation-team.rst +++ b/source/translators/how-tos/how-to-join-a-translation-team.rst @@ -5,7 +5,7 @@ In order to help translate Open edX projects, you must first join a translation for the language you wish to translate to. We use `Transifex`_ to allow our community to collaborate on translations. More detailed instructions for how to get involved in translations are located in the -:doc:`/translators/quickstarts/start-translating-openedx` page. +:ref:`How to start translating for Open edX` page. Steps ***** @@ -20,7 +20,7 @@ To join a translation team you must complete these steps: #. Join the Transifex `openedx-translations project`_ with the language(s) you wish to translate to. Please be proficient in both English and the language you wish to translate to! If that language does not yet exist, you may follow the directions - in :doc:`/translators/how-tos/how-to-request-a-new-language` to add it. + in :ref:`How to request a new language for translation` to add it. #. Join the Open edX Slack or Discuss. Links to join are available at the `Open edX Community`_ page. Translation help is available in the diff --git a/source/translators/how-tos/how-to-request-a-new-language.rst b/source/translators/how-tos/how-to-request-a-new-language.rst index 3110e3eeb..25e1c7b1d 100644 --- a/source/translators/how-tos/how-to-request-a-new-language.rst +++ b/source/translators/how-tos/how-to-request-a-new-language.rst @@ -1,3 +1,5 @@ +.. _How to request a new language for translation: + How to request a new language for translation ############################################# @@ -10,38 +12,52 @@ Assumptions * A variant of the language that may meet your needs is also not listed (``Chinese`` vs ``Chinese-China``). -* Prefer a root locale over a variant locale (``de`` over ``de_DE``) whenever applicable so other locales can inherit - from it e.g. ``de_AT``. +* Prefer a root locale over a variant locale (``de`` over ``de_DE``) whenever + applicable so other locales can inherit from it e.g. ``de_AT``. * If you request a new language, we ask that you commit to the success of your - language’s translation project. Particularly, we expect you to: + language's translation project. Particularly, we expect you to: - * Be an active translator: Translate the ``edx-platform``, ``edx-platform-js`` and main micro-frontends such as - Learning MFE and other resources in the `openedx-translations Transifex project`_ + * Be an active translator: Translate the ``edx-platform``, ``edx-platform-js`` + and main micro-frontends such as Learning MFE and other resources in the + `openedx-translations Transifex project`_. - * Work to recruit other translators and reviewers + * Work to recruit other translators and reviewers. * Monitor and address Transifex issues posted by translators. - * Monitor and fix translations validation errors: :doc:`how-to-fix-translation-errors`. + * Monitor and fix translations validation errors: :ref:`How to fix translation + validation errors`. You will be responsible for advancing your target language to completion, with all strings translated and reviewed, so that we can publish your work to the Open edX community. -.. note:: - Languages can be removed from the project if they are not actively maintained. +.. warning:: + + Languages can be removed from the project if they are not actively + maintained. Steps ***** -#. Go to the `openedx-translations Transifex project`_ +#. Email ``oscm@axim.org`` to request a new language code. Please do *not* + request a language from the `openedx-translations Transifex project`_, + because we can't communicate with you via this channel. Please email instead. + +#. Wait for an Open edX translation team member to respond to your request + within a few days. Please keep the following in mind: -#. Select the option :guilabel:`Request language` to start a new translation - project for your target language. + * The Open edX team needs to verify the language code and often will have + questions before accepting a new language. For example, a request for a + specific locale (such as German for Germany ``de_DE`` or Arabic for Iraq ``ar_IQ``) will be weighed + against a more global language code (such as global German ``de`` or global Arabic ``ar``). -#. Wait for an edX translation team member to - respond to your request within a few days. + * A language will only be added with a commitment from an individual or group + to manage the translators for the language for at least one release. The + Open edX project is large, and there's high turnaround of translators which + often results in low quality translations and in some cases invalid translations + that cause server errors. #. If the language that you request is approved, you become the coordinator of the project. You can add @@ -52,8 +68,8 @@ Steps **Maintenance chart** -+--------------+-------------------------------+----------------+--------------------------------+ -| Review Date | Working Group Reviewer | Release |Test situation | -+--------------+-------------------------------+----------------+--------------------------------+ -| | | | | -+--------------+-------------------------------+----------------+--------------------------------+ ++--------------+-------------------------------+----------------+----------------------------------------------------------------------+ +| Review Date | Working Group Reviewer | Release |Test situation | ++--------------+-------------------------------+----------------+----------------------------------------------------------------------+ +| 2025-10-03 | Omar | No release | Pass | ++--------------+-------------------------------+----------------+----------------------------------------------------------------------+ diff --git a/source/translators/quickstarts/start-translating-openedx.rst b/source/translators/quickstarts/start-translating-openedx.rst index 9367c4b1e..9b4cc4c69 100644 --- a/source/translators/quickstarts/start-translating-openedx.rst +++ b/source/translators/quickstarts/start-translating-openedx.rst @@ -1,3 +1,5 @@ +.. _How to start translating for Open edX: + Quick Start: How to start translating for Open edX ##################################################