Release post - GitLab 11.4

Review Apps: https://release-11-4.about.gitlab.com/2018/10/22/gitlab-11-4-released/

Release post:

• Intro: https://gitlab.com/gitlab-com/www-gitlab-com/blob/release-11-4/source/posts/2018-10-22-gitlab-11-4-released.html.md
• Items: https://gitlab.com/gitlab-com/www-gitlab-com/blob/release-11-4/data/release_posts/2018_10_22_gitlab_11_4_released.yml
• Images: https://gitlab.com/gitlab-com/www-gitlab-com/tree/release-11-4/source/images/11_4

Related files:

• Features YAML link: https://gitlab.com/gitlab-com/www-gitlab-com/blob/release-11-4/data/features.yml
• Home page banner: https://gitlab.com/gitlab-com/www-gitlab-com/blob/release-11-4/source/includes/hello-bar.html.haml
• MVPs: https://gitlab.com/gitlab-com/www-gitlab-com/blob/release-11-4/data/mvps.yml

Handbook references:

• Blog handbook: https://about.gitlab.com/handbook/marketing/blog/
• Release post handbook: https://about.gitlab.com/handbook/marketing/blog/release-posts/
• Markdown guide: https://about.gitlab.com/handbook/product/technical-writing/markdown-guide/

People:

• Release Post Managers: https://about.gitlab.com/handbook/marketing/blog/release-posts/managers/
• Release Managers: https://about.gitlab.com/release-managers/

Release post manager	Tech writer	Copyedit	Messaging Lead	Social
@jramsay	@eread	xx	@johnjeremiah	xx

General contributions

Due date: 2018-10-12 (6th working day before the 22nd)

All contributions added by team members, collaborators, and Product Managers (PMs).

Author's checklist

Due date: 2018-10-12 (6th working day before the 22nd) - @jramsay

The PM leading the post is responsible for adding and checking the following items:

• Label MR: ~"blog post" release release post ~P1
• Assign the MR to yourself
• 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
• Add authorship (author's data)
• Ask the Marketing reviewer to add the introduction
• Add MVP (feature block)
• Add MVP to data/mvps.yml
• Add cover image (image_title) (scaled and compressed)
• Add social sharing image (twitter_image) (scaled and compressed)
• Make sure all feature descriptions are positive and cheerful
• Make sure all features listed in the direction page are included in the post
• Mention the release managers to remind them to add the upgrade barometer section
• Mention the team leads to remind them to add the performance improvements: Yorick, Douwe, Sean, Remy, Stan, Kamil, Tim Z., Clement, Andre
• Ping @atflowers and @aoetama to add the Release Radar webcast link
• Make sure Upgrade barometer is in
• 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
• Perform the content review

Recurring blocks

Due date: 2018-10-12 (6th working day before the 22nd)

The following sections are always present, and managed by the PM or Eng lead owning the related area:

• Add GitLab Runner improvements: Fabio
• Add Omnibus improvements: Joshua
• Add Mattermost update to the Omnibus improvements section: Victor
• Add Performance improvements: Douwe, Sean, Kamil, Yorick, Tim

Feature blocks

Due date: 2018-10-12 (6th working day before the 22nd)

The Product Managers are responsible for adding their feature blocks to the release post by the due date for general contributions. PMs are also responsible for adding any notable Community Contributions.

PMs: please check your box only when all your features and deprecations were added with completion (documentation links, images, etc). Pls don't check if there are still things missing.

• Andreas (@akaemmerle)
• Daniel (@danielgruesso)
• Fabio (@bikebilly)
• James (@jramsay)
• Jason (@jlenny)
• Jeremy (@jeremy_)
• Joshua (@joshlambert)
• Victor (@victorwu)

Tip: make your own checklist:

• Primary features
• Improvements (secondary features)
• Deprecations
• Documentation updated
• Documentation links added to the post
• Community contributions
• Illustrations added to the post (compressed)
• Update features.yml (with accompanying screenshots)

Review

Ideally, complete the review until the 4th working day before the 22nd, so that the 3rd and the 2nd working day before the release could be left for fixes and small improvements.

Content review

Due date: 2018-10-15 (5th working day before the 22nd)

Performed by the author of the post: @jramsay

• Label MR: ~"blog post" release review-in-progress
• Check all comments in the thread (make sure no contribution was left behind)
• Check Features' names
• Check Features' availability (Core, Starter, Premium, Ultimate badges)
• Check Documentation links (all feature blocks contain documentation_link)
• Make sure documentation_link links to feature webpages when available
• Update home page bannersource/includes/hello-bar.html.haml
• Features were added to data/features.yml (with accompanying screenshots)
• Check all images size < 300KB (compress them all with TinyPNG or similar tool)
• Pull master, resolve any conflicts
• Make sure all discussions in the thread are resolved
• Mention Mark Pundsack to remind him to review
• Assign the MR to the next reviewer (structural check)
• Lock features.yml with File Locking on the 21st

Structural check

Due date: 2018-10-17 (3rd working day before the 22nd)

Performed by technical writers: @eread

• 1. Structural check
• Add the label review-structure
• Check 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
• 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)

Further reviews

Due date: 2018-10-18 (2nd working day before the 22nd)

• Copyedit (content team): @erica
  • Title
  • Description
  • Intro
  • Grammar, spelling, clearness (body)
  • Homepage Blurb
  • Tweet social sharing text (for Twitter, FB, and LinkedIn)
  • Assign the MR to the next reviewer (marketing)
• Marketing review (PMMs - messaging lead): @johnjeremiah
  • Write the introduction (by the 6th day before the 22nd)
  • Check/copyedit feature blocks
  • Check/copyedit features.yml
  • Check/copyedit homepage blurb
  • Check/copyedit social sharing text
  • Mention Job for final check
  • Remove the label review-in-progress
  • Assign the MR back to the author

Merge it

The author of the post is responsible for merging the MR and following up with possible adjustments/fixes.

Last check before merging

• Read the important notes below
• Mention @matteeyah 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
• 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
• Check if the tweet copy is ready and someone is ready to share on social media
• Ask the release managers to ping you when the packs are publicly available (and GitLab.com is up and running on the release version)
• Unlock features.yml just before merging
• Merge the MR
• Wait for the pipeline
• Check the look on social media with Twitter Card Validator and Facebook Debugger
• Share on social media

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 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. 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), 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

data/release_posts/2018_10_22_gitlab_11_4_released.yml

+###
+#
+# Release post data file
+#
+# Start the release post with this file, named `YYYY_MM_22_gitlab_X_Y_released.yml`
+# placed into `data/release_posts/`.
+#
+# Notes:
+#  - All description entries support markdown. Use it as you do for a regular markdown file.
+#   Just make sure the indentation is respected.
+#
+## Entries:
+#
+# - name: Amazing Feature # feature name: make it consistent, use the same name here, in the features.yml file, and in the docs
+# - available_in: [core, starter, premium, ultimate]
+# - gitlab_com: false # apply this for features not available in GitLab.com
+# - documentation_link: 'https://docs.gitlab.com/ee/#amazingdoc' # up-to-date documentation - required
+# - image_url: '/images/x_y/feature-a.png'
+# - image_noshadow: true # this eliminates double shadows for images that already have a shadow
+# - video: # overrides image_url - use the "embed" link
+# - reporter: pm1 # GitLab handle of the user adding the feature block in the list (not the feature author)
+# - team: teamname # GitLab team that implemented the feature (e.g., CI/CD, Secure - see https://gitlab.com/gitlab-org/gitlab-ce/blob/master/CONTRIBUTING.md#team-labels)
+# - issue_url: 'https://gitlab.com/gitlab-org/gitlab-ce/issues/12345' # link to the issue on GitLab.com where the feature is discussed and developed - required but replaceable with epic_url or mr_url
+# - issueboard_url: 'https://gitlab.com/group/project/boards/123?=' # link to the issue board for the feature (not required)
+# - epic_url: 'https://gitlab.com/groups/gitlab-org/-/epics/123' # link to the epic for the feature (not required)
+# - mr_url: 'https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/123' # link to the MR that introduced the feature (not required)
+# - webpage_url: '/features/gitlab-geo/' # link to the marketing webpage for a given feature (not required)
+#
+# Read through the Release Posts Handbook for more information:
+# https://about.gitlab.com/handbook/marketing/blog/release-posts/
+#
+# ATTENTION: Leave these instructions and the example blocks (with their inline comments) up until the time the review starts. Once you've added an item, and **only by then**, please remove the inline comment to indicate that the item has been updated, thus we can clear up the comments on the go and easily spot what's missing.
+###
+
+features:
+# TOP FEATURE
+  top:
+    - name: "Amazing Feature"
+      available_in: [starter, premium, ultimate] # required
+      gitlab_com: false # required if the feature is NOT available in GitLab.com. Else, delete this line.
+      documentation_link: 'https://docs.gitlab.com/ee/#amazing' # required
+      image_url: '/images/9_X/feature-a.png' # required
+      reporter: pm1 # required
+      team: teamname # required
+      issue_url: '' # required
+      description: | # supports markdown
+        Lorem ipsum dolor sit amet, consectetur adipisicing elit. Aliquid laudantium,
+        quisquam pariatur architecto quo vel sequi, aperiam ex autem itaque saepe
+        sint dignissimos, quis voluptates similique.
+        Hic veritatis facere eligendi, minus nisi eveniet delectus fugiat.
+
+        Lorem ipsum dolor sit amet, `consectetur adipisicing` elit.
+        Rerum nisi et ex rem, obcaecati, commodi incidunt fugit,
+        deleniti nesciunt aperiam consequuntur.
+
+        1. Lorem ipsum dolor.
+        1. Lorem ipsum dolor sit.
+
+        > Lorem ipsum dolor sit amet.
+
+        Lorem ipsum dolor sit amet, [consectetur adipisicing elit](#link).
+        Quae repellat, at ullam amet.
+
+        ![Amazing feature screenshot](/images/X_Y/amazing-feature.png){:.shadow}
+
+        Lorem ipsum dolor sit amet, consectetur adipisicing elit.
+
+# PRIMARY FEATURES
+  primary:
+    - name: "Lorem ipsum"
+      available_in: [core, starter, premium, ultimate] # required
+      gitlab_com: false # required if the feature is NOT available in GitLab.com. Else, delete this line.
+      documentation_link: 'https://docs.gitlab.com/ee/#amazing' # required
+      image_url: '/images/X_Y/feature-a.png' # required
+      video: 'https://www.youtube.com/embed/enMumwvLAug' # example - optional - overrides image_url
+      reporter: pm1 # required
+      team: teamname # required
+      issue_url: '' # required
+      description: | # supports markdown
+        Lorem ipsum [dolor sit amet](#link), consectetur adipisicing elit.
+        Perferendis nisi vitae quod ipsum saepe cumque quia `veritatis`.
+
+    - name: "Lorem ipsum"
+      available_in: [core, starter, premium, ultimate] # required
+      gitlab_com: false # required if the feature is NOT available in GitLab.com. Else, delete this line.
+      documentation_link: 'https://docs.gitlab.com/ee/#amazing' # required
+      image_url: '/images/X_Y/feature-a.png' # required
+      video: 'https://www.youtube.com/embed/enMumwvLAug' # example - optional - overrides image_url
+      reporter: pm1 # required
+      team: teamname # required
+      issue_url: '' # required
+      description: | # supports markdown
+        Lorem ipsum [dolor sit amet](#link), consectetur adipisicing elit.
+        Perferendis nisi vitae quod ipsum saepe cumque quia `veritatis`.
+
+# SECONDARY FEATURES
+  secondary:
+    - name: "Lorem ipsum"
+      available_in: [premium, ultimate] # required
+      gitlab_com: false # required if the feature is NOT available in GitLab.com. Else, delete this line.
+      documentation_link: 'https://docs.gitlab.com/ee/#amazing' # webpage or documentation - required
+      image_url: '/images/X_Y/feature-a.png' # optional - recommended
+      video: 'https://www.youtube.com/embed/enMumwvLAug' # example - optional - overrides image_url
+      reporter: pm1 # required
+      team: teamname # required
+      issue_url: '' # required
+      description: | # supports markdown
+        Lorem ipsum [dolor sit amet](#link), consectetur adipisicing elit.
+        Perferendis nisi vitae quod ipsum saepe cumque quia `veritatis`.
+
+        Lorem ipsum dolor sit amet, consectetur adipisicing elit.
+        Voluptate eveniet, adipisci earum sed harum nostrum
+        itaque beatae, repellat sunt unde.
+
+    - name: "Lorem ipsum"
+      available_in: [premium, ultimate] # required
+      gitlab_com: false # required if the feature is NOT available in GitLab.com. Else, delete this line.
+      documentation_link: 'https://docs.gitlab.com/ee/#amazing' # webpage or documentation - required
+      image_url: '/images/X_Y/feature-a.png' # optional - recommended
+      video: 'https://www.youtube.com/embed/enMumwvLAug' # example - optional - overrides image_url
+      reporter: pm1 # required
+      team: teamname # required
+      issue_url: ''
+      description: | # supports markdown
+        Lorem ipsum [dolor sit amet](#link), consectetur adipisicing elit.
+        Perferendis nisi vitae quod ipsum saepe cumque quia `veritatis`.
+
+        Lorem ipsum dolor sit amet, consectetur adipisicing elit.
+        Voluptate eveniet, adipisci earum sed harum nostrum
+        itaque beatae, repellat sunt unde.
+
+# Omnibus and performance (required)
+
+    - name: "Omnibus improvements"
+      available_in: [core, starter, premium, ultimate]
+      gitlab_com: false
+      documentation_link: 'https://docs.gitlab.com/omnibus/'
+      reporter: pm1 # required
+      team: teamname # required
+      description: | # supports markdown
+        Lorem ipsum [dolor sit amet](#link), consectetur adipisicing elit.
+        Perferendis nisi vitae quod ipsum saepe cumque quia `veritatis`.
+
+    - name: "Performance improvements"
+      available_in: [core, starter, premium, ultimate]
+      performance_url: https://gitlab.com/groups/gitlab-org/merge_requests?scope=all&utf8=%E2%9C%93&state=merged&label_name%5B%5D=performance&milestone_title=X.X # Link to the merged MRs in the corresponding milestone
+      reporter: pm1 # required
+      team: teamname # required
+      description: | # supports markdown
+        Lorem ipsum [dolor sit amet](#link), consectetur adipisicing elit.
+        Perferendis nisi vitae quod ipsum saepe cumque quia `veritatis`.
+
+# EXTRAS (Optional)
+# extras:
+#  - title: "Hello World"
+#    description: | # supports markdown
+#     Lorem ipsum dolor sit amet, consectetur adipisicing elit. Consequuntur, beatae!
+
+# MVP
+mvp:
+  fullname: "" # Name Surname
+  gitlab: # gitlab.com username
+  description: | # example (supports markdown)
+    Lorem ipsum [dolor sit amet](#link), consectetur adipisicing elit.
+    Perferendis nisi vitae quod ipsum saepe cumque quia `veritatis`.
+
+# COVER IMAGE LICENCE
+cover_img:
+  image_url: 'https://unsplash.com/photos/pF1ug8ysTtY'
+  licence: Unsplash
+  licence_url: 'https://unsplash.com/license'
+
+# CTA BUTTONS (optional)
+cta:
+  - title: "Join us for an upcoming event" # default
+    link: '/events/'
+  - title: "Release Radar webcast" # default
+    link: '' # add release radar link here
+  - title: Lorem ipsum amet # optional
+    link:
+
+# UPGRADE BAROMETER
+barometer:
+  reporter: pm1 # required
+  description: | # example (supports markdown)
+    To upgrade to GitLab 9.X from the latest 9.Y version, no downtime is required. To upgrade without downtime, please consult the [documentation on downtimeless upgrades](https://docs.gitlab.com/ee/update/README.html#upgrading-without-downtime).
+
+    For this release we have migrations, post-deploy migrations, and to help with the larger migrations we have introduced background migrations.
+
+    GitLab.com migrations took approximately X minutes and post-deploy migrations amounted for a total of around Y minutes. Background migrations on the other hand are sidekiq jobs that will run synchronously, for this release these migrations took around Z days to complete, no side effects were expected nor present, these target older pipeline builds so newer executed pipelines are not affected.
+
+    GitLab Geo users, please consult the documentation on [upgrading Geo](https://docs.gitlab.com/ee/administration/geo/replication/updating_the_geo_nodes.html).
+
+# DEPRECATIONS (optional)
+# include as many deprecation blocks as necessary
+deprecations:
+  - feature_name: "Lorem ipsum dolor"
+    due: May 22nd, 2017. # example
+    reporter: pm1 # required
+    description: |  # example (supports markdown)
+      Lorem ipsum dolor sit amet, consectetur adipisicing elit.
+      Veritatis, quisquam.
+  - feature_name: "Lorem ipsum dolor"
+    due: May 22nd, 2017.
+    reporter: pm1 # required
+    description: |  # example (supports markdown)
+      Lorem ipsum dolor sit amet, consectetur adipisicing elit.
+      Veritatis, quisquam.