Updating Documentation¶
Documentation updates are easy to make by anyone here on GitHub. Updates are submitted in the form of a GitHub pull request (“PR”) which developers can then review and discuss before merging the change into the documentation.
Note
Before submitting a documentation update, please read the Documentation Quality Guidelines, the Style Guide, the Formatting Guide, and the GitHub documentation on pull requests.
Warning
The following documents assume the submitter already has an account on GitHub.
Edit on GitHub¶
The easiest way to make a changes is to edit the file directly on GitHub.
Navigate to the page to edit in the documentation
Click Edit on GitHub to open the document source in GitHub
Click
to edit the sourceMake changes as needed
Enter an appropriate title and description for the change
Choose the option to start a pull request
Click Propose File Change and follow the prompts to create a pull request
Local Clone¶
Create a fork of the Documentation Source
Clone that fork locally with git
(optionally) Create a new branch named for the update being proposed
Make changes
Commit the changes using an appropriate commit message
Push the changes
From GitHub, initiate a pull request from the local branch to the master branch of the documentation repository.
Pull Requests¶
No matter how the documentation is edited, all methods result in a pull request (PR) that needs to be reviewed and merged. Additionally, changes to the documentation are automatically tested and checked, which makes it easier to spot problems without manual reviews.
After making changes and submitting a pull request, keep an eye on the PR for notes from the automated testing framework as well as notes from developers.