Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Find out which MFEs should be in Olive #494

Closed
2 tasks done
arbrandes opened this issue Oct 13, 2022 · 9 comments
Closed
2 tasks done

Find out which MFEs should be in Olive #494

arbrandes opened this issue Oct 13, 2022 · 9 comments
Assignees
@arbrandes @jmakowski1123
Milestone
Olive.1

Comments

@arbrandes
Copy link
Contributor

arbrandes commented Oct 13, 2022 •
edited
Loading

Investigate which MFEs should be included in Olive, from a product perspective with a technical feasibility in mind.

The BTR is tracking this question here:
@arbrandes arbrandes self-assigned this Oct 13, 2022
@arbrandes arbrandes moved this to Needs refinement in Frontend Working Group Oct 13, 2022
@arbrandes arbrandes added this to the Olive Release Candidate milestone Oct 17, 2022
@arbrandes arbrandes moved this to To Do - Backlog in Axim Engineering Tasks Oct 17, 2022
@arbrandes arbrandes moved this from To Do - Backlog to To Do - Prioritized for Current Sprint in Axim Engineering Tasks Oct 17, 2022
@arbrandes arbrandes moved this to To Do - Backlog in Axim Engineering Tasks Oct 17, 2022
@arbrandes arbrandes moved this from To Do - Backlog to To Do - Prioritized for Current Sprint in Axim Engineering Tasks Oct 17, 2022
@arbrandes arbrandes moved this from Needs refinement to In progress in Frontend Working Group Oct 25, 2022
@arbrandes arbrandes moved this from To Do - Prioritized for Current Sprint to In Progress in Axim Engineering Tasks Oct 25, 2022
@arbrandes
Copy link
Contributor Author

@jmakowski1123, FYI. (Copy-pasta from this)

The following MFEs have at least one champion in the BTR group for inclusion/enablement by default in the tutor-mfe plugin for Olive, so will be prioritized in testing:

  • frontend-app-course-authoring
  • frontend-app-ora-grading

The following has an open PR for inclusion and no objections were raised, so it will be tested:

  • frontend-app-learner-record

The following met no objections to "optional enablement", where there will be instruction in the Release Notes on how to get them running with Tutor, but they won't actually be part of the tutor-mfe plugin this release:

  • frontend-app-authn
  • frontend-app-support-tools

Last but not least, the group thinks frontend-app-discussions will likely not meet requirements in time, but a suggestion was made to make it its own plugin. The question was raised: are the authors of frontend-app-discussions willing to create and maintain such a plugin?

@arbrandes
Copy link
Contributor Author

Looks like we want authn, too. So as of now, the list to aim for is:

  • frontend-app-course-authoring
  • frontend-app-ora-grading
  • frontend-app-learner-record
  • frontend-app-authn

@arbrandes arbrandes moved this from In progress to Refined in Frontend Working Group Oct 31, 2022
@arbrandes arbrandes moved this from In Progress to To Do - Prioritized for Current Sprint in Axim Engineering Tasks Oct 31, 2022
@arbrandes arbrandes moved this from To Do - Prioritized for Current Sprint to In Progress in Axim Engineering Tasks Nov 3, 2022
@arbrandes arbrandes mentioned this issue Nov 6, 2022
Merged
@arbrandes
Copy link
Contributor Author

arbrandes commented Nov 6, 2022 •
edited
Loading

frontend-app-course-authoring

  • Minimal documentation: not present, but I submitted a PR to fix it.
  • Production readiness: In production at 2U.
  • i18n: Matches currently supported MFEs.
  • l10n: Matches currently supported MFEs.
  • a11y: Uses paragon extensively.
  • Customizable header: not yet, but no learner-facing pages are exposed. Likely not a concern.
  • Customizable footer: uses frontend-component-footer.
  • Branding module: imports brand-openedx and uses paragon variables
  • Branding friendly: no in-line explicit styles were found
  • tutor-mfe plugin: none yet
  • Runtime configuration: not implemented
  • Deprecation: no legacy feature that this replaces is being removed in this release
  • Dependencies: it depends on edx-exams for one feature, and frontend-app-discussions for another, neither of which are not included in Tutor at this time.

Other considerations:

