diff --git a/docs/0002-atlas-translations-management.rst b/docs/0002-atlas-translations-management.rst index 84bbd7ef9..1c36ab6b0 100644 --- a/docs/0002-atlas-translations-management.rst +++ b/docs/0002-atlas-translations-management.rst @@ -41,21 +41,29 @@ split back the translated files into the modules after pulling from the `openedx The `OEP-58`_ workflow will proceed as follows: -- The `openedx-translations repository`_ runs a daily cronjob to collect strings from the `openedx-app-ios`_ - ``main`` branch. - - The `extract-translation-source-files.yml`_ workflow will clone the `openedx-app-ios`_. - - The `extract-translation-source-files.yml`_ workflow will run the `openedx-app-ios`_'s ``make combine_translations``. - - The ``make combine_translations`` combines English ``Localizable.strings`` files from the mobile app modules into - a single ``I18N/I18N/en.lproj/Localizable.strings`` file. - - The ``I18N/I18N/en.lproj/Localizable.strings`` is committed in the `openedx-translations repository`_ - - The `GitHub Transifex app`_ will fetch the updated English source ``.strings`` files from `openedx-translations repository`_ - - Translators can translate the strings in the `Transifex openedx-translations project`_ - - The `GitHub Transifex app`_ syncs the translated strings into the `openedx-translations repository`_ -- Developers run ``make pull_translations`` to pull the translations from the `openedx-translations repository`_ - - The ``make pull_translations`` run `atlas pull`_ command pulls the translations - - The translation will be pulled in a single file for each language e.g. ``I18N/I18N/ar.lproj/Localizable.strings`` - - Then ``make pull_translations`` will run ``python scripts/split_translation_files.py`` script to split - the translations into the modules e.g. ``Course/Course/ar.lproj/Localizable.strings`` +* The `openedx-translations repository`_ runs a daily cronjob to collect strings from the `openedx-app-ios`_ ``main`` branch. + + * The `extract-translation-source-files.yml`_ workflow will clone the `openedx-app-ios`_. + + * The `extract-translation-source-files.yml`_ workflow will run the `openedx-app-ios`_'s ``make combine_translations``. + + * The ``make combine_translations`` combines English ``Localizable.strings`` files from the mobile app modules into a single ``I18N/I18N/en.lproj/Localizable.strings`` file. + + * The ``I18N/I18N/en.lproj/Localizable.strings`` is committed in the `openedx-translations repository`_. + + * The `GitHub Transifex app`_ will fetch the updated English source ``.strings`` files from `openedx-translations repository`_ + + * Translators can translate the strings in the `Transifex openedx-translations project`_ + + * The `GitHub Transifex app`_ syncs the translated strings into the `openedx-translations repository`_ + +* Developers run ``make pull_translations`` to pull the translations from the `openedx-translations repository`_ + + * The ``make pull_translations`` run `atlas pull`_ command pulls the translations + + * The translation will be pulled in a single file for each language e.g. ``I18N/I18N/ar.lproj/Localizable.strings`` + + * Then ``make pull_translations`` will run ``python scripts/split_translation_files.py`` script to split the translations into the modules e.g. ``Course/Course/ar.lproj/Localizable.strings`` Notable changes ===============