summaryrefslogtreecommitdiff
path: root/data/deprecations/templates/example.yml
diff options
context:
space:
mode:
Diffstat (limited to 'data/deprecations/templates/example.yml')
-rw-r--r--data/deprecations/templates/example.yml15
1 files changed, 10 insertions, 5 deletions
diff --git a/data/deprecations/templates/example.yml b/data/deprecations/templates/example.yml
index c69ebe2c768..e5e04e5d216 100644
--- a/data/deprecations/templates/example.yml
+++ b/data/deprecations/templates/example.yml
@@ -1,12 +1,11 @@
# This is a template for a feature deprecation.
#
-# Please refer to the deprecation guidelines to confirm your understanding of GitLab's definitions.
+# Please refer to the deprecation guidelines to confirm your understanding of the
+# definitions for "Deprecation", "End of Support", and "Removal":
# https://docs.gitlab.com/ee/development/deprecation_guidelines/#terminology
#
# Deprecations must be announced at least three releases prior to removal.
-#
-# If an End of Support period applies, the announcement should be shared with GitLab Support
-# in the `#spt_managers` on Slack and mention `@gitlab-com/support` in this MR.
+# See the OPTIONAL END OF SUPPORT FIELDS section below if an End of Support period also applies.
#
# Breaking changes must happen in a major release.
#
@@ -35,10 +34,16 @@
END OF BODY COMMENT -->
#
-# OPTIONAL FIELDS
+# OPTIONAL END OF SUPPORT FIELDS
+#
+# If an End of Support period applies, the announcement should be shared with GitLab Support
+# in the `#spt_managers` channel in Slack, and mention `@gitlab-com/support` in this MR.
#
end_of_support_milestone: # (optional) Use "XX.YY" format. The milestone when support for this feature will end.
end_of_support_date: # (optional) The date of the milestone release when support for this feature will end.
+#
+# OTHER OPTIONAL FIELDS
+#
tiers: # (optional - may be required in the future) An array of tiers that the feature is available in currently. e.g., [Free, Silver, Gold, Core, Premium, Ultimate]
documentation_url: # (optional) This is a link to the current documentation page
image_url: # (optional) This is a link to a thumbnail image depicting the feature