Creating a Documentation Pull Request
To contribute to the Kubernetes documentation, create a pull request against the kubernetes/website repository. This page shows how to create a pull request.
- Before you begin
- Creating a fork of the Kubernetes documentation repository
- Making your changes
- Submitting a pull request to the master branch (Current Release)
- Submitting a pull request to the <vnext> branch (Upcoming Release)
- Pull request review process for both Current and Upcoming Releases
- What’s next
Before you begin
-
Create a GitHub account.
Documentation will be published under the CC BY SA 4.0 license.
Creating a fork of the Kubernetes documentation repository
-
Go to the kubernetes/website 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 (Current Release)
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/website 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 (Upcoming Release)
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/website 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.
The staging site for the upcoming Kubernetes release is here: http://kubernetes-io-vnext-staging.netlify.com/. The staging site reflects the current state of what’s been merged in the release branch, or in other words, what the docs will look like for the next upcoming release. It’s automatically updated as new PRs get merged.
Pull request review process for both Current and Upcoming Releases
Once your pull request is created, a Kubernetes reviewer will take responsibility for providing clear, actionable feedback. As the owner of the pull request, it is your responsibility to modify your pull request to address the feedback that has been provided to you by the Kubernetes reviewer. Also note that you may end up having more than one Kubernetes reviewer provide you feedback or you may end up getting feedback from a Kubernetes reviewer that is different than the one originally assigned to provide you feedback. Furthermore, in some cases, one of your reviewers might ask for a technical review from a Kubernetes tech reviewer when needed. Reviewers will do their best to provide feedback in a timely fashion but response time can vary based on circumstances.
What’s next
- Learn about writing a new topic.
- Learn about using page templates.
- Learn about staging your changes.