Skip to content

Commit 183f306

Browse files
authored
Merge pull request #7216 from reylejano/sig-docs-annual-report-2022
SIG Docs annual report 2022
2 parents d433ef1 + 6ff4c82 commit 183f306

File tree

1 file changed

+47
-34
lines changed

1 file changed

+47
-34
lines changed

sig-docs/annual-report-2022.md

Lines changed: 47 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -4,62 +4,75 @@
44

55
1. What work did the SIG do this year that should be highlighted?
66

7-
-
8-
-
9-
-
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
1010

11-
2. What initiatives are you working on that aren't being tracked in KEPs?
1211

13-
-
14-
-
15-
-
12+
2. What initiatives are you working on that aren't being tracked in KEPs?
1613

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
1717

1818

1919
3. KEP work in 2022 (v1.24, v1.25, v1.26):
2020

21+
N/A
2122

2223
## Project health
2324

24-
1. What areas and/or subprojects does your group need the most help with?
25-
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)
2626

27-
-
28-
-
29-
-
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
3031

3132
2. What metrics/community health stats does your group care about and/or measure?
3233

33-
-
34-
-
35-
-
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:
35+
- 2022 Pages views: 112,180,650
36+
- Top pages for 2022 (excluding the home page):
37+
- https://kubernetes.io/docs/reference/kubectl/cheatsheet/
38+
- https://kubernetes.io/docs/concepts/services-networking/service/
39+
- https://kubernetes.io/docs/concepts/services-networking/ingress/
40+
- 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.
3642

3743
3. Does your [CONTRIBUTING.md] help **new** contributors engage with your group specifically by pointing
3844
to activities or programs that provide useful context or allow easy participation?
3945

40-
-
46+
- It is [updated](https://kubernetes.io/docs/contribute/) to the best of our knowledge.
4147

4248
4. If your group has special training, requirements for reviewers/approvers, or processes beyond the general [contributor guide],
4349
does your [CONTRIBUTING.md] document those to help **existing** contributors grow throughout the [contributor ladder]?
4450

45-
-
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+
4656

4757
5. Does the group have contributors from multiple companies/affiliations?
4858

49-
-
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)
5061

5162
6. Are there ways end users/companies can contribute that they currently are not?
5263
If one of those ways is more full time support, what would they work on and why?
5364

54-
-
55-
-
56-
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+
5767
## Membership
5868

59-
- Primary slack channel member count:
60-
- Primary mailing list member count:
61-
- Primary meeting attendee count (estimated, if needed):
62-
- 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
6376
- Unique reviewers for SIG-owned packages: <!-- in future, this will be generated from OWNERS files referenced from subprojects, expanded with OWNERS_ALIASES files -->
6477
- Unique approvers for SIG-owned packages: <!-- in future, this will be generated from OWNERS files referenced from subprojects, expanded with OWNERS_ALIASES files -->
6578

@@ -68,7 +81,6 @@ Include any other ways you measure group membership
6881
## [Subprojects](https://git.k8s.io/community/sig-docs#subprojects)
6982

7083

71-
7284
**New in 2022:**
7385

7486
- localization
@@ -87,16 +99,17 @@ Include any other ways you measure group membership
8799

88100
Operational tasks in [sig-governance.md]:
89101

90-
- [ ] [README.md] reviewed for accuracy and updated if needed
91-
- [ ] [CONTRIBUTING.md] reviewed for accuracy and updated if needed
102+
- [x] [README.md] reviewed for accuracy and updated if needed
103+
- [x] [CONTRIBUTING.md] reviewed for accuracy and updated if needed
92104
(or created if missing and your contributor steps and experience are different or more
93105
in-depth than the documentation listed in the general [contributor guide] and [devel] folder.)
94-
- [ ] Subprojects list and linked OWNERS files in [sigs.yaml] reviewed for accuracy and updated if needed
95-
- [ ] SIG leaders (chairs, tech leads, and subproject owners) in [sigs.yaml] are accurate and active, and updated if needed
96-
- [ ] Meeting notes and recordings for 2022 are linked from [README.md] and updated/uploaded if needed
97-
- [ ] Did you have community-wide updates in 2022 (e.g. community meetings, kubecon, or kubernetes-dev@ emails)? Links to email, slides, or recordings:
98-
-
99-
-
106+
- [x] Subprojects list and linked OWNERS files in [sigs.yaml] reviewed for accuracy and updated if needed
107+
- [x] SIG leaders (chairs, tech leads, and subproject owners) in [sigs.yaml] are accurate and active, and updated if needed
108+
- [x] Meeting notes and recordings for 2022 are linked from [README.md] and updated/uploaded if needed
109+
- [x] Did you have community-wide updates in 2022 (e.g. community meetings, kubecon, or kubernetes-dev@ emails)? Links to email, slides, or recordings:
110+
- [Localization Subproject Launch to SIG Docs](https://groups.google.com/g/kubernetes-sig-docs/c/DUFVEi-9tWc/m/ji2vPwBEBQAJ)
111+
- [Office Hours : SIG Docs](https://www.youtube.com/live/KJMka1ZzVUQ?feature=share)
112+
- [Contributing to the Kubernetes Website: A Guide for Everyone](https://sched.co/182O1)
100113

101114
[CONTRIBUTING.md]: https://git.k8s.io/community/sig-docs/CONTRIBUTING.md
102115
[contributor ladder]: https://git.k8s.io/community/community-membership.md

0 commit comments

Comments
 (0)