openedx/credentials

[DEPR]: Program Record UI

hurtstotouchfire opened this issue · 5 comments

Proposal Date

19 aug 2022

Ticket Acceptance Date

25 sept 2022

Technology Removal Date

30 Jan 2023 (date subject to change but will be after Olive cutoff)

First Open edX Named Release Without This Functionality

Palm (Spring 2023)

Rationale

The Credentials front end uses an outdated approach to React JS usage, and still uses django templating.

Removal

Entire front end: https://github.com/openedx/credentials/tree/master/credentials/templates

Replacement

We are replacing the UI with an MFE: https://github.com/edx/frontend-app-learner-record/

Core functionality will be 1:1. Exceptions include:

  • Credit pathway requests UI will be updated to support data model changes discussed in the following ADR: #1695
  • Masquerading will be replaced with a support tool.

Deprecation

No response

Migration

No response

Additional Info

No response

This frontned-app-learner-record MFE hasn't been included in an open release yet. I'm concerned about removing a feature in the same release that the MFE appears for the first time, i.e. olive.

But, that said, I'm not sure that the program-record UI has been supported in any prior open edX releases.

@pdpinch yes, that's understandable, but the impression that I've gotten is that swapping them in one release should be possible and generally fails due to oversights -- and I'd love to pin down what those all are. It sounds like it's largely related to pain around configuration defaults?

Sorry for the delayed response. BTR has an issue for documenting the requirements, openedx/wg-build-test-release#131 but it doesn't seem complete yet.

Off the top of my head, some of the hold-ups have been:

  • documentation for setup and configuration
  • support for translations
  • ability to deploy to a relative path, instead of to a separate named host (e.g. edx.org/learn instead of learn.edx.org)
  • lingering edX references

@arbrandes Are all DEPRs epics? If so that would save me having a dedicated view for them on https://github.com/orgs/openedx/projects/23/

@hurtstotouchfire, I tagged this one with epic for the benefit of the Frontend Development board, which has a dedicated view for issues labelled as such.

I'm of the opinion that, yes, any DEPR issue is by nature an epic, but I don't know if the DEPR working group feels the same way. Or even if they use the concept of epic at all. (I don't go to their meetings because it conflicts with the Contributors one, unfortunately.)