Update A Doc via GitHub#

This how-to will take you through the process of submitting an update to a page that you are looking at within the Open edX documnetation.

Prerequisites#

  • You’re on the published documentation page at some address like docs.openedx.org/... and you want to make changes to it.

  • You have a GitHub Account

  1. In the github UI, make any edits you need to make.

1. Edit a file#

  1. On the page you want to edit, find the suggest edit link.

    #TODO: Add a picture.

  2. Make the necessary changes.

    Ensure you keep to RST standards in file. See the Quick Reference: Writing RST a quick reference to RST.

  3. In the Commit Changes section at the bottom of the edit window:

    1. Add a comment about the changes you made.

    2. Click Commit changes to save these changes to your branch.

2. Create a Pull Request#

When you are ready to have the Open edX team review your proposed documentation changes, you create a pull request.

  1. Once you have clicked the Commit changes button

  2. Click Create pull request.

  3. In the pull request, add a description of your changes.

  4. Click Create pull request button again to complete submitting your changes.

The Open edX team will then review your changes. If they approve, they will merge the pull request, and you will see your changes in the latest documentation. The Open edX team may ask you to make further changes, to clarify the documentation or fix issues.