blob: 59e478ab83e14d6ee91c95d2fa573af9fa156603 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
|
# This is a template for a feature deprecation
# A deprecation typically occurs when a feature or capability is planned to be removed in a future release.
# Deprecations should be announced at least two releases prior to removal. Any breaking changes should only be done in major releases.
#
# Below is an example of what a single entry should look like, it's required attributes,
# and what types we expect those attribute values to be.
#
# For more information please refer to the handbook documentation here:
# {{LINK TBD}}
#
# 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.
removal_milestone: "XX.YY" # the milestone when this feature is planned to be removed
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.
Make sure to run `bin/rake gitlab:docs:compile_deprecations` locally before committing and pushing your changes.
When ready, assign to your tech writer to review and merge.
END OF BODY COMMENT -->
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
announcement_date: # YYYY-MM-DD format - the date of the milestone release when this feature was first announced as deprecated
removal_date: # (optional - may be required in the future) YYYY-MM-DD format - the date of the milestone release when this feature is planned to be removed
|
