2.0 KiB
| title | overview | order | layout | type |
|---|---|---|---|---|
| Creating a Pull Request | Shows you how to create a GitHub pull request in order to submit your docs for approval. | 20 | docs | markdown |
To contribute to Istio documentation, create a pull request against the istio/istio.github.io{: target="_blank"} repository. This page shows the steps necessary to create a pull request.
Before you begin
-
Create a GitHub account{: target="_blank"}.
-
Sign the Contributor License Agreement
Documentation will be published under the Apache 2.0 license.
Creating a fork
Before you can edit documentation, you need to create a fork of Istio's documentation GitHub repository:
-
Go to the istio/istio.github.io{: target="_blank"} repository.
-
In the upper-right corner, click Fork. This creates a copy of Istio's documentation repository in your GitHub account. The copy is called a fork.
Making your changes
-
In your GitHub account, in your fork of the Istio repository, create a new branch to use for your contribution.
-
In your new branch, make your changes and commit them. If you want to write a new topic, choose the page-type that is the best fit for your content.
Submitting a pull request
To publish your changes, you must create a pull request against the master branch of Istio's documentation repositoryL
-
In your GitHub account, in your new branch, create a pull request against the master branch of the istio/istio.github.io repository. This opens a page that shows the status of your pull request.
-
During the next few days, check your pull request for reviewer comments. If needed, revise your pull request by committing changes to your new branch in your fork.