Skip to content
Snippets Groups Projects

Release post - GitLab 11.4

Merged James Ramsay (ex-GitLab) requested to merge release-11-4 into master
Compare and Show latest version
732 files
+ 13508
7095
Compare changes
  • Side-by-side
  • Inline
Files
732
@@ -25,7 +25,7 @@ _People:_
| Release post manager | Tech writer | Copyedit | Messaging Lead | Social |
| --- | --- | --- | --- | --- |
| xx | xx | xx | xx | xx |
| `@mention` | `@mention` | `@mention` | `@mention` | `@mention` |
### General contributions
@@ -37,19 +37,21 @@ All contributions added by team members, collaborators, and Product Managers (PM
**Due date: YYYY-MM-DD** (6th working day before the 22nd)
The PM leading the post is responsible for adding and checking the following items:
The PM leading the post is responsible for adding and checking the following items: `@mention`
- [ ] Label MR: ~"blog post" ~release ~"release post" ~P1
- [ ] Assign the MR to yourself
- [ ] Check the reviewers on Slack and add their names (and your own) replacing each `@mention` in the MR description checklists
- [ ] Add milestone
- [ ] Update the links and due dates in this MR description
- [ ] Make sure the blog post initial files, as well as this MR template contain the latest templates
- [ ] Make sure the blog post have all initial files, as well as this MR template contains the latest template
- [ ] Add authorship (author's data)
- [ ] Ask the Marketing reviewer to add the introduction
- [ ] Add MVP (feature block)
- [ ] Add MVP (MVP block)
- [ ] Add MVP to `data/mvps.yml`
- [ ] Add [cover image](https://about.gitlab.com/handbook/marketing/blog/release-posts#cover-image) (`image_title`) (scaled and compressed)
- [ ] Add [social sharing image](https://about.gitlab.com/handbook/marketing/blog/release-posts#social-sharing-image) (`twitter_image`) (scaled and compressed)
- [ ] Make sure the PM for the MVP feature adds a corresponding feature block if applicable, linking from the MVP section
- [ ] Add [cover image](https://about.gitlab.com/handbook/marketing/blog/release-posts#cover-image) (`image_title`) (compressed)
- [ ] Add [social sharing image](https://about.gitlab.com/handbook/marketing/blog/release-posts#social-sharing-image) (`twitter_image`) (compressed)
- [ ] Make sure all feature descriptions are positive and cheerful
- [ ] Make sure all features listed in the [direction](https://about.gitlab.com/direction/)
page are included in the post
@@ -61,9 +63,9 @@ to add the [upgrade barometer](https://about.gitlab.com/handbook/marketing/blog/
- [ ] Check which one is the top feature (with Job and William)
- [ ] Check if deprecations are included
- [ ] Alert people one working day before each due date (post a comment to #release-post Slack channel)
- [ ] Remove remaining template sections
- [ ] Make sure all images (png, jpg, and gifs) are smaller than 300 KB each
- [ ] Run the release post through an automated spell and grammar check
- [ ] Pull `master` into the release post branch and resolve any conflicts
- [ ] Perform the [content review](#content-review)
#### Recurring blocks
@@ -120,7 +122,7 @@ could be left for fixes and small improvements.
**Due date: YYYY-MM-DD** (5th working day before the 22nd)
Performed by the author of the post:
Performed by the author of the post: `@mention`
- [ ] Label MR: ~"blog post" ~release ~review-in-progress
- [ ] Check all comments in the thread (make sure no contribution was left behind)
@@ -141,40 +143,40 @@ Performed by the author of the post:
**Due date: YYYY-MM-DD** (3rd working day before the 22nd)
Performed by technical writers (Axil, Evan, Marcia, or Mike):
The [structural review](https://about.gitlab.com/handbook/marketing/blog/release-posts/#structural-check) is performed by a technical writer: `@mention`
- 1. Structural check
- [ ] Add the label ~review-structure
- [ ] Check frontmatter (entries, syntax)
- [ ] Pull `master` into the release post branch and resolve any conflicts
- [ ] Check [frontmatter](https://about.gitlab.com/handbook/marketing/blog/release-posts/#frontmatter) (entries, syntax)
- [ ] Check `image_title` and `twitter_image`
- [ ] Check image shadow applied correctly: `{image_noshadow: true}` when an image already has shadow
- [ ] Videos/iframes wrapped in `<figure>` tags (responsiveness)
- [ ] Wrap text
- [ ] Check headers in sentence case
- [ ] Check feature and product names in capital case
- [ ] Check if images are harmonic/consistent
- [ ] Add/check cover img reference (at the end of the post)
- [ ] Columns (content balance between the columns)
- [ ] Meaningful links (SEO)
- [ ] Badges consistency (applied to all headings)
- [ ] Double check documentation updates
- [ ] Check documentation links (point to `/ee/`, not to `/ce/`)
- [ ] Check about.gitlab.com links: relative URLs
- [ ] Check the anchor links in the intro
- [ ] Remove any remaining instructions
- [ ] Remove HTML comments
- [ ] Run [deadlink checker](https://chrome.google.com/webstore/detail/check-my-links/ojkcdipcgfaekbeaelaapakgnjflfglf)
- [ ] Pull `master`
- [ ] Update release template with any changes (if necessary)
- [ ] Post a comment in the `#general` channel linking to the review app + MR reminding the team to take a look at the RP and report any problems in the `#release-post` channel. (Do NOT ping `@all` or `@channel`)
- [ ] Remove the label ~review-structure
- [ ] Assign the MR to the next reviewer (copyedit)
- [ ] Check image shadow applied correctly in release post data. Look for `image_noshadow: true` when an image already has shadow
- [ ] Ensure videos and iframes are wrapped in `<figure class="video_container">` tags (for responsiveness)
- [ ] Ensure all text is consistently hard wrapped at a suitable column boundary
- [ ] Check headings are in sentence case
- [ ] Check feature and product names are in capital case
- [ ] Check that images are harmonic/consistent
- [ ] Add or check cover img reference (at the end of the post). Data in `cover_img` in release post Yaml file
- [ ] Ensure content is balanced between the columns (both columns are even)
- [ ] Ensure links have [meaningful text](https://about.gitlab.com/handbook/communication/#writing-style-guidelines) for SEO (e.g., "click here" is bad link text)
- [ ] Check for badges consistency (applied to all headings)
- [ ] Double check that all features are documented
- [ ] Check documentation links point to `/ee/` and not to `/ce/`
- [ ] Check that all links to about.gitlab.com content are relative URLs
- [ ] Check the anchor links in the intro. All links in the release post markdown file should point to something in the release post Yaml file
- [ ] Remove any remaining instructions (comments) from the release post files
- [ ] Run a dead link checker, e.g., [Check my Links](https://chrome.google.com/webstore/detail/check-my-links/ojkcdipcgfaekbeaelaapakgnjflfglf) and ping reporters directly on Slack asking them to fix broken links
- [ ] Update the release template with any suitable changes
- [ ] Pull `master` into the release post branch and resolve any conflicts (again)
- [ ] Report any problems from structural check in the `#release-post` channel by pinging the reporters directly for each problem. Do NOT ping `@all` or `@channel` nor leave a general message that no one will pay attention to. If possible, ensure any issues are tracked by open discussions in the merge request
- [ ] Post a comment in the `#general` channel linking to the review app + merge request reminding the team to take a look at the release post and to report problems in `#release-post`
- [ ] Remove the label ~review-structure.
- [ ] Assign the MR to the next reviewer (copyedit).
#### Further reviews
**Due date: YYYY-MM-DD** (2nd working day before the 22nd)
- [ ] Copyedit (content team)
- [ ] Copyedit (content team): `@mention`
- [ ] Title
- [ ] Description
- [ ] Intro
@@ -182,7 +184,7 @@ Performed by technical writers (Axil, Evan, Marcia, or Mike):
- [ ] [Homepage Blurb](https://gitlab.com/gitlab-com/www-gitlab-com/blob/release-X-Y/source/includes/home/ten-oh-announcement.html.haml)
- [ ] Tweet social sharing text (for Twitter, FB, and LinkedIn)
- [ ] Assign the MR to the next reviewer (marketing)
- [ ] Marketing review (PMMs - [messaging lead](https://about.gitlab.com/handbook/marketing/blog/release-posts/#messaging-lead))
- [ ] Marketing review (PMMs - [messaging lead](https://about.gitlab.com/handbook/marketing/blog/release-posts/#messaging-lead)): `@mention`
- [ ] Write the introduction (**by the 6th day before the 22nd**)
- [ ] Check/copyedit feature blocks
- [ ] Check/copyedit `features.yml`
@@ -195,14 +197,14 @@ Performed by technical writers (Axil, Evan, Marcia, or Mike):
### Merge it :rocket:
The author of the post is responsible for merging the MR and following up
with possible adjustments/fixes.
with possible adjustments/fixes: `@mention`.
#### Last check before merging
- [ ] Read the [important notes](#important-notes) below
- [ ] Mention `@matteeyah` to remind him to send the swag pack to the MVP
- [ ] Mention `@dplanella` to remind him to send the swag pack to the MVP
- [ ] Check if all the anchor links in the intro are working
- [ ] Check if there are no broken links
- [ ] Check if there are no broken links in the review app (use a dead link checker, e.g., [Check my Links](https://chrome.google.com/webstore/detail/check-my-links/ojkcdipcgfaekbeaelaapakgnjflfglf))
- [ ] Pull `master` and fix any conflicts
- [ ] Check if there isn't any alert on Slack's `#release-post` and `#general` channels
- [ ] Check if there isn't any alert on this MR thread
@@ -212,19 +214,22 @@ with possible adjustments/fixes.
- [ ] Merge the MR
- [ ] Wait for the pipeline
- [ ] Check the look on social media with [Twitter Card Validator](https://cards-dev.twitter.com/validator) and [Facebook Debugger](https://developers.facebook.com/tools/debug/)
- [ ] Share on social media
- [ ] Check for broken links again once the post is live
- [ ] Share on social media (or make sure someone else does) only when you're sure everything is okay
#### Important notes
- The post is to be merged on the **22nd** at 15:00 UTC and as soon as
GitLab.com is up and running on the new release
version, and all packages are publicly available. Not before.
- The post is to be live on the **22nd** at 15:00 UTC and as soon as
GitLab.com is up and running on the new release version, and all packages
are publicly available. Not before. Ideallly, merge it around 14:20 UTC.
- The usual release time is **15:00 UTC** but it varies according to
the deployment. If something comes up and delays the release, the release post
will be delayed with the release.
- Coordinate the timing with the
[release managers](https://about.gitlab.com/release-managers/).
Ask them to keep you in the loop.
- After merging, wait a few minutes to see if no one spot an error (usually posted in #general),
[release managers](https://about.gitlab.com/release-managers/). Ask them to
keep you in the loop. Ideally, the packages should be published around
13:30-13:40, so they will be publicly available around 14:10 and you'll
be able to merge the post at 14:20ish.
- Once the post is live, wait a few minutes to see if no one spot an error (usually posted in #general),
then share on Twitter, Facebook, and LinkedIn, or make sure someone (Emily vH, JJ, Marcia) does.
- Keep an eye on Slack and in the blog post comments for a few hours to make sure no one found anything that should be fixed
Loading