Contribute to Kubernetes docs
This website is maintained by Kubernetes SIG Docs.
Kubernetes documentation contributors:
- Improve existing content
- Create new content
- Translate the documentation
- Manage and publish the documentation parts of the Kubernetes release cycle
Kubernetes documentation welcomes improvements from all contributors, new and experienced!
Anyone can open an issue about documentation, or contribute a change with a pull request (PR) to the
kubernetes/website GitHub repository. You need to be comfortable with git and GitHub to operate effectively in the Kubernetes community.
To get involved with documentation:
- Sign the CNCF Contributor License Agreement.
- Familiarize yourself with the documentation repository and the website’s static site generator.
- Make sure you understand the basic processes for opening a pull request and reviewing changes.
Some tasks require more trust and more access in the Kubernetes organization. See Participating in SIG Docs for more details about roles and permissions.
Your first contribution
- Read the Contribution overview to learn about the different ways you can contribute.
- See Contribute to kubernetes/website to find issues that make good entry points.
- Open a pull request using GitHub to existing documentation and learn more about filing issues in GitHub.
- Review pull requests from other Kubernetes community members for accuracy and language.
- Read the Kubernetes content and style guides so you can leave informed comments.
- Learn how to use page templates and Hugo shortcodes to make bigger changes.
- Learn to work from a local clone of the repository.
- Document features in a release.
- Participate in SIG Docs, and become a member or reviewer.
- Start or help with a localization.
Get involved with SIG Docs
SIG Docs is the group of contributors who publish and maintain Kubernetes documentation and the website. Getting involved with SIG Docs is a great way for Kubernetes contributors (feature development or otherwise) to have a large impact on the Kubernetes project.
SIG Docs communicates with different methods:
#sig-docson the Kubernetes Slack instance. Make sure to introduce yourself!
- Join the
kubernetes-sig-docsmailing list, where broader discussions take place and official decisions are recorded.
- Join the weekly SIG Docs video meeting. Meetings are always announced on
#sig-docsand added to the Kubernetes community meetings calendar. You’ll need to download the Zoom client or dial in using a phone.
Other ways to contribute
- Visit the Kubernetes community site. Participate on Twitter or Stack Overflow, learn about local Kubernetes meetups and events, and more.
- Read the contributor cheatsheet to get involved with Kubernetes feature development.
- Submit a blog post or case study.
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.