Skip to content
This repository was archived by the owner on May 1, 2024. It is now read-only.

Commit 1da75ad

Browse files
authored
docs: Add deprecation notice to readme (#717)
1 parent 4bdfcf9 commit 1da75ad

1 file changed

Lines changed: 18 additions & 21 deletions

File tree

README.rst

Lines changed: 18 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,19 @@
1-
edX Analytics API Server |build-status| |coverage-status|
2-
=========================================================
1+
edX Analytics API Server
2+
========================
3+
4+
DEPRECATION NOTICE
5+
------------------
6+
7+
The Insights product and associated repositories are in the process of being
8+
deprecated and removed from service. Details on the deprecation status and
9+
process can be found in the relevant `Github issue <https://github.com/openedx/public-engineering/issues/221>_`.
10+
11+
This repository may be archived and moved to the openedx-unsupported
12+
Github organization at any time.
13+
14+
The following sections are for historical purposes only.
15+
16+
------------------
317

418
This repository includes the Django server for the API as well as the
519
API package itself. The client is hosted at
@@ -93,8 +107,8 @@ you can follow these steps. If you do not intend to make changes to ``edx-enterp
93107

94108
Devstack Development
95109
~~~~~~~~~~~~~~~~~~~~
96-
#. Clone the `edx-enterprise-data <https://github.com/openedx/edx-enterprise-data>`_ repo into the ``src`` folder alongside your devstack
97-
workspace on the host system.
110+
#. Clone the `edx-enterprise-data <https://github.com/openedx/edx-enterprise-data>`_ repo into the ``src`` folder alongside your devstack
111+
workspace on the host system.
98112
#. The modified ``edx-enterprise-data`` repository will now be available to devstack containers at ``/edx/src/edx-enterprise-data``.
99113
#. Inside the ``edx-data-analytics-api`` container run `pip install `-e /edx/src/edx-enterprise-data``
100114

@@ -202,20 +216,3 @@ Running Tests
202216

203217
Run ``make validate`` install the requirements, run the tests, and run
204218
lint.
205-
206-
How to Contribute
207-
-----------------
208-
209-
Contributions are very welcome, but for legal reasons, you must submit a
210-
signed `individual contributor’s agreement`_ before we can accept your
211-
contribution. See our `CONTRIBUTING`_ file for more information – it
212-
also contains guidelines for how to maintain high code quality, which
213-
will make your contribution more likely to be accepted.
214-
215-
.. _individual contributor’s agreement: http://code.edx.org/individual-contributor-agreement.pdf
216-
.. _CONTRIBUTING: https://github.com/openedx/.github/blob/master/CONTRIBUTING.md
217-
218-
.. |build-status| image:: https://travis-ci.com/edx/edx-analytics-data-api.svg?branch=master
219-
:target: https://travis-ci.com/edx/edx-analytics-data-api
220-
.. |coverage-status| image:: https://img.shields.io/codecov/c/github/edx/edx-analytics-data-api/master.svg
221-
:target: https://codecov.io/gh/edx/edx-analytics-data-api

0 commit comments

Comments
 (0)