Skip to content

Commit

Permalink
docs: Add version compatibility matrix
Browse files Browse the repository at this point in the history
Explain which tagged release, and which Git branch, is compatible with
which Open edX/Tutor release.
  • Loading branch information
foadlind committed Aug 9, 2022
1 parent 577ab71 commit 55fe890
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,25 @@ This is an **experimental** plugin for
[Tutor](https://docs.tutor.overhang.io) that enables the [user retirement
feature](https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/configuration/user_retire/index.html) in Open edX.

Version compatibility matrix
----------------------------
You must install a supported release of this plugin to match the Open
edX and Tutor version you are deploying. If you are installing this
plugin from a branch in this Git repository, you must select the
appropriate one:

| Open edX release | Tutor version | Plugin branch | Plugin release |
|------------------|-------------------|---------------|----------------|
| Lilac | `>=12.0, <13` | Not supported | Not supported |
| Maple | `>=13.2, <14`[^1] | `maple` | 0.1.x |
| Nutmeg | `>=14.0, <15` | `main` | 1.x.x |

[^1]: For Open edX Maple and Tutor 13, you must run version 13.2.0 or
 later. That is because this plugin uses the Tutor v1 plugin API,
[which was introduced with that
 release](https://github.com/overhangio/tutor/blob/master/CHANGELOG.md#v1320-2022-04-24).

Installation
------------

Expand Down

0 comments on commit 55fe890

Please sign in to comment.