Skip to content

Release post content for commit SHA cache

Jason Yavorska requested to merge jlenny-master-patch-12464 into master

Engineer(s): @mbobin | Product Marketing: @williamchia | Tech Writer: @marcel.amirault

Content checklist

  • Description is informative and focuses on the problem we're solving and the value we're delivering
  • Check feature and product names are in capital case
  • Check headings are in sentence case
  • Check Feature availability (Core, Starter, Premium, Ultimate badges)
  • Make sure feature description is positive and cheerful
  • Screenshot/video is included (optional for secondary items)
  • Check all images size < 300KB compressed
  • Check if the image shadow is applied correctly. Add image_noshadow: true when an image already has a shadow
  • Ensure videos and iframes are wrapped in <figure class="video_container"> tags (for responsiveness)
  • Check documentation link points to the latest docs (documentation_link)
  • Check that documentation is updated and easy to understand
  • Check that all links to about.gitlab.com content are relative URLs
  • Run the content through an automated spelling and grammar check
  • Validate all links are functional and have meaningful text for SEO (e.g., "click here" is bad link text)
  • Remove any remaining instructions (comments)
  • Feature is added to data/features.yml (with accompanying screenshots)

Review

When the above is complete and the content is ready for review, it should be reviewed by Product Marketing and Tech Writing. Please assign the PMM and Tech writer to the MR when it is ready to be reviewed!

  • Tech writer and PMM assigned for review
    • Tech writer reviewed and approved
    • PMM reviewed and approved

PMM review

  • PMM review
    • problem/solution: Does this describe the user's pain without this feature and why this feature alleviates that pain?
    • short/pithy: Is this communicated clearly with the fewest words possible?
    • tone clarify: Is the language and sentence structure clear and grammatically correct?
    • technical clarity: Does it make sense what this feature does even for folks who don't know anything about GitLab?

Tech writing review

  • Verify Frontmatter:
    • Check that all links and URLs are wrapped in single quotes ' (documentation_link: 'https://docs.gitlab.com/ee/#amazing').
    • Check that name fields are wrapped in double quotes " (name: "Lorem ipsum").
    • No useless whitespace (end of line spaces, double spaces, extra blank lines, and lines with only spaces).
  • Links
    • Verify all links (including in feature description) work and that anchors are valid (note: the H1 (top) anchor on a docs page is not valid). Links should not redirect.
    • Verify that the feature is clearly mentioned in the linked documentation. If not, suggest a better doc link. If none exists, note this and raise an issue for creation of documentation if needed.
  • Content
    • Check that there are no typos or grammar mistakes, but style is up to the PM and PMM.
    • Ignoring style, verify that content accurately describes the feature based on your understanding of it.

Links

Edited by Thao Yeager

Merge request reports