tutor/docs/index.rst

.. 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:: quickstart.rst
    :start-line: 1

.. toctree::
   :maxdepth: 2
   :caption: User guide

   intro
   install
   quickstart
   configuration
   local
   k8s
   dev
   plugins
   extra
   troubleshooting
   tutor
   faq

Source code
-----------

The complete source code for Tutor is available on Github: https://github.com/regisb/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/regisb/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 :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>`_.
Improve docs wording and de-duplicate from readme The sphinx `include` directive is great! 2019-04-25 07:30:48 +00:00			`.. include:: ../README.rst`
			`:start-after: _readme_intro_start:`
			`:end-before: _readme_intro_end:`

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
			`.. toctree::`
			`:maxdepth: 2`
			`:caption: User guide`

Better documentation - More concise table of contents - New intro - Simpler make commands - Fix a couple typos here and there - Get rid of the default github issue template, and start using the template created online. 2019-05-13 14:33:26 +00:00			`intro`
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`
Configurable docker images Docker images for each service can now be configured one by one. Close #122. 2019-03-06 16:21:47 +00:00			`configuration`
Rename "singleserver" with "local" deployment 2018-12-26 17:20:53 +00:00			`local`
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`
Better documentation - More concise table of contents - New intro - Simpler make commands - Fix a couple typos here and there - Get rid of the default github issue template, and start using the template created online. 2019-05-13 14:33:26 +00:00			`dev`
Working Kubernetes quickstart The k8s quickstart command is now functional, with suppport for https, xqueue, notes and minio. There are still a few bugs to get rid of, though. 2019-06-06 19:58:21 +00:00			`plugins`
Better documentation - More concise table of contents - New intro - Simpler make commands - Fix a couple typos here and there - Get rid of the default github issue template, and start using the template created online. 2019-05-13 14:33:26 +00:00			`extra`
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
Improve docs wording and de-duplicate from readme The sphinx `include` directive is great! 2019-04-25 07:30:48 +00:00			`.. 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:`

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>`_.