[DEPR]: Legacy Problem Editor

kdmccormick commented 3 months ago

Proposal Date

2024-08-08

Target Ticket Acceptance Date

2025-09-01

Earliest Open edX Named Release Without This Functionality

Teak - 2025-04

Rationale

The legacy ProblemBlock (aka "CAPA") editor is based on outdated frontend technologies that do not integrate well with the new React-based Studio micro-frontend. There is a newer React-based editor that replaces it. Supporting both editors is a major burden for maintenance and feature development.

Removal

The old pop-up modal Problem editor will be removed.

[ NEED: SCREENSHOT ]

[ NEED: CODE LINKS ]

Replacement

The full-screen React-based Problem editor is the replacement.

[ NEED: SCREENSHOT ]

CODE: https://github.com/openedx/frontend-lib-content-components/

Deprecation

We will warn about the pending deprecation in the Sumac release notes.

Migration

TBD

Additional Info

There is a known feature delta between the old editor and the new one. This includes:

[ ] The default Markdown editing mode is removed and replaced with a default WSISWYG editing mode.
[ ] Multi-response problems, which supported in Markdown, are not supported in WSIWYG (they are still available in the advanced editing mode.
[ ] The Advanced (raw XML) editing mode is now nested under "Advanced Settings"
[ ] The editor takes up the full screen and cannot be minimized.
[ ] The editor cannot be opened in a new tab with right click.

[ NEED: SCREENSHOTS ]

Additional feedback on the new editor:

@Sidnani:

"Overall, it took someone between 2-10 times as long to build content in the new MFE editors vs. the Legacy editors. Building a basic assessment item, like a Multiple Choice Question, from content written elsewhere went from 30 seconds in Legacy to 3 minutes with the forms required in the MFE editor. Advanced Editors are also a couple of more clicks to access. Toggling back and forth between the Advanced and Basic editors required to preview and complete LaTeX content became more time consuming. (This is where we get into content taking 10 times or more to build.)"
[ NEED: Finish compiling feedback ]

Task List

TBD

kdmccormick commented 3 months ago

@pdpinch , here's a DEPR for the old Problem editor as we discussed. You mentioned that there were more Problem-specific editor concerns--let's collect those here.

SIdnani commented 2 months ago

Some more specific feedback I have gathered comparing the Legacy Problem Editor to the MFE Editors:

Ease of Copy-Paste: The Legacy Editor(Basic or Advanced) allowed you to copy-paste entire problems from text-editors outside the platform to build assessment items. As opposed to the MFE editor that requires you to copy-paste assessment items line by line into a form. A 10-item MCQ quiz with a standard 4 choices and solution and 2 hints goes from 10 copy-pastes actions from an external design doc to the Legacy Basic Editor and becomes 80 copy-paste actions with the addition of extra clicks to select the "correct" answer. This is a huge waste of time and will create errors.
The building everything as a form is only useful to folks as a learning aid, the first time they attempt something. After that, bulk building becomes the norm. Not one Instructional Designer or SME across all the institutions I have worked ever wrote content in the CMS of any LMS. So the forms required to build items makes them shy away from building online assessments.
Instructional Designers (IDs) often use a multi-step assessment items to hit one learning objective. These items have 1 submit button. For example: Putting an image, e.g. A Graph, with significant areas labeled a, b, c, etc., then 3 text-entry, or 3 numerical entry, or 3 drop-downs asking learners to identify, categorize, or compute values for each of those indicated areas. Sometimes IDs mix assessment types (Drop-downs, MCQ, Text-Entry, Numerical Entry) within one problem to hit different parts of the same learning objective and grade them as one whole.
The Legacy Editor allowed multi-assessment items to be generated at the WYSIWYG-level vs. the MFE Editor that forces you through the process of creating only one problem with the form editor for non-technical users then you need to end up in the advanced editor to be able to do anything else. Note: You are required at that point to know the weeds of the XML to get the same problem created.
Flexibility of formatting: Legacy Advanced Editor allowed you to implement and preview inline. This meant that you could compare your changes against other items in the Unit and re-format problems using HTML on the fly. You are not stuck with the default formatting available to an individual problem.
All of the standard usability changes that applied to Text components applies here as well. Things like location within the course, publication status, and advanced editors require more effort to access when the new MFE editor navigates folks away from their content on the Unit page.

kdmccormick commented 2 months ago

Thank you @SIdnani. Noted on all counts.

openedx / edx-platform