Update Doc Handbook for Week 9-11#2953
Conversation
k8s-ci-robot
added
do-not-merge/work-in-progress
k8s-ci-robot
added
needs-priority
area/release-team
k8s-ci-robot
added
the
cncf-cla: no
k8s-ci-robot
added
the
size/L
Urvashi0109
force-pushed
the
docs-handbook-updates-week-9-11
branch
from
6f90e16 to
dae38cc
Compare
k8s-ci-robot
added
cncf-cla: yes
|
/assign @katcosgrove |
Urvashi0109
changed the title
k8s-ci-robot
removed
the
do-not-merge/work-in-progress
There was a problem hiding this comment.
Pull request overview
This PR updates the Docs Release Timeline handbook for Weeks 9–11 (“Late Steps”) and introduces reusable Slack/meeting messaging templates to reflect current release practices.
Changes:
- Added a more detailed “Late Steps (Weeks 9–11)” workflow, including time estimates, action items, and a detailed final release notes preparation process.
- Introduced dedicated messaging templates for coordinating with SIG Docs and verifying kubeadm documentation with SIG Cluster Lifecycle.
- Updated the Release Timeline table of contents to match the revised Late Steps subsections.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| release-team/role-handbooks/docs/Release-Timeline.md | Updates Late Steps (Weeks 9–11) content and TOC to reflect current process and templates. |
| release-team/role-handbooks/docs/templates/sig-docs-coordination.md | Adds a reusable coordination message template for SIG Docs release-day support + generated docs status. |
| release-team/role-handbooks/docs/templates/sig-cluster-lifecycle-verification.md | Adds a reusable verification message template for SIG Cluster Lifecycle (kubeadm) docs readiness. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: Urvashi0109 The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
Urvashi0109
force-pushed
the
docs-handbook-updates-week-9-11
branch
from
2c10b6b to
c78c863
Compare
|
/cc @kernel-kun @sayanchowdhury for review and proof-reading |
|
@Urvashi0109: GitHub didn't allow me to request PR reviews from the following users: and, proof-reading, for, review. Note that only kubernetes members and repo collaborators can review this PR, and authors cannot review their own PRs. DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
| ## Late Steps (Weeks 9-11) - Prep for the Release | ||
|
|
||
| ### Touch base with SIG Docs | ||
| **Time Required:** ~4-6 hours total |
There was a problem hiding this comment.
I think it would better to drop the time-estimation because the Final Release Note Prep can vary from release to release. We would rather write a line or two of what is expected in these two weeks.
|
|
||
| ### Touch base with SIG Cluster Lifecycle (kubeadm) | ||
| > [!Important] | ||
| > This is a **Docs Lead responsibility** and a **time-intensive task**. Start this process as early as possible (after last Release Note PR is merged), as it can take considerable time depending on the number of release note PRs throughout the cycle. |
There was a problem hiding this comment.
Starting after the last Release Notes PR is merged would be too late, as release notes typically diminish after each RC. This process should begin around Docs Freeze, as noted in the calendar, with reviews completed approximately before the final rc1 release.
Reviews are required from SIG-Docs, the Release Lead, Shadows, and SIG Chairs and Tech Leads (they need to be intimated to look through their Release Notes changes).
This puts the Docs Lead in a comfortable position to incorporate the final RC-1 changes and merge before the release cut.
| - Request review from: | ||
| - Docs Team Shadows | ||
| - SIG Docs reviewers | ||
| - Release Team Lead |
There was a problem hiding this comment.
Add to post to chairs-and-techleads channel
I dropped this message for v1.36 release
https://kubernetes.slack.com/archives/CD6LAC15M/p1776792956903419
There was a problem hiding this comment.
Also, add text to prepare everything before the final week starts i.e with the reviews, lgtm and approval.
| The v[future release] release is scheduled for **[Day], [Date] at [Time] [Timezone]**. | ||
|
|
||
| **Need from SIG Docs:** | ||
| 1. **Release day support** - Who can help with Netlify configuration updates and release blog post publication? |
There was a problem hiding this comment.
Instead of specifying the task, it would better to draft in a manner where who will be a PoC for helping the docs lead with the tasks, and questions
| @@ -662,6 +744,7 @@ The following fields are required: | |||
| Have a Release Manager lgtm the dates on the PR. | |||
| This PR can be merged on release day by the Docs lead. | |||
There was a problem hiding this comment.
Could you please move these two lines here
This would help set the focus before starting with the updating the files. Could you placed as bullet items with and Actions achor.
What type of PR is this:
/kind documentation
What this PR does / why we need it:
This PR improves the
Late Steps (Weeks 9-11) - Prep for the Releasesection of the Docs Release Timeline handbook by updating documentation and the workflow for this critical phase of the release cycle with current practice followed.Key updates:
- Added and expanded a detailed section for Final Release Note preparation.
- Documented the step-by-step process currently being followed.
Late Steps (Weeks 9-11) - Prep for the Releasesection to match the renamed section headingsAI has been used in the following areas:
Which issue(s) this PR fixes:
Special notes for your reviewer: