christianlight/tutor
6
0
Fork 0
mirror of https://github.com/ChristianLight/tutor.git synced 2024-11-11 07:41:02 +00:00
Code Issues Releases Activity
4af9fed338
tutor/README.rst

97 lines
4.5 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
.. _readme_intro_start:
docs: minor formatting/link improvements
2022-01-18 08:25:35 +00:00
Tutor: the Docker-based Open edX distribution designed for peace of mind
Improve docs - Add tutor logo - add "edit on github" links - modify theme colors - and various other things...
2019-10-17 15:20:22 +00:00
========================================================================
Improve documentation
2018-12-26 15:00:47 +00:00
Fix tutor logo link in docs
2020-01-10 14:23:05 +00:00
.. image:: https://overhang.io/static/img/tutor-logo.svg
Improve docs - Add tutor logo - add "edit on github" links - modify theme colors - and various other things...
2019-10-17 15:20:22 +00:00
:alt: Tutor logo
:width: 500px
:align: center
docs: minor formatting/link improvements
2022-01-18 08:25:35 +00:00
|
docs: shields that are actually useful It is unnecessary to point to CI, or to indicate the doc version. Instead, we link directly to the source code. Also, we improve the icon colors and general appearance.
2021-09-16 11:03:34 +00:00
.. image:: https://img.shields.io/static/v1?logo=github&label=Git&style=flat-square&color=brightgreen&message=Source%20code
:alt: Source code
:target: https://github.com/overhangio/tutor
Improve documentation
2018-12-26 15:00:47 +00:00
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
.. image:: https://img.shields.io/static/v1?logo=discourse&label=Forums&style=flat-square&color=ff0080&message=discuss.openedx.org
docs: shields that are actually useful It is unnecessary to point to CI, or to indicate the doc version. Instead, we link directly to the source code. Also, we improve the icon colors and general appearance.
2021-09-16 11:03:34 +00:00
:alt: Forums
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
:target: https://discuss.openedx.org/tag/tutor
Add documentation status badge
2019-02-19 21:37:59 +00:00
docs: shields that are actually useful It is unnecessary to point to CI, or to indicate the doc version. Instead, we link directly to the source code. Also, we improve the icon colors and general appearance.
2021-09-16 11:03:34 +00:00
.. image:: https://img.shields.io/static/v1?logo=readthedocs&label=Documentation&style=flat-square&color=blue&message=docs.tutor.overhang.io
:alt: Documentation
:target: https://docs.tutor.overhang.io
Improve documentation
2018-12-26 15:00:47 +00:00
docs: shields that are actually useful It is unnecessary to point to CI, or to indicate the doc version. Instead, we link directly to the source code. Also, we improve the icon colors and general appearance.
2021-09-16 11:03:34 +00:00
.. image:: https://img.shields.io/pypi/v/tutor?logo=python&logoColor=white
:alt: PyPI releases
:target: https://pypi.org/project/tutor
Improve documentation
2018-12-26 15:00:47 +00:00
Improve docs - Add tutor logo - add "edit on github" links - modify theme colors - and various other things...
2019-10-17 15:20:22 +00:00
.. image:: https://img.shields.io/github/license/overhangio/tutor.svg?style=flat-square
docs: shields that are actually useful It is unnecessary to point to CI, or to indicate the doc version. Instead, we link directly to the source code. Also, we improve the icon colors and general appearance.
2021-09-16 11:03:34 +00:00
:alt: AGPL License
:target: https://www.gnu.org/licenses/agpl-3.0.en.html
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
docs: shields that are actually useful It is unnecessary to point to CI, or to indicate the doc version. Instead, we link directly to the source code. Also, we improve the icon colors and general appearance.
2021-09-16 11:03:34 +00:00
.. image:: https://img.shields.io/static/v1?logo=twitter&label=Twitter&style=flat-square&color=1d9bf0&message=@overhangio
:alt: Follow us on Twitter
:target: https://twitter.com/overhangio/
docs: advertise Cairn and the maintainers group Here we add to the docs a few shameless plugs about Cairn -- because it's really awesome! We also add a few improvements to the wording, here and there.
2021-06-25 14:52:05 +00:00
docs: shields that are actually useful It is unnecessary to point to CI, or to indicate the doc version. Instead, we link directly to the source code. Also, we improve the icon colors and general appearance.
2021-09-16 11:03:34 +00:00
.. image:: https://img.shields.io/static/v1?logo=youtube&label=YouTube&style=flat-square&color=ff0000&message=@overhangio
docs: advertise Cairn and the maintainers group Here we add to the docs a few shameless plugs about Cairn -- because it's really awesome! We also add a few improvements to the wording, here and there.
2021-06-25 14:52:05 +00:00
:alt: Follow us on Youtube
:target: https://www.youtube.com/c/OverhangIO
minor typos fixed
2022-03-27 10:36:55 +00:00
**Tutor** is the official Docker-based `Open edX <https://openedx.org>`_ distribution, both for production and local development. The goal of Tutor is to make it easy to deploy, customise, upgrade and scale Open edX. Tutor is reliable, fast, extensible, and it is already used to deploy hundreds of Open edX platforms around the world.
Hey America! Please do not fuck this up.
2020-10-01 09:15:47 +00:00
v11.0.0 (2020-12-09) - 💥[Improvement] Upgrade Open edX to Koa - 💥 Setting changes: - The ``ACTIVATE_HTTPS`` setting was renamed to ``ENABLE_HTTPS``. - Other ``ACTIVATE_*`` variables were all renamed to ``RUN_*``. - The ``WEB_PROXY`` setting was removed and ``RUN_CADDY`` was added. - The ``NGINX_HTTPS_PORT`` setting is deprecated. - Architectural changes: - Use Caddy as a web proxy for automated SSL/TLS certificate generation: - Nginx no longer listens to port 443 for https traffic - The Caddy configuration file comes with a new ``caddyfile`` patch for much simpler SSL/TLS management. - Configuration files for web proxies are no longer provided. - Kubernetes deployment no longer requires setting up a custom Ingress resource or custom manager. - Gunicorn and Whitenoise are replaced by uwsgi: this increases boostrap performance and makes it no longer necessary to mount media folders in the Nginx container. - Replace memcached and rabbitmq by redis. - Additional features: - Make it possible to disable all plugins at once with ``plugins disable all``. - Add ``tutor k8s wait`` command to wait for a pod to become ready - Faster, more reliable static assets with local memory caching - Deprecation: proxy files for Apache and Nginx are no longer provided out of the box. - Removed plugin `{{ patch (...) }}` statements: - "https-create", "k8s-ingress-rules", "k8s-ingress-tls-hosts": these are no longer necessary. Instead, declare your app in the "caddyfile" patch. - "local-docker-compose-nginx-volumes": this patch was primarily used to serve media assets. The recommended is now to serve assets with uwsgi.
2020-09-17 10:53:14 +00:00
Do you need professional assistance setting up or managing your Open edX platform? Overhang.IO provides online support as part of its `Long Term Support (LTS) offering <https://overhang.io/tutor/pricing>`__.
Hey America! Please do not fuck this up.
2020-10-01 09:15:47 +00:00
Coolify readme
2019-10-07 12:26:17 +00:00
Features
--------
* 100% `open source <https://github.com/overhangio/tutor>`__
* Runs entirely on Docker
Add scorm xblock to the openedx docker image
2020-04-25 12:20:13 +00:00
* World-famous 1-click `installation and upgrades <https://docs.tutor.overhang.io/install.html>`__
chore: update android app repository url
2021-12-14 18:27:20 +00:00
* Comes with batteries included: `theming <https://github.com/overhangio/indigo>`__, `SCORM <https://github.com/overhangio/openedx-scorm-xblock>`__, `HTTPS <https://docs.tutor.overhang.io/configuration.html#ssl-tls-certificates-for-https-access>`__, `web-based administration interface <https://github.com/overhangio/tutor-webui>`__, `mobile app <https://github.com/overhangio/tutor-android>`__, `custom translations <https://docs.tutor.overhang.io/configuration.html#adding-custom-translations>`__...
docs: fix plugins broken link
2022-05-18 09:27:27 +00:00
* Extensible architecture with `plugins <https://docs.tutor.overhang.io/plugins/index.html>`__
Add scorm xblock to the openedx docker image
2020-04-25 12:20:13 +00:00
* Works with `Kubernetes <https://docs.tutor.overhang.io/k8s.html>`__
docs: advertise Cairn and the maintainers group Here we add to the docs a few shameless plugs about Cairn -- because it's really awesome! We also add a few improvements to the wording, here and there.
2021-06-25 14:52:05 +00:00
* Amazing premium plugins available in the `Tutor Wizard Edition <https://overhang.io/tutor/wizardedition>`__, including `Cairn <https://overhang.io/tutor/plugin/cairn>`__ the next-generation analytics solution for Open edX.
docs: minor formatting/link improvements
2022-01-18 08:25:35 +00:00
* No technical skill required with the `zero-click Tutor AWS image <https://docs.tutor.overhang.io/install.html#zero-click-aws-installation>`__
Improve docs wording and de-duplicate from readme The sphinx `include` directive is great!
2019-04-25 07:30:48 +00:00
.. _readme_intro_end:
Improve documentation
2018-12-26 15:00:47 +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:: ./docs/img/quickstart.gif
:alt: Tutor local quickstart
:target: https://terminalizer.com/view/91b0bfdd557
Improve documentation
2018-12-26 15:00:47 +00:00
Quickstart
----------
Migrate github repo to overhangio organization
2019-06-23 17:56:15 +00:00
1. Install the `latest stable release <https://github.com/overhangio/tutor/releases>`_ of 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
2. Run ``tutor local quickstart``
3. You're done!
Improve documentation
2018-12-26 15:00:47 +00:00
Documentation
-------------
Docs are now hosted with https
2019-02-20 12:52:25 +00:00
Extensive documentation is available online: https://docs.tutor.overhang.io/
Improve documentation
2018-12-26 15:00:47 +00:00
feat: upgrade to open-release/lilac.master One of the breaking changes of this release is the removal of the webui and android features; these are moved to dedicated plugins. This causes a breaking change: the renaming of the DOCKER_IMAGE_ANDROID config variable to ANDROID_DOCKER_IMAGE. See this TEP for reference: https://discuss.overhang.io/t/separate-webui-and-android-from-tutor-core-and-move-to-dedicated-plugins/1473
2021-04-13 20:14:43 +00:00
Is there a problem?
-------------------
Please follow the instructions from the `troubleshooting section <https://docs.tutor.overhang.io/troubleshooting.html>`__ in the docs.
Improve docs wording and de-duplicate from readme The sphinx `include` directive is great!
2019-04-25 07:30:48 +00:00
.. _readme_support_start:
Add links to tutor forums
2019-02-19 21:26:43 +00:00
Support
-------
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
To get community support, go to the official Open edX discussion forum: https://discuss.openedx.org. For official support, please subscribe to a Long Term Support (LTS) license at https://overhang.io/tutor/pricing.
Add links to tutor forums
2019-02-19 21:26: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
.. _readme_support_end:
.. _readme_contributing_start:
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
Contributing
------------
Improve documentation
2018-12-26 15:00:47 +00:00
Update "contributing" section of the readme
2020-12-12 23:43:55 +00:00
We welcome contributions to Tutor! To learn how you can contribute, please check the relevant section of the Tutor docs: `https://docs.tutor.overhang.io/tutor.html#contributing <https://docs.tutor.overhang.io/tutor.html#contributing>`__.
Improve docs wording and de-duplicate from readme The sphinx `include` directive is great!
2019-04-25 07:30:48 +00:00
refactor: migrate from Travis.ci to GitHub Actions GitHub Actions now performs the following tasks: - run tests on every PR - sync with git.overhang.io on push - build binary releases on tags Travis.CI was completely removed from this repo.
2021-05-17 13:39:46 +00:00
.. _readme_contributing_end:
Copy Permalink