Remove duplicate content: Roles & Responsibilities (#18920)
* Remove duplicate content: Roles & Responsibilities Signed-off-by: Celeste <celeste@cncf.io> Address feedback Signed-off-by: Celeste <celeste@cncf.io> * Apply suggestions from review Co-Authored-By: Zach Corleissen <zacharysarah@users.noreply.github.com> * Link to contribution guidelines Signed-off-by: Celeste Horgan <celeste@cncf.io> * Address PR feedback Signed-off-by: Celeste Horgan <celeste@cncf.io> Co-authored-by: Zach Corleissen <zacharysarah@users.noreply.github.com>
This commit is contained in:
@@ -13,68 +13,39 @@ 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](/docs/contribute/style/).
|
||||
{{% /capture %}}
|
||||
|
||||
{{% capture body %}}
|
||||
|
||||
## Types of docs contributors
|
||||
## Getting Started
|
||||
|
||||
- A _member_ of the Kubernetes organization who has [signed the CLA](/docs/contribute/start#sign-the-cla)
|
||||
and contributed some time and effort to the project. See
|
||||
[Community membership](https://github.com/kubernetes/community/blob/master/community-membership.md)
|
||||
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.
|
||||
Anyone can open an issue describing problems or desired improvements with documentation, or contribute a change with a pull request (PR).
|
||||
Some tasks require more trust and need more access in the Kubernetes organization.
|
||||
See [Participating in SIG Docs](/docs/contribute/participating/) for more details about
|
||||
of roles and permissions.
|
||||
|
||||
## Ways to contribute to documentation
|
||||
Kubernetes documentation resides in a GitHub repository. While we welcome
|
||||
contributions from anyone, you do need basic comfort with git and GitHub to
|
||||
operate effectively in the Kubernetes community.
|
||||
|
||||
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.
|
||||
To get involved with documentation:
|
||||
|
||||
This is not an exhaustive list of ways you can contribute to the Kubernetes
|
||||
documentation, but it should help you get started.
|
||||
1. Sign the CNCF [Contributor License Agreement](https://github.com/kubernetes/community/blob/master/CLA.md).
|
||||
2. Familiarize yourself with the [documentation repository](https://github.com/kubernetes/website) and the website's [static site generator](https://gohugo.io).
|
||||
3. Make sure you understand the basic processes for [improving content](https://kubernetes.io/docs/contribute/start/#improve-existing-content) and [reviewing changes](https://kubernetes.io/docs/contribute/start/#review-docs-pull-requests).
|
||||
|
||||
- [Anyone](/docs/contribute/start/)
|
||||
- Open actionable issues
|
||||
- [Member](/docs/contribute/start/)
|
||||
- Improve existing docs
|
||||
- Bring up ideas for improvement on [Slack](http://slack.k8s.io/) or the [SIG docs mailing list](https://groups.google.com/forum/#!forum/kubernetes-sig-docs)
|
||||
- Improve docs accessibility
|
||||
- Provide non-binding feedback on PRs
|
||||
- Write a blog post or case study
|
||||
- [Reviewer](/docs/contribute/intermediate/)
|
||||
- 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](/docs/contribute/advanced/)
|
||||
- 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
|
||||
## Other 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](/community/).
|
||||
- To contribute to feature development, read the [contributor cheatsheet](https://github.com/kubernetes/community/tree/master/contributors/guide/contributor-cheatsheet) to get started.
|
||||
|
||||
{{% /capture %}}
|
||||
|
||||
{{% capture whatsnext %}}
|
||||
|
||||
- For more information about the basics of contributing to documentation, read [Start contributing](/docs/contribute/start/).
|
||||
- Follow the [Kubernetes documentation style guide](/docs/contribute/style/style-guide/) when proposing changes.
|
||||
- For more information about SIG Docs, read [Participating in SIG Docs](/docs/contribute/participating/).
|
||||
- For more information about localizing Kubernetes docs, read [Localizing Kubernetes documentation](/docs/contribute/localization/).
|
||||
|
||||
{{% /capture %}}
|
||||
|
||||
Reference in New Issue
Block a user