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