Breaking Changes Blog Post and Broadcast
-
Follow the process for requesting and creating a blog post and start one for breaking changes. - In the blog issue you create, communicate clearly that the URL for the blog post must be live/available on the first day of the major release milestone, for example, April 18 for a major release that's launching May 22
- You can reference: the issue and merge request for the 14.0 breaking-changes blog post.
- You can reference the 14.0 breaking changes blog for reference, repurposing the intro content, formatting, etc.
-
Add the blog issue you've created to Related Issues for this issue -
In the blog issue you created, ping the head of Technical Writing @susantacker
and ask her for a TW partner to help review the final blog post prior to publication -
Co-assign the issue/MR you create for the breaking changes blog to the designated TW and let them know you'll need them to review the blog content before it goes live. Set up a sync to align if needed.
-
Follow the process for scheduling a GitLab.com broadcast message: -
Create a broadcast message issue -
Use this copy for the broadcast message: The 15.0 major release is coming up! This version brings many exciting improvements to GitLab, but also removes some deprecated features. Visit the [deprecations page](https://docs.gitlab.com/ee/update/deprecations) to see what is scheduled for removal in 15.0, and check for any **breaking changes** that could impact your workflow.
-
In the broadcast message issue, communicate these requirements: - The message initiates on the 18th of the month (day 1) for milestone 14.10 (for example, March 18 if 14.10 is April 22)
- After the user closes the message, it should not reappear again
-
Add the broadcast message issue you've created to Related Issues for this issue
-
-
In Slack #release-post
, announce that the first broadcast message for breaking changes will run in 14.10. for SaaS users. Remind them they need to make sure that SSOT deprecations and removals in Docs is up to date as that's the source for automation.- Link them to the broadcast message issue for reference.
- Cross-post this Slack thread across the following channels:
#product #UX #tw-team #development #quality #eng-managers #marketing #product-marketing #customer-success #customer-support #sales #support_gitlab-com #support_self-managed #external-comms
Edited by Brian Rhea