Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README and PR template with latest info #2134

Merged
merged 2 commits into from
Apr 14, 2023
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
1 change: 0 additions & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ Possible roles follow. The PR submitter checks the boxes after each reviewer fin

- [ ] Subject matter expert:
- [ ] Subject matter expert:
- [ ] Doc team review (sanity check, copy edit, or dev edit?): @edx/doc
- [ ] Product review:
- [ ] Partner support:
- [ ] PM review:
Expand Down
29 changes: 17 additions & 12 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
###################
EdX Documentation
edX Documentation
###################

The edx-documentation repository contains source files for most of the
documentation for edX partners and the Open edX community. This repository is
managed by the edX Documentation team.
documentation for edX partners and the Open edX community.

* A new site, `docs.openedx.org`_, is currently being built. Before adding new
documentation to this repo, consider if the documentation should be added, or
moved, to the new site. See the rationale for this decision, as well as more
on how the new site is organized, in `this decision document`_.

* API documentation that includes docstrings from code files is stored in the
repository of that module.
Expand All @@ -15,11 +19,15 @@ managed by the edX Documentation team.
Documentation for developers, researchers, course staff, and students is
located in the language-specific subdirectories.

.. _docs.openedx.org: https://docs.openedx.org

.. _this decision document: https://docs.openedx.org/en/latest/documentors/decisions/0001-purpose-of-this-repo.html

******************************
View Published Documentation
******************************

EdX documentation is published through Read the Docs. Links to all published
edX documentation is published through Read the Docs. Links to all published
documentation are available through `docs.edx.org`_.

.. _docs.edx.org: http://docs.edx.org
Expand All @@ -28,20 +36,17 @@ documentation are available through `docs.edx.org`_.
Submit Documentation Issues
******************************

We welcome input from the community on any documentation issues. You can
submit issues to the Documentation project in the `Open edX JIRA board`_.

.. _Open edX JIRA board: https://openedx.atlassian.net
You may submit issues via the `edx-documentation GitHub Issues`_ system.

You can also email [email protected].
.. _edx-documentation GitHub Issues: https://github.com/openedx/edx-documentation/issues

**********************************
Contribute to edX Documentation
**********************************

You, the user community, can help update and revise edX documentation.

EdX documentation is published from `RST`_ source files using `Sphinx`_.
edX documentation is published from `RST`_ source files using `Sphinx`_.

.. _RST: http://docutils.sourceforge.net/rst.html
.. _Sphinx: http://sphinx-doc.org
Expand All @@ -52,8 +57,8 @@ Flow`_.

.. _GitHub Flow: https://github.com/blog/1557-github-flow-in-the-browser

All pull requests need approval from edX. For more information, contact edX at
[email protected].
All pull requests need approval from project maintainers, who will look over and
review your contributions.

============================================
Supplying Information with a Pull Request
Expand Down