docs: add tutor compatibility notes

overhangio · Sep 24, 2024 · 0a65166 · 0a65166
1 parent 47873ac
commit 0a65166
Showing 1 changed file with 28 additions and 0 deletions.
diff --git a/docs/install.rst b/docs/install.rst
@@ -130,6 +130,34 @@ The process for upgrading from one major release to the next works similarly to
     tutor local upgrade --from=quince
     tutor local launch
 
+
+Running older releases of Open edX
+-------------------------------------
+
+Instructions for installing the appropriate Tutor version for older Open edX releases. Each command ensures compatibility between Open edX and its corresponding Tutor version. For more details on versioning conventions in Tutor, see the :ref:`versioning` section.
+
++-------------------+---------------+--------------------------------------------+
+| Open edX Release  | Tutor version | Installation command                       |
++===================+===============+============================================+
+| Juniper           | v10           | pip install 'tutor[full]>=10.0.0,<11.0.0'  |
++-------------------+---------------+--------------------------------------------+
+| Koa               | v11           | pip install 'tutor[full]>=11.0.0,<12.0.0'  |
++-------------------+---------------+--------------------------------------------+
+| Lilac             | v12           | pip install 'tutor[full]>=12.0.0,<13.0.0'  |
++-------------------+---------------+--------------------------------------------+
+| Maple             | v13           | pip install 'tutor[full]>=13.0.0,<14.0.0'  |
++-------------------+---------------+--------------------------------------------+
+| Nutmeg            | v14           | pip install 'tutor[full]>=14.0.0,<15.0.0'  |
++-------------------+---------------+--------------------------------------------+
+| Olive             | v15           | pip install 'tutor[full]>=15.0.0,<16.0.0'  |
++-------------------+---------------+--------------------------------------------+
+| Palm              | v16           | pip install 'tutor[full]>=16.0.0,<17.0.0'  |
++-------------------+---------------+--------------------------------------------+
+| Quince            | v17           | pip install 'tutor[full]>=17.0.0,<18.0.0'  |
++-------------------+---------------+--------------------------------------------+
+| Redwood           | v18           | pip install 'tutor[full]>=18.0.0,<19.0.0'  |
++-------------------+---------------+--------------------------------------------+
+
 .. _autocomplete:
 
 Shell autocompletion