| Info |
|---|
These are my (Kyle McCormick's) running notes as I do an investigation into the challenges that Open edX developers face when using Microfrontends and how we can address those. They represent my opinion and have not been approved or reviewed by any other edX employee. |
...
So what do we need to do?
TODO: Flesh this out
Based on the above, I see three categories of work to be done:
Documentation
Communication:Most of the code to use MFEs is already available, but how to use it isn’t clearly documented. We should provide a canonical guide for developing, debugging, testing, and building MFEs that, ideally, would allow someone to do all those things without asking for the help of someone experienced with MFEs. It would be great if this is also the guide that we use for MFE development internally so that it stays up-to-date.
It is posible
It is
MFEs that are part of Open edX releases should have change logs.
Development environment
Deployment
Will this affect edX.org developers?
...
Furthermore, the developing-multiple-MFEs-at-once problem is just as much of an issue for edX.org devs as it is for Open edX community devs, so solving that is a win for everyone.
Prior Art
TODO: Flesh this out
Regis’ Open edX Micromanager: http://github.com/overhangio/openedx-micromanager
Work-in-progress frontend-dist tool for edX MFEs that I started: https://github.com/kdmccormick/frontend-dist
David Joy’s code: ???
Plan
TBD