diff --git a/data/deprecations/templates/_deprecation_template.md.erb b/data/deprecations/templates/_deprecation_template.md.erb index 3735e43a96ff3b01124f5e5359003d5af373c553..5261806f49a5a5c779cb1056d395323b1c63c327 100644 --- a/data/deprecations/templates/_deprecation_template.md.erb +++ b/data/deprecations/templates/_deprecation_template.md.erb @@ -5,9 +5,9 @@ info: "See the Technical Writers assigned to Development Guidelines: https://abo toc: false --- -# Deprecations by version +# Deprecations and removals by version -These GitLab features are deprecated and no longer recommended for use. +The following GitLab features are deprecated and no longer recommended for use. Each deprecated feature will be removed in a future release. Some features cause breaking changes when they are removed. @@ -24,8 +24,10 @@ and [GraphQL](https://docs.gitlab.com/ee/api/graphql/removed_items.html) depreca <!-- 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`. +This page is automatically generated from the template located at +`data/deprecations/templates/_deprecation_template.md.erb`, using +the YAML files in `/data/deprecations` by the rake task +located at `lib/tasks/gitlab/docs/compile_deprecations.rake`, For deprecation authors (usually Product Managers and Engineering Managers): diff --git a/doc/development/deprecation_guidelines/index.md b/doc/development/deprecation_guidelines/index.md index 11ba2d9ed628c9019a09aa796b7ee4f0f40b134f..044da025d54cd0d273c669299eccaa5f642bd675 100644 --- a/doc/development/deprecation_guidelines/index.md +++ b/doc/development/deprecation_guidelines/index.md @@ -40,18 +40,18 @@ For configuration removals, see the [Omnibus deprecation policy](../../administr For versioning and upgrade details, see our [Release and Maintenance policy](../../policy/maintenance.md). -## Update the deprecations documentation pages +## Update the deprecations and removals documentation -The [deprecations](../../update/deprecations.md) +The [deprecations and removals](../../update/deprecations.md) documentation is generated from the YAML files located in -[`gitlab/data/`](https://gitlab.com/gitlab-org/gitlab/-/tree/master/data). +[`gitlab/data/deprecations`](https://gitlab.com/gitlab-org/gitlab/-/tree/master/data/deprecations). -To update the deprecations page when an entry is added, +To update the deprecations and removals page when a YAML file is added, edited, or removed: 1. From the command line, navigate to your local clone of the [`gitlab-org/gitlab`](https://gitlab.com/gitlab-org/gitlab) project. 1. Create, edit, or remove the YAML file under [`data/deprecations`](https://gitlab.com/gitlab-org/gitlab/-/tree/master/data/deprecations). -1. Compile the deprecation documentation: +1. Compile the deprecations and removals documentation: ```shell bin/rake gitlab:docs:compile_deprecations @@ -64,13 +64,13 @@ edited, or removed: ``` 1. Commit the updated documentation and push the changes. -1. Create a merge request using the [Deprecations](https://gitlab.com/gitlab-org/gitlab/-/blob/master/.gitlab/merge_request_templates/Deprecations.md) +1. Create a merge request using the [Deprecations and Removals](https://gitlab.com/gitlab-org/gitlab/-/blob/master/.gitlab/merge_request_templates/Deprecations.md) template. Related Handbook pages: - <https://about.gitlab.com/handbook/marketing/blog/release-posts/#deprecations-removals-and-breaking-changes> -- <https://about.gitlab.com/handbook/marketing/blog/release-posts/#update-the-deprecations-and-removals-docs> +- <https://about.gitlab.com/handbook/marketing/blog/release-posts/#update-the-deprecations-and-removals-page> ## Update the related documentation diff --git a/doc/development/integrations/index.md b/doc/development/integrations/index.md index 961e9fdd19305c13177058282b45867fca37411d..bd672c86b28942722b010823f1e998d00a48bc52 100644 --- a/doc/development/integrations/index.md +++ b/doc/development/integrations/index.md @@ -310,7 +310,7 @@ see the [feature deprecation guidelines](../../development/deprecation_guideline You must announce any deprecation [no later than the third milestone preceding intended removal](../../development/deprecation_guidelines/index.md#when-can-a-feature-be-deprecated). To deprecate an integration: -- [Add a deprecation entry](../../development/deprecation_guidelines/index.md#update-the-deprecations-documentation-pages). +- [Add a deprecation entry](../../development/deprecation_guidelines/index.md#update-the-deprecations-and-removals-documentation). - [Mark the integration documentation as deprecated](../../development/documentation/versions.md#deprecate-a-page-or-topic). - Optional. To prevent any new project-level records from being created, add the integration to `Project#disabled_integrations` (see [example merge request](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/114835)). diff --git a/doc/update/deprecations.md b/doc/update/deprecations.md index 7405d08600c6354ca1e6120bf6d57131849ab645..cd58e8ca27c592147985632832a97657308e74f1 100644 --- a/doc/update/deprecations.md +++ b/doc/update/deprecations.md @@ -5,9 +5,9 @@ info: "See the Technical Writers assigned to Development Guidelines: https://abo toc: false --- -# Deprecations by version +# Deprecations and removals by version -These GitLab features are deprecated and no longer recommended for use. +The following GitLab features are deprecated and no longer recommended for use. Each deprecated feature will be removed in a future release. Some features cause breaking changes when they are removed. @@ -24,8 +24,10 @@ and [GraphQL](https://docs.gitlab.com/ee/api/graphql/removed_items.html) depreca <!-- 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`. +This page is automatically generated from the template located at +`data/deprecations/templates/_deprecation_template.md.erb`, using +the YAML files in `/data/deprecations` by the rake task +located at `lib/tasks/gitlab/docs/compile_deprecations.rake`, For deprecation authors (usually Product Managers and Engineering Managers):