From 6914303629bc424d130a0d091e2352ecddfba1b7 Mon Sep 17 00:00:00 2001 From: Omar Al-Ithawi Date: Tue, 27 Feb 2024 18:25:54 +0300 Subject: [PATCH] fix: changes Co-authored-by: Adolfo R. Brandes --- README.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index f829571d..a2cfa6bb 100644 --- a/README.rst +++ b/README.rst @@ -130,7 +130,7 @@ Adding new MFEs - As of Tutor v16 (Palm release) it is no longer possible to add new MFEs by creating ``*_MFE_APP`` settings. Instead, users must implement the approach described below. - As of Tutor v17 (Quince release) you must make sure that the git URL of your MFE repository ends with ``.git``. Otherwise the plugin build will fail. -- As of Tutor v18 (Redwood release) all MFEs must provides a ``make pull_translations`` command. Otherwise the plugin build will fail. Providing an empty command is enough to bypass this requirement. See the `Custom translations section <#mfe-custom-translations>`_ for more information. +- As of Tutor v18 (Redwood release) all MFEs must provide a ``make pull_translations`` command. Otherwise the plugin build will fail. Providing an empty command is enough to bypass this requirement. See the `Custom translations section <#mfe-custom-translations>`_ for more information. Other MFE developers can take advantage of this plugin to deploy their own MFEs. To declare a new MFE, create a Tutor plugin and add your MFE configuration to the ``tutormfe.hooks.MFE_APPS`` filter. This configuration should include the name, git repository (and optionally: git branch or tag) and development port. For example:: @@ -167,9 +167,9 @@ Using custom translations to your MFEs .. _mfe-custom-translations: During docker image build, this plugin runs ``make pull_translations`` for each Micro-frontend. This -program is used in the ``Dockerfile`` to pull translations from the `openedx/openedx-translations repository `_ via the `openedx-atlas `_. +program is used in the ``Dockerfile`` to pull translations from the `openedx/openedx-translations repository `_ via `openedx-atlas `_. -The ``make pull_translations`` command passes the ``ATLAS_OPTIONS`` environment variable to the ``atlas pull`` command. This allows specifying a custom repository or branch to pull translations from: +The ``make pull_translations`` command passes the ``ATLAS_OPTIONS`` environment variable to the ``atlas pull`` command. This allows specifying a custom repository or branch to pull translations from. Translations in the MFE plugin as well as other Tutor plugins can be customized with the following configuration variables: