Revert "Merge branch 'update-release-post-handbook' into 'master'"

This reverts merge request !6152

.gitlab/merge_request_templates/Release-Post.md

@@ -13,29 +13,28 @@ Due date: MM/DD (6th working day before the 22nd)
 - [ ] Add milestone 
 - [ ] Intro
 - [ ] MVP
-- [ ] Add cover image `image_title` (compressed)
+- [ ] Webcast link
 - [ ] Upgrade barometer
-- [ ] Top features
-- [ ] Primary features
-- [ ] Secondary features (improvements)
+- [ ] Main features
+- [ ] Secondary features
+- [ ] Other features
 - [ ] Performance improvements
 - [ ] Omnibus improvements
 - [ ] Deprecations
+- [ ] Extras
 - [ ] Documentation links
 - [ ] Authorship (author's data)
-### Review
-#### Content review (PMs)
-
-Due date: MM/DD (2nd working day before the 22nd)
+### Content Review
+Due date: MM/DD (4th working day before the 22nd)
 - [ ] Label MR: ~"blog post" ~release ~review-in-progress
 - [ ] General review (PM)
   - [ ] Check Features' names
   - [ ] Check Features' availability (CE, EES, EEP)
   - [ ] Check Documentation links
-  - [ ] Update `data/promo.yml`
+  - [ ] Add `data/promo.yml`
   - [ ] Check all images' size - compress whenever > 300KB
   - [ ] Meaningful links (SEO)
   - [ ] Check links to product/feature webpages
@@ -45,17 +44,24 @@ Due date: MM/DD (2nd working day before the 22nd)
   - [ ] Grammar, spelling, clearness (body)
 - [ ] Final review (Job)
-#### Structural Check
-Due date: MM/DD (2nd working day before the 22nd)
+### Structure & Styles
+
+Add HTML/CSS structure to style the blog post, review markup. Technical Writing / Frontend / UX.
+Due date: MM/DD (1st working day before the 22nd)
 - 1. Structural check
 - [ ] Label MR: ~"blog post" ~release ~review-structure
 - [ ] Check frontmatter (entries, syntax)
-- [ ] Check `image_title` and `twitter_image`
+  - [ ] Uncomment custom css and custom js
+- [ ] Add cover image `image_title` - compressed
+- [ ] Add social sharing image `twitter_image` - compressed
 - [ ] Check image shadow `{:.shadow}`
 - [ ] Check images' `ALT` text
 - [ ] Videos/iframes wrapped in `<figure>` tags (responsiveness)
+- 2. Apply styles
+- [ ] Add/check html parser `{::options parse_block_html="true" /}`
+- [ ] Apply semantic HTML (sections, divs, classes, ids)
 - [ ] Add/check `<!-- more -->` separator
 - [ ] Add/check cover img reference (at the end of the post)
 - [ ] Columns (content balance between the columns)

doc/AAAA_MM_DD_gitlab_x_y_released.yml

-###
-#
-# Release post data file
-#
-# Start the release post with this file, named `AAAA_MM_22_gitlab_X_Y_released.yml`
-# placed into `data/release_posts/`.
-#
-# Notes:
-#  - All description fields support markdown. Make sure the indentation is respected.
-#
-## Optional fields:
-#
-# - Features
-#   - Top:
-#     - documentation_text: "Learn more about Amazing Feature" # text displaying the documentation_link
-#   - Primary:
-#     - documentation_link: 'https://docs.gitlab.com/#amazing' # webpage or documentation
-#     - documentation_text: "Learn more about Amazing Feature" # text displaying the documentation_link
-#   - Secondary, upgrade barometer, deprecations:
-#     - documentation_link: 'https://docs.gitlab.com/#amazing' # webpage or documentation
-#     - documentation_text: "Learn more about Amazing Feature" # text displaying the documentation_link
-#     - image_url: '/images/x_y/feature-a.png'
-#   - Optional to all features:
-#     - image_noshadow: true # this eliminates double shadows for images that already have a shadow
-#
-# Read through the Release Posts Handbook for more information:
-# https://about.gitlab.com/handbook/marketing/blog/release-posts/
-#
-###
-
-features:
-# TOP FEATURE
-  top:
-    - name: Amazing Feature
-      available_in: [ees, eep] # required
-      documentation_link: 'https://docs.gitlab.com/#amazing' # webpage or documentation - required
-      documentation_text: "Learn more about Amazing Feature" # optional
-      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.
-
-        <figure class="video_container">
-          <iframe src="https://www.youtube.com/embed/videoid" frameborder="0" allowfullscreen="true"> </iframe>
-        </figure>
-
-        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: [ce, ees, eep] # required
-      documentation_link: '/features/lorem-ipsum' # webpage or documentation - optional
-      documentation_text: "Learn more about Lorem ipsum" # optional
-      image_url: '/images/9_X/feature-a.png' # required
-      image_noshadow: true # optional
-      description: | # supports markdown
-        Lorem ipsum [dolor sit amet](#link), consectetur adipisicing elit.
-        Perferendis nisi vitae quod ipsum saepe cumque quia `veritatis`.
-
-    - name: Lorem
-      available_in: [ees, eep] # required
-      documentation_link: 'https://docs.gitlab.com/#lorem' # webpage or documentation - optional
-      documentation_text: "Learn more about Lorem" # optional
-      image_url: '/images/9_X/feature-a.png' # 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: [eep] # required
-      documentation_link: 'https://docs.gitlab.com/#'
-      documentation_text: "Learn more on how to lorem ipsum." # webpage or documentation - optional
-      image_url: '/images/9_X/feature-a.png' # optional
-      image_noshadow: true # optional
-      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: Sunt nam accusantium nostrum
-      available_in: [ees, eep] # required
-      documentation_link: 'https://docs.gitlab.com/#' # webpage or documentation - optional
-      documentation_text: "Praesentium tempore nulla asperiores" # optional
-      description: | # supports markdown
-        Lorem ipsum [dolor sit amet](#link), consectetur adipisicing elit.
-        Perferendis nisi vitae quod ipsum saepe cumque quia `veritatis`.
-
-    - name: Omnibus Improvements
-      available_in: [ce, ees, eep] # required
-      documentation_link:  # webpage or documentation - optional
-      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: [ce, ees, eep] # required
-      documentation_link:  # webpage or documentation - optional
-      description: | # supports markdown
-        Lorem ipsum [dolor sit amet](#link), consectetur adipisicing elit.
-        Perferendis nisi vitae quod ipsum saepe cumque quia `veritatis`.
-
-# MVP
-mvp:
-  fullname: # Name Surname
-  gitlab: # gitlab.com username
-  description: | # example (supports markdown)
-    Dosuken extended our [Pipelines API](http://docs.gitlab.com/ce/api/pipelines.html#list-project-pipelines)
-    by [adding additional search attributes](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/9367).
-    This is a huge improvement to our CI API, for example enabling queries to easily return the latest
-    pipeline for a specific branch, as well as a host of other possibilities. Dosuken also made a great
-    contribution last release, laying the foundation for
-    [scheduled pipelines](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/10133). Thanks Dosuken!
-
-# COVER IMAGE LICENCE
-cover_img:
-  image_url: 'https://example.com#link_to_original_image' # required
-  licence: CC0 # which licence the image is available with - required
-  licence_url: '#https://example.com#link_to_licence' # required
-
-# CTA BUTTONS
-cta:
-  - title: "Join us for an upcoming event" # default
-    link: '/events/'
-  - title: "Join the release webcast" # optional
-    link: 
-  - title: Lorem ipsum amet # optional
-    link:
-
-# UPGRADE BAROMETER
-barometer:
-  description: | # example (supports markdown)
-    To upgrade to GitLab 9.2, no downtime is required.
-
-    However we're also migrating data for CI jobs. If you have a significant number of jobs, this could take some time.
-
-    Starting with GitLab 9.1.0 it's possible to upgrade to a newer version of GitLab without having to take your GitLab instance offline. However, for this to work there are the following requirements:
-
-    1.  You can only upgrade 1 release at a time. For example, if 9.1.15 is the last release of 9.1 then you can safely upgrade from that version to 9.2.0. However, if you are running 9.1.14 you first need to upgrade to 9.1.15.
-    2.  You have to use [post-deployment migrations](https://docs.gitlab.com/ce/development/post_deployment_migrations.html).
-    3.  You are using PostgreSQL. If you are using MySQL you will still need downtime when upgrading.
-
-    This applies to major, minor, and patch releases unless stated otherwise in a release post.
-
-    A new version of our API was released in [GitLab 9.0](https://about.gitlab.com/2017/03/22/gitlab-9-0-released/#api-v4). While existing calls to API v3 will continue to work until August 2017, we advise you to make any necessary changes to applications that use the v3 API. [Read the documentation](https://docs.gitlab.com/ee/api/v3_to_v4.html) to learn more.
-
-# DEPRECATIONS
-# include as many deprecation blocks as necessary
-deprecations:
-  - feature_name: Lorem ipsum dolor
-    due: May 22nd, 2017. # example
-    description: |  # example (supports markdown)
-      Lorem ipsum dolor sit amet, consectetur adipisicing elit.
-      Veritatis, quisquam.
-  - feature_name: Lorem ipsum dolor
-    due: May 22nd, 2017.
-    description: |  # example (supports markdown)
-      Lorem ipsum dolor sit amet, consectetur adipisicing elit.
-      Veritatis, quisquam.

doc/release_blog_template.html.md

 ---
-release_number: "X.Y" # feature number - required
-title: "GitLab X.Y Released with Feature A and Feature B" # short title - required
-author: Joshua Lambert # author name ans surname - required
-author_gitlab: joshlambert # author's gitlab.com username - required
-author_twitter: # author's twitter username - optional
-image_title: '/images/9_2/9_2-cover-image.jpg' # cover image - required
-description: "GitLab X.Y Released with Feature A, Feature B, Feature C, Feature D and much more!" # short description - required
-twitter_image: '/images/tweets/gitlab-9-2-released.png' # social sharing image - not required but recommended
-categories: release # required
-layout: release # required
+release_number: "x.x"
+title: "GitLab x.x Released with XXX and XXX"
+author: Name Surname
+author_gitlab: GitLab.com-username
+author_twitter: Twitter-username
+image_title: '/images/x_x/x_x-cover-image.jpg'
+description: "GitLab x.x Released with Main-CE-Feature, Main-EE-Feature, Secondary-Feature, Secondary-Feature, and much more!"
+twitter_image: '/images/tweets/gitlab-x-x-released.jpg'
+categories: release
+# extra_css:
+#  - release-posts.css
+# extra_js:
+#  - release-posts.js
 ---
 <!--
-This is the release blog post file. Add here the introduction only.
-All remaining content goes into data/release-posts/.
-**Use the merge request template "Release-Post", and please set the calendar due
-date for each stage (general contributions, review).**
-Read through the Release Posts Handbook for more information:
-https://about.gitlab.com/handbook/marketing/blog/release-posts/
+- Add the content here. _Ad hoc_ free until the 6th working day before the 22nd. After that, we'll freeze the post.
+- Content review: will take place during the 5th and the 4th working day before the 22nd.
+- Styles will be applied in the 3rd to 1st working day before the 22nd. How to apply styles: check the release post handbook: https://about.gitlab.com/handbook/marketing/blog/relese-post/.
+**Use the merge request template "Release-Post", and please set the calendar date for each stage.**
+-->
+
+## Introduction
+
+Enter the introduction here
+
+## MVP
+
+<!--
+
+- Name and Surname:
+- GitLab.com handle: https://gitlab.com/username
+- Contributed to:
+- Merge request link:
+- Short description (example below):
+
+-->
+
+Example <!-- delete this example when you add the MVP data -->
+
+"Jacopo made it possible to [undo marking a todo item as done in the todos list](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/8691). This is a huge productivity enhancement that helps you recover from mistakes in managing todos. Thanks Jacopo!" 
+
+<!--
+## Cover image:
+
+Link to original image:
+Image name (if available):
+Author's name (if available):
+Licensed under:
+Link to license:
+-->
+
+## Upgrade barometer
+
+- DESCRIBE HOW INVOLVED THE MIGRATIONS ARE. CAN USERS EXPECT MUCH DOWNTIME?
+- CHECK IF THERE ARE ANY MIGRATIONS THAT REMOVE OR CHANGE COLUMNS.
+- IF THERE ARE ONLY ADDITIONS OR NO MIGRATIONS CONFIRM THAT DEPLOY CAN BE WITHOUT DOWNTIME
+
+## Performance improvements
+
+Describe it as a feature.
+
+## Omnibus improvements
+
+- Describe all improvements here. Link to docs, issues, and MRs whenever applicable.
+
+## Extras
+Are there any extra stuff to be added, or noted? Please describe them here. E.g.: events, news, notifications, etc.
+## Deprecations
+
+Anything being deprecated? Please fill the following block. Copy and paste the items as much as necessary.
+ 
+<!--
+Template
+
+### GitLab XXX Deprecation
+
+- Feature name:
+- Available in: (CE/EES/EEP)
+- Link to issue or MR:
+
+Description:
+
+Due date:
+-->
+
+----
+
+<!-- FEATURES -->
+
+## FEATURES 🚀
+
+<!--
+For each feature added to the post, provide the required info. Use dashes to separate them. Push all related images to the MR and provide the correct link. Compress every image with [Tiny PNG](https://tinypng.com/) or similar tool.
 -->
-Introductory paragraph.
-<!-- more -->
-Introduction.
-[Markdown](/handbook/product/technical-writing/markdown-guide/) supported.
+<!-- Template:
+## Feature name
+
+
+- Available in: (CE/EES/EEP)
+- Feature weight: primary, secondary
+- Documentation link:
+- Feature description, related images, and videos:
+
+----
+
+Example:
+
+## Deploy Boards
+- Available in: EEP
+- Feature weight: primary
+- Documentation link: https://docs.gitlab.com/ee/user/project/deploy_boards.html
+- Feature description, related images, and videos:
+Today with 9.0, we are excited to release Deploy Boards for environments running on Kubernetes. The Environments page of Pipelines now offers a single place to view the current health and deployment status of each environment, displaying the specific status of each pod in the deployment. Developers and other teammates can view the progress and status of a rollout, pod by pod, in the workflow they already use without any need to access Kubernetes.
+
+![Deploy Boards](/images/9_0/deploy_boards.png){: .shadow}
+
+Watch the video:
+
+<figure class="video_container">
+  <iframe src="https://www.youtube.com/embed/enMumwvLAug" frameborder="0" allowfullscreen="true"> </iframe>
+</figure>
+
+----
+-->

lib/custom_helpers.rb

@@ -26,7 +26,7 @@ module CustomHelpers
     Tilt['markdown'].new { text }.render
   end
-  def kramdown s
+  def markdown s
     Kramdown::Document.new(s).to_html
   end

source/includes/release.html.haml

@@ -9,7 +9,7 @@
         %a{href: "/mvp/"} MVP
         is
         = link_to(mvp.fullname, "https://gitlab.com/#{mvp.gitlab}")
-      = kramdown(mvp.description)
+      = markdown(mvp.description)
 / top feature
@@ -32,7 +32,7 @@
             %a{"title" => "GitLab Enterprise Edition Premium", "data-toggle" => "tooltip", "data-placement" => "top"}
               %span{class: "#{available_in}"}
                 = "#{available_in}"
-    = kramdown(top_feature.description)
+    = markdown(top_feature.description)
     %p
       %i.fa.fa-book
       %a{href: "#{top_feature.documentation_link}", target: "_blank"}
@@ -66,7 +66,7 @@
                   %a{"title" => "GitLab Enterprise Edition Premium", "data-toggle" => "tooltip", "data-placement" => "top"}
                     %span{class: "#{available_in}"}
                       = "#{available_in}"
-          = kramdown(primary_feature.description)
+          = markdown(primary_feature.description)
           - if primary_feature.documentation_link != nil
             %p
               %i.fa.fa-book
@@ -102,7 +102,7 @@
                   %a{"title" => "GitLab Enterprise Edition Premium", "data-toggle" => "tooltip", "data-placement" => "top"}
                     %span{class: "#{available_in}"}
                       = "#{available_in}"
-          = kramdown(primary_feature.description)
+          = markdown(primary_feature.description)
           - if primary_feature.documentation_link != nil
             %p
               %i.fa.fa-book
@@ -145,7 +145,7 @@
                   %a{"title" => "GitLab Enterprise Edition Premium", "data-toggle" => "tooltip", "data-placement" => "top"}
                     %span{class: "#{available_in}"}
                       = "#{available_in}"
-          = kramdown(secondary_feature.description)
+          = markdown(secondary_feature.description)
           - if secondary_feature.image_url != nil
             - if secondary_feature.image_noshadow == true
               %img{:src => "#{secondary_feature.image_url}", :alt => "#{secondary_feature.name}"}/
@@ -181,7 +181,7 @@
                   %a{"title" => "GitLab Enterprise Edition Premium", "data-toggle" => "tooltip", "data-placement" => "top"}
                     %span{class: "#{available_in}"}
                       = "#{available_in}"
-          = kramdown(secondary_feature.description)
+          = markdown(secondary_feature.description)
           - if secondary_feature.image_url != nil
             - if secondary_feature.image_noshadow == true
               %img{:src => "#{secondary_feature.image_url}", :alt => "#{secondary_feature.name}"}/
@@ -208,7 +208,7 @@
         %h3{:id => "#{deprecation.feature_name.downcase.tr(" ", "-")}"}
           %a.header-link{href: "##{deprecation.feature_name.downcase.tr(" ", "-")}"}
           = deprecation.feature_name
-        = kramdown(deprecation.description)
+        = markdown(deprecation.description)
         %p
           Due:
           %strong= "#{deprecation.due}"
@@ -219,5 +219,5 @@
     %h2.text-center{:id => "barometer"}
       %a.header-link{href: "#barometer"}
       Upgrade barometer
-    = kramdown(barometer.description)
+    = markdown(barometer.description)