Skip to content

Create Example file for Release Post `extras` content type

Brian Rhea requested to merge extras-release-post-example into master

Why is this change being made?

Solve for non-standard product announcements in the release post

we have scenarios that don't fit into deprecations, removals, or breaking changes, and we need to extend the tertiary sections in the post to give each announcement a place to "live."

The release post template allows for non-standard announcements via the extras block and it is documented, but it is underutilized. The MR creates an example block that follows the structure of other tertiary content blocks and it updates the release post template to follow this structure as well.

Review

Todos

If this proposal is accepted, the following should be added to this MR:

  • Update the examples provided in the release post handbook
  • Update the structure of 14.0+ extras blocks to match the structure of this revision

Author Checklist

  • Provided a concise title for this Merge Request (MR)
  • Added a description to this MR explaining the reasons for the proposed change, per say why, not just what
    • Copy/paste the Slack conversation to document it for later, or upload screenshots. Verify that no confidential data is added.
  • Assign reviewers for this MR to the correct Directly Responsible Individual/s (DRI)
    • If the DRI for the page/s being updated isn’t immediately clear, then assign it to one of the people listed in the Maintained by section on the page being edited
    • If your manager does not have merge rights, please ask someone to merge it AFTER it has been approved by your manager in #mr-buddies
  • If the changes affect team members, or warrant an announcement in another way, please consider posting an update in #whats-happening-at-gitlab linking to this MR
    • If this is a change that directly impacts the majority of global team members, it should be a candidate for #company-fyi. Please work with internal communications and check the handbook for examples.

Edited by Brian Rhea

Merge request reports