Skip to content

Conversation

Anas12091101
Copy link
Contributor

@Anas12091101 Anas12091101 commented Oct 7, 2025

Description

This PR enables the conversion from Markdown to OLX. The reverse conversion (OLX to Markdown) has been deferred for now, as it would require implementing a dedicated OLX-to-Markdown converter, which may take additional time. We plan to address that in a future update to ensure this change is merged before the Ulmo cut.

Useful information to include:

  • Which user roles will this change impact? "Course Author", "Developer"
  • Include screenshots for changes to the UI (ideally, both "before" and "after" screenshots, if applicable).

In Course
https://github.com/user-attachments/assets/cafee2fe-5445-4ec5-b90a-8b2d9b54d9f3

In Library
https://github.com/user-attachments/assets/98f45954-2d11-4dec-abcc-cc75d537882a

Supporting information

#1920
https://github.com/mitodl/hq/issues/8729

Testing instructions

  • Create a new problem or edit an existing one that was originally created using the Markdown editor.
  • Verify that the "Switch to Advanced Editor" button is displayed in the Settings sidebar on the right.
  • Make some edits to the Markdown content, then click the "Switch to Advanced Editor" button and confirm the action in the confirmation modal.
  • Verify that the editor switches to the OLX editor, and that the content is correctly converted to OLX format.

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.

Best Practices Checklist

We're trying to move away from some deprecated patterns in this codebase. Please
check if your PR meets these recommendations before asking for a review:

  • Any new files are using TypeScript (.ts, .tsx).
  • Deprecated propTypes, defaultProps, and injectIntl patterns are not used in any new or modified code.
  • Tests should use the helpers in src/testUtils.tsx (specifically initializeMocks)
  • Do not add new fields to the Redux state/store. Use React Context to share state among multiple components.
  • Use React Query to load data from REST APIs. See any apiHooks.ts in this repo for examples.
  • All new i18n messages in messages.ts files have a description for translators to use.
  • Imports avoid using ../. To import from parent folders, use @src, e.g. import { initializeMocks } from '@src/testUtils'; instead of from '../../../../testUtils'

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Oct 7, 2025
@openedx-webhooks
Copy link

Thanks for the pull request, @Anas12091101!

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.

Copy link

codecov bot commented Oct 7, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.69%. Comparing base (8fe5fb6) to head (f3e2511).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #2518   +/-   ##
=======================================
  Coverage   94.68%   94.69%           
=======================================
  Files        1203     1203           
  Lines       26865    26876   +11     
  Branches     6026     6032    +6     
=======================================
+ Hits        25438    25449   +11     
  Misses       1357     1357           
  Partials       70       70           

☔ 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.

@Anas12091101 Anas12091101 force-pushed the anas/add-markdown-to-olx-btn branch from 82428e5 to f3e2511 Compare October 7, 2025 15:31
@Anas12091101 Anas12091101 moved this from Needs Triage to Ready for Review in Contributions Oct 8, 2025
Copy link
Contributor

@bradenmacdonald bradenmacdonald left a comment

Choose a reason for hiding this comment

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

This seems to work fine if I haven't saved the problem, but when I edit an existing (saved, published) markdown problem in a library, I don't see the option to convert it:

Screenshot 2025-10-15 at 3 18 59 PM

const state = getState();
export const switchToAdvancedEditor = (editorRef) => (dispatch, getState) => {
const { problem } = getState();
const editorObject = fetchEditorContent({ format: '' });
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we move this editorObject down inside the else { clause?

problemType: PropTypes.string.isRequired,
editorType: PropTypes.string.isRequired,
// eslint-disable-next-line react/forbid-prop-types
editorRef: PropTypes.object.isRequired,
Copy link
Contributor

Choose a reason for hiding this comment

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

This is fine, but I would have preferred we pass the editorRef around using a ProblemEditorContext instead of prop drilling.

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: Ready for Review

Development

Successfully merging this pull request may close these issues.

3 participants