Skip to content

Commit

Permalink
docs: update compatibility notes and remove eox-core because is being…
Browse files Browse the repository at this point in the history
… installed as dependency
  • Loading branch information
dcoa committed Jun 19, 2024
1 parent c43fe0f commit 42bc898
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 24 deletions.
28 changes: 6 additions & 22 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,11 @@ Installation
============

#. Install a new fresh instance of tutor following `this steps <https://docs.tutor.overhang.io/quickstart.html#quickstart-1-click-install>`_. *If your instance is running, you can skip this step.*
#. Add to the Tutor configuration in the file ``cat "$(tutor config printroot)/config.yml"`` these lines that install eox-tagging and eox-core lib:
#. Add to the Tutor configuration in the file ``cat "$(tutor config printroot)/config.yml"`` these lines that install eox-tagging lib:

.. code-block:: yaml
OPENEDX_EXTRA_PIP_REQUIREMENTS:
- eox_core
- eox_tagging
#. Build the openedx image by doing ``tutor images build openedx``.
Expand Down Expand Up @@ -53,27 +52,12 @@ Compatibility Notes
| Quince | >= 7.0 |
+------------------+--------------+

The following changes to the plugin settings are necessary. If the release you are looking for is
not listed, then the accumulation of changes from previous releases is enough.
The plugin is configured for the latest release (Quince).

**Ironwood**
We will list here the changes in the plugin settings that should be applied to be used for previous releases. If the release you are looking for is not listed,
the actual configuration is sufficient or incompatible with the current eox-tagging version.

.. code-block:: yaml
EOX_TAGGING_GET_ENROLLMENT_OBJECT: "eox_tagging.edxapp_wrappers.backends.enrollment_i_v1"
EOX_TAGGING_GET_COURSE_OVERVIEW: "eox_tagging.edxapp_wrappers.backends.course_overview_i_v1"
EOX_TAGGING_BEARER_AUTHENTICATION: "eox_tagging.edxapp_wrappers.backends.bearer_authentication_i_v1"
**Koa, Lilac, Maple, Nutmeg, Olive**

.. code-block:: yaml
EOX_TAGGING_GET_ENROLLMENT_OBJECT: "eox_tagging.edxapp_wrappers.backends.enrollment_l_v1"
Those settings can be changed in ``eox_tagging/settings/common.py`` or the instance settings.

**NOTE**: the current ``common.py`` works with Open edX Quince and Palm versions.
If you are installing a previous version, please refer to the tag to verify the configuration that should be applied.

Usage
======
Expand Down Expand Up @@ -323,4 +307,4 @@ quality, which will make your contribution more likely to be accepted.
License
=======

This project is licensed under the AGPL-3.0 License. See the LICENSE file for details.
This project is licensed under the AGPL-3.0 License. See the LICENSE file for details.
2 changes: 1 addition & 1 deletion eox_tagging/settings/production.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@
def plugin_settings(settings): # pylint: disable=unused-argument
"""
Set of plugin settings used by the Open Edx platform.
More info: https://github.com/edx/edx-platform/blob/master/openedx/core/djangoapps/plugins/README.rst
More info: https://github.com/openedx/edx-platform/blob/master/openedx/core/djangoapps/plugins/README.rst
"""
2 changes: 1 addition & 1 deletion eox_tagging/settings/test.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ class SettingsClass:
def plugin_settings(settings): # pylint: disable=function-redefined
"""
Set of plugin settings used by the Open Edx platform.
More info: https://github.com/edx/edx-platform/blob/master/openedx/core/djangoapps/plugins/README.rst
More info: https://github.com/eopenedx/edx-platform/blob/master/openedx/core/djangoapps/plugins/README.rst
"""
settings.EOX_TAGGING_SKIP_VALIDATIONS = True
settings.EOX_TAGGING_LOAD_PERMISSIONS = False
Expand Down

0 comments on commit 42bc898

Please sign in to comment.