-
Notifications
You must be signed in to change notification settings - Fork 398
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2624 from mbianchidev/patch-3
Update comms handbook v1.32
- Loading branch information
Showing
10 changed files
with
441 additions
and
100 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
26 changes: 26 additions & 0 deletions
26
...ase-team/role-handbooks/communications/templates/feature-blog-opt-in-message.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| This is a message to send to enhancement owners to opt in to write a feature blog for their enhancement, it should be sent on the KEP issue. | ||
| After this message is sent, the Comms team will follow up with the enhancement owner to help them keep in mind the timeline for the feature blog, every 1-2 weeks. | ||
|
|
||
| ``` | ||
| Hi @xx 👋 | ||
| This is <Comms shadow/lead name> from the <current release cycle version> Communications Team! | ||
| For the <current version> release, we are in the process of collecting and curating a list of potential feature blogs, and we'd love for you to consider writing one for your enhancement! | ||
| As you may be aware, feature blogs are a great way to communicate to users about features which fall into (but not limited to) the following categories: | ||
| - This KEP introduces some breaking change(s) | ||
| - This KEP has significant impacts and/or implications for Kubernetes users | ||
| - ...Or this is a long-awaited feature, in which case a blog would go a long way to cover the journey more in detail. | ||
| To opt in to write a feature blog, could you please let us know and open a "Feature Blog placeholder PR" (which can be only a skeleton at first) against the [website repository](https://github.com/kubernetes/website) by **<insert deadline here>**? For more information about writing a blog, please find the [blog contribution guidelines](https://kubernetes.io/docs/contribute/new-content/blogs-case-studies/#technical-considerations-for-submitting-a-blog-post) 📚 | ||
| Some timelines to keep in mind: | ||
| - <insert feature blog freeze deadline here>: Feature blog PR freeze | ||
| - <insert feature blog ready for review here>: Feature blogs ready for review | ||
| - You can find more in the [release document](https://github.com/kubernetes/sig-release/tree/master/releases/release-<version>#timeline) | ||
| **Note**: In your placeholder PR, use the current scheduled overall release date for the blog `date` and add a `draft:true` to the front matter. This will help us to merging this ahead of the release date and scheduling it after the release date. | ||
| If you have any questions or need help, please feel free to reach out to me or any of the Communications Team members. We are here to help you! | ||
| ``` |
91 changes: 91 additions & 0 deletions
91
release-team/role-handbooks/communications/templates/mid-cycle-blog-sneak-peek.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,91 @@ | ||
| # Outline for the release mid-cycle blog | ||
| This outline can be used as a reference for writing up the mid cycle release blog in case of sneak peek is required. Deprecations and removal are required in case there are any. | ||
|
|
||
| The following sections should give you an idea what can be considered for this mid-cycle blog, but it's not necessary to include every section. Include the ones that make sense for the features/announcements in the release. | ||
|
|
||
| * Introduction to the current status of the release | ||
| * The Kubernetes API Removal and Deprecation process | ||
| * Notes of important removals or deprecations (if any) | ||
| * Changes (KEPs) that are deemed to be interesting | ||
| * Order release features by impact, maturity, vision or grouped by SIG. | ||
| * This section lists out the key features (even if they are not being recommended to be used in production or are alphas). | ||
| * Call out important API deprecations and removals | ||
| * When possible, link upstream docs or KEP docs (past blogs link k/enhancement issues) | ||
| * Want to know more? | ||
| * Get involved | ||
| * SIGs | ||
| * Community meeting | ||
| * Where to host questions (or answer questions) | ||
| * Advocates | ||
| * Bluesky | ||
| * Slack | ||
| * Kubernetes blog | ||
|
|
||
|
|
||
| ## Release Mid-Cycle Blog Template | ||
|
|
||
| The template should give you some boilerplate. However, this blog is optional and each release has its own story to tell. You can be creative with it! | ||
|
|
||
| ```md | ||
| --- | ||
| layout: blog | ||
| title: 'Kubernetes 1.XX: Sneak peek' | ||
| date: 202n-mm-dd | ||
| slug: kubernetes-1-XX-sneak-peek | ||
| author: > | ||
| [Kubernetes v1.XX Release Team](https://github.com/kubernetes/sig-release/blob/master/releases/release-1.XX/release-team.md) | ||
| --- | ||
|
|
||
| **Editors:** [Comms teams members, ordered by last name ascending] | ||
|
|
||
| As we get closer to the release date for Kubernetes v1.xx, the project develops and matures, features may be deprecated, removed, or replaced with better ones for the project's overall health. This blog outlines some of the planned changes for the Kubernetes 1.xx release, that the release team feels you should be aware of for the continued maintenance of your Kubernetes environment and keeping up to date with the latest changes. The information listed below is based on the current status of the v1.xx release and may change before the actual release date. | ||
|
|
||
| ### The Kubernetes API Removal and Deprecation process | ||
| The Kubernetes project has a well-documented [deprecation policy](https://kubernetes.io/docs/reference/using-api/deprecation-policy/) for features. This policy states that stable APIs may only be deprecated when a newer, stable version of that same API is available and that APIs have a minimum lifetime for each stability level. A deprecated API has been marked for removal in a future Kubernetes release, it will continue to function until removal (at least one year from the deprecation), but usage will result in a warning being displayed. Removed APIs are no longer available in the current version, at which point you must migrate to using the replacement. | ||
|
|
||
| * Generally available (GA) or stable API versions may be marked as deprecated but must not be removed within a major version of Kubernetes. | ||
|
|
||
| * Beta or pre-release API versions must be supported for 3 releases after the deprecation. | ||
|
|
||
| * Alpha or experimental API versions may be removed in any release without prior deprecation notice, this process can become a withdrawal in cases where a different implementation for the same feature is already in place. | ||
|
|
||
| Whether an API is removed as a result of a feature graduating from beta to stable or because that API simply did not succeed, all removals comply with this deprecation policy. Whenever an API is removed, migration options are communicated in the [documentation](https://kubernetes.io/docs/reference/using-api/deprecation-guide/). | ||
|
|
||
| ## A note about xxx - Comms Lead | ||
|
|
||
| Here you can insert a note about a topic of the release or tangential to it. This can be a note about a feature, a process, or a community initiative that you think is important to highlight in the mid-cycle blog. | ||
|
|
||
| ## Sneak peek of Kubernetes 1.xx | ||
|
|
||
| ### KEP [#xxx](https://github.com/kubernetes/enhancements/issues/xxx) - Comms Owner | ||
| <insert here a KEP explanation paragraph> | ||
| - Repeat for every KEP that is interesting for the release | ||
|
|
||
| ## Want to know more? | ||
| New features and deprecations are also announced in the Kubernetes release notes. We will formally announce what's new in [Kubernetes v1.xx](https://github.com/kubernetes/kubernetes/blob/master/CHANGELOG/CHANGELOG-1.xx.md) as part of the CHANGELOG for that release. | ||
|
|
||
| You can see the announcements of changes in the release notes for: | ||
|
|
||
| * [Kubernetes v1.32](https://github.com/kubernetes/kubernetes/blob/master/CHANGELOG/CHANGELOG-1.32.md) | ||
|
|
||
| * [Kubernetes v1.31](https://github.com/kubernetes/kubernetes/blob/master/CHANGELOG/CHANGELOG-1.31.md) | ||
|
|
||
| * [Kubernetes v1.30](https://github.com/kubernetes/kubernetes/blob/master/CHANGELOG/CHANGELOG-1.30.md) | ||
|
|
||
| * [Kubernetes v1.29](https://github.com/kubernetes/kubernetes/blob/master/CHANGELOG/CHANGELOG-1.29.md) | ||
|
|
||
| ## Get involved | ||
|
|
||
| The simplest way to get involved with Kubernetes is by joining one of the many [Special Interest Groups](https://github.com/kubernetes/community/blob/master/sig-list.md) (SIGs) that align with your interests. | ||
| Have something you’d like to broadcast to the Kubernetes community? | ||
| Share your voice at our weekly [community meeting](https://github.com/kubernetes/community/tree/master/communication), and through the channels below. | ||
| Thank you for your continued feedback and support. | ||
|
|
||
| - Follow us on Bluesky [@Kubernetesio](https://bsky.app/profile/kubernetes.io) for the latest updates | ||
| - Join the community discussion on [Discuss](https://discuss.kubernetes.io/) | ||
| - Join the community on [Slack](http://slack.k8s.io/) | ||
| - Post questions (or answer questions) on [Stack Overflow](http://stackoverflow.com/questions/tagged/kubernetes) | ||
| - Share your Kubernetes [story](https://docs.google.com/a/linuxfoundation.org/forms/d/e/1FAIpQLScuI7Ye3VQHQTwBASrgkjQDSS5TP0g3AXfFhwSM9YpHgxRKFA/viewform) | ||
| - Read more about what’s happening with Kubernetes on the [blog](https://kubernetes.io/blog/) | ||
| - Learn more about the [Kubernetes Release Team](https://github.com/kubernetes/sig-release/tree/master/release-team) | ||
| ``` |
19 changes: 19 additions & 0 deletions
19
release-team/role-handbooks/communications/templates/pr-email.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| This email must be sent to the following recipients: | ||
| - [email protected] | ||
| - [email protected] | ||
| - <release-lead email, found in the contact sheet> | ||
|
|
||
| ``` | ||
| Hi there! | ||
| I'm the Comms Lead for Kubernetes <release version> (currently scheduled to release <release date>). | ||
| I'm reaching out to get our release day and pre-release press handled. | ||
| - 2-3 release highlights: <share 2-3 release highlights> | ||
| - Availability of our Lead for interviews <get it from release lead> | ||
| - the draft blog can be found at this link: https://github.com/kubernetes/website/pull/xxxx <share the draft PR> | ||
| Note: the draft blog will not contain the theme and the release logo, those will be added just ahead of the release to avoid spoiling the news but we can share such material in advance and in a separate file with you, as soon as our Lead creates the logo and shares the theme. | ||
| If you need anything else from the Comms team, don't hesitate to reach out! | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
15 changes: 15 additions & 0 deletions
15
...e-team/role-handbooks/communications/templates/release-highlights-discussion.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| This discussion is created by the Communications team to collect the Release Highlights for the current release cycle. | ||
|
|
||
| ``` | ||
| This is a discussion to collect the Release Highlights for the <version> release cycle. | ||
| Release Highlights are an essential part of the Kubernetes release cycle as they provide a birds-eye view of improvements, breaking or user-facing changes that are coming as part of the upcoming release. The release Comms team is asking for SIGs to comment on this discussion with items that we should highlight in release communications for <version>. | ||
| For each submission, please include a link to the KEP, the stage the feature is moving to, and a brief description of the KEP that will be used as an outline for the blog post content. | ||
| The deadline for <version> Release Highlights is <deadline>. | ||
| Here is the [discussion thread](https://github.com/kubernetes/sig-release/discussions/2639) from the last release cycle. | ||
| cc @kubernetes/release-team-leads | ||
| cc @comms-shadow1 @comms-shadow2 @comms-shadow3 @comms-shadow4 | ||
| ``` |
69 changes: 69 additions & 0 deletions
69
...am/role-handbooks/communications/templates/release-highlights-tracking-issue.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| ### Overview | ||
| The release comms team will use this issue to track the work on nudging SIGs for entries on release highlights for the <version> release cycle. | ||
|
|
||
| Release Highlights discussion for <version>: #xxxx Release Highlights deadline: **Some deadline**. | ||
|
|
||
| Release Highlights are collected during each release cycle for every SIG to see what should be highlighted in the release blog, webinar, and other communications. Different SIGs have a different number of [tracked enhancements](<enhancement-tracking-board-link>). Some SIGs have activities that aren't quite coupled with Kubernetes releases, and it's worth checking with them in case there are things worth calling out in what they did between the previous release and the current release. One example is the Dockershim removal from 1.24 or Immutable Secrets and ConfigMaps from the 1.21 release, as well the cgroup v2 change in 1.31. | ||
|
|
||
| ### What do I need to do? | ||
| 1. Pick a group of SIGs to reach out to (listed below), and comment your selection on this issue | ||
| 2. Reach out to the SIGs in slack to ask for Release Highlights feedback and directing them to the github discussion using the template below | ||
| 3. Comment here when you've completed reaching out to the SIGs | ||
|
|
||
| Depending on the responses we get, we may need to send out a reminder in Slack later in the release cycle to each SIG to get more feedback on Release Highlights Themes. | ||
|
|
||
| ### How do I find a SIG's slack channel? | ||
| The Slack channel for each SIG is usually #sig-, but accurate links are available in [k/community](https://github.com/kubernetes/community) under [sig-list.md](https://github.com/kubernetes/community/blob/master/sig-list.md). The plan is to ask for responses on the public Slack channel (non-disruptively). | ||
|
|
||
| ### What should I say? | ||
| Following is a bootstrap template that you can use to reach out to the individual SIGs informing them about the discussion thread. This template includes the important information to convey to the SIG, but you are free to add your own personalization to the message if you'd like to. | ||
|
|
||
| A template message can be found [here](/release-team/role-handbooks/communications/templates/release-highlight-message.md) | ||
|
|
||
| Following that message it is advised to ping the SIGs every 2 weeks to remind them about the release highlights. | ||
|
|
||
| ### SIG groups | ||
| The following are groups of SIGs we need to reach out to. The SIGs are grouped together in a mix of those that have tracked enhancements for this release and those that do not. Please comment below with the group you'd like to reach out to. | ||
|
|
||
| Group 1 | ||
|
|
||
| * [ ] Node | ||
| * [ ] Cloud Provider | ||
| * [ ] Architecture | ||
| * [ ] Testing | ||
|
|
||
| Group 2 | ||
|
|
||
| * [ ] Auth | ||
| * [ ] CLI | ||
| * [ ] K8s Infra | ||
| * [ ] Multicluster | ||
|
|
||
| Group 3 | ||
|
|
||
| * [ ] API Machinery | ||
| * [ ] Scheduling | ||
| * [ ] Autoscaling | ||
| * [ ] Security | ||
|
|
||
| Group 4 | ||
|
|
||
| * [ ] Network | ||
| * [ ] Instrumentation | ||
| * [ ] Cluster Lifecycle | ||
| * [ ] Scalability | ||
|
|
||
| Group 5 | ||
|
|
||
| * [ ] Storage | ||
| * [ ] Apps | ||
| * [ ] Windows | ||
| * [ ] UI | ||
|
|
||
|
|
||
| We'll try to keep the list up-to-date, but please double-check in the comments if someone has contacted their assigned channels. We can debate more details in Slack. | ||
|
|
||
| /milestone <version> | ||
|
|
||
| xref: #old-issue | ||
|
|
15 changes: 15 additions & 0 deletions
15
...e-team/role-handbooks/communications/templates/sig-release-highlight-message.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| This message is sent to SIGs, in their channel, to collect the Release Highlights for the release cycle. | ||
|
|
||
| ``` | ||
| Hi SIG @xxx 👋 | ||
| this is <Comms shadow/lead name> from the <current release cycle version> Communications Team! | ||
| Release Highlights are an essential part of the Kubernetes release cycle as they provide a birds-eye view of improvements, breaking or user-facing changes that are coming as part of the upcoming release. | ||
| Release Comms team is asking for your help gathering your Release Highlights for this release. If you have anything to call out, we would appreciate it if your SIG can submit the content in Kubernetes <current release cycle version> Release Highlights [GitHub discussion](https://github.com/kubernetes/sig-release/discussions/xxxx). | ||
| Ideally, we would like this to be completed by **<deadline>**. | ||
| Thank you so much for your cooperation :smile: | ||
| ``` |
17 changes: 17 additions & 0 deletions
17
release-team/role-handbooks/communications/templates/webinar-email.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| This email must be sent to the following recipients: | ||
| - [email protected]; | ||
| - [email protected] | ||
| - <release-lead email, found in the contact sheet> | ||
| - <enhancement-lead email, found in the contact sheet> | ||
|
|
||
| ``` | ||
| Hi! | ||
| I'm the Communications Lead for Kubernetes <release-version>, and I'm reaching out to schedule a live webinar for our Release and Enhancements Leads, reading in CC. | ||
| This version is currently scheduled to be released on the <release date>, see the details here: https://www.kubernetes.dev/resources/release/ | ||
| Could you help us to schedule the webinar? | ||
| Do you have availability sometime for 3-4 weeks after the release? We can work around your schedule. | ||
| Thanks! | ||
| ``` |
Oops, something went wrong.