docs: add warning to adding new MFEs section of the README about the MFE plugin URL ending in .git

overhangio / tutor-mfe

This plugin makes it possible to easily add micro frontend (MFE) applications on top of an Open edX platform that runs with Tutor.

GNU Affero General Public License v3.0

22 stars 95 forks source link

docs: add warning to adding new MFEs section of the README about the MFE plugin URL ending in .git #183

Closed FatemeKhodayari closed 10 months ago

FatemeKhodayari commented 10 months ago

As of Tutor v17 (Quince release) custom MFE plugins only accept URLs ending in .git. Providing a normal URL of the repository will cause failure in the build of MFE image when running tutor images build mfe as the custom MFE won't get cloned.

This issue was previously mentioned in this topic and the changelog was updated in this PR. This PR updates the readme.

Closes https://github.com/overhangio/tutor-mfe/issues/180

FatemeKhodayari commented 10 months ago

I second @regisb's requests for changes, but otherwise looks good!

Thanks for the recommendations @regisb Applied them and squashed commits.