diff options
Diffstat (limited to 'data/deprecations/templates/_deprecation_template.md.erb')
| -rw-r--r-- | data/deprecations/templates/_deprecation_template.md.erb | 16 |
1 files changed, 13 insertions, 3 deletions
diff --git a/data/deprecations/templates/_deprecation_template.md.erb b/data/deprecations/templates/_deprecation_template.md.erb index a037151c6ac..80b860b367f 100644 --- a/data/deprecations/templates/_deprecation_template.md.erb +++ b/data/deprecations/templates/_deprecation_template.md.erb @@ -17,13 +17,23 @@ sole discretion of GitLab Inc. <!-- vale off --> <!-- +DO NOT EDIT THIS PAGE DIRECTLY + This page is automatically generated from the YAML files in `/data/deprecations` by the rake task located at `lib/tasks/gitlab/docs/compile_deprecations.rake`. -Do not edit this page directly. +For deprecation authors (usually Product Managers and Engineering Managers): + +- To add a deprecation, use the example.yml file in `/data/deprecations/templates` as a template. +- For more information about authoring deprecations, check the the deprecation item guidance: + https://about.gitlab.com/handbook/marketing/blog/release-posts/#creating-a-deprecation-entry + +For deprecation reviewers (Technical Writers only): -To add a deprecation, use the example.yml file in `/data/deprecations/templates` as a template, -then run `bin/rake gitlab:docs:compile_deprecations`. +- To update the deprecation doc, run: `bin/rake gitlab:docs:compile_deprecations` +- To verify the deprecations doc is up to date, run: `bin/rake gitlab:docs:check_deprecations` +- For more information about updating the deprecation doc, see the deprecation doc update guidance: + https://about.gitlab.com/handbook/marketing/blog/release-posts/#update-the-deprecations-doc --> <% if milestones.any? -%> <%- milestones.each do |milestone| %> |