diff options
Diffstat (limited to 'data/deprecations/templates')
-rw-r--r-- | data/deprecations/templates/_deprecation_template.md.erb | 16 | ||||
-rw-r--r-- | data/deprecations/templates/example.yml | 3 |
2 files changed, 13 insertions, 6 deletions
diff --git a/data/deprecations/templates/_deprecation_template.md.erb b/data/deprecations/templates/_deprecation_template.md.erb index b0068c32ad9..70169ef5c5c 100644 --- a/data/deprecations/templates/_deprecation_template.md.erb +++ b/data/deprecations/templates/_deprecation_template.md.erb @@ -4,7 +4,7 @@ group: none info: "See the Technical Writers assigned to Development Guidelines: https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments-to-development-guidelines" --- -# Deprecated feature removal schedule +# Deprecations by milestone DISCLAIMER: This page contains information related to upcoming products, features, and functionality. @@ -38,13 +38,19 @@ For deprecation reviewers (Technical Writers only): <% if milestones.any? -%> <%- milestones.each do |milestone| %> ## <%= milestone %> - <%- deprecations.select{|d| d["removal_milestone"] == milestone}.each do |deprecation| %> + <%- entries.select{|d| d["announcement_milestone"] == milestone}.each do |deprecation| %> ### <%= deprecation["name"]%> +<% if deprecation["breaking_change"] -%> -<%= deprecation["body"] -%> +WARNING: +This feature will be changed or removed in <%= deprecation["removal_milestone"]%> +as a [breaking change](https://docs.gitlab.com/ee/development/contributing/#breaking-changes). +Before updating GitLab, review the details carefully to determine if you need to make any +changes to your code, settings, or workflow. -Announced: <%= deprecation["announcement_date"]%> -Planned removal: <%= deprecation["removal_date"]%> +<%= deprecation["body"] -%><% else %> +<%= deprecation["body"] -%><% end %> +**Planned removal milestone: <%= deprecation["removal_milestone"]%> (<%= deprecation["removal_date"]%>)** <%- end -%> <%- end -%> <%- else -%> diff --git a/data/deprecations/templates/example.yml b/data/deprecations/templates/example.yml index 07e65af8277..3097db557b8 100644 --- a/data/deprecations/templates/example.yml +++ b/data/deprecations/templates/example.yml @@ -14,7 +14,8 @@ 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: "YYYY-MM-DD" # This should almost always be the 22nd of a month (YYYY-MM-22), the date of the milestone release 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. <!-- START OF BODY COMMENT |