diff --git a/README.rst b/README.rst index e831d9b..a37ac94 100644 --- a/README.rst +++ b/README.rst @@ -1,4 +1,4 @@ -Micro Frontend base plugin for `Tutor `__ +Micro Frontend base plugin for `Tutor `__ ========================================================================= This plugin makes it possible to easily add micro frontend (MFE) applications on top of an Open edX platform that runs with Tutor. To learn more about MFEs, please check the `official Open edX documentation `__. @@ -32,7 +32,7 @@ To enable this plugin, run:: tutor plugins enable mfe tutor local launch -When running the plugin in production, it is recommended that you set up a catch-all CNAME for subdomains at the DNS provider: see the `Configuring DNS Records `__ section in the Tutor documentation for more details. This way, the plugin will work out of the box with no additional configuration. Which is to say, if your ``LMS_HOST`` is set to `myopenedx.com` the MFEs this plugin provides will be accessible under `apps.myopenedx.com` by default. +When running the plugin in production, it is recommended that you set up a catch-all CNAME for subdomains at the DNS provider: see the `Configuring DNS Records `__ section in the Tutor documentation for more details. This way, the plugin will work out of the box with no additional configuration. Which is to say, if your ``LMS_HOST`` is set to `myopenedx.com` the MFEs this plugin provides will be accessible under `apps.myopenedx.com` by default. To check what the current value of `MFE_HOST` is actually set to, run:: @@ -368,7 +368,7 @@ Finally, restart the platform with:: Troubleshooting --------------- -This Tutor plugin is maintained by Adolfo Brandes from `tCRIL `__. Community support is available from the official `Open edX forum `__. Do you need help with this plugin? See the `troubleshooting `__ section from the Tutor documentation. +This Tutor plugin is maintained by Adolfo Brandes from `tCRIL `__. Community support is available from the official `Open edX forum `__. Do you need help with this plugin? See the `troubleshooting `__ section from the Tutor documentation. License -------