From 0a6516681b1bce568e66de7b944ee4b85890790a Mon Sep 17 00:00:00 2001 From: Maria Fernanda Magallanes Zubillaga Date: Wed, 18 Sep 2024 11:01:58 -0500 Subject: [PATCH] docs: add tutor compatibility notes --- docs/install.rst | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/docs/install.rst b/docs/install.rst index 7645fbf..b5d8cca 100644 --- 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