|
| 1 | +# List of annual activities to be performed by SIG Docs leadership |
| 2 | + |
| 3 | +This document lists and details the activities to be performed annually by [SIG Docs leadership](./sig-docs/README.md#leadership) |
| 4 | + |
| 5 | +The recommended timeline for these activities is usually November - January due to lower levels of activity. |
| 6 | + |
| 7 | +## Prune OWNERS_ALIASES under k/website |
| 8 | + |
| 9 | +At the end of each year, leadership needs to ensure that folks listed in the [OWNERS_ALIASES file](https://github.com/kubernetes/website/blob/main/OWNERS_ALIASES) |
| 10 | +are willing to continue contributing. |
| 11 | + |
| 12 | +This can be done by using the [maintainers tool](https://github.com/kubernetes-sigs/maintainers) which helps parse the file for |
| 13 | +activity levels of those listed from GitHub and [devstats](https://k8s.devstats.cncf.io). |
| 14 | + |
| 15 | +### Steps |
| 16 | + |
| 17 | +- Set up the [maintainers tool](https://github.com/kubernetes-sigs/maintainers) along with its prerequisites locally by following the instructions. |
| 18 | +- Clone the [k/website](https://github.com/kubernetes/website) repository on your machine. |
| 19 | +- Create a new branch locally. This is required since there are nested OWNERS_ALIASES files within the repository. |
| 20 | +- Switch to the newly created branch and delete all nested OWNERS_ALIASES files. Retain the OWNERS_ALIASES file at the top of the repository root only. |
| 21 | +Without this, the maintainers tool will not produce the required output. |
| 22 | +- Run the maintainers tool against this new copy of the website repo locally. |
| 23 | + - Tip: While executing the command, ensure you exclude the following folks by using the `--exclude` flag: |
| 24 | + - Security Response Committee members, |
| 25 | + - Release engineering approvers and reviewers, |
| 26 | + - Co-chairs and tech leads of SIG Docs, SIG Release, and SIG Security |
| 27 | +- You'll get a list of SIG Docs approvers/reviewers with no contributions and with low reviews/approvals. |
| 28 | +- Submit a separate PR each for the list with no contributions and with low reviews/approvals and seek feedback. The timeframe for this activity should be ~2 weeks per PR. |
| 29 | + - Tip: The lists will likely be long. It'd be easier if you raise the second one after the first PR is merged. |
| 30 | + - Example PRs: |
| 31 | + - https://github.com/kubernetes/website/pull/38719 |
| 32 | + - https://github.com/kubernetes/website/pull/38853 |
| 33 | +- Socialize the activity within the [SIG Docs google group](https://groups.google.com/u/1/g/kubernetes-sig-docs) and the [#sig-docs slack channel](https://kubernetes.slack.com/messages/sig-docs). Add it as an item to the upcoming meeting agenda. |
| 34 | +- Work with all stakeholders to get the PRs merged, ideally before the end of the year. |
| 35 | +- In case of issues with merging due to conflicts with localization initiatives, such as lack of minimum number of approvers/reviewers, |
| 36 | +seek consensus with the localization subproject and wider SIG Docs community in the next year. |
| 37 | + |
| 38 | +## Create new PR Wrangler schedule |
| 39 | + |
| 40 | +Preferably, before the second week of December, [the PR Wrangler schedule](https://github.com/kubernetes/website/wiki/PR-Wranglers) for the upcoming year needs to be released. |
| 41 | + |
| 42 | +This needs to be done along with or after the pruning of the OWNERS_ALIASES file detailed above. |
| 43 | + |
| 44 | +SIG co-chairs, tech leads, and localization subproject leads have access to edit the [k/website wiki](https://github.com/kubernetes/website/wiki/). |
| 45 | + |
| 46 | +### Steps: |
| 47 | + |
| 48 | +- Create a new page under [PR Wranglers](https://github.com/kubernetes/website/wiki/PR-Wranglers) for the upcoming year. |
| 49 | +- Copy the table from previous year's page and amend the dates for the upcoming year. |
| 50 | +- Ensure approvers/reviewers pruned per the cleanup detailed above aren't reflecting in the list. |
| 51 | +- Socialize the new list on the [#sig-docs slack channel](https://kubernetes.slack.com/messages/sig-docs). |
| 52 | + |
| 53 | +## Create new Issue Wrangler schedule |
| 54 | + |
| 55 | +Preferably, before the second week of December, [the Issue Wrangler schedule](https://github.com/kubernetes/website/wiki/Issue-Wranglers) for the upcoming year needs to be released. |
| 56 | + |
| 57 | +This needs to be done along with or after the pruning of the OWNERS_ALIASES file detailed above. |
| 58 | + |
| 59 | +SIG co-chairs, tech leads, and localization subproject leads have access to edit the [k/website wiki](https://github.com/kubernetes/website/wiki/). |
| 60 | + |
| 61 | +### Steps: |
| 62 | + |
| 63 | +- Send out a call for nominations for the Issue Wrangler role during the last quarter of the year on the the [SIG Docs google group](https://groups.google.com/u/1/g/kubernetes-sig-docs). |
| 64 | +- Create a new page under [Issue Wranglers](https://github.com/kubernetes/website/wiki/Issue-Wranglers) for the upcoming year. |
| 65 | +- Copy the table from previous year's page and amend the dates for the upcoming year. |
| 66 | +- Add nominations received to the table. |
| 67 | + - Tip: Aim at populating data for Q1 of the upcoming year by December. |
| 68 | +- Socialize the new list on the [#sig-docs slack channel](https://kubernetes.slack.com/messages/sig-docs). |
| 69 | + |
| 70 | +## Prepare annual report |
| 71 | + |
| 72 | +SIG Docs co-chairs and tech leads are responsible for submission of annual report projecting SIG health during the first quarter of every year. |
| 73 | + |
| 74 | +The annual reports for previous years can be viewed [here](https://github.com/kubernetes/community/tree/master/sig-docs). |
| 75 | + |
| 76 | +General steps and timelines are outlined in [this document](https://github.com/kubernetes/community/blob/master/committee-steering/governance/annual-reports.md). |
| 77 | + |
| 78 | +Specific steps related to SIG Docs are outlined below. |
| 79 | + |
| 80 | +### Steps: |
| 81 | + |
| 82 | +- The [site analytics dashboard](https://datastudio.google.com/u/0/reporting/fede2672-b2fd-402a-91d2-7473bdb10f04/page/567IC) is featured as part of metrics we care about. |
| 83 | + - Specifically, we highlight number of page views and top pages for the year. |
| 84 | +- Normally, we do not have KEPs as part of release cycles. Any work on an ongoing KEP or a subproject formalization needs to be highlighted explicitly. |
0 commit comments