Edit This Page

Contribute to Kubernetes docs

If you would like to help contribute to the Kubernetes documentation or website, we’re happy to have your help! Anyone can contribute, whether you’re new to the project or you’ve been around a long time, and whether you self-identify as a developer, an end user, or someone who just can’t stand seeing typos.

• Getting Started
• Contributions best practices
• Other ways to contribute
• What's next

Getting Started

Anyone can open an issue describing problems or desired improvements with documentation, or contribute a change with a pull request (PR). Some tasks require more trust and need more access in the Kubernetes organization. See Participating in SIG Docs for more details about of roles and permissions.

Kubernetes documentation resides in a GitHub repository. While we welcome contributions from anyone, you do need basic comfort with git and GitHub to operate effectively in the Kubernetes community.

To get involved with documentation:

1. Sign the CNCF Contributor License Agreement.
2. Familiarize yourself with the documentation repository and the website’s static site generator.
3. Make sure you understand the basic processes for improving content and reviewing changes.

Contributions best practices

• Do write clear and meaningful GIT commit messages.
• Make sure to include Github Special Keywords which references the issue and automatically closes the issue when PR is merged.
• When you make a small change to a PR like fixing a typo, any style change, or changing grammar. Make sure you squash your commits so that you dont get a large number of commits for a relatively small change.
• Make sure you include a nice PR description depicting the code you have changes, why to change a following piece of code and ensuring there is sufficient information for the reviewer to understand your PR.
• Additional Readings :
  • chris.beams.io/posts/git-commit/
  • github.com/blog/1506-closing-issues-via-pull-requests
  • davidwalsh.name/squash-commits-git

Other ways to contribute

• To contribute to the Kubernetes community through online forums like Twitter or Stack Overflow, or learn about local meetups and Kubernetes events, visit the Kubernetes community site.
• To contribute to feature development, read the contributor cheatsheet to get started.

What's next

• For more information about the basics of contributing to documentation, read Start contributing.
• Follow the Kubernetes documentation style guide when proposing changes.
• For more information about SIG Docs, read Participating in SIG Docs.
• For more information about localizing Kubernetes docs, read Localizing Kubernetes documentation.

Feedback

Was this page helpful?

Thanks for the feedback. If you have a specific, answerable question about how to use Kubernetes, ask it on Stack Overflow. Open an issue in the GitHub repo if you want to report a problem or suggest an improvement.