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 'install tutor nightly' command. #368

Merged
merged 1 commit into from
Aug 22, 2023

Conversation

apexDev37
Copy link
Contributor

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.

Update to the tutorial: Quick Start: First Open edX Pull Request

Navigation:

|--- Quickstarts
     |--- Developers: Contribute to Open edX
           |--- Quick Start: First Open edX Pull Request
                 |--- #Section: Installing Tutor Nightly

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:

Usage: tutor dev [OPTIONS] COMMAND [ARGS]...
Try 'tutor dev -h' for help.

Error: No such command 'quickstart'.

Additional:
quickstart does not appear as one of the commands for tutor dev.
List usage commands with the following command, tutor dev -h.
Output from executing the command:

Usage: tutor dev [OPTIONS] COMMAND [ARGS]...

  Run Open edX locally with development settings

Options:
  -h, --help  Show this message and exit.

Commands:
  copyfrom  Copy files/folders from a container directory to the local...
  dc        Direct interface to docker-compose.
  do        Run a custom job in the right container(s).
  exec      Run a command in a running container
  launch    Configure and run Open edX from scratch
  logs      View output from containers
  reboot    Reboot an existing platform
  restart   Restart some components from a running platform.
  run       Run a command in a new container
  start     Run all or a selection of services.
  status    Print status information for containers
  stop      Stop a running platform
  upgrade   Perform release-specific upgrade tasks.

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 to tutor dev launch to configure and provision an Open edX instance.

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`.
@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Aug 10, 2023
@openedx-webhooks
Copy link

openedx-webhooks commented Aug 10, 2023

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:

  • supporting documentation
  • Open edX discussion forum threads
  • timeline information ("this must be merged by XX date", and why that is)
  • partner information ("this is a course on edx.org")
  • any other information that can help Product understand the context for the PR

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.

@mphilbrick211
Copy link

Hi @apexDev37! Thank you for this contribution! Please let me know if you have any questions regarding submitting your CLA form.

@apexDev37
Copy link
Contributor Author

Hey @mphilbrick211, Glad to contribute! I have submitted the Individual CLA form. Currently waiting for the email from DocuSign.

@apexDev37
Copy link
Contributor Author

@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 CHANGELOG).

Kindly advise me. Should I open a new pull request or add to this existing one?
Note, some modifications require major section updates.

@mphilbrick211
Copy link

@feanil - flagging this in case you have some input!

@feanil feanil changed the title docs: Update 'install tutor nightly' command docs: Update 'install tutor nightly' command. Aug 18, 2023
@feanil
Copy link
Contributor

feanil commented Aug 18, 2023

@mphilbrick211 this looks good to merge once the CLA process has been fully executed.

@apexDev37 apexDev37 changed the title docs: Update 'install tutor nightly' command. docs: Update install tutor nightly command. Aug 22, 2023
@apexDev37 apexDev37 changed the title docs: Update install tutor nightly command. docs: Update 'install tutor nightly' command. Aug 22, 2023
@apexDev37
Copy link
Contributor Author

The CLA process is complete and all checks have passed✅

@mphilbrick211
Copy link

The CLA process is complete and all checks have passed✅

Perfect, @apexDev37! I've marked this as ready for review.

@feanil feanil merged commit d1960b7 into openedx:main Aug 22, 2023
@openedx-webhooks
Copy link

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

@apexDev37
Copy link
Contributor Author

First, @mphilbrick211 and @feanil, thank you for the great support🌍
I raised a concern about an outdated section I encountered in the same developer Quick Start: First Open edX Pull Request.

@apexDev37
Copy link
Contributor Author

Section: Mounting edx-platform
Noted areas of concern include:

  1. The provided command tutor dev run --mount=./edx-platform lms bash to mount to a local edX checkout is deprected.
  2. Bashing into the LMS container to set up is now redundant and performed by Tutor automatically on launch.
  3. The steps provided can be significantly reduced to the following flow: fork, mount, and launch as specified here.

Source of information:

  1. Official Tutor CHANGELOG
  2. Official Tutor Documentation

Additional information:
This section required updates beyond minor "suggested edits". The updates can be observed in this feature branch.
If applicable, I can create a new pull request.

Your advice on merging the necessary update to the developer Quickstart is appreciated.

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.

4 participants