diff options
Diffstat (limited to 'data/removals/templates/_removal_template.md.erb')
| -rw-r--r-- | data/removals/templates/_removal_template.md.erb | 46 |
1 files changed, 46 insertions, 0 deletions
diff --git a/data/removals/templates/_removal_template.md.erb b/data/removals/templates/_removal_template.md.erb new file mode 100644 index 00000000000..e227c6aa6e6 --- /dev/null +++ b/data/removals/templates/_removal_template.md.erb @@ -0,0 +1,46 @@ +--- +stage: none +group: none +info: "See the Technical Writers assigned to Development Guidelines: https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments-to-development-guidelines" +--- + +# Removals by milestone + +<!-- vale off --> + +<!-- +DO NOT EDIT THIS PAGE DIRECTLY + +This page is automatically generated from the YAML files in `/data/removals` by the rake task +located at `lib/tasks/gitlab/docs/compile_removals.rake`. + +For removal authors (usually Product Managers and Engineering Managers): + +- To add a removal, use the example.yml file in `/data/removals/templates` as a template. +- For more information about authoring removals, check the the removal item guidance: + https://about.gitlab.com/handbook/marketing/blog/release-posts/#creating-a-removal-entry + +For removal reviewers (Technical Writers only): + +- To update the removal doc, run: `bin/rake gitlab:docs:compile_removals` +- To verify the removals doc is up to date, run: `bin/rake gitlab:docs:check_removals` +- For more information about updating the removal doc, see the removal doc update guidance: + https://about.gitlab.com/handbook/marketing/blog/release-posts/#update-the-removals-doc +--> +<% if milestones.any? -%> + <%- milestones.each do |milestone| %> +## <%= milestone %> + <%- entries.select{|entry| entry["removal_milestone"] == milestone}.each do |removal| %> +### <%= removal["name"]%> +<% if removal["breaking_change"] -%> +WARNING: +This feature was changed or removed in <%= removal["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. + +<%= removal["body"] -%><% else %> +<%= removal["body"] -%><% end %><%- end -%><%- end -%> +<%- else -%> +Features scheduled for removal will be listed here, sorted by GitLab milestone. +<% end -%> |