-
Notifications
You must be signed in to change notification settings - Fork 57
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 'install tutor nightly' command. #368
Conversation
Under the section, `Install Tutor Nightly` update the command `tutor dev quickstart` to `tutor dev launch` to configure and provision an Open edX instance. `quickstart` is not listed as one of the options commands for `tutor dev`.
Thanks for the pull request, @apexDev37! Please note that it may take us up to several weeks or months to complete a review and merge your PR. Feel free to add as much of the following information to the ticket as you can:
All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here. Please let us know once your PR is ready for our review and all tests are green. |
Hi @apexDev37! Thank you for this contribution! Please let me know if you have any questions regarding submitting your CLA form. |
Hey @mphilbrick211, Glad to contribute! I have submitted the Individual CLA form. Currently waiting for the email from DocuSign. |
@mphilbrick211, I managed to complete the developer Quick Start: First Open edX Pull Request. I encountered a couple of errors due to the documentation being outdated. I would like to share the updates I made to complete the Quick Start successfully (sourced for the Tutor documentation and Kindly advise me. Should I open a new pull request or add to this existing one? |
@feanil - flagging this in case you have some input! |
@mphilbrick211 this looks good to merge once the CLA process has been fully executed. |
install tutor nightly
command.
install tutor nightly
command.
The CLA process is complete and all checks have passed✅ |
Perfect, @apexDev37! I've marked this as ready for review. |
@apexDev37 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future. |
First, @mphilbrick211 and @feanil, thank you for the great support🌍 |
Section: Mounting edx-platform
Source of information:
Additional information: Your advice on merging the necessary update to the developer Quickstart is appreciated. |
Under the section,
Install Tutor Nightly
update the commandtutor dev quickstart
totutor dev launch
to configure and provision an Open edX instance.quickstart
is not listed as one of the options commands fortutor dev
.Update to the tutorial: Quick Start: First Open edX Pull Request
Navigation:
Here is the documentation link.
Problem:
When following the tutorial I encountered a blocker in executing one of the provided commands:
tutor dev quickstart
.Expected:
An interactive session to configure and provision an Open edX instance.
Actual:
The following terminal output error message:
Additional:
quickstart
does not appear as one of the commands fortutor dev
.List usage commands with the following command,
tutor dev -h
.Output from executing the command:
Context:
The host machine runs Ubuntu Focal. Python version:
3.8.10
. The only configuration run by the user was the instructions specified in the tutorial, Quick Start: First Open edX Pull Request. Prior to this, nothing concerning Open edX or Tutor was installed or set up on the user's host machine.Fix:
Suggest an edit to update the provided command from
tutor dev quickstart
totutor dev launch
to configure and provision an Open edX instance.