From 66d27b93cd3e58a866ac5174bb3080b5d444d8d9 Mon Sep 17 00:00:00 2001 From: Diana Huang Date: Fri, 2 Feb 2024 12:40:42 -0500 Subject: [PATCH] docs: Update README with a deprecation notice. (#1267) https://github.com/openedx/devstack/issues/907 --- README.rst | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index f67ae5da06..15c3d45f6c 100644 --- a/README.rst +++ b/README.rst @@ -1,14 +1,21 @@ -Open edX Devstack +Devstack ################# |ci-provisioning-badge| |ci-cli-badge| |doc-badge| |license-badge| |status-badge| -Purpose -******* -Devstack is a local Docker-based environment for developing in the Open edX -platform. Use it to get up and running quickly with Open edX services. +DEPRECATION NOTICE +****************** + +Going forward, devstack will be primarily used for development by 2U. To do development +on Open edX, it is recommended that `Tutor`_ be used instead. + +For more information on this deprecation, please visit the `associated deprecation ticket`_. + +.. _Tutor: https://docs.tutor.edly.io/ +.. _associated deprecation ticket: https://github.com/openedx/devstack/issues/907 + Getting Started ***************