The new XBlock editors feature depends (heavily) on a component that lives in the edx org (https://github.com/edx/frontend-lib-content-components/). Reportedly, however, the intention is to move it to openedx as capacity allows.

@arbrandes
Copy link
Contributor Author

arbrandes commented Nov 6, 2022 •
edited
Loading

frontend-app-discussions

  • Minimal documentation: not present. The README needs work.
  • Production readiness: not in production anywhere.
  • i18n: Better than most currently supported MFEs.
  • l10n: Matches currently supported MFEs.
  • a11y: Uses paragon extensively.
  • Customizable header: uses frontend-component-header.
  • Customizable footer: uses frontend-component-footer.
  • Branding module: imports brand-openedx and uses paragon variables
  • Branding friendly: no in-line explicit styles were found, but there are hard-coded overrides in index.scss
  • tutor-mfe plugin: none yet
  • Runtime configuration: not implemented
  • Deprecation: no legacy feature that this replaces is being removed in this release
  • Dependencies: It depends on frontend-app-course-authoring for configuration, and it is not not included in Tutor at this time.

Other considerations:

  • It is reported that several bugs were found in production at 2U, and thus the MFE was pulled until they were fixed. The target date for said fixes was set to "early November".
  • This still uses the old Ruby cs_comments_service and the accompanying paraphernalia in edx-platform. There is no replacement for that (yet?).

@arbrandes
Copy link
Contributor Author

frontend-app-ora-grading

  • Minimal documentation: present. (There's even a manual.)
  • Production readiness: in production at 2U.
  • i18n: Matches currently supported MFEs.
  • l10n: Matches currently supported MFEs.
  • a11y: Uses paragon extensively.
  • Customizable header: uses frontend-component-header.
  • Customizable footer: uses frontend-component-footer.
  • Branding module: imports brand-openedx and uses paragon variables
  • Branding friendly: no in-line explicit styles were found
  • tutor-mfe plugin: none yet
  • Runtime configuration: not implemented
  • Deprecation: no legacy feature that this replaces is being removed in this release
  • Dependencies: no external ones.

@arbrandes
Copy link
Contributor Author

arbrandes commented Nov 6, 2022 •
edited
Loading

frontend-app-learner-record

  • Minimal documentation: present.
  • Production readiness: in production at 2U.
  • i18n: Matches currently supported MFEs.
  • l10n: Only localized into Spanish.
  • a11y: Uses paragon extensively.
  • Customizable header: uses frontend-component-header.
  • Customizable footer: uses frontend-component-footer.
  • Branding module: imports brand-openedx and uses paragon variables
  • Branding friendly: no in-line explicit styles were found
  • tutor-mfe plugin: not merged yet, but there's a PR.
  • Runtime configuration: not merged yet, but there's a PR.
  • Deprecation: no legacy feature that this replaces is being removed in this release
  • Dependencies: credentials, not currently a part of Tutor. There's a credentials plugin, but at this time it's not clear how well maintained and up to date it is, including if it will be upgrade for Olive.

@arbrandes
Copy link
Contributor Author

frontend-app-authn

  • Minimal documentation: not present.
  • Production readiness: reportedly in production at 2U.
  • i18n: Matches currently supported MFEs.
  • l10n: Matches currently supported MFEs.
  • a11y: Uses paragon extensively.
  • N/A: Customizable header: doesn't have a header
  • N/A: Customizable footer: doesn't have a footer
  • Branding module: imports brand-openedx and uses paragon variables
  • Branding friendly: uses in-line styles such as large-yellow-line
  • tutor-mfe plugin: none yet
  • Runtime configuration: not merged yet, but there's a PR.
  • Deprecation: no legacy feature that this replaces is being removed in this release
  • Dependencies: no external ones.

This was referenced Nov 6, 2022
Closed
Closed
@arbrandes
Copy link
Contributor Author

The above findings were documented as a matrix here:

https://openedx.atlassian.net/wiki/spaces/COMM/pages/3571056752/Olive+MFE+Candidate+Requirements+Matrix

What's missing now is a decision by BTR on how to proceed, as none of them passed the bar fully. Hopefully we'll have one by tomorrow.

@arbrandes arbrandes moved this from Refined to In review in Frontend Working Group Nov 7, 2022
@arbrandes
Copy link
Contributor Author

See openedx/wg-build-test-release#200 (comment) for the conclusion.

Repository owner moved this from In Progress to Done in Axim Engineering Tasks Nov 8, 2022
Repository owner moved this from In review to In progress in Frontend Working Group Nov 8, 2022
@arbrandes arbrandes moved this from In progress to Closed in Frontend Working Group Nov 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@arbrandes arbrandes

@jmakowski1123 jmakowski1123

Labels
None yet
Projects
Frontend Working Group
Status: Closed
Milestone
Olive.1
Development

No branches or pull requests
2 participants
@arbrandes @jmakowski1123