From f760c198303a4a20d032cf6645cca851a6886c0b Mon Sep 17 00:00:00 2001 From: Irvi Aini Date: Thu, 25 Feb 2021 23:22:41 +0100 Subject: docs: SIG Docs 2020 Annual Report --- sig-docs/annual-report-2021.md | 87 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 87 insertions(+) create mode 100644 sig-docs/annual-report-2021.md diff --git a/sig-docs/annual-report-2021.md b/sig-docs/annual-report-2021.md new file mode 100644 index 00000000..de1653aa --- /dev/null +++ b/sig-docs/annual-report-2021.md @@ -0,0 +1,87 @@ +# SIG Docs 2020 Annual Report + +**Authors:** + +Irvi Aini ([@irvifa](https://github.com/irvifa)) +Jim Angel ([@jimangel](https://github.com/jimangel)) +Kaitlyn Barnard ([@kbarnard10](https://github.com/kbarnard10)) + +- [Operational](#operational) +- [Membership](#membership) +- [Current initiatives and project health](#current-initiatives-and-project-health) + +## Operational + +**How are you doing with operational tasks in [sig-governance.md](/committee-steering/governance/sig-governance.md)?** + + + +**Is your README accurate? have a CONTRIBUTING.md file?** + + + +**All subprojects correctly mapped and listed in [sigs.yaml](/sig-list.md)?** + + + +**What’s your meeting culture? Large/small, active/quiet, learnings? Meeting notes up to date? Are you keeping recordings up to date/trends in community members watching recordings?** + + + +**How does the group get updates, reports, or feedback from subprojects? Are there any springing up or being retired? Are OWNERS files up to date in these areas?** + + + +**How does the group get updates, reports, or feedback from Working Groups? Are there any springing up or being retired? Are OWNERS files up to date in these areas?** + + + +**When was your last monthly community-wide update? (provide link to deck and/or recording)** + + + +## Membership + +**Are all listed SIG leaders (chairs, tech leads, and subproject owners) active?** + + + +**How do you measure membership? By mailing list members, OWNERs, or something else?** + + + +**How does the group measure reviewer and approver bandwidth? Do you need help in any area now? What are you doing about it?** + + + +**Is there a healthy onboarding and growth path for contributors in your SIG? What are some activities that the group does to encourage this? What programs are you participating in to grow contributors throughout the contributor ladder?** + + + +**What programs do you participate in for new contributors?** + + + +**Does the group have contributors from multiple companies/affiliations? Can end users/companies contribute in some way that they currently are not?** + + + +## Current initiatives and project health + +[ ] Please include links to KEPs and other supporting information that will be beneficial to multiple types of community members. + +**What are initiatives that should be highlighted, lauded, shout out, that your group is proud of? Currently underway? What are some of the longer tail projects that your group is working on?** + + + +**Year to date KEP work review: What’s now stable? Beta? Alpha? Road to alpha?** + + + +**What areas and/or subprojects does the group need the most help with?** + + + +**What's the average open days of a PR and Issue in your group? / what metrics does your group care about and/or measure?** + + -- cgit v1.2.3 From 5f637910eb216bcaf3f6e42a84af4e31625e4865 Mon Sep 17 00:00:00 2001 From: Irvi Aini Date: Tue, 2 Mar 2021 22:20:55 +0100 Subject: docs: Initialize reports on the SIG health on general --- sig-docs/annual-report-2021.md | 51 +++++++++++++++++++++++++----------------- 1 file changed, 31 insertions(+), 20 deletions(-) diff --git a/sig-docs/annual-report-2021.md b/sig-docs/annual-report-2021.md index de1653aa..fffb3f26 100644 --- a/sig-docs/annual-report-2021.md +++ b/sig-docs/annual-report-2021.md @@ -2,8 +2,8 @@ **Authors:** -Irvi Aini ([@irvifa](https://github.com/irvifa)) -Jim Angel ([@jimangel](https://github.com/jimangel)) +Irvi Aini ([@irvifa](https://github.com/irvifa)), +Jim Angel ([@jimangel](https://github.com/jimangel)), Kaitlyn Barnard ([@kbarnard10](https://github.com/kbarnard10)) - [Operational](#operational) @@ -14,25 +14,27 @@ Kaitlyn Barnard ([@kbarnard10](https://github.com/kbarnard10)) **How are you doing with operational tasks in [sig-governance.md](/committee-steering/governance/sig-governance.md)?** - - -**Is your README accurate? have a CONTRIBUTING.md file?** + - **Is your README accurate? have a CONTRIBUTING.md file?** - + Yes. We also have `Contributing.md` file. + - **All subprojects correctly mapped and listed in [sigs.yaml](/sig-list.md)?** -**All subprojects correctly mapped and listed in [sigs.yaml](/sig-list.md)?** + Yes. + + - **What’s your meeting culture? Large/small, active/quiet, learnings? Meeting notes up to date? + Are you keeping recordings up to date/trends in community members watching recordings?** + + Quite small (usually 5-10 people) and generally we try to make people feel comfortable to give their opinion. + Meeting notes are up to date. We have recording of the meetings uploaded. - -**What’s your meeting culture? Large/small, active/quiet, learnings? Meeting notes up to date? Are you keeping recordings up to date/trends in community members watching recordings?** +**How does the group get updates, reports, or feedback from subprojects? Are there any springing up or being retired? +Are OWNERS files up to date in these areas?** -**How does the group get updates, reports, or feedback from subprojects? Are there any springing up or being retired? Are OWNERS files up to date in these areas?** - - - -**How does the group get updates, reports, or feedback from Working Groups? Are there any springing up or being retired? Are OWNERS files up to date in these areas?** +**How does the group get updates, reports, or feedback from Working Groups? Are there any springing up or being retired? +Are OWNERS files up to date in these areas?** @@ -48,21 +50,29 @@ Kaitlyn Barnard ([@kbarnard10](https://github.com/kbarnard10)) **How do you measure membership? By mailing list members, OWNERs, or something else?** - +We don't have an official way of measuring membership. **How does the group measure reviewer and approver bandwidth? Do you need help in any area now? What are you doing about it?** - +PR are generally open for anyone to review. We have [PR wrangler rotation](https://github.com/kubernetes/website/wiki/PR-Wranglers). +In general each of the approver will taking the rotation. Under exceptional circumstances where there's lots of +pressure for the wrangler, another approver usually will be willing to help. -**Is there a healthy onboarding and growth path for contributors in your SIG? What are some activities that the group does to encourage this? What programs are you participating in to grow contributors throughout the contributor ladder?** +For technical reviews, other than SIG Docs Tech Leads, we also notify respective SIGs with necessary knowledge of the +technical aspect of the content. - +**Is there a healthy onboarding and growth path for contributors in your SIG? +What are some activities that the group does to encourage this? +What programs are you participating in to grow contributors throughout the contributor ladder?** + +There is no official onboarding process. **What programs do you participate in for new contributors?** -**Does the group have contributors from multiple companies/affiliations? Can end users/companies contribute in some way that they currently are not?** +**Does the group have contributors from multiple companies/affiliations? +Can end users/companies contribute in some way that they currently are not?** @@ -70,7 +80,8 @@ Kaitlyn Barnard ([@kbarnard10](https://github.com/kbarnard10)) [ ] Please include links to KEPs and other supporting information that will be beneficial to multiple types of community members. -**What are initiatives that should be highlighted, lauded, shout out, that your group is proud of? Currently underway? What are some of the longer tail projects that your group is working on?** +**What are initiatives that should be highlighted, lauded, shout out, that your group is proud of? +Currently underway? What are some of the longer tail projects that your group is working on?** -- cgit v1.2.3 From b25aedf7709ced645a7260648720e13b7051f55c Mon Sep 17 00:00:00 2001 From: Irvi Aini Date: Sat, 6 Mar 2021 23:11:57 +0100 Subject: docs: Add image of devstat and apply suggestions from other lead. --- sig-docs/annual-report-2021.md | 31 +++++++++++++++++++++------- sig-docs/devstats/devstats-quarter-2021.png | Bin 0 -> 428791 bytes 2 files changed, 23 insertions(+), 8 deletions(-) create mode 100644 sig-docs/devstats/devstats-quarter-2021.png diff --git a/sig-docs/annual-report-2021.md b/sig-docs/annual-report-2021.md index fffb3f26..8301bd70 100644 --- a/sig-docs/annual-report-2021.md +++ b/sig-docs/annual-report-2021.md @@ -4,7 +4,10 @@ Irvi Aini ([@irvifa](https://github.com/irvifa)), Jim Angel ([@jimangel](https://github.com/jimangel)), -Kaitlyn Barnard ([@kbarnard10](https://github.com/kbarnard10)) +Karen Bradshaw ([kbhawkey](https://github.com/kbhawkey)), +Kaitlyn Barnard ([@kbarnard10](https://github.com/kbarnard10)), +Taylor Dolezal ([onlydole](https://github.com/onlydole)), +Tim Bannister ([sftim](https://github.com/sftim)) - [Operational](#operational) - [Membership](#membership) @@ -31,12 +34,12 @@ Kaitlyn Barnard ([@kbarnard10](https://github.com/kbarnard10)) **How does the group get updates, reports, or feedback from subprojects? Are there any springing up or being retired? Are OWNERS files up to date in these areas?** - +Yes it is. **How does the group get updates, reports, or feedback from Working Groups? Are there any springing up or being retired? Are OWNERS files up to date in these areas?** - +Yes it is. **When was your last monthly community-wide update? (provide link to deck and/or recording)** @@ -46,7 +49,7 @@ Are OWNERS files up to date in these areas?** **Are all listed SIG leaders (chairs, tech leads, and subproject owners) active?** - +Yes, they are. **How do you measure membership? By mailing list members, OWNERs, or something else?** @@ -65,11 +68,16 @@ technical aspect of the content. What are some activities that the group does to encourage this? What programs are you participating in to grow contributors throughout the contributor ladder?** -There is no official onboarding process. +There is no official onboarding process. However, the SIG is supportive of new contributors, +willing to walk through the contribution process and eager to see contributions completed. +Issues are created regularly and triaged. Issues are also created specifically for new +contributors. There are issues labelled for the different contribution areas (web development, +blog, first time contributors, task, concept, API, etc) which helps new contributors +identify how to get started. **What programs do you participate in for new contributors?** - +We have an in person session during the KubeCon. **Does the group have contributors from multiple companies/affiliations? Can end users/companies contribute in some way that they currently are not?** @@ -87,7 +95,9 @@ Currently underway? What are some of the longer tail projects that your group is **Year to date KEP work review: What’s now stable? Beta? Alpha? Road to alpha?** - +We have ongoing KEP, but we don't have a deadline set on when it should be finished. + +- [Doc policies for third party content](https://github.com/kubernetes/enhancements/tree/master/keps/sig-docs/1326-third-party-content-in-docs) **What areas and/or subprojects does the group need the most help with?** @@ -95,4 +105,9 @@ Currently underway? What are some of the longer tail projects that your group is **What's the average open days of a PR and Issue in your group? / what metrics does your group care about and/or measure?** - +We have the information from [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): + +![Devstat 2020](devstats/devstats-quarter-2021.png) + +For example, based on 10/01/2020 data, we have: +Average number of opened PRs 1.23 K with the median opened PRs age 3 days 13 hours 52 minutes 10 seconds. diff --git a/sig-docs/devstats/devstats-quarter-2021.png b/sig-docs/devstats/devstats-quarter-2021.png new file mode 100644 index 00000000..2a93bb95 Binary files /dev/null and b/sig-docs/devstats/devstats-quarter-2021.png differ -- cgit v1.2.3 From 27677b24d8ceace6950dec408619ef52b5ecb0cf Mon Sep 17 00:00:00 2001 From: Irvi Aini <7439590+irvifa@users.noreply.github.com> Date: Thu, 8 Apr 2021 18:36:25 +0200 Subject: Update annual-report-2021.md Add some input from the others. --- sig-docs/annual-report-2021.md | 24 ++++++++++++++++++------ 1 file changed, 18 insertions(+), 6 deletions(-) diff --git a/sig-docs/annual-report-2021.md b/sig-docs/annual-report-2021.md index 8301bd70..a46d2ffd 100644 --- a/sig-docs/annual-report-2021.md +++ b/sig-docs/annual-report-2021.md @@ -29,6 +29,10 @@ Tim Bannister ([sftim](https://github.com/sftim)) Quite small (usually 5-10 people) and generally we try to make people feel comfortable to give their opinion. Meeting notes are up to date. We have recording of the meetings uploaded. + + We have a new sub-project, it's localization sub-project, where we conduct monthly meeting + attended by all people from the localizatiin team. This sub-porjcet focusing on sharing any concerns, + tips, or toolings that may be can be reused by other team as well. **How does the group get updates, reports, or feedback from subprojects? Are there any springing up or being retired? @@ -58,11 +62,9 @@ We don't have an official way of measuring membership. **How does the group measure reviewer and approver bandwidth? Do you need help in any area now? What are you doing about it?** PR are generally open for anyone to review. We have [PR wrangler rotation](https://github.com/kubernetes/website/wiki/PR-Wranglers). -In general each of the approver will taking the rotation. Under exceptional circumstances where there's lots of -pressure for the wrangler, another approver usually will be willing to help. +In general each of the approver will taking the rotation. Each approver participates in the PR wrangler rotation. Approvers are supported during their rotation by other reviewers and approvers. -For technical reviews, other than SIG Docs Tech Leads, we also notify respective SIGs with necessary knowledge of the -technical aspect of the content. +For technical reviews, other than SIG Docs Tech Leads, we also notify respective SIGs with necessary knowledge of the technical aspect of the content. SIG Docs receives contributions from community members representing different SIGs. During the PR review process, SIG Docs reaches out to other SIGs when a pull request requires technical review. **Is there a healthy onboarding and growth path for contributors in your SIG? What are some activities that the group does to encourage this? @@ -75,19 +77,29 @@ contributors. There are issues labelled for the different contribution areas (we blog, first time contributors, task, concept, API, etc) which helps new contributors identify how to get started. +From time to time we use the weekly meeting Zoom call to help new contributors get onboard. + **What programs do you participate in for new contributors?** We have an in person session during the KubeCon. **Does the group have contributors from multiple companies/affiliations? + +Yes + Can end users/companies contribute in some way that they currently are not?** - +I suppose we're particular keen to hear about suggested improvements from people who are using Kubernetes in production and can see gaps in what's there. ## Current initiatives and project health [ ] Please include links to KEPs and other supporting information that will be beneficial to multiple types of community members. +Longer term projects include + +- co-ordination with WG naming for things like removing the word “slave” (and other problematic terms) from docs. +- publishing better information about releases kubernetes/website#20293 + **What are initiatives that should be highlighted, lauded, shout out, that your group is proud of? Currently underway? What are some of the longer tail projects that your group is working on?** @@ -101,7 +113,7 @@ We have ongoing KEP, but we don't have a deadline set on when it should be finis **What areas and/or subprojects does the group need the most help with?** - +- Blog subproject **What's the average open days of a PR and Issue in your group? / what metrics does your group care about and/or measure?** -- cgit v1.2.3 From 25ad7752f57bde5acd5624377cdcd57fcb5b12de Mon Sep 17 00:00:00 2001 From: Irvi Aini <7439590+irvifa@users.noreply.github.com> Date: Sun, 11 Apr 2021 06:36:43 +0200 Subject: Apply suggestions from code review Co-authored-by: Jim Angel --- sig-docs/annual-report-2021.md | 24 +++++++++++++++--------- 1 file changed, 15 insertions(+), 9 deletions(-) diff --git a/sig-docs/annual-report-2021.md b/sig-docs/annual-report-2021.md index a46d2ffd..a4c29c23 100644 --- a/sig-docs/annual-report-2021.md +++ b/sig-docs/annual-report-2021.md @@ -31,7 +31,7 @@ Tim Bannister ([sftim](https://github.com/sftim)) Meeting notes are up to date. We have recording of the meetings uploaded. We have a new sub-project, it's localization sub-project, where we conduct monthly meeting - attended by all people from the localizatiin team. This sub-porjcet focusing on sharing any concerns, + attended by all people from the localization team. This sub-project focusing on sharing any concerns, tips, or toolings that may be can be reused by other team as well. @@ -47,7 +47,7 @@ Yes it is. **When was your last monthly community-wide update? (provide link to deck and/or recording)** - +[Q2 of 2020 (created April 8 2020)](https://docs.google.com/presentation/d/12WnYz8SbjWRZbK4k2qlc1Ab7Z-f2F7kk-Tb2eRTfTy8/edit?usp=sharing). ## Membership @@ -77,39 +77,42 @@ contributors. There are issues labelled for the different contribution areas (we blog, first time contributors, task, concept, API, etc) which helps new contributors identify how to get started. -From time to time we use the weekly meeting Zoom call to help new contributors get onboard. +From time to time we use the weekly meeting Zoom calls to help new contributors get onboard. **What programs do you participate in for new contributors?** -We have an in person session during the KubeCon. +We used to host doc sprints during the KubeCon, +the doc sprints acted as a way to onboard new contributors as well as tackle a lot of open issues. -**Does the group have contributors from multiple companies/affiliations? +**Does the group have contributors from multiple companies/affiliations?** Yes -Can end users/companies contribute in some way that they currently are not?** +**Can end users/companies contribute in some way that they currently are not?** I suppose we're particular keen to hear about suggested improvements from people who are using Kubernetes in production and can see gaps in what's there. ## Current initiatives and project health -[ ] Please include links to KEPs and other supporting information that will be beneficial to multiple types of community members. +- [x] Please include links to KEPs and other supporting information that will be beneficial to multiple types of community members. Longer term projects include -- co-ordination with WG naming for things like removing the word “slave” (and other problematic terms) from docs. +- coordination with WG naming for things like removing the word “slave” (and other problematic terms) from docs. - publishing better information about releases kubernetes/website#20293 **What are initiatives that should be highlighted, lauded, shout out, that your group is proud of? Currently underway? What are some of the longer tail projects that your group is working on?** - +Shoutout to docsy theme work as well as the reference documentation generation :tada:. **Year to date KEP work review: What’s now stable? Beta? Alpha? Road to alpha?** We have ongoing KEP, but we don't have a deadline set on when it should be finished. - [Doc policies for third party content](https://github.com/kubernetes/enhancements/tree/master/keps/sig-docs/1326-third-party-content-in-docs) + There's also an umbrella issue written as well [kubernetes/website#20232](https://github.com/kubernetes/website/issues/20232). + **What areas and/or subprojects does the group need the most help with?** @@ -123,3 +126,6 @@ We have the information from [devstat](https://k8s.devstats.cncf.io/d/25/open-pr For example, based on 10/01/2020 data, we have: Average number of opened PRs 1.23 K with the median opened PRs age 3 days 13 hours 52 minutes 10 seconds. +In addition, we informally review metrics quarterly as well as ad hoc if anyone brings it up at a weekly meeting. +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. -- cgit v1.2.3