Skip to content

Latest commit

 

History

History
84 lines (58 loc) · 5.6 KB

annual-activities.md

File metadata and controls

84 lines (58 loc) · 5.6 KB
Raw

List of annual activities to be performed by SIG Docs leadership

This document lists and details the activities to be performed annually by SIG Docs leadership

The recommended timeline for these activities is usually November - January due to lower levels of activity.

Prune OWNERS_ALIASES under k/website

At the end of each year, leadership needs to ensure that folks listed in the OWNERS_ALIASES file are willing to continue contributing.

This can be done by using the maintainers tool which helps parse the file for activity levels of those listed from GitHub and devstats.

Steps

  • Set up the maintainers tool along with its prerequisites locally by following the instructions.
  • Clone the k/website repository on your machine.
  • Create a new branch locally. This is required since there are nested OWNERS_ALIASES files within the repository.
  • 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. Without this, the maintainers tool will not produce the required output.
  • Run the maintainers tool against this new copy of the website repo locally.
    • Tip: While executing the command, ensure you exclude the following folks by using the --exclude flag:
      • Security Response Committee members,
      • Release engineering approvers and reviewers,
      • Co-chairs and tech leads of SIG Docs, SIG Release, and SIG Security
  • You'll get a list of SIG Docs approvers/reviewers with no contributions and with low reviews/approvals.
  • 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.
  • Socialize the activity within the SIG Docs google group and the #sig-docs slack channel. Add it as an item to the upcoming meeting agenda.
  • Work with all stakeholders to get the PRs merged, ideally before the end of the year.
  • In case of issues with merging due to conflicts with localization initiatives, such as lack of minimum number of approvers/reviewers, seek consensus with the localization subproject and wider SIG Docs community in the next year.

Create new PR Wrangler schedule

Preferably, before the second week of December, the PR Wrangler schedule for the upcoming year needs to be released.

This needs to be done along with or after the pruning of the OWNERS_ALIASES file detailed above.

SIG co-chairs, tech leads, and localization subproject leads have access to edit the k/website wiki.

Steps:

  • Create a new page under PR Wranglers for the upcoming year.
  • Copy the table from previous year's page and amend the dates for the upcoming year.
  • Ensure approvers/reviewers pruned per the cleanup detailed above aren't reflecting in the list.
  • Socialize the new list on the #sig-docs slack channel.

Create new Issue Wrangler schedule

Preferably, before the second week of December, the Issue Wrangler schedule for the upcoming year needs to be released.

This needs to be done along with or after the pruning of the OWNERS_ALIASES file detailed above.

SIG co-chairs, tech leads, and localization subproject leads have access to edit the k/website wiki.

Steps:

  • 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.
  • Create a new page under Issue Wranglers for the upcoming year.
  • Copy the table from previous year's page and amend the dates for the upcoming year.
  • Add nominations received to the table.
    • Tip: Aim at populating data for Q1 of the upcoming year by December.
  • Socialize the new list on the #sig-docs slack channel.

Prepare annual report

SIG Docs co-chairs and tech leads are responsible for submission of annual report projecting SIG health during the first quarter of every year.

The annual reports for previous years can be viewed here.

General steps and timelines are outlined in this document.

Specific steps related to SIG Docs are outlined below.

Steps:

  • The site analytics dashboard is featured as part of metrics we care about.
    • Specifically, we highlight number of page views and top pages for the year.
  • 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.