Contribute to Kubernetes docs

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.

For information on the Kubernetes documentation content and style, see the Documentation style overview.

Types of docs contributors

  • A member of the Kubernetes organization who has signed the CLA and contributed some time and effort to the project. See Community membership for specific criteria for membership.
  • A SIG Docs reviewer is a member of the Kubernetes organization who has expressed interest in reviewing documentation pull requests and who has been added to the appropriate GitHub group and OWNERS files in the GitHub repository, by a SIG Docs Approver.
  • A SIG Docs approver is a member in good standing who has shown a continued commitment to the project. An approver can merge pull requests and publish content on behalf of the Kubernetes organization. Approvers can also represent SIG Docs in the larger Kubernetes community. Some of the duties of a SIG Docs approver, such as coordinating a release, require a significant time commitment.

Ways to contribute to documentation

This list is divided into things anyone can do, things Kubernetes organization members can do, and things that require a higher level of access and familiarity with SIG Docs processes. Contributing consistently over time can help you understand some of the tooling and organizational decisions that have already been made.

This is not an exhaustive list of ways you can contribute to the Kubernetes documentation, but it should help you get started.

  • Anyone
    • Open actionable issues
  • Member
    • Improve existing docs
    • Bring up ideas for improvement on Slack or the SIG docs mailing list
    • Improve docs accessibility
    • Provide non-binding feedback on PRs
    • Write a blog post or case study
  • Reviewer
    • Document new features
    • Triage and categorize issues
    • Review PRs
    • Create diagrams, graphics assets, and embeddable screencasts / videos
    • Localization
    • Contribute to other repos as a docs representative
    • Edit user-facing strings in code
    • Improve code comments, Godoc
  • Approver
    • Publish contributor content by approving and merging PRs
    • Participate in a Kubernetes release team as a docs representative
    • Propose improvements to the style guide
    • Propose improvements to docs tests
    • Propose improvements to the Kubernetes website or other tooling

Additional 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.

Feedback