-
Notifications
You must be signed in to change notification settings - Fork 81
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
docs: update the README with an easy way to run the MFE with Tutor (on your host) #1364
Conversation
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 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. 🔘 Let us know that your PR is ready for review:Who will review my changes?This repository is currently maintained by 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. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
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. |
915ae73
to
2360fb0
Compare
@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. |
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.