Skip to content
This repository has been archived by the owner on Jan 19, 2024. It is now read-only.

docs: mark bok-choy as deprecated #364

Merged
merged 2 commits into from
Feb 18, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
------------

Expand Down
9 changes: 9 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down