Skip to content

Conversation

@kdmccormick
Copy link
Member

@kdmccormick kdmccormick commented Jun 6, 2025

(based on Anas's work: #36602)

Description

This adds a migration to turn on the new React-based Markdown editing option
for newly-created ProblemBlocks for all authors. The option is nested
under "Advanced settings", just like the Advanced (OLX) problem editor.

The migration is written such that it will not overwrite an existing global "No" waffle flag. Furthermore, our waffle utilities are designed such that org-level and course-level overrides will still take preference over the flag that the migration creates. Therefore, this should only take effect in cases where no existing waffle flag applies.

BREAKING CHANGE: Operators who do not want the new React-based Markdown editor to be shown should create a flag contentstore.use_react_markdown_editor with the value "No".

Testing information

Create a "No" entry for contentstore.use_react_markdown_editor.

Run migrations. Confirm that the "No" entry still exists.

Delete that "No" entry:

Delete the record of this PR's migration from the django_migrations table.

tutor dev do sqlshell
> use openedx;
> delete from django_migrations where name = '0011_enable_markdown_editor_flag_by_default';

Run migrations again.

Follow the steps on openedx/frontend-app-authoring#1805, but notice that the waffle flag already exists.

Supporting information

Slack thread where we decided to turn this on in Teak: https://axim-collaborative.slack.com/archives/C058TVC79MF/p1749140304975279

Implementation and screenshots: openedx/frontend-app-authoring#1805

Part of: openedx/platform-roadmap#384

Prior art for turning on Waffle flags like this: https://github.com/openedx/edx-platform/blob/master/lms/djangoapps/grades/migrations/0018_add_waffle_flag_defaults.py

Other Information

This is all @Anas12091101 's work : ce4fa2c

Teak backport: #36876

@kdmccormick kdmccormick added the create-sandbox A test sandbox will be created for this PR, using the `open-craft/pr-sandbox-automation` tool label Jun 6, 2025
@kdmccormick kdmccormick changed the title feat: enable authoring MFE markdown editor waffle for everyone by default feat!: enable authoring MFE markdown editor waffle for everyone by default Jun 6, 2025
@kdmccormick kdmccormick requested a review from feanil June 6, 2025 20:16
@open-craft-grove
Copy link

Sandbox deployment successful 🚀
🎓 LMS
📝 Studio
ℹ️ Grove Config, Tutor Config, Tutor Requirements

…fault

This adds a migration to turn on the new React-based Markdown editing option
for newly-created ProblemBlocks for all authors. The option is nested
under "Advanced settings", just like the Advanced (OLX) problem editor.

The migration is written such that it will *not* overwrite an existing global
"No" waffle flag. Furthermore, our waffle utilities are designed such that
org-level and course-level overrides will still take preference over the flag
that the migration creates. Therefore, this should only take effect in cases
where no existing waffle flag applies.

BREAKING CHANGE: Operators who do not want the new React-based Markdown editor
to be shown should create a flag contentstore.use_react_markdown_editor with
the value "No".

We plan to backport this to Teak.
Prior art for flipping waffles like this: 9b00243
Part of: openedx/platform-roadmap#384
Co-authored-by: Muhammad Anas <muhammad.anas@arbisoft.com>
@kdmccormick kdmccormick merged commit 29c1268 into openedx:master Jun 9, 2025
49 checks passed
@kdmccormick kdmccormick deleted the kdmccormick/react-editor-on-default branch June 9, 2025 14:58
@open-craft-grove
Copy link

Sandbox deployment failed 💥
Please check the settings and requirements.
Retry deployment by pushing a new commit or updating the requirements/settings in the pull request's description.
📜 Failure Logs
ℹ️ Grove Config, Tutor Config, Tutor Requirements

@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been rolled back from the edX production environment.

@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

marlonkeating pushed a commit that referenced this pull request Jul 15, 2025
…fault (#36872)

This adds a migration to turn on the new React-based Markdown editing option
for newly-created ProblemBlocks for all authors. The option is nested
under "Advanced settings", just like the Advanced (OLX) problem editor.

The migration is written such that it will *not* overwrite an existing global
"No" waffle flag. Furthermore, our waffle utilities are designed such that
org-level and course-level overrides will still take preference over the flag
that the migration creates. Therefore, this should only take effect in cases
where no existing waffle flag applies.

BREAKING CHANGE: Operators who do not want the new React-based Markdown editor
to be shown should create a flag contentstore.use_react_markdown_editor with
the value "No".

We plan to backport this to Teak.
Prior art for flipping waffles like this: 9b00243
Part of: openedx/platform-roadmap#384

Co-authored-by: Muhammad Anas <muhammad.anas@arbisoft.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

create-sandbox A test sandbox will be created for this PR, using the `open-craft/pr-sandbox-automation` tool

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants