The steps below contain links to pages with detailed information about how to perform that step.
Before you begin, make sure you have the right tools.
- Clone the GitHub edx-documentation repo.
- Create a branch.
- Locate and edit the .rst files. See the table at 3. Locate and Edit Documentation for file locations for various documentation products.
- Verify and test the documentation. Note that testing the documentation is required.
- Commit and push changes, then submit a pull request. Fill in the automatically created template.
- Rebase and squash commits if necessary. Merge your changes.
- Ask a member of the doc team to publish the updated guide on ReadTheDocs. After the changes are published, make sure to view the updated guide to make sure changes appear correctly.