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
124 files
+ 2030
726
Compare changes
  • Side-by-side
  • Inline
Files
124
@@ -141,34 +141,47 @@ 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):
- 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](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)
Performed by assigned technical writer from the technical writing team:
- [Axil](https://gitlab.com/axil)
- [Evan](https://gitlab.com/eread)
- [Marcia](https://gitlab.com/marcia)
- [Mike](https://gitlab.com/mikelewis).
Sources of data to check:
- Release post data: `.../data/release_posts`.
- Release post itself: `.../source/posts`.
- [ ] Perform structural check
- [ ] Add the label ~review-structure to merge request.
- [ ] Git `pull` release post branch.
- [ ] Check frontmatter (entries, syntax).
- [ ] Check `image_title` and `twitter_image`.
- [ ] 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>` tags (for responsiveness).
- [ ] Ensure all text is hard wrapped at a suitable column boundary.
- [ ] Check headers 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 data.
- [ ] Ensure content is balanced between the columns.
- [ ] Ensure links have meaningful text for SEO. "Click here" is bad link text.
- [ ] Check for badges consistency (applied to all headings).
- [ ] Double check that all features have documentation updates.
- [ ] 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 should point to something in the release post data.
- [ ] Remove any remaining instructions from the release post data. Use previous release post data as a guide.
- [ ] Remove HTML comments from the release post. Use previous release posts as a guide.
- [ ] Run [Check My Links plugin](https://chrome.google.com/webstore/detail/check-my-links/ojkcdipcgfaekbeaelaapakgnjflfglf) for Chrome. For broken links, highlight them in merge request discussion.
- [ ] Update release template with any required changes.
- [ ] Git `push` any changes made during structural check to release post branch.
- [ ] Remove the label ~review-structure.
- [ ] Assign the MR to the next reviewer (copyedit).
- [ ] Report results of structural check
- [ ] 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 to report problems in `#release-post`.
- [ ] Report any problems from structural check in the `#release-post` channel. (Do NOT ping `@all` or `@channel`). If possible, ensure the issues are tracked in the merge request discussion.
#### Further reviews
Loading