Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

📖 Documentation improvements: suggestions for team leads #9270

Merged
merged 1 commit into from
Aug 23, 2023
Merged

📖 Documentation improvements: suggestions for team leads #9270

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/release/release-tasks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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.
Expand Down
46 changes: 33 additions & 13 deletions docs/release/release-team.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 -->

Expand Down Expand Up @@ -89,10 +90,29 @@ When assembling a release team, the release team lead should look for volunteers

## Time Commitment
sbueringer marked this conversation as resolved.
Show resolved Hide resolved

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:
Expand Down