Skip to content

Update deprecation and removal example

Brian Rhea requested to merge update-dep-rem-examples into master

What does this MR do and why?

This MR is an iteration on !104449 (merged) based on a related conversation in gitlab-com/www-gitlab-com!115169 (comment 1181686916)

For a detailed account of the problem and proposed solution, see gitlab-com/www-gitlab-com#14106 (closed)

Changes in this MR

  • Adds guidance to the templates that deprecation and removal announcements should be actionable
  • Changes the "name" field to "title" in all Dep/Rem .yml files to reinforce that an announcement shouldn't just list the feature name being deprecated or removed, it should be an actionable title
  • Updates the compilation scripts to account for the changed field name

Screenshots or screen recordings

Screenshots are required for UI changes, and strongly recommended for all other merge requests.

How to set up and validate locally

Numbered steps to set up and validate the change are strongly suggested.

MR acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

Merge request reports