diff options
Diffstat (limited to 'data/removals/templates/example.yml')
| -rw-r--r-- | data/removals/templates/example.yml | 19 |
1 files changed, 13 insertions, 6 deletions
diff --git a/data/removals/templates/example.yml b/data/removals/templates/example.yml index b6c3c75d496..3674583cd7d 100644 --- a/data/removals/templates/example.yml +++ b/data/removals/templates/example.yml @@ -1,14 +1,17 @@ -# This is a template for a feature removal -# Generally, a feature or configuration should be removed in a major release. -# It should be announced at least 2 releases prior to being removed. +# This is a template for a feature removal. # -# Below is an example of a removal. +# Please refer to the deprecation guidelines to confirm your understanding of GitLab's definitions. +# https://docs.gitlab.com/ee/development/deprecation_guidelines/#terminology +# +# If this removal is a breaking change, it must take place in a major release. # # For more information please refer to the handbook documentation here: # https://about.gitlab.com/handbook/marketing/blog/release-posts/#removals # # Please delete this line and above before submitting your merge request. - +# +# REQUIRED FIELDS +# - 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. @@ -26,7 +29,11 @@ When ready, assign to your tech writer for review. When ready, they will run `bin/rake gitlab:docs:compile_removals` to update the removals doc, then merge. END OF BODY COMMENT --> -# The following items are not published on the docs page, but may be used in the future. +# +# OPTIONAL FIELDS +# + 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. 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 |