feat: add markdown editor waffle flag #36512

Anas12091101 · 2025-04-10T16:43:35Z

Description

This PR adds contentstore.use_react_markdown_editor course waffle flag in cms. This flag helps in enabling the markdown editor in the authoring mfe.

This PR also adds the markdown_edited field in the Problem Xblock to persist the user's choice of switching to the markdown editor on the authoring MFE.

More details in the authoring MFE PR: openedx/frontend-app-authoring#1805

Useful information to include:

Which edX user roles will this change impact? "Course Author"
Include screenshots for changes to the UI (ideally, both "before" and "after" screenshots, if applicable).
Provide links to the description of corresponding configuration changes. Remember to correctly annotate these
changes.

Supporting information

Link to other information about the change, such as Jira issues, GitHub issues, or Discourse discussions.
Be sure to check they are publicly readable, or if not, repeat the information here.

https://openedx.atlassian.net/wiki/spaces/OEPM/pages/4517232656/Re-enable+Markdown+editing+of+CAPA+problems+to+meet+various+use+cases

https://github.com/mitodl/hq/issues/6812

Testing instructions

Please follow the instructions in the authoring PR:

Deadline

Before Teak's cut.

Other information

Include anything else that will help reviewers and consumers understand the change.

Does this change depend on other changes elsewhere? Yes, on feat: added markdown editor for editing problems in markdown format frontend-app-authoring#1805

openedx-webhooks · 2025-04-10T16:43:39Z

Thanks for the pull request, @Anas12091101!

