Docs.openedx.org
Open edX Official Documentation
Install / Use
/learn @openedx/Docs.openedx.orgREADME
ReadMe
We're so happy you're here! We welcome contributions of all kinds, particularly issues and pull requests. Please read on for instructions on how to participate.
About This Repository
This repository contains source files for the Open edX Documentation_ site. This repository is managed by the Open edX documentation working group, and maintained by the docs-openedx-org-maintainers GitHub group.
The Open edX Documentation_ site contains documentation for:
- Educators
- Learners
- Site Operators
- Developers
Documentation for other components of the Open edX ecosystem is found in each component's repository.
When known, links to other documentation are provided in the Open edX Documentation_.
Submit Documentation Issues
We welcome input from the community on Open edX documentation. You can report a problem or suggest an improvement to the documentation issues by following the Report a Problem instructions <https://docs.openedx.org/en/latest/documentors/how-tos/report_problem_with_docs.html>_.
Contribute to Open edX Documentation
You, the user community, can help update and revise Open edX documentation!
Open edX documentation is published from RST_ source files using Sphinx_.
Here are some resources for getting started:
First docs PR using the GitHub UI <https://docs.openedx.org/en/latest/documentors/quickstarts/first_documentation_pr.html>_Update existing docs through GitHub <https://docs.openedx.org/en/latest/documentors/quickstarts/update_doc_via_github.html>_Add new documentation through GitHub <https://docs.openedx.org/en/latest/documentors/quickstarts/quick_start_add_doc.html>_- More resources available at the
Documentors Homepage <https://docs.openedx.org/en/latest/documentors/index.html>_
Propose Changes While Viewing Documentation
While viewing documentation, you can easily propose a change by selecting suggest edit from the menu under the GitHub icon. The page you are viewing then opens in GitHub, in edit mode. When you save your edits, create a new branch, commit your changes, and create a new Pull Request, to have your changes reviewed by the Open edX team.
Build and Test Documentation Locally
For developers comfortable pulling down the repository locally and making changes (see GitHub Flow_), you can build the documentation directly on your machine.
See the How-to Develop Documentation Locally_ guide.
.. _Open edX Documentation: https://docs.openedx.org/ .. _GitHub repository: https://github.com/openedx/docs.openedx.org .. _RST: https://en.wikipedia.org/wiki/ReStructuredText .. _Sphinx: https://www.sphinx-doc.org/ .. _GitHub Flow: https://docs.github.com/en/get-started/using-github/github-flow .. _How-to Develop Documentation Locally: https://docs.openedx.org/en/latest/documentors/how-tos/develop_docs_locally.html
