Working with GitHub
We’re excited that you’re interested in contributing to improve and expand our docs! Please take a few moments to get familiar with our procedures before you get started.
To work on Istio documentation, you need to:
Create a GitHub account.
Sign the Contributor License Agreement.
The documentation is published under the Apache 2.0 license.
How to contribute
There are three ways you can contribute to the Istio documentation:
If you want to edit an existing page, you can open up the page in your browser and select the Edit This Page on GitHub option from the gear menu at the top right of each page. This takes you to GitHub to edit and submit the changes.
If you want to work on the site in general, follow the steps in our How to add content section.
If you want to review an existing pull request (PR), follow the steps in our How to review content section
Once your changes are merged, they show up immediately on
preliminary.istio.io. However, the changes only
show up on
istio.io the next time we produce a new
release, which happens around once a quarter.
How to add content
To add content you must create a fork of the repository and a PR from your fork to the docs main repository. The following steps describe the process:
Browse this site’s source code
Click the button above to visit the GitHub repository.
Click the Fork button in the upper-right corner of the screen to create a copy of our repository in your GitHub account.
Create a clone of your fork and make any changes you want.
When you are ready to send those changes to us, push the changes to your fork.
Go to the index page for your fork, and click New Pull Request to let us know about it.
How to review content
If your review is small, simply comment on the PR directly. If you review the content in detail, follow these steps:
Leave a comment on the PR with the text
/hold. This command prevents the PR from being merged before you are able to complete your review.
Perform your detailed review. When possible leave specific comments directly on the files and lines affected.
Provide suggestions to the PR owner in your comments when appropriate. For example:
Use present tense to avoid verb congruence issues and to make the text easier to understand: ```suggestion Pilot maintains an abstract model of the mesh. ```
Publish your review to share your comments and suggestions with us and the PR owner. Request changes as the review warrants.
Once you publish your review, leave a comment with the text:
/hold cancel. That command unblocks the PR from being merged.
Previewing your work
When you submit a pull request, your PR page on GitHub shows a link to a staging site built automatically for your PR. This is useful for you to see what the final page looks like to end-users. Folks reviewing your pull request also use this staging site to make sure everything looks good.
If you created a fork of the repository, you can preview your changes locally. See this README for instructions.
Istio community roles
Depending on your contributions and responsibilities, there are several roles you can assume.
Visit our role summary page to learn about the roles, the related requirements and responsibilities, and the privileges associated with the roles.
Visit our community page to learn more about the Istio community in general.