Skip to content
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

docs: update the README with an easy way to run the MFE with Tutor (on your host) #1364

Merged
merged 1 commit into from
Oct 10, 2024

Conversation

bradenmacdonald
Copy link
Contributor

Description

When I became maintainer of the Learning MFE, I updated its README to explain how to easily run it in dev mode on your host, along with Tutor.

This PR makes the same improvements to the README of the Authoring MFE.

@bradenmacdonald bradenmacdonald requested a review from a team as a code owner October 5, 2024 21:48
@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Oct 5, 2024
@openedx-webhooks
Copy link

Thanks for the pull request, @bradenmacdonald!

What's next?

Please work through the following steps to get your changes 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.

🔘 Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @openedx/2u-tnl. Tag them in a comment and let them know that your changes are ready for review.

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 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.01%. Comparing base (434fea3) to head (2360fb0).
Report is 2 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1364   +/-   ##
=======================================
  Coverage   93.01%   93.01%           
=======================================
  Files        1035     1035           
  Lines       19630    19630           
  Branches     4161     4161           
=======================================
  Hits        18258    18258           
- Misses       1307     1310    +3     
+ Partials       65       62    -3     

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

@bradenmacdonald
Copy link
Contributor Author

@KristinAoki (not urgent) Would 2U be OK with this change to the README? Currently it recommends devstack, but outside of 2U devstack is deprecated. And this way of running it on the host instead of inside a container is much nicer for development.

@KristinAoki
Copy link
Member

@KristinAoki (not urgent) Would 2U be OK with this change to the README? Currently it recommends devstack, but outside of 2U devstack is deprecated. And this way of running it on the host instead of inside a container is much nicer for development.

Yes! If we need the devstack instructions we have that internally or we can look at the file history.

@bradenmacdonald bradenmacdonald merged commit 66b14a5 into openedx:master Oct 10, 2024
8 checks passed
@bradenmacdonald bradenmacdonald deleted the braden/update-readme branch October 10, 2024 21:02
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
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants