-
Notifications
You must be signed in to change notification settings - Fork 4k
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
base: master
Are you sure you want to change the base?
feat: enable authoring MFE markdown editor waffle flag for everyone by default #36602
Conversation
Thanks for the pull request, @Anas12091101! This repository is currently maintained by 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 approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo 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:
🔘 Get a green buildIf 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:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
8b009e3
to
6b61352
Compare
@kdmccormick Could you please take a look at this PR when you get a chance? |
There was a problem hiding this 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?
@@ -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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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 |
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
# .. toggle_use_cases: opt_in | |
# .. toggle_use_cases: opt_out |
74135fa
to
adfdcca
Compare
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 |
adfdcca
to
3b9ed02
Compare
@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? |
Description
This PR replaces the
contentstore.use_react_markdown_editor
flag withcontentstore.disable_react_markdown_editor
to enable the Markdown editor by default for all courses. The editor will now be disabled only if thecontentstore.disable_react_markdown_editor
flag is explicitly turned on.Useful information to include:
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.
http://{LMS_BASE_URL}/api/contentstore/v1/course_waffle_flags/{course_id}
in your browser and confirm that theuse_react_markdown_editor
value isTrue
.contentstore.disable_react_markdown_editor
for a course and Force On` the override choice.http://{LMS_BASE_URL}/api/contentstore/v1/course_waffle_flags/{course_id}
in your browser and confirm that the flag’s value isFalse
.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.