Skip to content

Update end of support language in deprecations

Marcel Amirault requested to merge docs-update-end-of-support-language into master

What does this MR do?

This is a follow-up to !127026 (merged), which:

  • Fixes a typo (missing in) in the template.
  • Removes the end-of-support milestone from deprecation entries that don't actually have an "End of support" period. See: https://docs.gitlab.com/ee/update/terminology.html#end-of-support, which explains:
    • Optional step before removal.
    • Feature usage strongly discouraged.
    • Will be removed in a future major release.

Essentially, "End of Support" is for edge cases where we need to pull the plug on a feature early (before actually removing it), usually in a minor release. We don't fully remove the feature yet, to avoid making a breaking change in a minor milestone, but we announce that we no longer offer any support/updates for the feature after the end of support milestone. Then later, in a major milestone, we remove it.

So if the removal and end of support milestones are identical, then there isn't actually an end of support period, it's just a normal removal.

A great example of an end of support period is the deprecation of Redis 5: https://docs.gitlab.com/ee/update/deprecations.html#redis-5-deprecated. It reached EOL in April 2022, so we first deprecated it in 15.3, stopped officially offering support for it in 15.6, then finally removed the code (breaking change) in 16.0.

Related issues

Related to !127026 (merged)

Author's checklist

If you are a GitLab team member and only adding documentation, do not add any of the following labels:

  • ~"frontend"
  • ~"backend"
  • ~"type::bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Reviewer's checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

If you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • Ensure a release milestone is set.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.
Edited by Marcel Amirault

Merge request reports