docs: mark bok-choy as deprecated (#364)

openedx-unsupported · Feb 18, 2022 · b9fcace · b9fcace
1 parent c70246c
commit b9fcace
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 1 deletion.
diff --git a/README.rst b/README.rst
@@ -29,13 +29,19 @@ UI-level acceptance test framework.  `Full documentation available on ReadTheDoc
 
 __ http://bok-choy.readthedocs.org/en/latest/
 
+⚠️ Deprecation Notice ⚠️
+------------------------
+
+As of 2022-02-18, `bok-choy is deprecated <https://github.com/openedx/public-engineering/issues/13>`_.
+All tests written using bok-choy have either been removed or are slated to be removed soon.
+Please do not write new tests using bok-choy!
+In the near future, this repository will be archived.
 
 Overview
 --------
 
 A Python framework for writing robust Selenium tests.
 
-
 Installation
 ------------
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -3,6 +3,15 @@ bok-choy
 
 UI-level acceptance test framework.
 
+.. warning::
+    As of 2022-02-18, `bok-choy is deprecated <https://github.com/openedx/public-engineering/issues/13>`_.
+    All tests written using bok-choy have either been removed or are slated to be removed soon,
+    and the code for the bok-choy framework itself will be archived in the near future.
+
+    If you are trying to write an acceptance or end-to-end test for Open edX code,
+    please use a third-party tool like `Cypress <https://www.cypress.io/>`_ instead.
+
+
 .. toctree::
    :maxdepth: 2