diff options
Diffstat (limited to 'data/removals/templates')
-rw-r--r-- | data/removals/templates/_removal_template.md.erb | 5 | ||||
-rw-r--r-- | data/removals/templates/example.yml | 12 |
2 files changed, 15 insertions, 2 deletions
diff --git a/data/removals/templates/_removal_template.md.erb b/data/removals/templates/_removal_template.md.erb index ad0298a6596..89e25c76e04 100644 --- a/data/removals/templates/_removal_template.md.erb +++ b/data/removals/templates/_removal_template.md.erb @@ -9,6 +9,9 @@ info: "See the Technical Writers assigned to Development Guidelines: https://abo In each release, GitLab removes features that were deprecated in an earlier release. Some features cause breaking changes when they are removed. +**{rss}** **To be notified of upcoming breaking changes**, +add this URL to your RSS feed reader: `https://about.gitlab.com/breaking-changes.xml` + <!-- vale off --> <!-- @@ -34,7 +37,7 @@ For removal reviewers (Technical Writers only): <%- milestones.each do |milestone| %> ## Removed in <%= milestone %> <%- entries.select{|entry| entry["removal_milestone"] == milestone}.each do |removal| %> -### <%= removal["name"]%> +### <%= removal["title"]%> <% if removal["breaking_change"] -%> WARNING: diff --git a/data/removals/templates/example.yml b/data/removals/templates/example.yml index 8d7d694be26..e7c0268c182 100644 --- a/data/removals/templates/example.yml +++ b/data/removals/templates/example.yml @@ -12,7 +12,7 @@ # # 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. +- title: "X is removed. Do Y instead." # (required) Actionable title. e.g., The `confidential` field for a `Note` is deprecated. Use `internal` instead. 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. @@ -26,6 +26,16 @@ This area supports markdown. Delete this entire comment and replace it with your markdown content. + Removals must be actionable. + + Use terms such as "removed in favor of" or "use X instead." If no replacement is available, the action would be, "Discontinue use of foo immediately." + + For example: + + - The `confidential` field for a `Note` is removed. Use `internal` instead. + - The `merge_status` field in the merge request API has been removed in favor of `detailed_merge_status`. + - The `notable` endpoint has been removed. Discontinue use of `notable` immediately. + 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 --> |