Participating in SIG Docs
SIG Docs is one of the within the Kubernetes project, focused on writing, updating, and maintaining the documentation for Kubernetes as a whole. See for more information about the SIG.
SIG Docs welcomes content and reviews from all contributors. Anyone can open a pull request (PR), and anyone is welcome to file issues about content or comment on pull requests in progress.
You can also become a member, reviewer, or approver. These roles require greater access and entail certain responsibilities for approving and committing changes. See for more information on how membership works within the Kubernetes community.
The rest of this document outlines some unique ways these roles function within SIG Docs, which is responsible for maintaining one of the most public-facing aspects of Kubernetes -- the Kubernetes website and documentation.
SIG Docs chairperson
Each SIG, including SIG Docs, selects one or more SIG members to act as chairpersons. These are points of contact between SIG Docs and other parts of the Kubernetes organization. They require extensive knowledge of the structure of the Kubernetes project as a whole and how SIG Docs works within it. See for the current list of chairpersons.
SIG Docs teams and automation
Automation in SIG Docs relies on two different mechanisms: GitHub teams and OWNERS files.
GitHub teams
There are two categories of SIG Docs teams on GitHub:
@sig-docs-{language}-ownersare approvers and leads@sig-docs-{language}-reviewersare reviewers
Each can be referenced with their @name in GitHub comments to communicate with
everyone in that group.
Sometimes Prow and GitHub teams overlap without matching exactly. For
assignment of issues, pull requests, and to support PR approvals, the
automation uses information from OWNERS files.
OWNERS files and front-matter
The Kubernetes project uses an automation tool called prow for automation related to GitHub issues and pull requests. The :
- blunderbuss
- approve
These two plugins use the
files in the top level of the kubernetes/website GitHub repository to control
how prow works within the repository.
An OWNERS file contains a list of people who are SIG Docs reviewers and
approvers. OWNERS files can also exist in subdirectories, and can override who
can act as a reviewer or approver of files in that subdirectory and its
descendants. For more information about OWNERS files in general, see
In addition, an individual Markdown file can list reviewers and approvers in its
front-matter, either by listing individual GitHub usernames or GitHub groups. The combination of OWNERS files and front-matter in Markdown files determines
the advice PR owners get from automated systems about who to ask for technical
and editorial review of their PR. When a pull request is merged to the branch used to publish content, that content is published to
For more information about contributing to the Kubernetes documentation, see:How merging works
lgtm and approve labels, has no hold
labels, and all tests are passing, the pull request merges automatically./hold comment
or withholding a /lgtm comment).lgtm label by adding a /lgtm comment./approve comment. Some approvers also perform additional
specific roles, such as PR Wrangler or
SIG Docs chairperson.What's next