7
0
mirror of https://github.com/ChristianLight/tutor.git synced 2024-06-07 00:20:49 +00:00

Various docs improvements

There is still a lot of work to do. In particular, local.rst and
configuration.rst are a mess. But that's a job for another time.
This commit is contained in:
Régis Behmo 2020-03-16 22:27:04 +01:00
parent 390c39fa19
commit 328e70b8b5
5 changed files with 6 additions and 7 deletions

View File

@ -55,7 +55,7 @@ Yes, many of them. There is no way to count precisely how many running Open edX
Why should I trust software written by some random guy on the Internet?
-----------------------------------------------------------------------
You shouldn't :) Tutor is actively maintained by `Overhang.io <https://overhang.io>`_, a France-based company founded by `Régis Behmo <https://github.com/regisb/>`_. Régis has been working on Tutor since early 2018; he has been a contributor of the Open edX project since 2015. In particular, he has worked for 2 years on `FUN-MOOC <https://www.fun-mooc.fr/>`_, one of the top 5 largest Open edX platforms in the world. He presented several talks at the Open edX conferences:
You shouldn't :) Tutor is actively maintained by `Overhang.IO <https://overhang.io>`_, a France-based company founded by `Régis Behmo <https://github.com/regisb/>`_. Régis has been working on Tutor since early 2018; he has been a contributor of the Open edX project since 2015. In particular, he has worked for 2 years at `FUN-MOOC <https://www.fun-mooc.fr/>`_, one of the top 5 largest Open edX platforms in the world. He presented several talks at the Open edX conferences:
- *Deploying a robust, scalable Open edX platform in 1 click (or less) with Tutor*, March 2019 (`video <https://www.youtube.com/watch?v=Oqc7c-3qFc4>`_, `slides <https://regisb.github.io/openedx2019/>`_)
- *Videofront: a Self-Hosted YouTube*, June 2017 (`video <https://www.youtube.com/watch?v=e7bJchJrmP8&t=5m53s>`__, `slides <http://regisb.github.io/openedx-conference-2017/>`__)

View File

@ -143,8 +143,8 @@ To update the course search index, run::
Reloading Open edX settings
~~~~~~~~~~~~~~~~~~~~~~~~~~~
soft
After modifying Open edX settings, for instance when running ``tutor config save``, you will want to restart the web processes of the LMS and the CMS to take into account those new settings. It is possible to simply restart the whole platform (with ``tutor local reboot``) but that is overkill. A quicker alternative is to send the HUP signal to the gunicorn processes running inside the containers. The "openedx" Docker image comes with a convenient script that does just that. To run it, execute::
After modifying Open edX settings, for instance when running ``tutor config save``, you will want to restart the web processes of the LMS and the CMS to take into account those new settings. It is possible to simply restart the whole platform (with ``tutor local reboot``) or just a single service (``tutor local restart lms``) but that is overkill. A quicker alternative is to send the HUP signal to the gunicorn processes running inside the containers. The "openedx" Docker image comes with a convenient script that does just that. To run it, execute::
tutor local exec lms reload-gunicorn

View File

@ -3,7 +3,7 @@
Quickstart (1-click install)
----------------------------
1. `Download <https://github.com/overhangio/tutor/releases>`_ the latest stable release of Tutor, uncompress the file and place the ``tutor`` executable in your path. From the command line:
1. `Download <https://github.com/overhangio/tutor/releases>`_ the latest stable release of Tutor and place the ``tutor`` executable in your path. From the command line:
.. include:: cli_download.rst

View File

@ -31,7 +31,7 @@ class DevContext(Context):
)
@click.group(help="Run Open edX platform with development settings")
@click.group(help="Run Open edX locally with development settings")
@click.pass_context
def dev(context):
context.obj = DevContext(context.obj.root)

View File

@ -31,8 +31,7 @@ class LocalContext(Context):
@click.group(
short_help="Run Open edX locally",
help="Run Open edX platform locally, with docker-compose.",
help="Run Open edX locally with docker-compose",
)
@click.pass_context
def local(context):