---
# System prepended metadata

title: Guidance checklist for Release Docs status updates

---

# References
* https://github.com/kubernetes/sig-release/issues/2324
* https://github.com/kubernetes/sig-release/blob/master/release-team/role-handbooks/docs/Release-Timeline.md
# Overview
The purpose of this document is to structure expectations for status updates to SIG Docs and the Release Team, so that we can deliver each release on time and without friction. Better guidance around how status is reported can give docs leads and shadows a better idea of the amount of work upcoming, what constitutes a yellow/red status update, and empower them to make better decisions around deadlines.
# Docs Release Checklist
## Early Steps (Weeks 1-2)
These steps take approximately one hour to complete, and should be completed immediately.
- [ ] Join the Kubernetes #sig-release Slack channel. Introduce yourself as the Docs Lead for the [future release].

- [ ] Send a Slack direct message to the [future release] lead to introduce yourself.
- [ ] Join these Google groups:
    * kubernetes-sig-release
    * kubernetes-sig-docs
    * kubernetes-dev
    * kubernetes-release-team
        ⚠️ The list of members for this group is managed in git. Please create a PR against kuberenetes/sig-release repo to include your email under release-team group in sig-release/group.yaml
    * kubernetes-release-team-shadows
        ⚠️ The list of members for this group is managed in git. Please create a PR against kuberenetes/sig-release repo to include your email under release-team-shadows group in sig-release/group.yaml
- [ ]  Make sure your team is included in the "current" release team file, e.g: release 1.21. If not submit a PR see a sample for 1.21 here.
- [ ] Please create a PR against kuberenetes/sig-release repo to include the Team Docs email of this release under release-team group in sig-release/group.yaml
- [ ] Open a PR to add the Docs Team in the release-1.xx. For example here is the Release Team of 1.26        
- [ ]  Create a GitHub discussion in k/sig-release to introduce yourself to the current localization owners and to sync up early on the release timeline. 

### Early Steps Status Update
* Green: I have completed the entire checklist of tasks above.  
* Yellow: I have completed some of the checklist of tasks above and I'm not blocked on completing the remaining tasks.
* Red: I have completed some of the checklist of tasks above and I'm blocked on completing the remaining tasks. 


## Scratch Section
Docs lead activities to be added: 
* Confirm with the Release Lead about adding shadows to the mailing list as well as the release team Google group and GitHub. *Whose job is this actually? (Release Lead, Emeritus Advisor)*
* Create a sign up sheet ([example](https://docs.google.com/spreadsheets/d/1wHcgv0LTSzew8E3O3EPpBU8qFkiMc9IWRLv2oG83xl0/edit?usp=sharing)) for shadows to: 
    1.  Join the Release Team weekly call as the Docs RT representative. 
    2.  Join the SIG Docs weekly call as the Docs RT representative. 
    3.  Perform the docs branch sync. 
* Goal for the role markdown file: a set of checklist steps broken down weekly. Define the health status for each week (red/yellow/green). 
* Explain what you are doing and why to your shadows as you perform every action. Your shadows must be aware of what they are responsible for when they become the lead. 
