Skip to content

Commit

Permalink
docs: add warning to the adding new MFEs section of the README about …
Browse files Browse the repository at this point in the history
…the MFE plugin URL ending in .git
  • Loading branch information
FatemeKhodayari authored and regisb committed Jan 22, 2024
1 parent 58aeac1 commit de52636
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -126,18 +126,21 @@ MFE management
Adding new MFEs
~~~~~~~~~~~~~~~

.. warning:: 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 here.
⚠️ **Warnings**

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) and development port. For example::
- 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.

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

from tutormfe.hooks import MFE_APPS

@MFE_APPS.add()
def _add_my_mfe(mfes):
mfes["mymfe"] = {
"repository": "https://github.com/myorg/mymfe",
"repository": "https://github.com/myorg/mymfe.git",
"port": 2001,
"version": "me/my-custom-branch", # optional, will default to the Open edX current tag.
"version": "me/my-custom-branch-or-tag", # optional, will default to the Open edX current tag.
}
return mfes

Expand Down

0 comments on commit de52636

Please sign in to comment.