Skip to content
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

docs: add new language and fix translation errors | FC-0012 #469

Merged
merged 1 commit into from
Mar 27, 2024
Merged

docs: add new language and fix translation errors | FC-0012 #469

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 24 additions & 0 deletions source/translators/how-tos/how-to-fix-translation-errors.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
How to fix translation validation errors
########################################

As part of OEP-58 (:doc:`/developers/concepts/oep58`), 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.
Other file formats are not checked, but `contributions to support .json and other files validation are welcome`_.

Steps
*****

#. Monitor the list of `invalid translations reports`_ in the `openedx-translations repository`_.
#. Identify the invalid translation entries in the pull requests of your language by checking the bot report in
the comments.
#. Go to the `openedx-translations project page`_.
#. Search for the invalid translation entries in the Transifex resources.
#. Once the issues are fixed, the Transifex bot will update the pull request and it'll be automatically merged.

.. _openedx-translations project page: https://explore.transifex.com/open-edx/openedx-translations/
.. _contributions to support .json and other files validation are welcome: https://github.com/openedx/openedx-translations/issues/549
.. _validation scripts and GitHub Actions: https://github.com/openedx/openedx-translations/blob/main/.github/workflows/validate-translation-files.yml
.. _invalid translations reports: https://github.com/openedx/openedx-translations/pulls?q=is%3Apr+is%3Aopen+%22Some+translations+are+invalid.%22
.. _openedx-translations repository: https://github.com/openedx/openedx-translations
19 changes: 14 additions & 5 deletions source/translators/how-tos/how-to-request-a-new-language.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,27 +5,37 @@ Assumptions
***********

* The language you are interested in is not listed on the Transifex
`edx-platform project page`_.
`openedx-translations Transifex project`_.

* 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``.

* 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:

* Be an active translator
* 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

* Monitor and address Transifex issues posted by translators.

* Monitor and fix translations validation errors: :doc:`how-to-fix-translation-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.

Steps
*****

#. Go to the `edx-platform project page`_
#. Go to the `openedx-translations Transifex project`_

#. Select the option :guilabel:`Request language` to start a new translation
project for your target language.
Expand All @@ -37,5 +47,4 @@ Steps
is approved, you become the coordinator of the project. You can add
additional coordinators, reviewers, and translators as you wish.

.. _edx-platform project page: https://explore.transifex.com/open-edx/edx-platform/

.. _openedx-translations Transifex project: https://explore.transifex.com/open-edx/openedx-translations/