docs: SIG Docs 2020 Annual Report #5569

irvifa · 2021-02-25T22:25:22Z

Currently just the annual report template.
Requested in #5503.

Co-author:
/assign @irvifa @jimangel @kbarnard10

Steering liaison:
/assign @liggitt

SIG Docs leads: @kubernetes/sig-docs-leads
Fixes #5503

k8s-ci-robot · 2021-02-25T22:25:35Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: irvifa

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~sig-docs/OWNERS~~ [irvifa]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

irvifa · 2021-03-02T21:25:09Z

sig-docs/annual-report-2021.md

+**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?**
+
+<!-- TODO -->


@sftim Once we have the thought of doing clean up of approver that's not active anymore on the shift, is this already done? Any specific procedure that we need to share?

I think we decided that OWNER files are up to date.

Got it thanks 👍

irvifa · 2021-03-02T21:25:34Z

sig-docs/annual-report-2021.md

+
+<!-- TODO -->
+
+**When was your last monthly community-wide update? (provide link to deck and/or recording)**


@jimangel Would you mind filling this part?

I don't recall which community meeting this was done in, but guessing Q2 of 2020 (created April 8 2020)? https://docs.google.com/presentation/d/12WnYz8SbjWRZbK4k2qlc1Ab7Z-f2F7kk-Tb2eRTfTy8/edit?usp=sharing

sig-docs/annual-report-2021.md

irvifa · 2021-03-02T21:27:18Z

sig-docs/annual-report-2021.md

+
+**Year to date KEP work review: What’s now stable? Beta? Alpha? Road to alpha?**
+
+<!-- TODO -->


For this one I don't think we have this, please correct me if I'm wrong

I think the third part content removal is a kep, https://github.com/kubernetes/enhancements/tree/master/keps/sig-docs/1326-third-party-content-in-docs. but i'm not sure of the current state or if there is anything to report in this section

Cleanup for that is in progress, it's an ongoing process that doesn't target a specific release.

We could report on PRs linked to the umbrella issue if we want to?

I think it may be beneficial to link to the umbrella issue then, do you have the link?

kubernetes/website#20232

irvifa · 2021-03-02T21:28:20Z

sig-docs/annual-report-2021.md

+
+**What's the average open days of a PR and Issue in your group? / what metrics does your group care about and/or measure?**
+
+<!-- TODO -->


Do we have something that can be used to track how many Issues and PR that available in general per day?

https://k8s.devstats.cncf.io/ is useful here
We usually look at total open PRs, total open issues (both for k/website specifically), and total open PRs labelled “language/en”.

Also see https://k8s.devstats.cncf.io/d/25/open-pr-age-by-repository-group?orgId=1&var-period=d7&var-repogroup_name=SIG%20Docs&var-kind_name=All

I put the graph and the link to the graph, PTAL

kbhawkey · 2021-03-06T21:50:03Z

sig-docs/annual-report-2021.md

+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.


Optional:
I would add that 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, ...) which helps new contributors identify how to get started.

Got it, I added it on the docs, thank you 👍

parispittman · 2021-04-03T02:58:11Z

sig-docs/annual-report-2021.md

+**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 from the subprojects? do you have that included in standup at the meeting? or some other way?

any new subprojects in the last year?

I was wondering if the localization one is actually a subproject @bradtopol I remember that this was founded last year

Subproject teams provide project updates at the SIG quarterly meetings or discuss changes at the weekly meetings.

It seems like the localization project is considered a subproject (maintains separate meetings like the Blog subproject).

I think it really depends on the long term goal. I know when the localization group was created, the intention was to unify all localization efforts and dissolve (making it a working group). However, I do see value in it continuing permanently as long as there's contributor support.

My "gut feeling" is that the localization group started as a WG and probably should be considered a subproject now. At the very least, it's worth calling out here.

At the very least, it's worth calling out here.

+1

parispittman · 2021-04-03T02:59:06Z

sig-docs/annual-report-2021.md

+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.
+
+For technical reviews, other than SIG Docs Tech Leads, we also notify respective SIGs with necessary knowledge of the


Do you need help in this area?

Yes, I need help on this area

Does SIG Docs need help with reviewer and approver bandwidth?

My gut feeling is that we don't have good enough measurements on that / aren't looking at the measurements enough to know. It sounds like we're missing a check, but if that's the accurate story then we should say so.

I don't think we have measured the types of contributions identified by SIG, per PR.

Could add something like:
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.

sftim

Some thoughts

sftim · 2021-04-05T16:13:18Z

sig-docs/annual-report-2021.md

+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.
+
+For technical reviews, other than SIG Docs Tech Leads, we also notify respective SIGs with necessary knowledge of the


Does SIG Docs need help with reviewer and approver bandwidth?

My gut feeling is that we don't have good enough measurements on that / aren't looking at the measurements enough to know. It sounds like we're missing a check, but if that's the accurate story then we should say so.

sig-docs/annual-report-2021.md

kbhawkey · 2021-04-06T01:45:23Z

sig-docs/annual-report-2021.md

+**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


nit: I think line 60 (and the included link) explains the PR rotation. I would rewrite lines 61-62 as:

Each approver participates in the PR wrangler rotation. Approvers are supported during their rotation by other reviewers and approvers.

Add some input from the others.

dims · 2021-04-09T21:23:49Z

/committee steering

jimangel

Sorry for my delay, let some minor nits and comments. Great work @irvifa! Thanks for getting this started!

jimangel · 2021-04-10T01:59:00Z

sig-docs/annual-report-2021.md

