Skip to content
Snippets Groups Projects

Release post for WAF Statistics Reporting

Merged Matt Wilson requested to merge matt_wilson-release_posts-waf_statistics_reporting into master

Engineer(s): @theoretick @markrian | Product Marketing: @cblake | Tech Writer: @axil | Engineering Manager: @twoodham

Please review the guidelines for feature block creation at https://about.gitlab.com/handbook/marketing/blog/release-posts/#feature-blocks. They are frequently updated, and everyone should make sure they are aware of the current standards (PM, PMM and TW).

PM release post item checklist

  • Structure
    • Screenshot/video is included (optional for secondary items).
    • Check that image size < 150KB.
    • Check if the image shadow is applied correctly. Add image_noshadow: true when an image already has a shadow.
    • Remove any remaining instructions (comments).
    • Feature is added to data/features.yml (with accompanying screenshots).
  • Frontmatter
    • Check feature availability frontmatter (available_in:) is correct: (Core, Starter, Premium, Ultimate).
    • Ensure videos and iframes added within the feature description are wrapped in <figure class="video_container"> tags (for responsiveness).
    • Check documentation link points to the latest docs (documentation_link:), and includes the anchor to the relevant section on the page if possible.
    • Check that all links to about.gitlab.com content are relative URLs.
  • Content
    • Check title is in sentence case, and feature and product names are in capital case.
    • Ensure that the title and description clearly explain the user problem we're solving and the value we're delivering. Make clear if it is a new feature, or an improvement to an existing feature.
    • Check that documentation is updated, very clearly talks about the feature (mentions it by name).
    • 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).

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.

Merge

Once all content is reviewed and complete, add the Ready label and assign this issue to the engineering manager. The EM is responsible for merging as soon as the implementing issue is deployed to GitLab.com, after which this content will appear on the GitLab.com Release page and can be included in the next release post. All release post items must be merged on or before the 17th of the month. If a feature is not ready by the 17th deadline, the EM should push the release post item to the next milestone.

Links

Edited by Thomas Woodham

Merge request reports

Loading
Loading

Activity

Filter activity
  • Approvals
  • Assignees & reviewers
  • Comments (from bots)
  • Comments (from users)
  • Commits & branches
  • Edits
  • Labels
  • Lock status
  • Mentions
  • Merge request status
  • Tracking
  • Matt Wilson added 188 commits

    added 188 commits

    • 0753b657...a332a15d - 186 commits from branch master
    • 728a600d - Merge branch 'master' of gitlab.com:gitlab-com/www-gitlab-com into...
    • 0607d6d2 - adding missing blank line to EOF

    Compare with previous version

  • Cindy Blake marked the checklist item PMM review as completed

    marked the checklist item PMM review as completed

  • unassigned @cblake

  • Achilleas Pipinellis marked the checklist item Verify Frontmatter: as completed

    marked the checklist item Verify Frontmatter: as completed

  • Achilleas Pipinellis marked the checklist item Links as completed

    marked the checklist item Links as completed

  • Achilleas Pipinellis marked the checklist item Content as completed

    marked the checklist item Content as completed

  • Mark Florian
  • Matt Wilson changed milestone to %12.7

    changed milestone to %12.7

  • Matt Wilson added 1 commit

    added 1 commit

    • 3eb653cc - Apply suggestion to data/release_posts/unreleased/waf-statistics-reporting.yml

    Compare with previous version

  • Matt Wilson added 1 commit

    added 1 commit

    • e59afbe2 - Apply suggestion to data/release_posts/unreleased/waf-statistics-reporting.yml

    Compare with previous version

  • Matt Wilson added 1 commit

    added 1 commit

    • 5943c78e - Apply suggestion to data/release_posts/unreleased/waf-statistics-reporting.yml

    Compare with previous version

  • Matt Wilson added 1 commit

    added 1 commit

    • 9756233f - Apply suggestion to data/release_posts/unreleased/waf-statistics-reporting.yml

    Compare with previous version

  • Matt Wilson added 1 commit

    added 1 commit

    • f486deec - Apply suggestion to data/features.yml

    Compare with previous version

  • Matt Wilson resolved all threads

    resolved all threads

  • Matt Wilson resolved all threads

    resolved all threads

  • @matt_wilson @twoodham it is after the 18th, and the Release Post has been assembled! :alarm_clock: Please check if the milestone is correct. If you expect this feature to be in GitLab 12.7, please leave a comment on !37630 (merged) and merge this item as a matter of urgency.

  • Author Contributor

    @jramsay It slipped to %12.8, milestone adjusted accordingly.

  • assigned to @sam.white

  • Sam White mentioned in merge request !34442 (closed)

    mentioned in merge request !34442 (closed)

  • assigned to @marcia, @axil, and @cblake

  • Sam White marked the checklist item Structure as completed

    marked the checklist item Structure as completed

  • Sam White marked the checklist item Frontmatter as completed

    marked the checklist item Frontmatter as completed

  • Sam White marked the checklist item Content as completed

    marked the checklist item Content as completed

  • Amy Qualls
  • Amy Qualls
  • Amy Qualls
  • Amy Qualls
  • Sam White added 1 commit

    added 1 commit

    • 3deee55e - Apply suggestion to data/release_posts/unreleased/waf-statistics-reporting.yml

    Compare with previous version

  • Sam White added 1 commit

    added 1 commit

    • 7e4da47a - Apply suggestion to data/release_posts/unreleased/waf-statistics-reporting.yml

    Compare with previous version

  • Sam White added 1 commit

    added 1 commit

    • 676a825e - Update features.yml to bold Security and Compliance

    Compare with previous version

  • Sam White added 1 commit

    added 1 commit

    • feb5ef9a - Update waf-statistics-reporting.yml

    Compare with previous version

  • Sam White resolved all threads

    resolved all threads

  • Achilleas Pipinellis approved this merge request

    approved this merge request

  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Please register or sign in to reply
    Loading