christianlight/tutor
7
0
Fork 0
mirror of https://github.com/ChristianLight/tutor.git synced 2024-06-01 22:00:48 +00:00
Code Issues Releases Activity
2a30d67a40
tutor/docs/index.rst

64 lines
1.7 KiB
ReStructuredText
Raw Normal View History

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:
docs: tutor is a registered trademark
2021-02-19 12:47:43 +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
----------------------------------
docs: include user testimonials
2019-10-08 20:25:20 +00:00
.. include:: testimonials.rst
----------------------------------
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 docs organization With this reoreganization, we have a cleaner TOC and more intuitive content navigation.
2020-03-16 11:07:58 +00:00
gettingstarted
run
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
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
docs: generate reference docs automatically This is performed with the help of sphinx-click: https://sphinx-click.readthedocs.io
2021-09-16 09:39:26 +00:00
reference
docs: reorganize local guides in tutorials 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`.
2021-09-16 08:53:52 +00:00
tutorials
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
docs: add links to source code/forums/pypi These links are available in the sidebar.
2021-09-16 10:18:06 +00:00
.. toctree::
:maxdepth: 2
:caption: Project links
Source code <https://github.com/overhangio/tutor>
Community forums <https://discuss.overhang.io>
Pypi releases <https://pypi.org/project/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
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
Migrate github repo to overhangio organization
2019-06-23 17:56:15 +00:00
The complete source code for Tutor is available on Github: https://github.com/overhangio/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:
docs: tutor is a registered trademark
2021-02-19 12:47:43 +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_contributing_start:
:end-before: _readme_contributing_end:
docs: tutor is a registered trademark
2021-02-19 12:47:43 +00:00
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
-------
Migrate github repo to overhangio organization
2019-06-23 17:56:15 +00:00
This work is licensed under the terms of the `GNU Affero General Public License (AGPL) <https://github.com/overhangio/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.
Add the lts plugin to the tutor binary
2019-12-25 00:09:53 +00:00
The Tutor plugin system is licensed under the terms of the `Apache License, Version 2.0 <https://opensource.org/licenses/Apache-2.0>`__.
docs: tutor is a registered trademark
2021-02-19 12:47:43 +00:00
© 2021 Tutor is a registered trademark of SASU NULI NULI. All Rights Reserved.
Copy Permalink