-
Notifications
You must be signed in to change notification settings - Fork 91
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: add learner record MFE to plugin #63
feat: add learner record MFE to plugin #63
Conversation
I don't think that we should merge this in master right now, as it would be a huge change to the Nutmeg release. Maybe we can merge to nightly instead? Also, could you please add some docs about the learner records MFE to the README? Other MFEs have some screenshots and explanations. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Aren't we supposed to make changes to the LMS/CMS learner records configuration in order to point them to the MFE container?
"env": { | ||
"production": { | ||
"SUPPORT_URL_LEARNER_RECORDS":"", | ||
"USE_LR_MFE": "", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is there a good reason why these settings do not have these values as default upstream?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the first settings currently only has an edX-specific default, and the second one is for a feature that currently unsupported in tutor. Would it be a better idea to just leave them out? the MFE still operates if they are not present.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the first settings currently only has an edX-specific default
Can we change the upstream default such that it works out of the box for everyone instead of just edX?
Would it be a better idea to just leave them out?
Not if they are needed for some features, no.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
FTR, it was decided in a BTR meeting that instead of adding the learner-records MFE to Tutor (and thus enabling it by default for everyone) there would be instructions on how to enable it, either here in the tutor-mfe README, or in the learner-records MFE README.
I'm fine with the nightly release. When I have a moment I will change the target and address feedback, thanks for taking a look at this! |
@regisb Is there not a stable Nutmeg release? From an Open edX release perspective this shouldn't go into Nutmeg as it's being added for Olive, so we should PR against whatever is appropriate for Olive and going forward. As far as docs, we're working with Jenna to collect some context about the new MFE here: openedx/frontend-app-learner-record#107 |
There is! The Nutmeg releases are built off the master branch. Changes that affect meant for future releases (including Olive) should go to the nightly branch. See this section of the docs for more information: https://docs.tutor.overhang.io/tutorials/nightly.html |
We would like to close this PR and follow up instead with instructions in the LRMFE README for how to configure the MFE with Tutor. |
Adds the learner record MFE to
tutor-mfe
to use in place of the old UI in credentials, as we are planning on deprecating soon.