christianlight
/
tutor
mirror of https://github.com/ChristianLight/tutor.git
7
0
Fork 0
Code Issues Releases Activity

Improve docs wording and de-duplicate from readme 

The sphinx `include` directive is great!
This commit is contained in:
Régis Behmo 2019-04-25 09:30:48 +02:00
parent 207229e16e
commit e25982ed20
3 changed files with 30 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.rst
View File

@ -1,5 +1,7 @@
Tutor 🎓 Open edX 1-click install for everyone
==============================================
.. _readme_intro_start:
Tutor 🎓 The docker-based Open edX distribution designed for peace of mind
==========================================================================
.. image:: https://img.shields.io/travis/regisb/tutor.svg
:alt: Build status
@ -21,7 +23,9 @@ Tutor 🎓 Open edX 1-click install for everyone
:alt: AGPL License
:target: https://www.gnu.org/licenses/agpl-3.0.en.html
**Tutor** is a one-click install of `Open edX <https://openedx.org>`_, both for production and local development, inside docker containers. Tutor is easy to run, fast, full of cool features, and it is already used by dozens of Open edX platforms in the world.
**Tutor** is a docker-based `Open edX <https://openedx.org>`_ 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 easy to use, fast, full of cool features, and it is already used by dozens of Open edX platforms in the world.
.. _readme_intro_end:
.. image:: ./docs/img/quickstart.gif
:alt: Tutor local quickstart
@ -39,12 +43,20 @@ Documentation
Extensive documentation is available online: https://docs.tutor.overhang.io/
.. _readme_support_start:
Support
-------
To get community support, go to the official discussion forums: https://discuss.overhang.io.
.. _readme_support_end:
.. _readme_contributing_start:
Contributing
------------
We go to great lengths to make it as easy as possible for people to run Open edX inside Docker containers. If you have an improvement idea, feel free to first discuss it on the `Tutor forum <https://discuss.overhang.io>`_. Did you find an issue with Tutor? Please first make sure that it's related to Tutor, and not an issue with Open edX. Then, `open an issue on Github <https://github.com/regisb/tutor/issues/new>`_. `Pull requests <https://github.com/regisb/tutor/pulls>`_ will be happily examined, too!
We are very much open to new ideas, features for Tutor. If you have an improvement idea, feel free to first discuss it on the `Tutor forums <https://discuss.overhang.io>`_. If you are not quite familiar with Open edX or if you need technical advice, the forums are a great place to start, too. Did you find an issue with Tutor? Please first make sure that it's related to Tutor, and not an upstream issue with Open edX. Then, `open an issue on Github <https://github.com/regisb/tutor/issues/new>`_. `Pull requests <https://github.com/regisb/tutor/pulls>`_ will be happily examined, too!
.. _readme_contributing_end:

56
docs/index.rst
View File

@ -1,37 +1,7 @@
.. Tutor documentation master file, created by
sphinx-quickstart on Mon Dec 3 21:36:51 2018.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Tutor 🎓 Open edX 1-click install for everyone
==============================================
.. image:: https://img.shields.io/travis/regisb/tutor.svg
:alt: Build status
:target: https://travis-ci.org/regisb/tutor
.. image:: https://img.shields.io/badge/docs-current-brightgreen.svg
:alt: Documentation
:target: https://docs.tutor.overhang.io
.. image:: https://img.shields.io/github/stars/regisb/tutor.svg?style=social
:alt: Github stars
:target: https://github.com/regisb/tutor/
.. image:: https://img.shields.io/github/issues/regisb/tutor.svg
:alt: GitHub issues
:target: https://github.com/regisb/tutor/issues
.. image:: https://img.shields.io/github/issues-closed/regisb/tutor.svg?colorB=brightgreen
:alt: GitHub closed issues
:target: https://github.com/regisb/tutor/issues?q=is%3Aclosed
.. image:: https://img.shields.io/github/license/regisb/tutor.svg
:alt: AGPL License
:target: https://www.gnu.org/licenses/agpl-3.0.en.html
**Tutor** is a one-click install of `Open edX <https://openedx.org>`_, both for production and local development, inside docker containers. Tutor is easy to run, fast, full of cool features, and it is already used by dozens of Open edX platforms in the world.
.. include:: ../README.rst
:start-after: _readme_intro_start:
:end-before: _readme_intro_end:
.. image:: ./img/quickstart.gif
:alt: Tutor local quickstart
:target: https://terminalizer.com/view/91b0bfdd557
@ -65,16 +35,14 @@ Source code
The complete source code for Tutor is available on Github: https://github.com/regisb/tutor
Support
-------
To get community support, go to the official discussion forums: https://discuss.overhang.io.
Contributing
------------
We go to great lengths to make it as easy as possible for people to run Open edX inside Docker containers. If you have an improvement idea, feel free to first discuss it on the `Tutor forum <https://discuss.overhang.io>`_. Did you find an issue with Tutor? Please first make sure that it's related to Tutor, and not an issue with Open edX. Then, `open an issue on Github <https://github.com/regisb/tutor/issues/new>`_. `Pull requests <https://github.com/regisb/tutor/pulls>`_ will be happily examined, too!
.. include:: ../README.rst
:start-after: _readme_support_start:
:end-before: _readme_support_end:
.. include:: ../README.rst
:start-after: _readme_contributing_start:
:end-before: _readme_contributing_end:
License
-------

4
docs/quickstart.rst
View File

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