summaryrefslogtreecommitdiff
path: root/sig-docs/README.md
blob: 705a7c65cd9094bea498f62b386a316f5788ddd5 (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
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
<!---
This is an autogenerated file!

Please do not edit this file directly, but instead make changes to the
sigs.yaml file in the project root.

To understand how this file is generated, see https://git.k8s.io/community/generator/README.md
--->
# Docs Special Interest Group

Covers documentation, doc processes, and doc publishing for Kubernetes.

## Meetings
* Regular SIG Meeting: [Tuesdays at 17:30 UTC](https://docs.google.com/document/d/1FQx0BPlkkl1Bn0c9ocVBxYIKojpmrS1CFP5h0DI68AE/edit) (weekly - except fourth Tuesday every month). [Convert to your timezone](http://www.thetimezoneconverter.com/?t=17:30&tz=UTC).
  * [Meeting notes and Agenda](https://docs.google.com/document/d/1Ds87eRiNZeXwRBEbFr6Z7ukjbTow5RQcNZLaSvWWQsE/edit).
  * [Meeting recordings](https://www.youtube.com/playlist?list=PL69nYSiGNLP3b5hlx0YV7Lo7DtckM84y8).
* APAC SIG Meeting: [Wednesdays at 02:00 UTC](https://docs.google.com/document/d/1FQx0BPlkkl1Bn0c9ocVBxYIKojpmrS1CFP5h0DI68AE/edit) (monthly - fourth Wednesday every month). [Convert to your timezone](http://www.thetimezoneconverter.com/?t=02:00&tz=UTC).
  * [Meeting notes and Agenda](https://docs.google.com/document/d/1Ds87eRiNZeXwRBEbFr6Z7ukjbTow5RQcNZLaSvWWQsE/edit).
  * [Meeting recordings](https://www.youtube.com/playlist?list=PL69nYSiGNLP3b5hlx0YV7Lo7DtckM84y8).

## Leadership

### Chairs
The Chairs of the SIG run operations and processes governing the SIG.

* Andrew Chen (**[@chenopis](https://github.com/chenopis)**), Google
* Zach Corleissen (**[@zacharysarah](https://github.com/zacharysarah)**), Linux Foundation
* Jennifer Rondeau (**[@bradamant3](https://github.com/bradamant3)**), Heptio

## Contact
* [Slack](https://kubernetes.slack.com/messages/sig-docs)
* [Mailing list](https://groups.google.com/forum/#!forum/kubernetes-sig-docs)
* [Open Community Issues/PRs](https://github.com/kubernetes/community/labels/sig%2Fdocs)

## Subprojects

The following subprojects are owned by sig-docs:
- **reference-docs**
  - Owners:
    - https://raw.githubusercontent.com/kubernetes-incubator/reference-docs/master/OWNERS
- **website**
  - Owners:
    - https://raw.githubusercontent.com/kubernetes/website/master/OWNERS

## GitHub Teams

The below teams can be mentioned on issues and PRs in order to get attention from the right people.
Note that the links to display team membership will only work if you are a member of the org.

| Team Name | Details | Description |
| --------- |:-------:| ----------- |
| @kubernetes/sig-docs-maintainers | [link](https://github.com/orgs/kubernetes/teams/sig-docs-maintainers) | Documentation maintainers |
| @kubernetes/sig-docs-pr-reviews | [link](https://github.com/orgs/kubernetes/teams/sig-docs-pr-reviews) | Documentation PR reviews |
| @kubernetes/sig-docs-ko-owners | [link](https://github.com/orgs/kubernetes/teams/sig-docs-ko-owners) | Korean localization |
| @kubernetes/sig-docs-ja-owners | [link](https://github.com/orgs/kubernetes/teams/sig-docs-ja-owners) | Japanese localization |
| @kubernetes/sig-docs-zh-owners | [link](https://github.com/orgs/kubernetes/teams/sig-docs-zh-owners) | Chinese localization |

<!-- BEGIN CUSTOM CONTENT -->
## Goals
* Discuss documentation and docs issues for kubernetes.io
* Plan docs releases for kubernetes
* Suggest improvements to user onboarding through better documentation on Kubernetes.io
* Identify and implement ways to get documentation feedback and metrics
* Help community contributors get involved in kubernetes documentation
<!-- END CUSTOM CONTENT -->