1- ###################
2- edX Documentation
3- ###################
1+ ###############################
2+ edX Documentation (Deprecated)
3+ ###############################
4+
5+ Note: This repository is now deprecated. See `the associated DEPR ticket `_.
46
57The edx-documentation repository contains source files for most of the
6- documentation for edX partners and the Open edX community .
8+ documentation for edx.org partners and learners .
79
8- * A new site, `docs.openedx.org `_, is currently being built. Before adding new
9- documentation to this repo, consider if the documentation should be added, or
10- moved, to the new site. See the rationale for this decision, as well as more
10+ * A new site, `docs.openedx.org `_, now hosts documentation for the Open edX community.
11+ See the rationale for the decision to move to a new site, as well as more
1112 on how the new site is organized, in `this decision document `_.
1213
1314* API documentation that includes docstrings from code files is stored in the
1415 repository of that module.
1516
16- * Documentation source files for Insights is in the edx-analytics-dashboard
17+ * Documentation source files for Insights (deprecated) is in the edx-analytics-dashboard
1718 repository.
1819
1920Documentation for developers, researchers, course staff, and students is
@@ -23,6 +24,8 @@ located in the language-specific subdirectories.
2324
2425.. _this decision document : https://docs.openedx.org/en/latest/documentors/decisions/0001-purpose-of-this-repo.html
2526
27+ .. _the associated DEPR ticket : https://github.com/openedx/edx-documentation/issues/2319
28+
2629******************************
2730View Published Documentation
2831******************************
@@ -32,51 +35,23 @@ documentation are available through `docs.edx.org`_.
3235
3336.. _docs.edx.org : http://docs.edx.org
3437
35- ******************************
36- Submit Documentation Issues
37- ******************************
38-
39- You may submit issues via the `edx-documentation GitHub Issues `_ system.
40-
41- .. _edx-documentation GitHub Issues : https://github.com/openedx/edx-documentation/issues
42-
4338**********************************
44- Contribute to edX Documentation
39+ About edX Documentation
4540**********************************
4641
47- You, the user community, can help update and revise edX documentation.
48-
4942edX documentation is published from `RST `_ source files using `Sphinx `_.
5043
5144.. _RST : http://docutils.sourceforge.net/rst.html
5245.. _Sphinx : http://sphinx-doc.org
5346
54- To suggest a revision, fork the project, make changes in your fork, and submit
55- a pull request back to the original project: this is known as the `GitHub
56- Flow `_.
57-
58- .. _GitHub Flow : https://github.com/blog/1557-github-flow-in-the-browser
59-
60- All pull requests need approval from project maintainers, who will look over and
61- review your contributions.
62-
63- ============================================
64- Supplying Information with a Pull Request
65- ============================================
66-
67- The edX documentation team created a template that is automatically added to pull requests. You are strongly encouraged to use this template.
68-
6947======================
70- Testing a Contribution
48+ Testing
7149======================
7250
73- Before submitting a pull request, it is recommended you run the test suite on
74- your contribution to ensure it can be compiled into HTML format without errors.
75-
7651You may first need to install `GraphViz <http://graphviz.org/ >`_.
7752See the `Download Page <http://graphviz.org/download/ >`_ for more instructions on how to install for your particular Operating System.
7853
79- To run a test compilation of a contribution , first install the prerequisites.
54+ To run a test compilation, first install the prerequisites.
8055
8156.. code ::
8257
0 commit comments