Documentation improvements: suggestions for team leads

Signed-off-by: Prajyot-Parab <prajyot.parab2@ibm.com>
kubernetes-sigs · Aug 22, 2023 · 3ea1488 · 3ea1488
1 parent b8338f5
commit 3ea1488
Show file tree

Hide file tree

Showing 2 changed files with 41 additions and 14 deletions.
diff --git a/docs/release/release-tasks.md b/docs/release/release-tasks.md
@@ -26,6 +26,7 @@ This document details the responsibilities and tasks for each role in the releas
     - [[Continuously] Maintain the GitHub release milestone](#continuously-maintain-the-github-release-milestone)
     - [[Continuously] Bump the Go version](#continuously-bump-the-go-version)
     - [[Repeatedly] Cut a release](#repeatedly-cut-a-release)
+    - [[Optional] Public release session](#optional-public-release-session)
     - [[Optional] [Track] Bump the Cluster API apiVersion](#optional-track-bump-the-cluster-api-apiversion)
     - [[Optional] [Track] Bump the Kubernetes version](#optional-track-bump-the-kubernetes-version)
 - [Communications/Docs/Release Notes Manager](#communicationsdocsrelease-notes-manager)
@@ -238,7 +239,7 @@ Additional information:
   * Create a release tag on the GitHub repository.
   * Create/update/publish GitHub releases.
 
-[Optional] Public release session
+#### [Optional] Public release session
    1. Host a release session over a public zoom meeting.
    2. Record the session for future reference and transparency.
    3. Use release process-related waiting periods as a forum for discussing issues/questions.

diff --git a/docs/release/release-team.md b/docs/release/release-team.md
@@ -1,18 +1,19 @@
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 
-* [Cluster API Release Team](#cluster-api-release-team)
-  * [Overview](#overview)
-    * [Goals](#goals)
-    * [Non-Goals/Future work](#non-goalsfuture-work)
-  * [Duration of Term](#duration-of-term)
-  * [Specific Responsibilities](#specific-responsibilities)
-  * [Team Roles](#team-roles)
-  * [Team Selection](#team-selection)
-    * [Selection Criteria](#selection-criteria)
-  * [Time Commitment](#time-commitment)
-  * [Why should I volunteer?](#why-should-i-volunteer)
-  * [Cluster API release team vs kubernetes/kubernetes-SIG membership](#cluster-api-release-team-vs-kuberneteskubernetes-sig-membership)
+- [Cluster API Release Team](#cluster-api-release-team)
+  - [Overview](#overview)
+    - [Goals](#goals)
+    - [Non-Goals/Future work](#non-goalsfuture-work)
+  - [Duration of Term](#duration-of-term)
+  - [Specific Responsibilities](#specific-responsibilities)
+  - [Team Roles](#team-roles)
+  - [Team Selection](#team-selection)
+    - [Selection Criteria](#selection-criteria)
+  - [Time Commitment](#time-commitment)
+  - [Suggestions for Team Leads](#suggestions-for-team-leads)
+  - [Why should I volunteer?](#why-should-i-volunteer)
+  - [Cluster API release team vs kubernetes/kubernetes-SIG membership](#cluster-api-release-team-vs-kuberneteskubernetes-sig-membership)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
@@ -89,10 +90,35 @@ When assembling a release team, the release team lead should look for volunteers
 
 ## Time Commitment
 
-As a member of the release team, you should expect to spend approximately 4-8 hours a week on release related activities for the duration of the term. 
+As a member of the release team, you should expect to spend approximately 4-8 hours a week on release related activities for the duration of the term.
+
+Here's a rough estimate of the time requirements per week:
+
+   * Weeks 1-4: 4-8 hours a week
+   * Weeks 5-15: 6-10 hours a week
+   * Week after Code Freeze: Be prepared to dedicate a significant amount of time each day to release-related activities.
+   * Weeks 16-18: 6-10 hours a week
+   * Release Day: Prepare to spend the entire day on release-related activities. If the choice is between working after-hours or on weekends and having the release delayed beyond the initial target, delaying the release is preferred.
+
+Specific time commitments include:
+   * Release Team meetings once a week throughout the entire release cycle.
+   * Release Day meetings ideally occurring once during the actual release weeks (weeks 5, 9, 13-14, 16-18).
+   * Any other release-related critical meetings with prior notice.
 
 Before you volunteer to be part of a CAPI release team, please make certain that your employer is aware and supportive of your commitment to the release team.
 
+## Suggestions for Team Leads
+
+  * Clearly communicate with the team that the majority of the work during the release cycle will be a collaborative effort.
+  * Establish an ownership rotation policy in consultation with respective team members.
+  * Provide opportunities for team members to take the lead in cutting a release within the cycle, based on feasibility.
+  * Define backup ownership and tasks for team members, such as:
+      * Hosting community meetings.
+      * Communicating key updates during office hours meetings when necessary.
+      * Sharing release-related updates with the CAPI community.
+      * Monitoring and reporting CI status regularly to the release team.
+      * Scheduling additional meetings as required to facilitate a smooth release cycle.
+
 ## Why should I volunteer?
 
 Volunteering to be part of a CAPI release team is a great way to contribute to the community and to the release process: