mirror of
https://github.com/ChristianLight/tutor.git
synced 2024-11-10 23:30:59 +00:00
e14f660cb1
There is too much information in each of the local/k8s/dev docs pages. The "guides" that are listed in each one of those pages are moved either to "common tasks" or to a dedicated "tutorials" section. This paves the way for more comprehensive tutorials, where we describe how to run the latest master branches of Open edX. I am well aware that, as they stand, the tutorials are of poor quality and should be rewritten. This is a task for another day/commit. For now, we only move the contents to a separate part of the docs. Also, we should add a "reference" section to the docs, where we add the result of `tutor <subcommand> --help`.
54 lines
1.5 KiB
ReStructuredText
54 lines
1.5 KiB
ReStructuredText
.. 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
|
|
|
|
----------------------------------
|
|
|
|
.. include:: testimonials.rst
|
|
|
|
----------------------------------
|
|
|
|
.. include:: quickstart.rst
|
|
:start-line: 1
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: User guide
|
|
|
|
gettingstarted
|
|
run
|
|
configuration
|
|
plugins
|
|
tutorials
|
|
troubleshooting
|
|
tutor
|
|
faq
|
|
|
|
Source code
|
|
-----------
|
|
|
|
The complete source code for Tutor is available on Github: https://github.com/overhangio/tutor
|
|
|
|
.. 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
|
|
-------
|
|
|
|
This work is licensed under the terms of the `GNU Affero General Public License (AGPL) <https://github.com/overhangio/tutor/blob/master/LICENSE.txt>`_.
|
|
|
|
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 Tutor plugin system is licensed under the terms of the `Apache License, Version 2.0 <https://opensource.org/licenses/Apache-2.0>`__.
|
|
|
|
© 2021 Tutor is a registered trademark of SASU NULI NULI. All Rights Reserved.
|