diff options
Diffstat (limited to 'data/deprecations/templates/example.yml')
| -rw-r--r-- | data/deprecations/templates/example.yml | 27 |
1 files changed, 14 insertions, 13 deletions
diff --git a/data/deprecations/templates/example.yml b/data/deprecations/templates/example.yml index 3097db557b8..06e53084ed2 100644 --- a/data/deprecations/templates/example.yml +++ b/data/deprecations/templates/example.yml @@ -10,13 +10,14 @@ # # Please delete this line and above before submitting your merge request. -- name: "Feature name" # The name of the feature to be deprecated - announcement_milestone: "XX.YY" # The milestone when this feature was first announced as deprecated. - announcement_date: "YYYY-MM-DD" # The date of the milestone release when this feature was first announced as deprecated. This should almost always be the 22nd of a month (YYYY-MM-22), unless you did an out of band blog post. - removal_milestone: "XX.YY" # The milestone when this feature is planned to be removed - removal_date: # The date of the milestone release when this feature was first announced as deprecated. This should almost always be the 22nd of a month (YYYY-MM-22), unless you did an out of band blog post. - breaking_change: false # If this deprecation is a breaking change, set this value to true - body: | # Do not modify this line, instead modify the lines below. +- name: "Feature name" # The name of the feature to be deprecated + announcement_milestone: "XX.YY" # The milestone when this feature was first announced as deprecated. + announcement_date: "YYYY-MM-DD" # The date of the milestone release when this feature was first announced as deprecated. This should almost always be the 22nd of a month (YYYY-MM-22), unless you did an out of band blog post. + removal_milestone: "XX.YY" # The milestone when this feature is planned to be removed + removal_date: # The date of the milestone release when this feature is planned to be removed. This should almost always be the 22nd of a month (YYYY-MM-22), unless you did an out of band blog post. + breaking_change: false # If this deprecation is a breaking change, set this value to true + reporter: exampleuser # GitLab username of the person reporting the deprecation + body: | # 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 +26,9 @@ 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 + 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 |