Skip to content

Backport fix: enable markdown editor in libraries #2098

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

Conversation

bradenmacdonald
Copy link
Contributor

@bradenmacdonald bradenmacdonald commented Jun 5, 2025

Description

The markdown problem editor wasn't available in libraries, but probably unintentionally.

Supporting information

Don't merge yet - there is a minor bug with this: #2099

Testing instructions

Create a new problem in a library. Switch to markdown editor.
Confirm that if the waffle flag is modified, the markdown option is no longer available.

Other information

@openedx-webhooks
Copy link

Thanks for the pull request, @bradenmacdonald!

This repository is currently maintained by @bradenmacdonald.

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 open-source-contribution PR author is not from Axim or 2U core contributor PR author is a Core Contributor (who may or may not have write access to this repo). labels Jun 5, 2025
@github-project-automation github-project-automation bot moved this to Needs Triage in Contributions Jun 5, 2025
@bradenmacdonald
Copy link
Contributor Author

FYI @Anas12091101 @kdmccormick

Copy link

codecov bot commented Jun 6, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (release/teak@fcdf1fd). Learn more about missing BASE report.

Additional details and impacted files
@@               Coverage Diff               @@
##             release/teak    #2098   +/-   ##
===============================================
  Coverage                ?   93.90%           
===============================================
  Files                   ?     1148           
  Lines                   ?    24039           
  Branches                ?     5082           
===============================================
  Hits                    ?    22573           
  Misses                  ?     1398           
  Partials                ?       68           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@bradenmacdonald
Copy link
Contributor Author

@kdmccormick Now that #2112 is merged and will presumably be backported soon, I'd like to merge this backport - would you mind reviewing?

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.

Just to make sure I'm clear -- this isn't a direct backport, but is rather a meant to achieve the same functionality as #2068 (comment) minus the refactoring? If so can you make note of that in the commit?

@kdmccormick kdmccormick added the create-sandbox open-craft-grove should create a sandbox environment from this PR label Jun 10, 2025
bradenmacdonald and others added 2 commits June 10, 2025 11:12
This fix is also achieved on master via 5991fd3 / openedx#2068 but this is a simpler fix, not a direct backport of that refactor.
Removes the unnecessary duplicate save  request of markdown_edited
value to the backend.

Part of: openedx#2099
Backports: 62589ae
@bradenmacdonald bradenmacdonald force-pushed the braden/teak-markdown-editor-libraries branch from b335195 to 21e4d6b Compare June 10, 2025 18:12
@bradenmacdonald
Copy link
Contributor Author

@kdmccormick Sure, I added that note to the commit and cherry-picked in the other fix from #2127

@kdmccormick
Copy link
Member

Great, I will let you know once I confirm these both on the PR sandbox.

@farhaanbukhsh , any objections to both this and #2127 being backported to Teak? It's just more bugfixes for the Switch-to-markdown option in the Problem editor.

@farhaanbukhsh
Copy link
Member

@kdmccormick nope, onwards and upwards for more bugfixes.

@bradenmacdonald
Copy link
Contributor Author

I don't see any sandbox here? I asked on Slack about it. I guess we're waiting on that unless someone can test manually.

@mphilbrick211 mphilbrick211 moved this from Needs Triage to In Eng Review in Contributions Jun 12, 2025
@open-craft-grove
Copy link

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

@bradenmacdonald
Copy link
Contributor Author

Tested creating markdown problems on the sandbox in a library and a course and everything is working well :)

@bradenmacdonald bradenmacdonald merged commit 1968d14 into openedx:release/teak Jun 12, 2025
7 checks passed
@github-project-automation github-project-automation bot moved this from In Eng Review to Done in Contributions Jun 12, 2025
@bradenmacdonald bradenmacdonald deleted the braden/teak-markdown-editor-libraries branch June 12, 2025 16:16
ihor-romaniuk pushed a commit to raccoongang/frontend-app-authoring that referenced this pull request Jun 19, 2025
* fix: enable markdown editor for problems in libraries too

This fix is also achieved on master via 5991fd3 / openedx#2068 but this is a simpler fix, not a direct backport of that refactor.

* fix: remove duplicate markdown_edited save request (openedx#2127)

Removes the unnecessary duplicate save  request of markdown_edited
value to the backend.

Part of: openedx#2099
Backports: 62589ae

---------

Co-authored-by: Muhammad Anas <[email protected]>
ihor-romaniuk pushed a commit to raccoongang/frontend-app-authoring that referenced this pull request Jun 20, 2025
* fix: enable markdown editor for problems in libraries too

This fix is also achieved on master via 5991fd3 / openedx#2068 but this is a simpler fix, not a direct backport of that refactor.

* fix: remove duplicate markdown_edited save request (openedx#2127)

Removes the unnecessary duplicate save  request of markdown_edited
value to the backend.

Part of: openedx#2099
Backports: 62589ae

---------

Co-authored-by: Muhammad Anas <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core contributor PR author is a Core Contributor (who may or may not have write access to this repo). create-sandbox open-craft-grove should create a sandbox environment from this PR open-source-contribution PR author is not from Axim or 2U
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

6 participants