This repository is currently maintained by @openedx/wg-maintenance-edx-platform.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
- This process (including the steps you'll need to take) is documented here.
If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

Dependencies

This PR must be merged before / after / at the same time as ...
Blockers

This PR is waiting for OEP-1234 to be accepted.
Timeline information

This PR must be merged by XX date because ...
Partner information

This is for a course on edx.org.
Supporting documentation
Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

The size and impact of the changes that it introduces
The need for product review
Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

kdmccormick

Glad to see this coming along!

kdmccormick · 2025-04-10T16:56:42Z

cms/djangoapps/contentstore/toggles.py

+# .. toggle_name: contentstore.new_studio_mfe.use_markdown_editor
+# .. toggle_implementation: CourseWaffleFlag
+# .. toggle_default: False
+# .. toggle_description: This flag enables the use of the Markdown editor when creating or editing problems.


Since markdown editing is always enabled for the legacy problem editor, please clarify that this enables markdown specifically in the new Authoring MFE editor

kdmccormick · 2025-04-10T16:58:36Z

cms/djangoapps/contentstore/toggles.py

    """
    return ENABLE_NEW_STUDIO_CUSTOM_PAGES.is_enabled(course_key)

+# .. toggle_name: contentstore.new_studio_mfe.use_markdown_editor


We are in the process of retiring the new_studio_mfe namespace as part of the legacy studio frontend DEPR. Could you name this contentstore.react_markdown_editor instead?

kdmccormick · 2025-04-10T16:59:16Z

cms/djangoapps/contentstore/toggles.py

+# .. toggle_target_removal_date: 2025-8-31
+# .. toggle_tickets: https://openedx.atlassian.net/wiki/spaces/OEPM/pages/4517232656/Re-enable+Markdown+editing+of+CAPA+problems+to+meet+various+use+cases
+# .. toggle_warning:
+ENABLE_MARKDOWN_EDITOR = CourseWaffleFlag(


Suggestion to clarify that this is specifically for the React problem editor

Suggested change

ENABLE_MARKDOWN_EDITOR = CourseWaffleFlag(

ENABLE_REACT_MARKDOWN_EDITOR = CourseWaffleFlag(

kdmccormick

Please apply these changes, but otherwise this look good to merge 👍🏻

kdmccormick · 2025-04-11T15:09:01Z

cms/djangoapps/contentstore/rest_api/v1/serializers/course_waffle_flags.py

    use_new_textbooks_page = serializers.SerializerMethodField()
    use_new_group_configurations_page = serializers.SerializerMethodField()
    enable_course_optimizer = serializers.SerializerMethodField()
+    react_markdown_editor = serializers.SerializerMethodField()


Suggested change

react_markdown_editor = serializers.SerializerMethodField()

use_react_markdown_editor = serializers.SerializerMethodField()

to clarify that this is a boolean, and for consistency with the other flags in this serializer

kdmccormick · 2025-04-11T15:09:43Z

cms/djangoapps/contentstore/toggles.py

+# .. toggle_use_cases: temporary
+# .. toggle_creation_date: 2025-4-10
+# .. toggle_target_removal_date: 2025-8-31


Suggested change

# .. toggle_use_cases: temporary

# .. toggle_creation_date: 2025-4-10

# .. toggle_target_removal_date: 2025-8-31

# .. toggle_use_cases: open_edx

# .. toggle_creation_date: 2025-4-10

We might need this toggle forever, so let's not write that it's temporary

kdmccormick · 2025-04-11T15:10:43Z

cms/djangoapps/contentstore/toggles.py

+    f'{CONTENTSTORE_NAMESPACE}.react_markdown_editor', __name__)
+
+
+def react_markdown_editor(course_key):


Suggested change

def react_markdown_editor(course_key):

def use_react_markdown_editor(course_key):

for consistency with the other functions in this file

kdmccormick · 2025-04-11T15:12:09Z

cms/djangoapps/contentstore/rest_api/v1/views/tests/test_course_waffle_flags.py

        expected_response["use_new_home_page"] = False

        response = self.client.get(course_url)
+        print(expected_response, response.data)


Suggested change

print(expected_response, response.data)

kdmccormick · 2025-04-11T15:34:00Z

cms/djangoapps/contentstore/toggles.py

+# .. toggle_name: contentstore.use_react_markdown_editor
+# .. toggle_implementation: CourseWaffleFlag
+# .. toggle_default: False
+# .. toggle_description: This flag enables the use of the Markdown editor when creating or editing problems in the authoring MFE
+# .. toggle_tickets: https://openedx.atlassian.net/wiki/spaces/OEPM/pages/4517232656/Re-enable+Markdown+editing+of+CAPA+problems+to+meet+various+use+cases
+# .. toggle_warning:


Suggested change

# .. toggle_name: contentstore.use_react_markdown_editor

# .. toggle_implementation: CourseWaffleFlag

# .. toggle_default: False

# .. toggle_description: This flag enables the use of the Markdown editor when creating or editing problems in the authoring MFE

# .. toggle_tickets: https://openedx.atlassian.net/wiki/spaces/OEPM/pages/4517232656/Re-enable+Markdown+editing+of+CAPA+problems+to+meet+various+use+cases

# .. toggle_warning:

# .. toggle_name: contentstore.use_react_markdown_editor

# .. toggle_implementation: CourseWaffleFlag

# .. toggle_default: False

# .. toggles_use_cases: opt_in

# .. toggle_description: This flag enables the use of the Markdown editor when creating or editing problems in the authoring MFE

# .. toggle_tickets: https://openedx.atlassian.net/wiki/spaces/OEPM/pages/4517232656/Re-enable+Markdown+editing+of+CAPA+problems+to+meet+various+use+cases

you will still need to declare a use case @Anas12091101 . I think "opt_in" is appropriate here.

kdmccormick

Looks good. Please fix the PR description.

Do you need me to merge this or are you working with another edx-platform core contributor who can merge it?

Anas12091101 · 2025-04-11T16:55:08Z

Thanks for the quick review, @kdmccormick! It would be great if you could merge it. I’m not currently coordinating with another core contributor for this one.

edx-pipeline-bot · 2025-04-15T17:11:35Z

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

edx-pipeline-bot · 2025-04-15T17:36:06Z

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

edx-pipeline-bot · 2025-04-15T17:58:47Z

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

edx-pipeline-bot · 2025-04-15T18:47:14Z

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

edx-pipeline-bot · 2025-04-15T19:00:55Z

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

edx-pipeline-bot · 2025-04-15T19:25:09Z

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

edx-pipeline-bot · 2025-04-15T19:25:09Z

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

This PR adds contentstore.use_react_markdown_editor course waffle flag in cms. This flag helps in enabling the markdown editor in the authoring mfe. This PR also adds the markdown_edited field in the Problem Xblock to persist the user's choice of switching to the markdown editor on the authoring MFE. More details in the authoring MFE PR: openedx/frontend-app-authoring#1805

openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Apr 10, 2025

openedx-webhooks added this to Contributions Apr 10, 2025

github-project-automation bot moved this to Needs Triage in Contributions Apr 10, 2025

Anas12091101 mentioned this pull request Apr 10, 2025

feat: added markdown editor for editing problems in markdown format openedx/frontend-app-authoring#1805

Merged

Anas12091101 marked this pull request as draft April 10, 2025 16:44

kdmccormick reviewed Apr 10, 2025

View reviewed changes

Anas12091101 marked this pull request as ready for review April 11, 2025 01:38

Anas12091101 requested a review from kdmccormick April 11, 2025 13:48

kdmccormick approved these changes Apr 11, 2025

View reviewed changes

Anas12091101 added 6 commits April 11, 2025 20:27

feat: add markdown editor waffle flag

b565c18

fix: remove print statements

f100889

fix: updated name of waffle flag

78cbf27

fix: test

25c1272

fix: test

ad8a965

fix: issues

930dcb7

Anas12091101 force-pushed the anas/add-markdown-waffle-flag branch from 1c491b8 to 930dcb7 Compare April 11, 2025 15:28

kdmccormick reviewed Apr 11, 2025

View reviewed changes

fix: issues

88f0a1e

Anas12091101 requested a review from kdmccormick April 11, 2025 15:41

fix: pylint

5bc5503

kdmccormick approved these changes Apr 11, 2025

View reviewed changes

mphilbrick211 moved this from Needs Triage to Ready for Review in Contributions Apr 14, 2025

mphilbrick211 requested a review from kdmccormick April 14, 2025 21:33

mphilbrick211 moved this from Ready for Review to Ready to Merge in Contributions Apr 14, 2025

kdmccormick merged commit 2930214 into openedx:master Apr 15, 2025
49 checks passed

github-project-automation bot moved this from Ready to Merge to Done in Contributions Apr 15, 2025

ormsbee mentioned this pull request Apr 23, 2025

Remove py2neo dependency #36586

Merged

Anas12091101 mentioned this pull request Apr 25, 2025

feat: enable authoring MFE markdown editor waffle flag for everyone by default #36602

Closed

	ENABLE_MARKDOWN_EDITOR = CourseWaffleFlag(
	ENABLE_REACT_MARKDOWN_EDITOR = CourseWaffleFlag(

	react_markdown_editor = serializers.SerializerMethodField()
	use_react_markdown_editor = serializers.SerializerMethodField()

		f'{CONTENTSTORE_NAMESPACE}.react_markdown_editor', __name__)


		def react_markdown_editor(course_key):

	def react_markdown_editor(course_key):
	def use_react_markdown_editor(course_key):

feat: add markdown editor waffle flag #36512

feat: add markdown editor waffle flag #36512

Uh oh!

Conversation

Anas12091101 commented Apr 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Supporting information

Testing instructions

Deadline

Other information

Uh oh!

openedx-webhooks commented Apr 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kdmccormick left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kdmccormick left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kdmccormick left a comment

Choose a reason for hiding this comment

Uh oh!

Anas12091101 commented Apr 11, 2025

Uh oh!

Uh oh!

edx-pipeline-bot commented Apr 15, 2025

Uh oh!

edx-pipeline-bot commented Apr 15, 2025

Uh oh!

edx-pipeline-bot commented Apr 15, 2025

Uh oh!

edx-pipeline-bot commented Apr 15, 2025

Uh oh!

edx-pipeline-bot commented Apr 15, 2025

Uh oh!

edx-pipeline-bot commented Apr 15, 2025

Uh oh!

edx-pipeline-bot commented Apr 15, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Anas12091101 commented Apr 10, 2025 •

edited

Loading

openedx-webhooks commented Apr 10, 2025 •

edited

Loading