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
Copy file name to clipboardExpand all lines: sig-docs/annual-report-2021.md
+61-73Lines changed: 61 additions & 73 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,79 +4,88 @@
4
4
5
5
1. What work did the SIG do this year that should be highlighted?
6
6
7
-
-
8
-
-
9
-
-
7
+
- SIG Docs put meaningful effort into growing its contributor and reviewer base in 2021, introducing [a shadow program for PR Wrangling](https://github.com/kubernetes/website/issues/31956) as well as dedicating more time to being active via our Slack community channel. This is an ongoing effort to grow our contributor base to a stable number, alongside easing the burden on our small group of reviewers and approvers.
8
+
- Ahead of the [dockershim removal](https://kubernetes.io/blog/2022/02/17/dockershim-faq/) in the Kubernetes 1.24 release, SIG Docs has been collaborating with various community members and the CNCF towards ensuring updation and creation of content in the form of documentation, blog posts etc. With weekly meetings and a [project board](https://github.com/orgs/kubernetes/projects/67) to track progress, this has allowed for us to invite contributors across experience levels to help us keep the Kubernetes website updated and relevant ahead of the major change.
9
+
- Alongside growing our contributor base, SIG Docs also worked on a leadership transition strategy to bring community members into leadership roles. Via a specialized six month mentorship program expertly led by Steering Committee member Paris Pittman, SIG Docs was able to grow its leadership cohort for the main SIG, as well as some of its subgroups, adding new co-chairs and tech leads.
10
+
-[SIG Docs google group](https://groups.google.com/g/kubernetes-sig-docs/)
11
+
-[Call for help sent to [email protected], kubernetes-sig-leads, kubernetes-sig-docs](https://groups.google.com/g/kubernetes-sig-docs/c/hspG6mzgkrs)
12
+
-[Announcement of new roles and leadership nominations](https://groups.google.com/g/kubernetes-sig-docs/c/cgrAyDLxydk)
10
13
11
-
2. What initiatives are you working on that aren't being tracked in KEPs?
12
14
13
-
-
14
-
-
15
-
-
15
+
2. What initiatives are you working on that aren't being tracked in KEPs?
16
+
- One of our main initiatives is to ensure consistent maintenance of the Kubernetes documentation website and blog. As an existing subproject within SIG Docs, we have a [project board](https://github.com/kubernetes/website/projects/11) tracking our efforts for the Kubernetes blog.
17
+
- Localization Subproject: SIG Docs is working on formalizing the localization work that has been ongoing for some time, with appointed leads of this initiative as well as recognizing the contributions of various community members across the different languages the Kubernetes website has been translated into. This subproject will be finalized by Q1 2022, with all active localizations informed and updated. The issue tracking the formalizing process can be viewed [here](https://github.com/kubernetes/website/issues/31955).
18
+
- New Contributor Ambassador Program: As a continuation of our push to grow the SIG Docs contributor base, we're working on a specalized role that aims to support new and would-be contributors get up to speed with our processes and workflows. This role would be capped at six months for it to be shared amongst the community, with this feeding into a possible reviewer funnel as contributors get more comfortable with providing feedback to others. The issue tracking the formalization and documentation of this role can be viewed [here](https://github.com/kubernetes/website/issues/31946).
16
19
17
-
3. KEP work in 2021 (1.x, 1.y, 1.z):
20
+
3. KEP work in 2021 (continuous and does not target any release):
18
21
19
22
<!--
20
23
In future, this will be generated from kubernetes/enhancements kep.yaml files
21
24
1. with SIG as owning-sig or in participating-sigs
22
25
2. listing 1.x, 1.y, or 1.z in milestones or in latest-milestone
-[1326 - Doc policies for third party content](https://git.k8s.io/enhancements/keps/sig-docs/1326-third-party-content-in-docs/README.md)
29
+
36
30
37
31
## Project health
38
32
39
33
1. What areas and/or subprojects does your group need the most help with?
40
34
Any areas with 2 or fewer OWNERs? (link to more details)
41
35
42
-
-
43
-
-
44
-
-
45
-
36
+
- The blog subproject is particularly short on resources and attention. At the moment a very
37
+
small pool of active editors are the constraint / most critical resource for article publication. One editor
38
+
is involved in the majority of published articles; other editors are perhaps even more stretched with other
39
+
Kubernetes contributions and involvement with other SIGs.
40
+
- Whilst there is work under way to move other people along the contribution ladder, the blog subproject
41
+
remains constrained.
42
+
- SIG Docs would welcome more contributors to form a stable pool for the blog subproject in particular and
43
+
for SIG Docs, generally.
44
+
- Require guidelines on how we could ramp up folks nominated to the New Contributor Ambassador role specific to SIG Docs.
45
+
- One localization (Ukrainian) is primarily worked on by people based in Ukraine,
46
+
where the ongoing and intensifying conflict creates challenges that take priority over
47
+
open source contribution.
46
48
2. What metrics/community health stats does your group care about and/or measure?
47
49
48
-
-
49
-
-
50
-
-
50
+
51
+
- SIG Docs has a [dashboard](https://datastudio.google.com/u/0/reporting/fede2672-b2fd-402a-91d2-7473bdb10f04/page/567IC) available with site analytics. Some highlights include:
- PR velocity and open PR age is tracked in [Devstat](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). We aim to have < 100 open PRs for the English localization, and will take steps as needed if we see the figure climbing much above that. For example, based on 12/31/2020 data, we have: Average number of opened PRs 368 with the median opened PRs age 5 days 21 hours 26 minutes 42 seconds
51
58
52
59
3. Does your [CONTRIBUTING.md] help **new** contributors engage with your group specifically by pointing
53
60
to activities or programs that provide useful context or allow easy participation?
54
61
55
-
-
62
+
-[It's updated](https://kubernetes.io/docs/contribute/) to the best of our knowledge.
56
63
57
64
4. If your group has special training, requirements for reviewers/approvers, or processes beyond the general [contributor guide],
58
65
does your [CONTRIBUTING.md] document those to help **existing** contributors grow throughout the [contributor ladder]?
59
66
60
-
-
67
+
- 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.
68
+
- We actively assign good-first-issue labels to issues that we think early-lifecycle contributors could begin with. During KubeCons we also do introduction presentations and mentoring sessions to try and funnel contributors in to our SIG. Some of them are listed below,
69
+
-[Intro to Kubernetes Docs](https://www.youtube.com/watch?v=pprMgmNzDcw), presented at KubeCon NA, 2020
70
+
-[Kubernetes SIG Docs: A Deep Dive](https://www.youtube.com/watch?v=GDfcBF5et3Q), presented at KubeCon NA, 2021
61
71
62
72
5. Does the group have contributors from multiple companies/affiliations?
63
73
64
-
-
74
+
- 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=1609455600000&to=1639350000000) with top 50% contributions coming our way from IBM, Google, VMWare, RedHat, and NEC Corporation. A special mention for all the independent contributors who feature third on the list in terms of number of contributions.
65
75
66
76
6. Are there ways end users/companies can contribute that they currently are not?
67
77
If one of those ways is more full time support, what would they work on and why?
68
78
69
-
-
70
-
-
79
+
- 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 will be finalizing it as a [localization subproject](https://github.com/kubernetes/website/issues/31955). We aim for the subproject to, potentially, provide more avenues for contribution. More details around leadership and the formalization process can be found in [this message](https://groups.google.com/a/kubernetes.io/g/dev/c/SP6weMvx3wg/m/l8LAL-OFCQAJ) sent to [email protected]
71
80
72
81
## Membership
73
82
74
-
- Primary slack channel member count:
75
-
- Primary mailing list member count:
76
-
- Primary meeting attendee count (estimated, if needed):
77
-
- Primary meeting participant count (estimated, if needed):
78
-
- Unique reviewers for SIG-owned packages: <!-- in future, this will be generated from OWNERS files referenced from subprojects, expanded with OWNERS_ALIASES files -->
79
-
- Unique approvers for SIG-owned packages: <!-- in future, this will be generated from OWNERS files referenced from subprojects, expanded with OWNERS_ALIASES files -->
83
+
- Primary slack channel member count: 1876
84
+
- Primary mailing list member count: 453
85
+
- Primary meeting attendee count (estimated, if needed): 10
86
+
- Primary meeting participant count (estimated, if needed): 6
87
+
- Unique reviewers for SIG-owned packages: 76 <!-- in future, this will be generated from OWNERS files referenced from subprojects, expanded with OWNERS_ALIASES files -->
88
+
- Unique approvers for SIG-owned packages: 93<!-- in future, this will be generated from OWNERS files referenced from subprojects, expanded with OWNERS_ALIASES files -->
80
89
81
90
Include any other ways you measure group membership
82
91
@@ -87,51 +96,30 @@ In future, this will be generated from delta of sigs.yaml from $YYYY-01-01 to $Y
87
96
Manually visible via `git diff HEAD@{$YYYY-01-01} HEAD@{$YYYY-12-31} -- $sig-id/README.md`
In 2021, SIG Docs started to formalize the localization subgroup into an official subproject.
120
105
121
106
## Operational
122
107
123
108
Operational tasks in [sig-governance.md]:
124
109
125
-
-[][README.md] reviewed for accuracy and updated if needed
126
-
-[][CONTRIBUTING.md] reviewed for accuracy and updated if needed
110
+
-[x][README.md] reviewed for accuracy and updated if needed
111
+
-[X][CONTRIBUTING.md] reviewed for accuracy and updated if needed
127
112
(or created if missing and your contributor steps and experience are different or more
128
113
in-depth than the documentation listed in the general [contributor guide] and [devel] folder.)
129
-
-[ ] Subprojects list and linked OWNERS files in [sigs.yaml] reviewed for accuracy and updated if needed
130
-
-[ ] SIG leaders (chairs, tech leads, and subproject owners) in [sigs.yaml] are accurate and active, and updated if needed
131
-
-[ ] Meeting notes and recordings for 2021 are linked from [README.md] and updated/uploaded if needed
132
-
-[ ] Did you have community-wide updates in 2021 (e.g. community meetings, kubecon, or kubernetes-dev@ emails)? Links to email, slides, or recordings:
133
-
-
134
-
-
114
+
-[X] Subprojects list and linked OWNERS files in [sigs.yaml] reviewed for accuracy and updated if needed
115
+
-[X] SIG leaders (chairs, tech leads, and subproject owners) in [sigs.yaml] are accurate and active, and updated if needed
116
+
-[x] Meeting notes and recordings for 2021 are linked from [README.md] and updated/uploaded if needed
117
+
-[x] Did you have community-wide updates in 2021 (e.g. community meetings, kubecon, or kubernetes-dev@ emails)? Links to email, slides, or recordings:
118
+
- [Kubernetes SIG Docs: A Deep Dive](https://www.youtube.com/watch?v=GDfcBF5et3Q), presented at KubeCon NA, 2021
119
+
- [SIG Docs needs your help! to [email protected]](https://groups.google.com/g/kubernetes-sig-docs/c/hspG6mzgkrs)
120
+
- [SIG Docs Co-Chair Nomination: Divya Mohan to [email protected]](https://groups.google.com/g/kubernetes-sig-docs/c/_1R7sh-_iiQ)
121
+
- [SIG Docs: New roles & leadership nominations to [email protected]](https://groups.google.com/a/kubernetes.io/g/dev/c/SP6weMvx3wg/m/l8LAL-OFCQAJ)
122
+
- [SIG Docs APAC Meeting has changed to 1 AM IST/5.30 AM UTC on the last Wednesday of every month to [email protected]](https://groups.google.com/g/kubernetes-sig-docs/c/P7iLejmEIFA/m/-dPsBOpoDAAJ)
0 commit comments