Note:

To learn more about contributing to Kubernetes in general, see the .

You can also read the CNCF about contributing to Kubernetes.

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

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 and GitHub to work effectively in the Kubernetes community.

  1. Sign the CNCF .
  2. Make sure you understand the basic processes for opening a pull request and .

flowchart TB subgraph third[Open PR] direction TB U[ ] -.- Q[Improve content] —- N[Create content] N —- O[Translate docs] O —- P[Manage/publish docs parts
of K8s release cycle] end subgraph second[Review] direction TB T[ ] -.- D[Look over the
K8s/website
repository] —- E[Check out the
Hugo static site
generator] E —- F[Understand basic
GitHub commands] F —- G[Review open PR
and change review
processes] end subgraph first[Sign up] direction TB S[ ] -.- B[Sign the CNCF
Contributor
License Agreement] —- C[Join sig-docs
Slack channel] C —- V[Join kubernetes-sig-docs
mailing list] V —- M[Attend weekly
sig-docs calls
or slack meetings] end A([fa:fa-user New
Contributor]) —> first A —> second A —> third A —> H[Ask Questions!!!] classDef grey fill:#dddddd,stroke:#ffffff,stroke-width:px,color:#000000, font-size:15px; classDef white fill:#ffffff,stroke:#000,stroke-width:px,color:#000,font-weight:bold classDef spacewhite fill:#ffffff,stroke:#fff,stroke-width:0px,color:#000 class A,B,C,D,E,F,G,H,M,Q,N,O,P,V grey class S,T,U spacewhite class first,second,third white

JavaScript must be enabled to view this content

Figure 1. Getting started for a new contributor.

Figure 1 outlines a roadmap for new contributors. You can follow some or all of the steps for and . Now you are ready to open PRs that achieve your contribution objectives with some listed under . Again, questions are always welcome!

Some tasks require more trust and more access in the Kubernetes organization. See for more details about roles and permissions.

You can prepare for your first contribution by reviewing several steps beforehand. Figure 2 outlines the steps and the details follow.

JavaScript must be to view this content

Figure 2. Preparation for your first contribution.

  • Read the Contribution overview to learn about the different ways you can contribute.
  • Check for issues that make good entry points.
  • Open a pull request using GitHub to existing documentation and learn more about filing issues in GitHub.
  • from other Kubernetes community members for accuracy and language.
  • Read the Kubernetes content and so you can leave informed comments.
  • Learn about page content types and .

SIG Docs communicates with different methods:

  • . Make sure to introduce yourself!
  • Join the kubernetes-sig-docs mailing list, where broader discussions take place and official decisions are recorded.
  • Join the held every two weeks. Meetings are always announced on and added to the Kubernetes community meetings calendar. You’ll need to download the or dial in using a phone.
  • Join the SIG Docs async Slack standup meeting on those weeks when the in-person Zoom video meeting does not take place. Meetings are always announced on . You can contribute to any one of the threads up to 24 hours after meeting announcement.
  • Visit the . 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.
  • Visit the contributor site to learn more about and additional contributor resources.
  • Submit a .