Skip to content

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

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.

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

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

Anas12091101
Copy link
Contributor

@Anas12091101 Anas12091101 commented Apr 25, 2025

Description

This PR replaces the contentstore.use_react_markdown_editor flag with contentstore.disable_react_markdown_editor to enable the Markdown editor by default for all courses. The editor will now be disabled only if the contentstore.disable_react_markdown_editor flag is explicitly turned on.

Useful information to include:

  • Which edX user roles will this change impact? Common user roles are "Course Author" & "Developer"
  • 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.

Relevant PRs: #36512, openedx/frontend-app-authoring#1805

Testing instructions

Please provide detailed step-by-step instructions for testing this change.

  • Visit http://{LMS_BASE_URL}/api/contentstore/v1/course_waffle_flags/{course_id} in your browser and confirm that the use_react_markdown_editor value is True.
  • Add a Waffle Flag Course Override for flag contentstore.disable_react_markdown_editor for a course and Force On` the override choice.
  • Visit http://{LMS_BASE_URL}/api/contentstore/v1/course_waffle_flags/{course_id} in your browser and confirm that the flag’s value is False.

Deadline

"None" if there's no rush, or provide a specific date or event (and reason) if there is one.

Other information

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

  • Does this change depend on other changes elsewhere?
  • Any special concerns or limitations? For example: deprecations, migrations, security, or accessibility.
  • If your database migration can't be rolled back easily.

@openedx-webhooks
Copy link

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.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Apr 25, 2025
@github-project-automation github-project-automation bot moved this to Needs Triage in Contributions Apr 25, 2025
@Anas12091101 Anas12091101 force-pushed the anas/default-enable-markdown-editor-flag branch from 8b009e3 to 6b61352 Compare April 25, 2025 10:14
@Anas12091101
Copy link
Contributor Author

Anas12091101 commented Apr 25, 2025

@kdmccormick Could you please take a look at this PR when you get a chance?

@kdmccormick kdmccormick self-requested a review April 25, 2025 17:18
@mphilbrick211 mphilbrick211 moved this from Needs Triage to Ready for Review in Contributions Apr 28, 2025
Copy link
Member

@kdmccormick kdmccormick left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple minor code comments, looks good otherwise.

However, I am hesitant to release the Markdown editor as default-on without having performed acceptance testing yet. Could we wait until some initial testing is performed, and then make a judgement call about when to merge this PR?

FYI @pdpinch @jmakowski1123

@@ -156,7 +156,7 @@ def get_enable_course_optimizer(self, obj):

def get_use_react_markdown_editor(self, obj):
"""
Method to get the use_react_markdown_editor waffle flag
Method to get the use_react_markdown_editor switch
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Method to get the use_react_markdown_editor switch
Determine whether the new markdown editor should be enabled in the react problem editor

Suggested rewording, which avoid referencing the outdated markdown editor switch

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why remove these details?

when creating or editing problems

The markdown editor is only for problems and I think that we should make the docs clear about this.

# .. 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_description: This flag disables the Markdown editor in the authoring MFE
# .. toggle_use_cases: opt_in
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# .. toggle_use_cases: opt_in
# .. toggle_use_cases: opt_out

@kdmccormick kdmccormick moved this from Ready for Review to Blocked in Contributions Apr 28, 2025
@Anas12091101 Anas12091101 force-pushed the anas/default-enable-markdown-editor-flag branch from 74135fa to adfdcca Compare April 29, 2025 07:07
@kdmccormick kdmccormick removed their request for review April 29, 2025 14:35
@pdpinch
Copy link
Contributor

pdpinch commented May 2, 2025

I think this is ready to be merged after a rebase. @kdmccormick let me know if you disagree.

@Anas12091101 I think we'd like a backport to the realease/teak.master branch as well.

@Anas12091101 Anas12091101 force-pushed the anas/default-enable-markdown-editor-flag branch from adfdcca to 3b9ed02 Compare May 9, 2025 09:55
@pdpinch
Copy link
Contributor

pdpinch commented May 12, 2025

@Anas12091101 can you rebase this?

@kdmccormick do you feel this is blocked by openedx/frontend-app-authoring#1920 or can we consider that an enhancement?

@mphilbrick211 mphilbrick211 moved this from Blocked to In Eng Review in Contributions May 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
open-source-contribution PR author is not from Axim or 2U
Projects
Status: In Eng Review
Development

Successfully merging this pull request may close these issues.

4 participants