+
+<!-- TODO -->
+
+**When was your last monthly community-wide update? (provide link to deck and/or recording)**


I don't recall which community meeting this was done in, but guessing Q2 of 2020 (created April 8 2020)? https://docs.google.com/presentation/d/12WnYz8SbjWRZbK4k2qlc1Ab7Z-f2F7kk-Tb2eRTfTy8/edit?usp=sharing

sig-docs/annual-report-2021.md

jimangel · 2021-04-10T02:05:32Z

sig-docs/annual-report-2021.md

+**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.


I think it really depends on the long term goal. I know when the localization group was created, the intention was to unify all localization efforts and dissolve (making it a working group). However, I do see value in it continuing permanently as long as there's contributor support.

My "gut feeling" is that the localization group started as a WG and probably should be considered a subproject now. At the very least, it's worth calling out here.

sig-docs/annual-report-2021.md

irvifa

I added suggestions from Jim as well in my latest commit. NP just glad I can help somehow.

sftim · 2021-04-11T20:17:35Z

sig-docs/annual-report-2021.md

+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.


Maybe add that we informally review metrics quarterly. Also 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.

that's a nice goal / ballpark benchmark to call out

liggitt · 2021-04-13T14:31:54Z

looks like there were a couple outstanding suggestions to fold in, then looks good to me

liggitt · 2021-04-13T14:32:19Z

any other last suggestions from any other reviewers?

sftim · 2021-04-13T14:46:16Z

No further questions your worships.

Co-authored-by: Jim Angel <jimangel@users.noreply.github.com>

irvifa · 2021-04-13T15:16:44Z

Hi all, I just added the last few comments on the PR, kindly check and let me know if there's something left.

liggitt

thanks!

/lgtm

liggitt · 2021-04-19T19:29:11Z

/merge-method squash

docs: SIG Docs 2020 Annual Report

f760c19

k8s-ci-robot assigned irvifa and jimangel Feb 25, 2021

k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Feb 25, 2021

k8s-ci-robot assigned kbarnard10 and liggitt Feb 25, 2021

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Feb 25, 2021

k8s-ci-robot requested review from jimangel and kbarnard10 February 25, 2021 22:25

k8s-ci-robot added sig/docs Categorizes an issue or PR as relevant to SIG Docs. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Feb 25, 2021

docs: Initialize reports on the SIG health on general

5f63791

irvifa commented Mar 2, 2021

View reviewed changes

kbhawkey reviewed Mar 6, 2021

View reviewed changes

k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Mar 6, 2021

irvifa force-pushed the 2020-annual-report branch from 06e140e to 4d7d156 Compare March 6, 2021 22:16

irvifa requested review from kbhawkey and sftim March 6, 2021 22:16

docs: Add image of devstat and apply suggestions from other lead.

b25aedf

irvifa force-pushed the 2020-annual-report branch from 4d7d156 to b25aedf Compare March 30, 2021 15:55

irvifa changed the title ~~[WIP] docs: SIG Docs 2020 Annual Report~~ docs: SIG Docs 2020 Annual Report Mar 30, 2021

k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Mar 30, 2021

parispittman reviewed Apr 3, 2021

View reviewed changes

sftim reviewed Apr 5, 2021

View reviewed changes

kbhawkey reviewed Apr 6, 2021

View reviewed changes

sig-docs/annual-report-2021.md Show resolved Hide resolved

kbhawkey reviewed Apr 6, 2021

View reviewed changes

Update annual-report-2021.md

27677b2

Add some input from the others.

k8s-ci-robot added the committee/steering Denotes an issue or PR intended to be handled by the steering committee. label Apr 9, 2021

jimangel reviewed Apr 10, 2021

View reviewed changes

irvifa commented Apr 11, 2021

View reviewed changes

irvifa force-pushed the 2020-annual-report branch from b09a903 to e8c082a Compare April 11, 2021 17:52

sftim reviewed Apr 11, 2021

View reviewed changes

Apply suggestions from code review

25ad775

Co-authored-by: Jim Angel <jimangel@users.noreply.github.com>

irvifa force-pushed the 2020-annual-report branch from e8c082a to 25ad775 Compare April 13, 2021 15:15

liggitt reviewed Apr 19, 2021

View reviewed changes

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 19, 2021

k8s-ci-robot merged commit 2bf7028 into kubernetes:master Apr 19, 2021

irvifa deleted the 2020-annual-report branch April 19, 2021 19:40


		<!-- TODO -->

		When was your last monthly community-wide update? (provide link to deck and/or recording)


		Year to date KEP work review: What’s now stable? Beta? Alpha? Road to alpha?

		<!-- TODO -->


		What's the average open days of a PR and Issue in your group? / what metrics does your group care about and/or measure?

		<!-- TODO -->

docs: SIG Docs 2020 Annual Report #5569

docs: SIG Docs 2020 Annual Report #5569

Conversation

irvifa commented Feb 25, 2021 • edited Loading

k8s-ci-robot commented Feb 25, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sftim left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kbhawkey Apr 6, 2021 • edited Loading

Choose a reason for hiding this comment

dims commented Apr 9, 2021

jimangel left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

irvifa left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

liggitt commented Apr 13, 2021

liggitt commented Apr 13, 2021

sftim commented Apr 13, 2021

irvifa commented Apr 13, 2021

liggitt left a comment

Choose a reason for hiding this comment

liggitt commented Apr 19, 2021

irvifa commented Feb 25, 2021 •

edited

Loading

kbhawkey Apr 6, 2021 •

edited

Loading

irvifa left a comment •

edited

Loading