-
Notifications
You must be signed in to change notification settings - Fork 4.2k
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
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. DetailsWhere 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? |
kdmccormick
left a comment
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?
cms/djangoapps/contentstore/rest_api/v1/serializers/course_waffle_flags.py
Outdated
Show resolved
Hide resolved
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? |
3b9ed02 to
94bbb43
Compare
kdmccormick
left a comment
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.
An update on this... using the same approach as this PR, we flipped the Studio MFE waffle flags to by on by-default back in April, and actually regretted taking approach. It ended up being a lot of work for us developers, and a lot of work for operators who wanted to continue temporarily disabling the flags. 2U ended up having to update 100+ flags in their database, and I fear that other operators will have to do the same. Furthermore, due to how Waffle works, the change removed the ability for the MFE pages to be released to certain set of beta users.
We discussed this in Maintenance Working Group and decided that your original approach @Anas12091101 (the one where you use a migration to turn the flags on) is superior, and that we'd like to try using that approach going forward for turning on waffle flags by default.
I'm still not sure if we are merging this PR for Teak or for Ulmo, but in either case, could you revert back to the original migration-based approach you had? Thanks, and sorry for the extra work!
|
OK, we have consensus that we should turn this on by default in Teak! Thanks for your patience @Anas12091101 . Would you be able to update the PR based on my latest feedback, and then once we merge this, open a backport against |
|
Just due to the tight timeline, I'm recreating Anas's first commit in a new PR over here: #36872 |
Description
This PR replaces the
contentstore.use_react_markdown_editorflag withcontentstore.disable_react_markdown_editorto enable the Markdown editor by default for all courses. The editor will now be disabled only if thecontentstore.disable_react_markdown_editorflag 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://{CMS_BASE_URL}/api/contentstore/v1/course_waffle_flags/{course_id}in your browser and confirm that theuse_react_markdown_editorvalue isTrue.contentstore.disable_react_markdown_editorfor 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.