|
| 1 | +# Contributing to SIG Docs |
| 2 | + |
| 3 | +SIG Docs focuses on creating, maintaining, and publishing documentation for the Kubernetes project |
| 4 | +in the kubernetes.io [website](https://kubernetes.io), |
| 5 | +[blog](https://kubernetes.io/blog), |
| 6 | +and API [e.g. API reference for v1.23](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/) |
| 7 | +& [CLI](https://kubernetes.io/docs/reference/generated/kubectl/kubectl-commands) |
| 8 | +reference documentation. |
| 9 | + |
| 10 | +For more details on SIG Docs' scope of work, what's in-scope, and what's out-of-scope, see the |
| 11 | +[SIG Docs charter](https://github.com/kubernetes/community/blob/master/sig-docs/charter.md). |
| 12 | + |
| 13 | +## Getting started |
| 14 | + |
| 15 | +Anyone can contribute with a pull request to the [kubernetes/website](https://github.com/kubernetes/website) GitHub repository or open an issue to [kubernetes/website](https://github.com/kubernetes/website). |
| 16 | + |
| 17 | +Before opening a pull request, contributors must sign the [CNCF Contributor License Agreement](https://github.com/kubernetes/community/blob/master/CLA.md). |
| 18 | + |
| 19 | +Contributors should be familiar with the following: |
| 20 | +- [kubernetes/website repo](https://github.com/kubernetes/website) |
| 21 | +- [Reference docs repo](https://github.com/kubernetes-sigs/reference-docs)) |
| 22 | +- [Hugo static site generator](https://gohugo.io/) |
| 23 | +- [Documentation content guide](https://kubernetes.io/docs/contribute/style/content-guide/) |
| 24 | + - [What's allowed](https://kubernetes.io/docs/contribute/style/content-guide/#what-s-allowed) |
| 25 | + - [Third-party content](https://kubernetes.io/docs/contribute/style/content-guide/#third-party-content) |
| 26 | +- [Documentation style guide](https://kubernetes.io/docs/contribute/style/style-guide/) |
| 27 | +- [Submitting a blog or case study](https://kubernetes.io/docs/contribute/new-content/blogs-case-studies/) |
| 28 | + |
| 29 | +More information can be found on the [contribute page](https://kubernetes.io/docs/contribute/) |
| 30 | +and on the [documentation style overview page](https://kubernetes.io/docs/contribute/style/). |
| 31 | + |
| 32 | +## Pull request process |
| 33 | + |
| 34 | +The pull request process for the kubernetes.io website is documented on the |
| 35 | +[Open a pull request](https://kubernetes.io/docs/contribute/new-content/open-a-pr/) page. |
| 36 | + |
| 37 | +Anyone can review pull requests and the review process is outlined in the |
| 38 | +[Reviewing pull requests](https://kubernetes.io/docs/contribute/review/reviewing-prs/) page. |
| 39 | + |
| 40 | +## Questions about contributing |
| 41 | +Feel free to ask any questions in the [#sig-docs](https://kubernetes.slack.com/messages/sig-docs) |
| 42 | +Slack channel or in a |
| 43 | +[SIG Docs meeting](https://github.com/kubernetes/community/tree/master/sig-docs#meetings). |
0 commit comments