This repository has been archived by the owner on Aug 21, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 132
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Add deprecation notice to readme (#1566)
* docs: Add deprecation notice to readme
- Loading branch information
Showing
1 changed file
with
14 additions
and
23 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,20 @@ | ||
Part of [Open edX](https://open.edx.org/) | ||
|
||
edX Analytics Dashboard [![CoverageStatus](https://img.shields.io/coveralls/edx/edx-analytics-dashboard.svg)](https://coveralls.io/r/edx/edx-analytics-dashboard?branch=master) | ||
edX Analytics Dashboard | ||
======================= | ||
Dashboard to display course analytics to course teams | ||
|
||
# DEPRECATION NOTICE | ||
|
||
The Insights product and associated repositories are in the process of being | ||
deprecated and removed from service. Details on the deprecation status and | ||
process can be found in the relevant [Github issue](https://github.com/openedx/public-engineering/issues/221). | ||
|
||
This repository may be archived and moved to the openedx-unsupported | ||
Github organization at any time. | ||
|
||
The following sections are for historical purposes only. | ||
|
||
--- | ||
|
||
Prerequisites | ||
------------- | ||
* Python 3.8.x | ||
|
@@ -231,20 +242,6 @@ The code in this repository is licensed under version 3 of the AGPL unless other | |
|
||
Please see `LICENSE.txt` for details. | ||
|
||
How to Contribute | ||
----------------- | ||
|
||
Contributions are very welcome, but for legal reasons, you must submit a signed | ||
[individual contributor's agreement](https://openedx.org/cla) | ||
before we can accept your contribution. See our | ||
[CONTRIBUTING](https://github.com/openedx/.github/blob/master/CONTRIBUTING.md) | ||
file for more information -- it also contains guidelines for how to maintain | ||
high code quality, which will make your contribution more likely to be accepted. | ||
|
||
### JavaScript Code Quality | ||
JavaScript developers should adhere to the [edX JavaScript standards](https://github.com/openedx/edx-platform/wiki/Javascript-standards-for-the-edx-platform). | ||
These standards are enforced using [JSHint](http://www.jshint.com/) and [jscs](https://www.npmjs.org/package/jscs). | ||
|
||
Testing | ||
------- | ||
|
||
|
@@ -320,9 +317,3 @@ HTTP status codes. Use the command below to execute this script. | |
Reporting Security Issues | ||
------------------------- | ||
Please do not report security issues in public. Please email [email protected]. | ||
|
||
|
||
Mailing List and IRC Channel | ||
---------------------------- | ||
You can discuss this code on the [edx-code Google Group](https://groups.google.com/forum/#!forum/edx-code) or in the | ||
`edx-code` IRC channel on Freenode. |