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

feat: introduce 'tutor dev quickstart' (also, some extra docs) #6

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ For Open edX deployers
For Open edX develeopers
~~~~~~~~~~~~~~~~~~~~~~~~

1. Install `Tutor Nightly <docs/tutorials/nightly.rst#install>`_
1. Install `Tutor Nightly <docs/tutorials/nightly.rst>`_
2. Run ``tutor dev quickstart``
3. You're done!

Expand Down
32 changes: 30 additions & 2 deletions docs/intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ To learn more about Tutor, watch this 7-minute lightning talk that was made at t

.. youtube:: Oqc7c-3qFc4

How does Tutor work, technically speaking?
------------------------------------------
How does Tutor simplify Open edX deployment?
--------------------------------------------

Tutor simplifies the deployment of Open edX by:

Expand Down Expand Up @@ -101,6 +101,34 @@ You can now take advantage of the Tutor-powered CLI (item #3) to bootstrap your

Under the hood, Tutor simply runs ``docker-compose`` and ``docker`` commands to launch your platform. These commands are printed in the standard output, such that you are free to replicate the same behaviour by simply copying/pasting the same commands.

How do I navigate Tutor's command-line interface?
-------------------------------------------------

Tutor commands are structured in an easy-to-follow hierarchy. At the top level, there are command trees for image and configuration management::

tutor config ...
tutor images ...

as well as command trees for each mode in which Tutor can run::

tutor local ... # Commands for managing a local Open edX deployment.
tutor k8s ... # Commands for managing a Kubernetes Open edX deployment.
tutor dev ... # Commands for hacking on Open edX in development mode.

Within each mode, Tutor has subcommands for managing that type of Open edX instance. Many of them are common between modes, such as ``quickstart``, ``start``, ``stop``, ``exec``, and ``logs``. For example::

tutor local logs # View logs of a local deployment.
tutor k8s logs # View logs of a Kubernetes-managed deployment.
tutor dev logs # View logs of a development platform.

Many commands can be further parameterized to specify their target and options, for example::

tutor local logs cms # View logs of the CMS container in a local deployment.
tutor k8s logs mysql # View logs of MySQL in Kubernetes-managed deployment.
tutor dev logs lms --tail 10 # View ten lines of logs of the LMS container in development mode.

And that's it! You do not need to understand Tutor's entire command-line interface to get started. Using the ``--help`` option that's availble on every command, it is easy to learn as you go.

I'm ready, where do I start?
----------------------------

Expand Down
2 changes: 0 additions & 2 deletions docs/tutorials/nightly.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ Running Open edX on the master branch ("nightly")

Tutor was designed to make it easy for everyone to run the latest release of Open edX. But sometimes, you want to run the latest, bleeding-edge version of Open edX. This is what we call "running master", as opposed to running the release branch. Running the master branch in production is strongly **not** recommended unless you are an Open edX expert and you really know what you are doing. But Open edX developers frequently need to run the master branch locally to implement and test new features. Thus, Tutor makes it easy to run Open edX on the master branch: this is called "Tutor Nightly".

.. _install:

Copy link
Owner Author

Choose a reason for hiding this comment

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

This just fixes a mistake in the previous commit.

Installing Tutor Nightly
------------------------

Expand Down