3.5 KiB
| redirect_from | |
|---|---|
|
{% capture overview %}
To contribute to the Kubernetes documentation, create a pull request against the kubernetes/kubernetes.github.io{: target="_blank"} repository. This page shows how to create a pull request.
{% endcapture %}
{% capture prerequisites %}
-
Create a GitHub account{: target="_blank"}.
-
Sign the Google Contributor License Agreement{: target="_blank"}.
-
Sign the Linux Contributor License Agreement{: target="_blank"}.
{% endcapture %}
{% capture steps %}
Creating a fork of the Kubernetes documentation repository
-
Go to the kubernetes/kubernetes.github.io{: target="_blank"} repository.
-
In the upper-right corner, click Fork. This creates a copy of the Kubernetes documentation repository in your GitHub account. The copy is called a fork.
Making your changes
-
In your GitHub account, in your fork of the Kubernetes docs, 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 the master branch
If you want your change to be published in the released version Kubernetes docs, create a pull request against the master branch of the Kubernetes documentation repository.
-
In your GitHub account, in your new branch, create a pull request against the master branch of the kubernetes/kubernetes.github.io repository. This opens a page that shows the status of your pull request.
-
Click Show all checks. Wait for the deploy/netlify check to complete. To the right of deploy/netlify, click Details. This opens a staging site where you can verify that your changes have rendered correctly.
-
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.
Submitting a pull request to the <vnext> branch
If your documentation change should not be released until the next release of
the Kubernetes product, create a pull request against the <vnext> branch
of the Kubernetes documentation repository. The <vnext> branch has the
form release-<version-number>, for example release-1.5.
-
In your GitHub account, in your new branch, create a pull request against the <vnext> branch of the kubernetes/kubernetes.github.io repository. This opens a page that shows the status of your pull request.
-
Click Show all checks. Wait for the deploy/netlify check to complete. To the right of deploy/netlify, click Details. This opens a staging site where you can verify that your changes have rendered correctly.
-
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.
{% endcapture %}
{% capture whatsnext %}
- Learn about writing a new topic.
- Learn about using page templates.
- Learn about staging your changes. {% endcapture %}
{% include templates/task.md %}