From de57812c2c63ad46e4f385293532d8f028eeccf7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9gis=20Behmo?= Date: Tue, 25 Feb 2020 17:03:40 +0100 Subject: [PATCH] Minor docs improvements --- docs/install.rst | 10 ++++++---- docs/intro.rst | 4 ++-- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/docs/install.rst b/docs/install.rst index 362c2d5..8a0330c 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -9,7 +9,7 @@ Requirements The only prerequisite for running this is a working Docker installation. You'll need both the ``docker`` and ``docker-compose`` commands in your system ``$PATH``. Follow the instructions from the official documentation: - `Docker `_: minimum supported version is 18.06.0. -- `Docker compose `_ +- `Docker Compose `_ .. warning:: Do not attempt to simply run ``apt-get install docker docker-compose`` on older Ubuntu platforms, such as 16.04 (Xenial), as you will get older versions of these utilities. @@ -31,7 +31,7 @@ The latest binaries can be downloaded from https://github.com/overhangio/tutor/r .. include:: cli_download.rst -This is the simplest and recommended installation method for most people. Note however that you will not be able to use custom plugins with this pre-compiled binary. The only plugins you can use with this approach are those that are already bundled with the binary: `discovery `__, `ecommerce `__, `figures `__, `minio `__, `notes `__, `xqueue `__. +This is the simplest and recommended installation method for most people. Note however that you will not be able to use custom plugins with this pre-compiled binary. The only plugins you can use with this approach are those that are already bundled with the binary: see the :ref:`existing plugins `. From source ----------- @@ -55,14 +55,16 @@ Installing from a local clone of the repository:: Cloud deployment ---------------- -Tutor can be launched on Amazon Web Services very quickly with the `official Tutor AMI `_. Shell access is not even required, as all configuration will happen through the Tutor web user interface. +Tutor can be launched on Amazon Web Services very quickly with the `official Tutor AMI `_. Shell access is not even required, as all configuration will happen through the Tutor web user interface. For detailed installation instructions, we recommend watching the following video: + +.. youtube:: xtXP52qGphA .. _upgrade: Upgrading --------- -To upgrade a running Open edX platform, just install the latest ``tutor`` version (using either methods above) and run the ``quickstart`` command again. If you have :ref:`customised ` your docker images, you will have to re-build them prior to running ``quickstart``. +With Tutor, it is very easy to upgrade to a more recent Open edX or Tutor release. Just install the latest ``tutor`` version (using either methods above) and run the ``quickstart`` command again. If you have :ref:`customised ` your docker images, you will have to re-build them prior to running ``quickstart``. .. _autocomplete: diff --git a/docs/intro.rst b/docs/intro.rst index 6b02c41..71b4bf4 100644 --- a/docs/intro.rst +++ b/docs/intro.rst @@ -36,7 +36,7 @@ This command does two things: 1. Generate a ``config.yml`` configuration file: this file contains core :ref:`configuration parameters ` for your Open edX platforms, such as passwords and feature flags. 2. Generate an ``env/`` folder, which we call the Tutor "environment", and which contains all the files that are necessary to run an Open edX platform: these are mostly Open edX configuration files. -All these files are stored in a single folder, called the Tutor project root. On Linux, this folder is in ``~/.local/share/tutor`` and on Mac OS it is ``~/Library/Application Support/tutor``. +All these files are stored in a single folder, called the Tutor project root. On Linux, this folder is in ``~/.local/share/tutor``. On Mac OS it is ``~/Library/Application Support/tutor``. The values from ``config.yml`` are used to generate the environment files in ``env/``. As a consequence, **every time the values from** ``config.yml`` **are modified, the environment must be regenerated**. This can be done with:: @@ -56,4 +56,4 @@ Now that you have generated a configuration and environment, you probably want t Bells and whistles ------------------ -For more advanced usage of Tutor, take a look at the :ref:`configuration and customisation ` and the :ref:`extra ` sections \ No newline at end of file +For more advanced usage of Tutor, take a look at the :ref:`configuration and customisation `, the :ref:`existing plugins ` and the :ref:`extra ` sections \ No newline at end of file