tutor/README.rst

.. _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
    :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/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 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
    :target: https://terminalizer.com/view/91b0bfdd557

Quickstart
----------

1. Install the `latest stable release <https://github.com/regisb/tutor/releases>`_ of Tutor
2. Run ``tutor local quickstart``
3. You're done!

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 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:
Improve docs wording and de-duplicate from readme The sphinx `include` directive is great! 2019-04-25 07:30:48 +00:00			`.. _readme_intro_start:`

			`Tutor 🎓 The docker-based Open edX distribution designed for peace of mind`
			`==========================================================================`
Improve documentation 2018-12-26 15:00:47 +00:00
Change "openedx-docker" github urls to tutor 2018-12-26 18:29:32 +00:00			`.. image:: https://img.shields.io/travis/regisb/tutor.svg`
Improve documentation 2018-12-26 15:00:47 +00:00			`:alt: Build status`
Change "openedx-docker" github urls to tutor 2018-12-26 18:29:32 +00:00			`:target: https://travis-ci.org/regisb/tutor`
Improve documentation 2018-12-26 15:00:47 +00:00
Docs are now hosted with https 2019-02-20 12:52:25 +00:00			`.. image:: https://img.shields.io/badge/docs-current-brightgreen.svg`
			`:alt: Documentation`
			`:target: https://docs.tutor.overhang.io`
Add documentation status badge 2019-02-19 21:37:59 +00:00
Change "openedx-docker" github urls to tutor 2018-12-26 18:29:32 +00:00			`.. image:: https://img.shields.io/github/issues/regisb/tutor.svg`
Improve documentation 2018-12-26 15:00:47 +00:00			`:alt: GitHub issues`
Change "openedx-docker" github urls to tutor 2018-12-26 18:29:32 +00:00			`:target: https://github.com/regisb/tutor/issues`
Improve documentation 2018-12-26 15:00:47 +00:00
Change "openedx-docker" github urls to tutor 2018-12-26 18:29:32 +00:00			`.. image:: https://img.shields.io/github/issues-closed/regisb/tutor.svg?colorB=brightgreen`
Improve documentation 2018-12-26 15:00:47 +00:00			`:alt: GitHub closed issues`
Change "openedx-docker" github urls to tutor 2018-12-26 18:29:32 +00:00			`:target: https://github.com/regisb/tutor/issues?q=is%3Aclosed`
Improve documentation 2018-12-26 15:00:47 +00:00
Tutor v3 complete rewrite Replace all make commands by a single "tutor" binary. Environment and data are all moved to ~/.tutor/local/share/tutor. We take the opportunity to add a web UI and revamp the documentation. This is a complete rewrite. Close #121. Close #147. 2019-01-22 20:25:04 +00:00			`.. image:: https://img.shields.io/github/license/regisb/tutor.svg`
			`:alt: AGPL License`
			`:target: https://www.gnu.org/licenses/agpl-3.0.en.html`

Improve docs wording and de-duplicate from readme The sphinx `include` directive is great! 2019-04-25 07:30:48 +00:00			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:`
Improve documentation 2018-12-26 15:00:47 +00:00
Gif animation for quickstart Animation created with Terminalizer: https://terminalizer.com/ Try it! It's awesome :) 2019-02-10 18:13:35 +00:00			`.. image:: ./docs/img/quickstart.gif`
			`:alt: Tutor local quickstart`
			`:target: https://terminalizer.com/view/91b0bfdd557`
Improve documentation 2018-12-26 15:00:47 +00:00
			`Quickstart`
			`----------`

Better release descriptions By using `github-releases`, we can now generate much better release description blurbs. 2019-04-22 13:14:46 +00:00			1. Install the `latest stable release <https://github.com/regisb/tutor/releases>`_ of Tutor
Tutor v3 complete rewrite Replace all make commands by a single "tutor" binary. Environment and data are all moved to ~/.tutor/local/share/tutor. We take the opportunity to add a web UI and revamp the documentation. This is a complete rewrite. Close #121. Close #147. 2019-01-22 20:25:04 +00:00			2. Run ``tutor local quickstart``
			`3. You're done!`
Improve documentation 2018-12-26 15:00:47 +00:00
			`Documentation`
			`-------------`

Docs are now hosted with https 2019-02-20 12:52:25 +00:00			`Extensive documentation is available online: https://docs.tutor.overhang.io/`
Improve documentation 2018-12-26 15:00:47 +00:00
Improve docs wording and de-duplicate from readme The sphinx `include` directive is great! 2019-04-25 07:30:48 +00:00			`.. _readme_support_start:`

Add links to tutor forums 2019-02-19 21:26:43 +00:00			`Support`
			`-------`

			`To get community support, go to the official discussion forums: https://discuss.overhang.io.`

Improve docs wording and de-duplicate from readme The sphinx `include` directive is great! 2019-04-25 07:30:48 +00:00			`.. _readme_support_end:`

			`.. _readme_contributing_start:`

Tutor v3 complete rewrite Replace all make commands by a single "tutor" binary. Environment and data are all moved to ~/.tutor/local/share/tutor. We take the opportunity to add a web UI and revamp the documentation. This is a complete rewrite. Close #121. Close #147. 2019-01-22 20:25:04 +00:00			`Contributing`
			`------------`
Improve documentation 2018-12-26 15:00:47 +00:00
Improve docs wording and de-duplicate from readme The sphinx `include` directive is great! 2019-04-25 07:30:48 +00:00			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:`