diff --git a/README.rst b/README.rst index 5ac263c4..83782c2a 100644 --- a/README.rst +++ b/README.rst @@ -497,6 +497,20 @@ File changed: ``tutormfe/templates/mfe/apps/mfe/Caddyfile`` Troubleshooting --------------- +NPM Dependency Conflict When overriding ``@edx/frontend-component-header`` or ``@edx/frontend-component-footer`` +---------------------------------------------------------------------------------------------------------------- + +When there is a need to customize the ``@edx/frontend-component-header`` or ``@edx/frontend-component-footer`` component, two things we have to care of to avoid dependency conflict error during ``npm`` installation. + +1. Identify your openedx version, for example ``quince``. +2. Navigate to `learning `_ and `learner-dashboard `_ MFEs repositories and checkout to branch ``open-release/quince.master``. Inspect which header and footer versions are installed from ``package.json``. You can explore the header and footer versions for additional MFEs to ensure that all MFEs support the same major versions of header and footer. +3. Then, determine which versions of ``@edx/frontend-platform`` MFEs are utilizing and the header you plan to customize is compatible with the same version of ``@edx/frontend-platform`` specified in ``package.json`` file (peer-dependencies). +4. Ensure consistency between the versions. For example, If MFE has ``@edx/frontend-platform: 7.0.1``, then customize the header component which has ``@edx/frontend-platform: ^7.0.0`` in ``package.json`` under peer-dependencies +5. Checkout to that specific tag (e.g: ``v7.0.0``) of header component and customize it +6. Install the customized header/footer components into your MFEs. This will resolve any npm dependency conflict issues. +7. Repeat the same process for customizing the footer component if necessary. + + 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