Skip to content

Clarify announcement timeframe for deprecations

Luke Duncalfe requested to merge ld-docs-elaborate-on-deprecation-milestone-timeframe into master

Why is this change being made?

This introduces an example to give clarity around what the expectations of the timeframe before the major milestone that a deprecation should be announced.

We currently advise that deprecations were announced:

At least 2 milestones before intended removal.

When we consider the timeframes of SaaS, which have continuous deployments throughout a milestone, we land on more specific advice around what ensuring 2 milestones before the intended removal means in practice (see gitlab-org/gitlab!81869 (comment 860486727)).

This example will hopefully remove all ambiguity about the notice period of a deprecation announcement.

See:

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 Luke Duncalfe

Merge request reports