christianlight/tutor
6
0
Fork 0
mirror of https://github.com/ChristianLight/tutor.git synced 2024-12-12 14:17:46 +00:00
Code Issues Releases Activity
f417fbf4f9
tutor/docs/index.rst

85 lines
3.3 KiB
ReStructuredText
Raw Normal View History

Migrate openedx-docker project to Tutor :woman_teacher: The project gets a new name and some proper documentation. Build/Deploy are now properly separated.
2018-12-03 18:59:09 +00:00
.. 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.
Improve documentation
2018-12-26 15:00:47 +00:00
Tutor 🎓 Open edX 1-click install for everyone
==============================================
Migrate openedx-docker project to Tutor :woman_teacher: The project gets a new name and some proper documentation. Build/Deploy are now properly separated.
2018-12-03 18:59:09 +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
Migrate openedx-docker project to Tutor :woman_teacher: The project gets a new name and some proper documentation. Build/Deploy are now properly separated.
2018-12-03 18:59:09 +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
Migrate openedx-docker project to Tutor :woman_teacher: The project gets a new name and some proper documentation. Build/Deploy are now properly separated.
2018-12-03 18:59:09 +00:00
Add documentation status badge
2019-02-19 21:37:59 +00:00
.. image:: https://readthedocs.org/projects/tutor/badge/?version=latest
:alt: Documentation Status
Fix http link to docs
2019-02-19 21:38:57 +00:00
:target: http://docs.tutor.overhang.io/en/latest/?badge=latest
Add documentation status badge
2019-02-19 21:37:59 +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/stars/regisb/tutor.svg?style=social
:alt: Github stars
:target: https://github.com/regisb/tutor/
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
Migrate openedx-docker project to Tutor :woman_teacher: The project gets a new name and some proper documentation. Build/Deploy are now properly separated.
2018-12-03 18:59:09 +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
Migrate openedx-docker project to Tutor :woman_teacher: The project gets a new name and some proper documentation. Build/Deploy are now properly separated.
2018-12-03 18:59:09 +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
Migrate openedx-docker project to Tutor :woman_teacher: The project gets a new name and some proper documentation. Build/Deploy are now properly separated.
2018-12-03 18:59:09 +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
Migrate openedx-docker project to Tutor :woman_teacher: The project gets a new name and some proper documentation. Build/Deploy are now properly separated.
2018-12-03 18:59:09 +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 documentation
2018-12-26 15:00:47 +00:00
**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.
Migrate openedx-docker project to Tutor :woman_teacher: The project gets a new name and some proper documentation. Build/Deploy are now properly separated.
2018-12-03 18:59:09 +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:: ./img/quickstart.gif
:alt: Tutor local quickstart
:target: https://terminalizer.com/view/91b0bfdd557
Migrate openedx-docker project to Tutor :woman_teacher: The project gets a new name and some proper documentation. Build/Deploy are now properly separated.
2018-12-03 18:59:09 +00:00
----------------------------------
Improve documentation
2018-12-26 15:00:47 +00:00
.. include:: quickstart.rst
:start-line: 1
Migrate openedx-docker project to Tutor :woman_teacher: The project gets a new name and some proper documentation. Build/Deploy are now properly separated.
2018-12-03 18:59:09 +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
But there's a lot more to Tutor than that! For more advanced usage, please refer to the following sections.
Migrate openedx-docker project to Tutor :woman_teacher: The project gets a new name and some proper documentation. Build/Deploy are now properly separated.
2018-12-03 18:59:09 +00:00
.. toctree::
:maxdepth: 2
:caption: User guide
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
install
Improve documentation
2018-12-26 15:00:47 +00:00
quickstart
Rename "singleserver" with "local" deployment
2018-12-26 17:20:53 +00:00
local
Migrate openedx-docker project to Tutor :woman_teacher: The project gets a new name and some proper documentation. Build/Deploy are now properly separated.
2018-12-03 18:59:09 +00:00
options
customise
dev
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
k8s
webui
Migrate openedx-docker project to Tutor :woman_teacher: The project gets a new name and some proper documentation. Build/Deploy are now properly separated.
2018-12-03 18:59:09 +00:00
troubleshooting
Improve documentation
2018-12-26 15:00:47 +00:00
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
faq
Migrate openedx-docker project to Tutor :woman_teacher: The project gets a new name and some proper documentation. Build/Deploy are now properly separated.
2018-12-03 18:59:09 +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
Source code
-----------
Migrate openedx-docker project to Tutor :woman_teacher: The project gets a new name and some proper documentation. Build/Deploy are now properly separated.
2018-12-03 18:59:09 +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
The complete source code for Tutor is available on Github: https://github.com/regisb/tutor
Migrate openedx-docker project to Tutor :woman_teacher: The project gets a new name and some proper documentation. Build/Deploy are now properly separated.
2018-12-03 18:59:09 +00:00
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.
Migrate openedx-docker project to Tutor :woman_teacher: The project gets a new name and some proper documentation. Build/Deploy are now properly separated.
2018-12-03 18:59:09 +00:00
Contributing
------------
Add links to tutor forums
2019-02-19 21:26:43 +00:00
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!
Migrate openedx-docker project to Tutor :woman_teacher: The project gets a new name and some proper documentation. Build/Deploy are now properly separated.
2018-12-03 18:59:09 +00:00
License
-------
Switch license to AGPL
2019-01-16 16:22:53 +00:00
This work is licensed under the terms of the `GNU Affero General Public License (AGPL) <https://github.com/regisb/tutor/blob/master/LICENSE.txt>`_.
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
The AGPL license covers the Tutor code, including the Dockerfiles, but not the content of the Docker images which can be downloaded from https://hub.docker.com. Software other than Tutor provided with the docker images retain their original license.
The :ref:`Tutor Web UI <webui>` depends on the `Gotty <https://github.com/yudai/gotty/>`_ binary, which is provided under the terms of the `MIT license <https://github.com/yudai/gotty/blob/master/LICENSE>`_.
Copy Permalink