kubernetes
/
website
mirror of https://github.com/kubernetes/website.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
website/content/en/docs/home/contribute/participating.md

115 lines
7.0 KiB
Markdown
Raw Normal View History

Roles sigdocs (#7133) * strawman structure * updates from PR review/feedback * consolidate usage of SIG Docs and how to volunteer into a single location * adding into ToC * updates for Zach * re-organizing and adding back approver lgtm comment
2018-02-17 08:10:38 +00:00
---
title: Participating in SIG-DOCS
Convert site to Hugo (#8316) This commit converts content and layout to use Hugo.
2018-05-05 16:00:51 +00:00
content_template: templates/concept
Roles sigdocs (#7133) * strawman structure * updates from PR review/feedback * consolidate usage of SIG Docs and how to volunteer into a single location * adding into ToC * updates for Zach * re-organizing and adding back approver lgtm comment
2018-02-17 08:10:38 +00:00
---
Convert site to Hugo (#8316) This commit converts content and layout to use Hugo.
2018-05-05 16:00:51 +00:00
{{% capture overview %}}
Roles sigdocs (#7133) * strawman structure * updates from PR review/feedback * consolidate usage of SIG Docs and how to volunteer into a single location * adding into ToC * updates for Zach * re-organizing and adding back approver lgtm comment
2018-02-17 08:10:38 +00:00
SIG-DOCS is one of the [special interest groups](https://github.com/kubernetes/community/blob/master/sig-list.md) within the Kubernetes project, focused on writing, updating, and maintaining the documentation for Kubernetes as a whole.
Convert site to Hugo (#8316) This commit converts content and layout to use Hugo.
2018-05-05 16:00:51 +00:00
{{% /capture %}}
Roles sigdocs (#7133) * strawman structure * updates from PR review/feedback * consolidate usage of SIG Docs and how to volunteer into a single location * adding into ToC * updates for Zach * re-organizing and adding back approver lgtm comment
2018-02-17 08:10:38 +00:00
Convert site to Hugo (#8316) This commit converts content and layout to use Hugo.
2018-05-05 16:00:51 +00:00
{{% capture body %}}
Roles sigdocs (#7133) * strawman structure * updates from PR review/feedback * consolidate usage of SIG Docs and how to volunteer into a single location * adding into ToC * updates for Zach * re-organizing and adding back approver lgtm comment
2018-02-17 08:10:38 +00:00
SIG Docs welcomes content and reviews from all contributors. Anyone can open a pull request (PR), and anyone is welcome to comment on content or pull requests in progress.
Within the Kubernetes project, you may also become a member, reviewer, or approver.
These roles confer additional privileges and responsibilities when it comes to approving and committing changes.
See [community-membership](https://github.com/kubernetes/community/blob/master/community-membership.md) for more information on how membership works within the Kubernetes community.
## Roles and Responsibilities
The automation reads `/hold`, `/lgtm`, and `/approve` comments and sets labels on the pull request.
When a pull request has the `lgtm` and `approve` labels without any `hold` labels, the pull request merges automatically.
Kubernetes org members, and reviewers and approvers for SIG Docs can add comments to control the merge automation.
- Members
Hugo: Fix participating page (#8565) The page was wrongly formatted: * Two lists were shown as paragraphs, add empty lines so that they are parsed as lists. * The list of members, reviewers was not intended properly, so that the single items are intended but not their description. Indent everything. * Fix URL to owners.md file, the old one gives a 404.
2018-05-18 16:41:51 +00:00
Any member of the [Kubernetes organization](https://github.com/kubernetes) can review a pull request, and SIG Docs team members frequently request reviews from members of other SIGs for technical accuracy.
SIG Docs also welcomes reviews and feedback regardless of Kubernetes org membership.
You can indicate your approval by adding a comment of `/lgtm` to a pull request.
Roles sigdocs (#7133) * strawman structure * updates from PR review/feedback * consolidate usage of SIG Docs and how to volunteer into a single location * adding into ToC * updates for Zach * re-organizing and adding back approver lgtm comment
2018-02-17 08:10:38 +00:00
- Reviewers
Hugo: Fix participating page (#8565) The page was wrongly formatted: * Two lists were shown as paragraphs, add empty lines so that they are parsed as lists. * The list of members, reviewers was not intended properly, so that the single items are intended but not their description. Indent everything. * Fix URL to owners.md file, the old one gives a 404.
2018-05-18 16:41:51 +00:00
Reviewers are individuals who review documentation pull requests.
Roles sigdocs (#7133) * strawman structure * updates from PR review/feedback * consolidate usage of SIG Docs and how to volunteer into a single location * adding into ToC * updates for Zach * re-organizing and adding back approver lgtm comment
2018-02-17 08:10:38 +00:00
Hugo: Fix participating page (#8565) The page was wrongly formatted: * Two lists were shown as paragraphs, add empty lines so that they are parsed as lists. * The list of members, reviewers was not intended properly, so that the single items are intended but not their description. Indent everything. * Fix URL to owners.md file, the old one gives a 404.
2018-05-18 16:41:51 +00:00
Automation assigns reviewers to pull requests, and contributors can request a review with a comment on the pull request: `/assign [@_github_handle]`.
To indicate that a pull request requires no further changes, a reviewer should add comment to the pull request `/lgtm`.
A reviewer indicates technical accuracy with a `/lgtm` comment.
Roles sigdocs (#7133) * strawman structure * updates from PR review/feedback * consolidate usage of SIG Docs and how to volunteer into a single location * adding into ToC * updates for Zach * re-organizing and adding back approver lgtm comment
2018-02-17 08:10:38 +00:00
Hugo: Fix participating page (#8565) The page was wrongly formatted: * Two lists were shown as paragraphs, add empty lines so that they are parsed as lists. * The list of members, reviewers was not intended properly, so that the single items are intended but not their description. Indent everything. * Fix URL to owners.md file, the old one gives a 404.
2018-05-18 16:41:51 +00:00
Reviewers can add a `/hold` comment to prevent the pull request from being merged.
Another reviewer or approver can remove a hold with the comment: `/hold cancel`.
Roles sigdocs (#7133) * strawman structure * updates from PR review/feedback * consolidate usage of SIG Docs and how to volunteer into a single location * adding into ToC * updates for Zach * re-organizing and adding back approver lgtm comment
2018-02-17 08:10:38 +00:00
Hugo: Fix participating page (#8565) The page was wrongly formatted: * Two lists were shown as paragraphs, add empty lines so that they are parsed as lists. * The list of members, reviewers was not intended properly, so that the single items are intended but not their description. Indent everything. * Fix URL to owners.md file, the old one gives a 404.
2018-05-18 16:41:51 +00:00
When a reviewer is assigned a pull request to review it is not a sole responsibility, and any other reviewer may also offer their opinions on the pull request.
If a reviewer is requested, it is generally expected that the PR will be left to that reviewer to do their editorial pass on the content.
If a PR author or SIG Docs maintainer requests a review, refrain from merging or closing the PR until the requested reviewer completes their review.
Roles sigdocs (#7133) * strawman structure * updates from PR review/feedback * consolidate usage of SIG Docs and how to volunteer into a single location * adding into ToC * updates for Zach * re-organizing and adding back approver lgtm comment
2018-02-17 08:10:38 +00:00
- Approvers
Hugo: Fix participating page (#8565) The page was wrongly formatted: * Two lists were shown as paragraphs, add empty lines so that they are parsed as lists. * The list of members, reviewers was not intended properly, so that the single items are intended but not their description. Indent everything. * Fix URL to owners.md file, the old one gives a 404.
2018-05-18 16:41:51 +00:00
Approvers have the ability to merge a PR.
Roles sigdocs (#7133) * strawman structure * updates from PR review/feedback * consolidate usage of SIG Docs and how to volunteer into a single location * adding into ToC * updates for Zach * re-organizing and adding back approver lgtm comment
2018-02-17 08:10:38 +00:00
Hugo: Fix participating page (#8565) The page was wrongly formatted: * Two lists were shown as paragraphs, add empty lines so that they are parsed as lists. * The list of members, reviewers was not intended properly, so that the single items are intended but not their description. Indent everything. * Fix URL to owners.md file, the old one gives a 404.
2018-05-18 16:41:51 +00:00
Approvers can indicate their approval with a comment to the pull request: `/approve`.
An approver is indicating editorial approval with the an `/approve` comment.
Roles sigdocs (#7133) * strawman structure * updates from PR review/feedback * consolidate usage of SIG Docs and how to volunteer into a single location * adding into ToC * updates for Zach * re-organizing and adding back approver lgtm comment
2018-02-17 08:10:38 +00:00
Hugo: Fix participating page (#8565) The page was wrongly formatted: * Two lists were shown as paragraphs, add empty lines so that they are parsed as lists. * The list of members, reviewers was not intended properly, so that the single items are intended but not their description. Indent everything. * Fix URL to owners.md file, the old one gives a 404.
2018-05-18 16:41:51 +00:00
Approvers can add a `/hold` comment to prevent the pull request from being merged.
Another reviewer or approver can remove a hold with the comment: `/hold cancel`.
Roles sigdocs (#7133) * strawman structure * updates from PR review/feedback * consolidate usage of SIG Docs and how to volunteer into a single location * adding into ToC * updates for Zach * re-organizing and adding back approver lgtm comment
2018-02-17 08:10:38 +00:00
Hugo: Fix participating page (#8565) The page was wrongly formatted: * Two lists were shown as paragraphs, add empty lines so that they are parsed as lists. * The list of members, reviewers was not intended properly, so that the single items are intended but not their description. Indent everything. * Fix URL to owners.md file, the old one gives a 404.
2018-05-18 16:41:51 +00:00
Approvers may skip further reviews for small pull requests if the proposed changes appear trivial and/or well-understood.
An approver can indicate `/lgtm` or `/approve` in a PR comment to have a pull request merged, and all pull requests require at least one approver to provide their vote in order for the PR to be merged.
Roles sigdocs (#7133) * strawman structure * updates from PR review/feedback * consolidate usage of SIG Docs and how to volunteer into a single location * adding into ToC * updates for Zach * re-organizing and adding back approver lgtm comment
2018-02-17 08:10:38 +00:00
Hugo: Fix participating page (#8565) The page was wrongly formatted: * Two lists were shown as paragraphs, add empty lines so that they are parsed as lists. * The list of members, reviewers was not intended properly, so that the single items are intended but not their description. Indent everything. * Fix URL to owners.md file, the old one gives a 404.
2018-05-18 16:41:51 +00:00
{{< note >}}**Note:** There is a special case when an approver uses the comment: `/lgtm`. In these cases, the automation will add both `lgtm` and `approve` tags, skipping any further review.
{{< /note >}}
Roles sigdocs (#7133) * strawman structure * updates from PR review/feedback * consolidate usage of SIG Docs and how to volunteer into a single location * adding into ToC * updates for Zach * re-organizing and adding back approver lgtm comment
2018-02-17 08:10:38 +00:00
Hugo: Fix participating page (#8565) The page was wrongly formatted: * Two lists were shown as paragraphs, add empty lines so that they are parsed as lists. * The list of members, reviewers was not intended properly, so that the single items are intended but not their description. Indent everything. * Fix URL to owners.md file, the old one gives a 404.
2018-05-18 16:41:51 +00:00
For PRs that require no review (typos or otherwise trivial changes), approvers can enter an `lgtm` comment, indicating no need for further review and flagging the PR with approval to merge.
Roles sigdocs (#7133) * strawman structure * updates from PR review/feedback * consolidate usage of SIG Docs and how to volunteer into a single location * adding into ToC * updates for Zach * re-organizing and adding back approver lgtm comment
2018-02-17 08:10:38 +00:00
### Teams and groups within SIG Docs
You can get an overview of [SIG Docs from the community github repo](https://github.com/kubernetes/community/tree/master/sig-docs).
The SIG Docs group defines two teams on Github:
Hugo: Fix participating page (#8565) The page was wrongly formatted: * Two lists were shown as paragraphs, add empty lines so that they are parsed as lists. * The list of members, reviewers was not intended properly, so that the single items are intended but not their description. Indent everything. * Fix URL to owners.md file, the old one gives a 404.
2018-05-18 16:41:51 +00:00
Roles sigdocs (#7133) * strawman structure * updates from PR review/feedback * consolidate usage of SIG Docs and how to volunteer into a single location * adding into ToC * updates for Zach * re-organizing and adding back approver lgtm comment
2018-02-17 08:10:38 +00:00
- [@kubernetes/sig-docs-maintainers](https://github.com/orgs/kubernetes/teams/sig-docs-maintainers)
- [@kubernetes/sig-docs-pr-reviews](https://github.com/orgs/kubernetes/teams/sig-docs-pr-reviews)
These groups maintain the [Kubernetes website repository](https://github.com/kubernetes/website), which houses the content hosted at this site.
Both can be referenced with their `@name` in github comments to communicate with everyone in that group.
These teams overlap, but do not exactly match, the groups used by the automation tooling.
For assignment of issues, pull requests, and to support PR approvals, the automation uses information from the OWNERS file.
Hugo: Fix participating page (#8565) The page was wrongly formatted: * Two lists were shown as paragraphs, add empty lines so that they are parsed as lists. * The list of members, reviewers was not intended properly, so that the single items are intended but not their description. Indent everything. * Fix URL to owners.md file, the old one gives a 404.
2018-05-18 16:41:51 +00:00
To volunteer as a reviewer or approver, make a pull request and add your Github handle to the relevant section in the [OWNERS file](https://github.com/kubernetes/community/blob/master/contributors/guide/owners.md).
Roles sigdocs (#7133) * strawman structure * updates from PR review/feedback * consolidate usage of SIG Docs and how to volunteer into a single location * adding into ToC * updates for Zach * re-organizing and adding back approver lgtm comment
2018-02-17 08:10:38 +00:00
Convert site to Hugo (#8316) This commit converts content and layout to use Hugo.
2018-05-05 16:00:51 +00:00
{{< note >}}
Roles sigdocs (#7133) * strawman structure * updates from PR review/feedback * consolidate usage of SIG Docs and how to volunteer into a single location * adding into ToC * updates for Zach * re-organizing and adding back approver lgtm comment
2018-02-17 08:10:38 +00:00
**Note:** Reviewers and approvers must meet requirements for participation.
For more information, see the [Kubernetes community](https://github.com/kubernetes/community/blob/master/community-membership.md#membership) repository.
Convert site to Hugo (#8316) This commit converts content and layout to use Hugo.
2018-05-05 16:00:51 +00:00
{{< /note >}}
Roles sigdocs (#7133) * strawman structure * updates from PR review/feedback * consolidate usage of SIG Docs and how to volunteer into a single location * adding into ToC * updates for Zach * re-organizing and adding back approver lgtm comment
2018-02-17 08:10:38 +00:00
Hugo: Fix participating page (#8565) The page was wrongly formatted: * Two lists were shown as paragraphs, add empty lines so that they are parsed as lists. * The list of members, reviewers was not intended properly, so that the single items are intended but not their description. Indent everything. * Fix URL to owners.md file, the old one gives a 404.
2018-05-18 16:41:51 +00:00
Documentation for the [OWNERS](https://github.com/kubernetes/community/blob/master/contributors/guide/owners.md)
explains how to maintain OWNERS for each repository that enables it.
Roles sigdocs (#7133) * strawman structure * updates from PR review/feedback * consolidate usage of SIG Docs and how to volunteer into a single location * adding into ToC * updates for Zach * re-organizing and adding back approver lgtm comment
2018-02-17 08:10:38 +00:00
The [Kubernetes website repository](https://github.com/kubernetes/website) has two automation (prow) [plugins enabled](https://github.com/kubernetes/test-infra/blob/master/prow/plugins.yaml#L210):
Hugo: Fix participating page (#8565) The page was wrongly formatted: * Two lists were shown as paragraphs, add empty lines so that they are parsed as lists. * The list of members, reviewers was not intended properly, so that the single items are intended but not their description. Indent everything. * Fix URL to owners.md file, the old one gives a 404.
2018-05-18 16:41:51 +00:00
Roles sigdocs (#7133) * strawman structure * updates from PR review/feedback * consolidate usage of SIG Docs and how to volunteer into a single location * adding into ToC * updates for Zach * re-organizing and adding back approver lgtm comment
2018-02-17 08:10:38 +00:00
- blunderbuss
- approve
correct the owner_aliases (#7849)
2018-03-27 21:57:03 +00:00
These two plugins use the [OWNERS](https://github.com/kubernetes/website/blob/master/OWNERS) and [OWNERS_ALIASES](https://github.com/kubernetes/website/blob/master/OWNERS_ALIASES) files in our repo for configuration.
Roles sigdocs (#7133) * strawman structure * updates from PR review/feedback * consolidate usage of SIG Docs and how to volunteer into a single location * adding into ToC * updates for Zach * re-organizing and adding back approver lgtm comment
2018-02-17 08:10:38 +00:00
Convert site to Hugo (#8316) This commit converts content and layout to use Hugo.
2018-05-05 16:00:51 +00:00
{{% /capture %}}
Roles sigdocs (#7133) * strawman structure * updates from PR review/feedback * consolidate usage of SIG Docs and how to volunteer into a single location * adding into ToC * updates for Zach * re-organizing and adding back approver lgtm comment
2018-02-17 08:10:38 +00:00
Convert site to Hugo (#8316) This commit converts content and layout to use Hugo.
2018-05-05 16:00:51 +00:00
{{% capture whatsnext %}}
Roles sigdocs (#7133) * strawman structure * updates from PR review/feedback * consolidate usage of SIG Docs and how to volunteer into a single location * adding into ToC * updates for Zach * re-organizing and adding back approver lgtm comment
2018-02-17 08:10:38 +00:00
For more information about contributing to the Kubernetes documentation, see:
* Review the SIG Docs [Style Guide](/docs/home/contribute/style-guide/).
* Learn how to [stage your documentation changes](/docs/home/contribute/stage-documentation-changes/).
* Learn about [writing a new topic](/docs/home/contribute/write-new-topic/).
* Learn about [using page templates](/docs/home/contribute/page-templates/).
* Learn about [staging your changes](/docs/home/contribute/stage-documentation-changes/).
* Learn about [creating a pull request](/docs/home/contribute/create-pull-request/).
* How to generate documentation:
* Learn how to [generate Reference Documentation for Kubernetes Federation API](/docs/home/contribute/generated-reference/federation-api/)
* Learn how to [generate Reference Documentation for kubectl Commands](/docs/home/contribute/generated-reference/kubectl/)
* Learn how to [generate Reference Documentation for the Kubernetes API](/docs/home/contribute/generated-reference/kubernetes-api/)
* Learn how to [generate Reference Pages for Kubernetes Components and Tools](/docs/home/contribute/generated-reference/kubernetes-components/)
Convert site to Hugo (#8316) This commit converts content and layout to use Hugo.
2018-05-05 16:00:51 +00:00
{{% /capture %}}
Roles sigdocs (#7133) * strawman structure * updates from PR review/feedback * consolidate usage of SIG Docs and how to volunteer into a single location * adding into ToC * updates for Zach * re-organizing and adding back approver lgtm comment
2018-02-17 08:10:38 +00:00