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 | 7 |
2 files changed, 16 insertions, 7 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| %> diff --git a/data/deprecations/templates/example.yml b/data/deprecations/templates/example.yml index a11a6800a74..0aaa68e4bd8 100644 --- a/data/deprecations/templates/example.yml +++ b/data/deprecations/templates/example.yml @@ -6,7 +6,7 @@ # and what types we expect those attribute values to be. # # For more information please refer to the handbook documentation here: -# {{LINK TBD}} +# https://about.gitlab.com/handbook/marketing/blog/release-posts/#deprecations # # Please delete this line and above before submitting your merge request. @@ -19,11 +19,10 @@ 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. + When ready, assign to your tech writer for review. When ready, they will run `bin/rake gitlab:docs:compile_deprecations` to update the deprecations doc, then merge. END OF BODY COMMENT --> +# The following items are not published on the docs page, but may be used in the future. 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 |