This page lists items you should check when you are creating new documentation. We recommend reviewing this list before you create a pull request.
Make sure your documentation is targeted to the right audience and organized under that audience’s section of the documentation. Each topic in the documentation is for one of the following audiences:
Ensure that new topics are stored in the directory for the appropriate audience, under the
For more information, see Documentation Audiences.
Each topic in the documentation is one of four types:
Ensure that you have clearly identified the types of new topics you have created, and have stored new files in the directory for that topic type.
For more information, see Documentation Content Types.
New Topics in TOCs#
Every new topic must be added to a table of contents. Add each new topic to the audience home page in the appropriate place.
Ensure that the new documentation adheres to RST standards and Open edX best practices. You should use Documentation Templates as much as possible, and review Getting Started.
All new images should be placed in the
source/_images directory and referenced in the RST file as:
Line of content, followed by a line with an image. .. image:: /_images/image-file-name Or, a line of content, followed by a clickable thumbnail of a large image. .. thumbnail:: /_images/image-file-name
External links should be stored one in the
source/links.txt file in the form:
.. _Link Name: URL
Then referenced in topics as:
Link Name in the entire documentation project must be unique.
Review Documentation in the Pull Request#
When you create a pull request, a version of the documentation with your changes is automatically built, as a website that matches
https://docs.openedx.org except for your changes. You can tell that the site built for your pull request is different than the main Open edX documentation because the URL includes your pull request number, and because the following warning appears at the top of each page:
You must ensure that the documentation for the pull request builds successfully, with no errors or warnings. You can access documentation build information in the pull request. The following example shows a successful documentation build:
In the pull request, click Details to see the documentation with your changes. Ensure the changes are published in the way you expect.
If there is an error when building the documentation, the pull request will indicate that checks failed, and the Details link will take you to the error message. If you are able to fix the issue indicated by the error message, do so; if not, contact the Open edX team for assistance.