You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
1. What work did the SIG do this year that should be highlighted?
7
6
8
-
-
9
-
-
10
-
-
7
+
- Contributors across many SIGs, companies, and foundations worked together with SIG Docs to finalize the [dockershim removal](https://kubernetes.io/blog/2022/02/17/dockershim-faq/) from the Kubernetes website
8
+
- Our Localization subproject was officially documented in our community resources, with two subproject leads appointed and the `area/localization` label created
9
+
- The Hindi localization, our first localized set of documentation using the Devanagari script, officially launched
11
10
12
-
2. What initiatives are you working on that aren't being tracked in KEPs?
13
11
14
-
-
15
-
-
16
-
-
12
+
2. What initiatives are you working on that aren't being tracked in KEPs?
17
13
14
+
- A new [Issue Wrangler](https://github.com/kubernetes/website/discussions/38861) role, as a compliment to the [SIG Docs PR Wrangler]
15
+
- Katacoda tutorial [shutdown notice](https://github.com/kubernetes/website/issues/33936) and replacement work (see Katacoda Shutdown information on the Kubernetes blog [here](https://kubernetes.io/blog/2023/02/14/kubernetes-katacoda-tutorials-stop-from-2023-03-31/))
16
+
-[Diagram implementation guide](https://kubernetes.io/docs/contribute/style/diagram-guide/) for Kubernetes documentation, using the Mermaid JavaScript library
18
17
19
18
20
19
3. KEP work in 2022 (v1.24, v1.25, v1.26):
21
20
21
+
N/A
22
22
23
23
## Project health
24
24
25
-
1. What areas and/or subprojects does your group need the most help with?
26
-
Any areas with 2 or fewer OWNERs? (link to more details)
25
+
1. What areas and/or subprojects does your group need the most help with? Any areas with 2 or fewer OWNERs? (link to more details)
27
26
28
-
-
29
-
-
30
-
-
27
+
- Our localizations have two owners as a minimum default, thus, SIG Docs doesn't count this as a project health issue. Our Localization subproject had one of its leads move to Emeritus in early 2023, however, we're in the process of mentoring a second lead throughout 2023.
28
+
- Our blog subproject is still short on resources, however, we have been able to add an additional reviewer over the last year. We're still looking to add to the very small pool of active editors, which are our most critical resource for article publication.
29
+
- We're looking for active contributors to take on the Issue Wrangling role, which would require some involvement in community meetings and Slack discussion to better triage issues and bugs.
30
+
- Project management is an area that our leads have been trying to cover, but SIG Docs overall could use more help in this space. Help with coordinating large-scale efforts such as the Katacoda tutorial replacement, or organizing the various attempts to debug Netlify issues, would be a huge benefit
31
31
32
32
2. What metrics/community health stats does your group care about and/or measure?
33
33
34
-
-
35
-
-
36
-
-
34
+
- SIG Docs has a dashboard available with [site analytics](https://lookerstudio.google.com/u/0/reporting/fede2672-b2fd-402a-91d2-7473bdb10f04/page/567IC). Some highlights include:
- It is worth noting that our top pages in 2022 mirror our 2021 results
41
+
- PR velocity and open PR age is tracked in [Devstats](https://k8s.devstats.cncf.io/d/25/open-pr-age-by-repository-group?orgId=1&var-period=q&var-repogroup_name=SIG%20Docs&var-kind_name=All&from=1640991600000&to=1672527599000). We aim to have < 150 open PRs for the English localization, and will take steps as needed if we see the figure climbing much above that. It's worth noting that during every documentation review period for a release, our PR number in the English localization will climb significantly.
37
42
38
43
3. Does your [CONTRIBUTING.md] help **new** contributors engage with your group specifically by pointing
39
44
to activities or programs that provide useful context or allow easy participation?
40
45
41
-
-
46
+
- It is [updated](https://kubernetes.io/docs/contribute/) to the best of our knowledge.
42
47
43
48
4. If your group has special training, requirements for reviewers/approvers, or processes beyond the general [contributor guide],
44
49
does your [CONTRIBUTING.md] document those to help **existing** contributors grow throughout the [contributor ladder]?
45
50
46
-
-
51
+
- We have [a well-documented guide](https://kubernetes.io/docs/contribute/) that details how folks can get started and the various ways in which they can scale the contributor ladder.
52
+
- We actively assign good-first-issue labels to issues that we think early-lifecycle contributors could begin with, with other contributors sharing these issues actively in the #sig-docs Slack channel. We've also created introduction presentations and mentoring sessions at various KubeCon events to try and funnel contributors into our SIG. Some of them are listed below:
53
+
-[Intro to Kubernetes Docs](https://www.youtube.com/watch?v=pprMgmNzDcw) – presented at KubeCon/CloudNativeCon NA, 2020
54
+
-[Kubernetes SIG Docs: A Deep Dive](https://www.youtube.com/watch?v=GDfcBF5et3Q) – presented at KubeCon/CloudNativeCon NA, 2021
55
+
47
56
48
57
5. Does the group have contributors from multiple companies/affiliations?
49
58
50
-
-
59
+
- Yes. We have a contributor base spread across [98 companies](https://k8s.devstats.cncf.io/d/8/company-statistics-by-repository-group?orgId=1&var-period=y&var-metric=contributions&var-repogroup_name=SIG%20Docs&var-repo_name=kubernetes%2Fkubernetes&var-companies=All&from=1640991600000&to=1670886000000) with the top 50% of contributions coming from IBM, DaoCloud, Google, NEC Corporation, VMWare, and Red Hat. We'd like to give a shout-out to all of the independent contributors who feature third on this ranking in terms of number of contributions
60
+
- Our group also strives to be a positive example when it comes to Diversity, Equity, and Inclusion, where we ensure we have SIG leads from some of our biggest membership bases (India, China), alongside women in technical leadership roles (co-chairs, tech leads)
51
61
52
62
6. Are there ways end users/companies can contribute that they currently are not?
53
63
If one of those ways is more full time support, what would they work on and why?
54
64
55
-
-
56
-
-
57
-
65
+
With a contributor base that is spread globally, SIG Docs identified a potential opportunity for diversifying our documentation via multiple language support. Given the wide audience, this helps in making it more inclusive and user friendly for non-native English users of Kubernetes. Towards formalizing this ongoing initiative, SIG Docs finalized a [localization subproject](https://github.com/kubernetes/website/issues/31955) to, potentially, provide more avenues for contribution.
66
+
58
67
## Membership
59
68
60
-
- Primary slack channel member count:
61
-
- Primary mailing list member count:
62
-
- Primary meeting attendee count (estimated, if needed):
63
-
- Primary meeting participant count (estimated, if needed):
69
+
- Primary slack channel member count: 2264
70
+
- Subproject slack channel member count:
71
+
- #sig-docs-blog: 342
72
+
- #sig-docs-localizations: 320
73
+
- Primary mailing list member count: 576
74
+
- Primary meeting attendee count (estimated, if needed): 12
75
+
- Primary meeting participant count (estimated, if needed): 6
64
76
- Unique reviewers for SIG-owned packages: <!-- in future, this will be generated from OWNERS files referenced from subprojects, expanded with OWNERS_ALIASES files -->
65
77
- Unique approvers for SIG-owned packages: <!-- in future, this will be generated from OWNERS files referenced from subprojects, expanded with OWNERS_ALIASES files -->
66
78
@@ -69,7 +81,6 @@ Include any other ways you measure group membership
What work did the SIG do this year that should be highlighted?
115
-
116
-
* Contributors across many SIGs, companies, and foundations worked together with SIG Docs to finalize the [dockershim removal](https://kubernetes.io/blog/2022/02/17/dockershim-faq/) from the Kubernetes website
117
-
* Our Localization subproject was officially documented in our community resources, with two subproject leads appointed and the `area/localization` label created
118
-
* The Hindi localization, our first localized set of documentation using the Devanagari script, officially launched
119
-
* A new [Issue Wrangler](https://github.com/kubernetes/website/discussions/38861) role, as a compliment to the [SIG Docs PR Wrangler](https://github.com/kubernetes/website/wiki/PR-Wranglers) role, has been put together to tackle issue triage and feature requests more efficiently
120
-
* (add more)
121
-
122
-
**What initiatives are you working on that aren't being tracked in KEPs?**
123
-
124
-
* Katacoda tutorial [shutdown notice](https://github.com/kubernetes/website/issues/33936) and replacement work (see Katacoda Shutdown information on the Kubernetes blog [here](https://kubernetes.io/blog/2023/02/14/kubernetes-katacoda-tutorials-stop-from-2023-03-31/))
125
-
*[Diagram implementation guide](https://kubernetes.io/docs/contribute/style/diagram-guide/) for Kubernetes documentation, using the Mermaid JavaScript library
126
-
* (did i miss something?)
127
-
128
-
**KEP work in 2022 (v1.24, v1.25, v1.26):**
129
-
130
-
* N/A
131
-
132
-
***Project health***
133
-
134
-
**What areas and/or subprojects does your group need the most help with? Any areas with 2 or fewer OWNERs? (link to more details)**
135
-
136
-
* Our localizations have two owners as a minimum default, thus, SIG Docs doesn't count this as a project health issue. Our Localization subproject had one of its leads move to Emeritus in early 2023, however, we're in the process of mentoring a second lead throughout 2023
137
-
* Our blog subproject is still short on resources, however, we have been able to add an additional reviewer over the last year. We're still looking to add to the very small pool of active editors, which are our most critical resource for article publication
138
-
* We're looking for active contributors to take on the Issue Wrangling role, which would require some involvement in community meetings and Slack discussion to better triage issues and bugs
139
-
* Project management is an area that our leads have been trying to cover, but SIG Docs overall could use more help in this space. Help with coordinating large-scale efforts such as the Katacoda tutorial replacement, or organizing the various attempts to debug Netlify issues, would be a huge benefit
140
-
* (where else do we need help?)
141
-
142
-
**What metrics/community health stats does your group care about and/or measure?**
143
-
144
-
* SIG Docs has a dashboard available with [site analytics](https://lookerstudio.google.com/u/0/reporting/fede2672-b2fd-402a-91d2-7473bdb10f04/page/567IC). Some highlights include:
* It is worth noting that our top pages in 2022 mirror our 2021 results
151
-
* PR velocity and open PR age is tracked in [Devstats](https://k8s.devstats.cncf.io/d/25/open-pr-age-by-repository-group?orgId=1&var-period=q&var-repogroup_name=SIG%20Docs&var-kind_name=All&from=1640991600000&to=1672527599000). We aim to have < 150 open PRs for the English localization, and will take steps as needed if we see the figure climbing much above that. It's worth noting that during every documentation review period for a release, our PR number in the English localization will climb significantly
152
-
153
-
**Does your CONTRIBUTING.md help new contributors engage with your group specifically by pointing to activities or programs that provide useful context or allow easy participation?**
154
-
155
-
* It is [updated](https://kubernetes.io/docs/contribute/) to the best of our knowledge (this isn't true, we need to make some tweaks)
156
-
157
-
**If your group has special training, requirements for reviewers/approvers, or processes beyond the general contributor guide, does your CONTRIBUTING.md document those to help existing contributors grow throughout the contributor ladder?**
158
-
159
-
* We have [a well-documented guide](https://kubernetes.io/docs/contribute/) that details how folks can get started and the various ways in which they can scale the contributor ladder
160
-
* We actively assign good-first-issue labels to issues that we think early-lifecycle contributors could begin with, with other contributors sharing these issues actively in the #sig-docs Slack channel. We've also created introduction presentations and mentoring sessions at various KubeCon events to try and funnel contributors into our SIG. Some of them are listed below:
161
-
*[Intro to Kubernetes Docs](https://www.youtube.com/watch?v=pprMgmNzDcw) – presented at KubeCon/CloudNativeCon NA, 2020
162
-
*[Kubernetes SIG Docs: A Deep Dive](https://www.youtube.com/watch?v=GDfcBF5et3Q) – presented at KubeCon/CloudNativeCon NA, 2021
163
-
164
-
165
-
**Does the group have contributors from multiple companies/affiliations?**
166
-
167
-
* Yes. We have a contributor base spread across [98 companies](https://k8s.devstats.cncf.io/d/8/company-statistics-by-repository-group?orgId=1&var-period=y&var-metric=contributions&var-repogroup_name=SIG%20Docs&var-repo_name=kubernetes%2Fkubernetes&var-companies=All&from=1640991600000&to=1670886000000) with the top 50% of contributions coming from IBM, DaoCloud, Google, NEC Corporation, VMWare, and Red Hat. We'd like to give a shout-out to all of the independent contributors who feature third on this ranking in terms of number of contributions
168
-
* Our group also strives to be a positive example when it comes to Diversity, Equity, and Inclusion, where we ensure we have SIG leads from some of our biggest membership bases (India, China), alongside women in technical leadership roles (co-chairs, tech leads)
169
-
170
-
**Are there ways end users/companies can contribute that they currently are not? If one of those ways is more full time support, what would they work on and why?**
171
-
172
-
* (to add)
173
-
174
-
***Membership***
175
-
176
-
* Primary Slack channel member count: 2,264
177
-
* Primary mailing list member count: 576
178
-
* Primary meeting attendee count (estimated, if needed): 12
179
-
* Primary meeting participant count (estimated, if needed): 6
180
-
* Unique reviewers for SIG-owned packages: xx
181
-
* Unique approvers for SIG-owned packages: xx
182
-
183
-
***Subprojects***
184
-
185
-
New in 2022:
186
-
187
-
localization
188
-
189
-
Continuing:
190
-
191
-
kubernetes-blog
192
-
reference-docs
193
-
website
194
-
195
-
***Operational***
196
-
197
-
Operational tasks in sig-governance.md:
198
-
199
-
-[ ] README.md reviewed for accuracy and updated if needed
200
-
-[ ] CONTRIBUTING.md reviewed for accuracy and updated if needed (or created if missing and your contributor steps and experience are different or more in-depth than the documentation listed in the general contributor guide and devel folder.)
201
-
-[ ] Subprojects list and linked OWNERS files in sigs.yaml reviewed for accuracy and updated if needed
202
-
-[ ] SIG leaders (chairs, tech leads, and subproject owners) in sigs.yaml are accurate and active, and updated if needed
203
-
-[ ] Meeting notes and recordings for 2022 are linked from README.md and updated/uploaded if needed
204
-
-[ ] Did you have community-wide updates in 2022 (e.g. community meetings, KubeCon, or kubernetes-dev@ emails)? Links to email, slides, or recordings:
205
-
*[Localization Subproject Launch to SIG Docs](https://groups.google.com/g/kubernetes-sig-docs/c/DUFVEi-9tWc/m/ji2vPwBEBQAJ)
206
-
* (I cannot find our KubeCon NA 2022 talk but lets please list it here)
207
-
>>>>>>> 4ad06693 (add initial draft of sig docs 2022 annual report)
0 commit comments