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

66 lines
1.9 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:
feat: deprecate "quickstart" and rename to "launch" `quickstart` is being renamed to `launch` and deprecated in favor of using `launch`. The `quickstart` function temporarily aliases to `launch`. Further mentions of `quickstart` have been changed to reference `launch` instead. We are indicating that this change is breaking 💥 to encourage people to migrate their scripts right away!
2022-09-30 10:00:24 +00:00
..
TODO replace quickstart.gif + alt with 'launch'
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
feat: migrate to plugins.v1 with filters & actions This is a very large refactoring which aims at making Tutor both more extendable and more generic. Historically, the Tutor plugin system was designed as an ad-hoc solution to allow developers to modify their own Open edX platforms without having to fork Tutor. The plugin API was simple, but limited, because of its ad-hoc nature. As a consequence, there were many things that plugin developers could not do, such as extending different parts of the CLI or adding custom template filters. Here, we refactor the whole codebase to make use of a generic plugin system. This system was inspired by the Wordpress plugin API and the Open edX "hooks and filters" API. The various components are added to a small core thanks to a set of actions and filters. Actions are callback functions that can be triggered at different points of the application lifecycle. Filters are functions that modify some data. Both actions and filters are collectively named as "hooks". Hooks can optionally be created within a certain context, which makes it easier to keep track of which application created which callback. This new hooks system allows us to provide a Python API that developers can use to extend their applications. The API reference is added to the documentation, along with a new plugin development tutorial. The plugin v0 API remains supported for backward compatibility of existing plugins. Done: - Do not load commands from plugins which are not enabled. - Load enabled plugins once on start. - Implement contexts for actions and filters, which allow us to keep track of the source of every hook. - Migrate patches - Migrate commands - Migrate plugin detection - Migrate templates_root - Migrate config - Migrate template environment globals and filters - Migrate hooks to tasks - Generate hook documentation - Generate patch reference documentation - Add the concept of action priority Close #499.
2022-02-07 17:11:43 +00:00
plugins/index
reference/index
tutorials/index
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>
docs: move forum to discuss.openedx.org Now that Tutor is the official community installation for Open edX, it no longer makes sense to host a forum that is separate from the general Open edX forum. Moving conversations there will encourage cross-communication between projects and maintainers. This change is part of a larger overhaul described in this Tutor enhancement proposal (TEP): https://discuss.overhang.io/t/tep-rethinking-the-tutor-maintainers-program/2724 In the future, plugin maintainers should point their users to the Open edX forum as well. They are encouraged to create dedicated "tutor-pluginnname" tags on the forum and to set their notification level to "watching".
2022-05-19 08:25:28 +00:00
Community forums <https://discuss.openedx.org/tag/tutor>
docs: add links to source code/forums/pypi These links are available in the sidebar.
2021-09-16 10:18:06 +00:00
Pypi releases <https://pypi.org/project/tutor>
docs: add link to changelog in project links
2022-01-08 17:57:33 +00:00
Changelog <https://github.com/overhangio/tutor/blob/master/CHANGELOG.md>
docs: add links to source code/forums/pypi These links are available in the sidebar.
2021-09-16 10:18:06 +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
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.
feat: migrate to plugins.v1 with filters & actions This is a very large refactoring which aims at making Tutor both more extendable and more generic. Historically, the Tutor plugin system was designed as an ad-hoc solution to allow developers to modify their own Open edX platforms without having to fork Tutor. The plugin API was simple, but limited, because of its ad-hoc nature. As a consequence, there were many things that plugin developers could not do, such as extending different parts of the CLI or adding custom template filters. Here, we refactor the whole codebase to make use of a generic plugin system. This system was inspired by the Wordpress plugin API and the Open edX "hooks and filters" API. The various components are added to a small core thanks to a set of actions and filters. Actions are callback functions that can be triggered at different points of the application lifecycle. Filters are functions that modify some data. Both actions and filters are collectively named as "hooks". Hooks can optionally be created within a certain context, which makes it easier to keep track of which application created which callback. This new hooks system allows us to provide a Python API that developers can use to extend their applications. The API reference is added to the documentation, along with a new plugin development tutorial. The plugin v0 API remains supported for backward compatibility of existing plugins. Done: - Do not load commands from plugins which are not enabled. - Load enabled plugins once on start. - Implement contexts for actions and filters, which allow us to keep track of the source of every hook. - Migrate patches - Migrate commands - Migrate plugin detection - Migrate templates_root - Migrate config - Migrate template environment globals and filters - Migrate hooks to tasks - Generate hook documentation - Generate patch reference documentation - Add the concept of action priority Close #499.
2022-02-07 17:11:43 +00:00
The Tutor plugin and hooks system is licensed under the terms of the `Apache License, Version 2.0 <https://opensource.org/licenses/Apache-2.0>`__.
Add the lts plugin to the tutor binary
2019-12-25 00:09:53 +00:00
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