From 5e6ad893a6b168c936cdbc726f99eceb519a6eae Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9gis=20Behmo?= Date: Mon, 7 Oct 2019 14:26:17 +0200 Subject: [PATCH] Coolify readme --- README.rst | 13 ++++++++++++- docs/Makefile | 2 +- docs/install.rst | 13 +++++++++++-- 3 files changed, 24 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index c63c419..4b525a2 100644 --- a/README.rst +++ b/README.rst @@ -27,7 +27,18 @@ Tutor 🎓 The docker-based Open edX distribution designed for peace of mind :alt: AGPL License :target: https://www.gnu.org/licenses/agpl-3.0.en.html -**Tutor** is a docker-based `Open edX `_ distribution, both for production and local development. The goal of Tutor is to make it easy to deploy, customize, upgrade and scale Open edX. Tutor is fast, full of cool features, extensible, and it is already used by dozens of Open edX platforms in the world. +**Tutor** is a docker-based `Open edX `_ distribution, both for production and local development. The goal of Tutor is to make it easy to deploy, customize, upgrade and scale Open edX. Tutor is reliable, fast, extensible, and it is already used by dozens of Open edX platforms in the world. + +Features +-------- + +* 100% `open source `__ +* Runs entirely on Docker +* World-famous 1-click :ref:`installation ` and :ref:`upgrades ` +* Extensible architecture with :ref:`plugins ` +* Works with :ref:`Kubernetes ` +* No technical skill required with the :ref:`1-click Tutor AWS image ` +* Try it out! .. _readme_intro_end: diff --git a/docs/Makefile b/docs/Makefile index 0e59dc6..30d220c 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -8,4 +8,4 @@ browse: sensible-browser _build/html/index.html watch: html browse - while true; do inotifywait -e modify *.rst; $(MAKE) html; done + while true; do inotifywait -e modify *.rst ../*.rst; $(MAKE) html; done diff --git a/docs/install.rst b/docs/install.rst index e87504b..0ea0e99 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -48,11 +48,20 @@ Installing from a local clone of the repository:: git clone https://github.com/overhangio/tutor cd tutor pip install -e . - + +.. _install_cloud: + 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. This is a commercial offer priced at $50/month ($500/year) that was created to support the development of Tutor. +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. This is a commercial offer priced at $50/month ($500/year) that was created to support the development of Tutor. + +.. _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``. Autocomplete ------------