Skip to content

Provide guidance for the names of deprecations

Evan Read requested to merge eread/guidance-for-deprecation-names into master

Why is this change being made?

There isn't the level of consistency with section headings in the deprecations page: https://docs.gitlab.com/ee/update/deprecations that we aim for in the documentation, mostly because each entry is written in isolation.

If we begin to add some guidance, we should see a bit more consistency in how these section headings are structured.

Author Checklist

  • Provided a concise title for the 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 change to the correct DRI(s)
    • 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 in 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 Evan Read

Merge request reports