docs: add tutor compatibility notes

overhangio · Sep 18, 2024 · 0fd8bc0 · 0fd8bc0
1 parent 46b4016
commit 0fd8bc0
Show file tree

Hide file tree

Showing 4 changed files with 42 additions and 0 deletions.
diff --git a/README.rst b/README.rst
@@ -66,6 +66,36 @@ Quickstart
 2. Run ``tutor local launch``
 3. You're done!
 
+.. _compatibility_notes_start:
+
+Compatibility Notes
+--------------------
+
++-------------------+-------------------+
+| Open edX Release  | Tutor version     |
++===================+===================+
+| Juniper           | v10               |
++-------------------+-------------------+
+| Koa               | v11               |
++-------------------+-------------------+
+| Lilac             | v12               |
++-------------------+-------------------+
+| Maple             | v13               |
++-------------------+-------------------+
+| Nutmeg            | v14               |
++-------------------+-------------------+
+| Olive             | v15               |
++-------------------+-------------------+
+| Palm              | v16               |
++-------------------+-------------------+
+| Quince            | v17               |
++-------------------+-------------------+
+| Redwood           | v18               |
++-------------------+-------------------+
+
+
+.. _compatibility_notes_end:
+
 Documentation
 -------------
 

diff --git a/changelog.d/20240918_121327_maria.magallanes_docs_tutor_version.md b/changelog.d/20240918_121327_maria.magallanes_docs_tutor_version.md
@@ -0,0 +1 @@
+[Documentation] Add compatibility notes, so you find info about what version of Tutor you should install by the Open edX release you need. (by @MaferMazu)
diff --git a/docs/download/pip.rst b/docs/download/pip.rst
@@ -1,3 +1,7 @@
 .. parsed-literal::
 
+    # To download the latest release
     pip install "tutor[full]"
+
+    # Or pip install tutor==<tutor_version>
+    # See the section about :ref:`compatibility_notes` for more details.
diff --git a/docs/index.rst b/docs/index.rst
@@ -42,6 +42,13 @@ Tutor: the Docker-based Open edX distribution designed for peace of mind
    Pypi releases <https://pypi.org/project/tutor>
    Changelog <https://github.com/overhangio/tutor/blob/master/CHANGELOG.md>
 
+.. _compatibility_notes:
+
+.. include:: ../README.rst
+    :start-after: _compatibility_notes_start:
+    :end-before: _compatibility_notes_end:
+
+
 Source code
 -----------