From 007b980d3d839ebec6431cb8f1d47246f4c08090 Mon Sep 17 00:00:00 2001 From: Prajyot-Parab Date: Wed, 23 Aug 2023 00:16:43 +0530 Subject: [PATCH] Documentation improvements: suggestions for team leads Signed-off-by: Prajyot-Parab --- docs/release/release-tasks.md | 3 ++- docs/release/release-team.md | 46 +++++++++++++++++++++++++---------- 2 files changed, 35 insertions(+), 14 deletions(-) diff --git a/docs/release/release-tasks.md b/docs/release/release-tasks.md index 54b92a774ef0..08c75a1798db 100644 --- 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 index 452d83137d19..778a0f910106 100644 --- a/docs/release/release-team.md +++ b/docs/release/release-team.md @@ -1,18 +1,19 @@ -* [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) @@ -89,10 +90,29 @@ 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. + +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. Refer to release cycle timeline for more specific details. + * Any other release-related critical meetings with prior notice. + +While we don't anticipate individuals to be available every week during the release cycle, please feel free to inform the team of any unavailability so we can plan accordingly. 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 shadows you are responsible for, 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 release team 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: