Skip to content

Commit

Permalink
fix: remove references to the wizard edition
Browse files Browse the repository at this point in the history
  • Loading branch information
CodeWithEmad authored Aug 3, 2023
1 parent 63c8f8e commit 8414200
Show file tree
Hide file tree
Showing 6 changed files with 6 additions and 8 deletions.
1 change: 0 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,6 @@ Features
* 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>`__...
* Extensible architecture with `plugins <https://docs.tutor.overhang.io/plugins/index.html>`__
* Works with `Kubernetes <https://docs.tutor.overhang.io/k8s.html>`__
* 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.
* No technical skill required with the `zero-click Tutor AWS image <https://docs.tutor.overhang.io/install.html#zero-click-aws-installation>`__

.. _readme_intro_end:
Expand Down
1 change: 1 addition & 0 deletions changelog.d/20230801_201804_codewithemad_remove_wizard.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
- [Improvement] Wizard references removed. (by @CodeWithEmad)
2 changes: 1 addition & 1 deletion docs/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ What features are missing from Tutor?

Tutor tries very hard to support all major Open edX features, notably in the form of :ref:`plugins <existing_plugins>`. If you are interested in sponsoring the development of a new plugin, please `get in touch <mailto:[email protected]>`__!

It should be noted that the `Insights <https://github.com/openedx/edx-analytics-pipeline>`__ stack is currently unsupported, because of its complexity, lack of support, and extensibility. To replace it, Overhang.IO developed `Cairn <https://overhang.io/tutor/plugin/cairn>`__ the next-generation analytics solution for Open edX, part of the `Tutor Wizard Edition <https://overhang.io/tutor/wizardedition>`__. You should check it out 😉
It should be noted that the `Insights <https://github.com/openedx/edx-analytics-pipeline>`__ stack is currently unsupported, because of its complexity, lack of support, and extensibility. To replace it, Overhang.IO developed `Cairn <https://overhang.io/tutor/plugin/cairn>`__ the next-generation analytics solution for Open edX. You should check it out 😉

Are there people already running this in production?
----------------------------------------------------
Expand Down
5 changes: 2 additions & 3 deletions docs/plugins/intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,13 +45,12 @@ Many plugins are available from plugin indexes. These indexes are lists of plugi
tutor plugins update
tutor plugins search

More plugins can be downloaded from the "contrib" and "wizard" indexes::
More plugins can be downloaded from the "contrib" index::

tutor plugins index add contrib
tutor plugins index add wizard
tutor plugins search

The "main", "contrib" and "wizard" indexes include a curated list of plugins that are well maintained and introduce useful features to Open edX. These indexes are maintained by `Overhang.IO <https://overhang.io>`__. For more information about these indexes, refer to the official `overhangio/tpi <https://github.com/overhangio/tpi>`__ repository.
The "main" and "contrib" indexes include a curated list of plugins that are well maintained and introduce useful features to Open edX. These indexes are maintained by `Overhang.IO <https://overhang.io>`__. For more information about these indexes, refer to the official `overhangio/tpi <https://github.com/overhangio/tpi>`__ repository.

Thanks to these indexes, it is very easy to download and upgrade plugins. For instance, to install the `notes plugin <https://github.com/overhangio/tutor-notes/>`__::

Expand Down
4 changes: 2 additions & 2 deletions tutor/commands/plugins.py
Original file line number Diff line number Diff line change
Expand Up @@ -382,8 +382,8 @@ def index_add(context: Context, url: str) -> None:
The index URL will be appended with '{version}/plugins.yml'. The index path can be
either an http(s) url or a local file path.
For official indexes, there is no need to pass a full URL. Instead, use "main",
"contrib" or "wizard".
For official indexes, there is no need to pass a full URL. Instead, use "main" or
"contrib".
"""
config = tutor_config.load_minimal(context.root)
if indexes.add(url, config):
Expand Down
1 change: 0 additions & 1 deletion tutor/plugins/indexes.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@ def _get_index_url_from_alias(url: str) -> str:
known_aliases = {
"main": "https://overhang.io/tutor/main",
"contrib": "https://overhang.io/tutor/contrib",
"wizard": "https://overhang.io/tutor/wizard",
}
return known_aliases.get(url, url)

Expand Down

0 comments on commit 8414200

Please sign in to comment.