summaryrefslogtreecommitdiff
path: root/data/removals/templates/example.yml
diff options
context:
space:
mode:
Diffstat (limited to 'data/removals/templates/example.yml')
-rw-r--r--data/removals/templates/example.yml20
1 files changed, 10 insertions, 10 deletions
diff --git a/data/removals/templates/example.yml b/data/removals/templates/example.yml
index 0904c6a6d7a..b6c3c75d496 100644
--- a/data/removals/templates/example.yml
+++ b/data/removals/templates/example.yml
@@ -9,14 +9,16 @@
#
# Please delete this line and above before submitting your merge request.
-- name: "Feature name" # the name of the feature being removed. Avoid the words `deprecation`, `deprecate`, `removal`, and `remove` in this field because these are implied.
- announcement_milestone: "XX.YY" # The milestone when this feature was deprecated.
- announcement_date: "YYYY-MM-DD" # The date of the milestone release when this feature was deprecated. This should almost always be the 22nd of a month (YYYY-MM-DD), unless you did an out of band blog post.
- removal_milestone: "XX.YY" # The milestone when this feature is being removed.
- removal_date: "YYYY-MM-DD" # This should almost always be the 22nd of a month (YYYY-MM-DD), the date of the milestone release when this feature will be removed.
- breaking_change: false # Change to true if this removal is a breaking change.
- reporter: exampleuser # GitLab username of the person reporting the removal
- body: | # Do not modify this line, instead modify the lines below.
+- name: "Feature name" # (required) the name of the feature being removed. Avoid the words `deprecation`, `deprecate`, `removal`, and `remove` in this field because these are implied.
+ announcement_milestone: "XX.YY" # (required) The milestone when this feature was deprecated.
+ announcement_date: "YYYY-MM-DD" # (required) The date of the milestone release when this feature was deprecated. This should almost always be the 22nd of a month (YYYY-MM-DD), unless you did an out of band blog post.
+ removal_milestone: "XX.YY" # (required) The milestone when this feature is being removed.
+ removal_date: "YYYY-MM-DD" # (required) This should almost always be the 22nd of a month (YYYY-MM-DD), the date of the milestone release when this feature will be removed.
+ breaking_change: false # (required) Change to true if this removal is a breaking change.
+ reporter: exampleuser # (required) GitLab username of the person reporting the removal
+ stage: stage # (required) String value of the stage that the feature was created in. e.g., Growth
+ issue_url: https://gitlab.com/gitlab-org/gitlab/-/issues/000000 # (required) Link to the deprecation issue in GitLab
+ body: | # (required) Do not modify this line, instead modify the lines below.
<!-- START OF BODY COMMENT
This area supports markdown. Delete this entire comment and replace it with your markdown content.
@@ -25,9 +27,7 @@
END OF BODY COMMENT -->
# The following items are not published on the docs page, but may be used in the future.
- stage: # (optional - may be required in the future) String value of the stage that the feature was created in. e.g., Growth
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]
- issue_url: # (optional) This is a link to the deprecation issue in GitLab
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
video_url: # (optional) Use the youtube thumbnail URL with the structure of https://img.youtube.com/vi/UNIQUEID/hqdefault.jpg