Merge branch 'docs-update-deprecations' into 'master'

Fix issues in deprecation doc

See merge request !174346



Merged-by: Marcel Amirault <mamirault@gitlab.com>
Approved-by: Amy Qualls <aqualls@gitlab.com>

data/deprecations/14-6-deprecation-license-compliance-api-terms.yml

@@ -3,7 +3,7 @@
   removal_milestone: "15.0"  # The milestone when this feature is planned to be removed
   breaking_change: true
   body: |  # Do not modify this line, instead modify the lines below.
-    We deprecated legacy names for approval status of license policy (blacklisted, approved) in the `managed_licenses` API but they are still used in our API queries and responses. They will be removed in 15.0.
+    We deprecated legacy names for approval status of license policy (`blacklisted`, `approved`) in the `managed_licenses` API but they are still used in our API queries and responses. They will be removed in 15.0.
 
     If you are using our License Compliance API you should stop using the `approved` and `blacklisted` query parameters, they are now `allowed` and `denied`. In 15.0 the responses will also stop using `approved` and `blacklisted` so you need to adjust any of your custom tools to use the old and new values so they do not break with the 15.0 release.
 # The following items are not published on the docs page, but may be used in the future.

data/deprecations/14-7-deprecate-godep-support-in-license-compliance.yml

@@ -2,7 +2,7 @@
   announcement_milestone: "14.7"  # The milestone when this feature was first announced as deprecated.
   removal_milestone: "15.0"  # The milestone when this feature is planned to be removed
   body: |  # Do not modify this line, instead modify the lines below.
-    The Godep dependency manager for Golang was deprecated in 2020 by Go and
+    The Godep dependency manager for Go was deprecated in 2020 by Go and
     has been replaced with Go modules.
     To reduce our maintenance cost we are deprecating License Compliance for Godep projects as of 14.7
     and will remove it in GitLab 15.0

data/deprecations/14-7-deprecate-static-site-editor.yml

@@ -2,7 +2,7 @@
   announcement_milestone: "14.7"  # The milestone when this feature was first announced as deprecated.
   removal_milestone: "15.0"  # The milestone when this feature is planned to be removed
   body: |  # Do not modify this line, instead modify the lines below.
-    The Static Site Editor will no longer be available starting in GitLab 15.0. Improvements to the Markdown editing experience across GitLab will deliver smiliar benefit but with a wider reach. Incoming requests to the Static Site Editor will be redirected to the [Web IDE](https://docs.gitlab.com/ee/user/project/web_ide/index.html).
+    The Static Site Editor will no longer be available starting in GitLab 15.0. Improvements to the Markdown editing experience across GitLab will deliver similiar benefit but with a wider reach. Incoming requests to the Static Site Editor will be redirected to the [Web IDE](https://docs.gitlab.com/ee/user/project/web_ide/index.html).
 
     Current users of the Static Site Editor can view the [documentation](https://docs.gitlab.com/ee/user/project/web_ide/index.html) for more information, including how to remove the configuration files from existing projects.
 # The following items are not published on the docs page, but may be used in the future.

data/deprecations/14-7-sidekiq-metrics-health-check-donfig.yml

@@ -19,7 +19,7 @@
 
     For the deprecation period those settings are optional
     and GitLab will default the Sidekiq health-checks port to the same port as `sidekiq_exporter`
-    and only run one server (not changing the current behaviour).
+    and only run one server (not changing the current behavior).
     Only if they are both set and a different port is provided, a separate metrics server will spin up
     to serve the Sidekiq metrics, similar to the way Sidekiq will behave in 15.0.
   stage: Enablement

data/deprecations/14-8-compliance-required-pipeline-configuration-premium.yml

@@ -6,7 +6,7 @@
   body: |  # Do not modify this line, instead modify the lines below.
     The [required pipeline configuration](https://docs.gitlab.com/ee/administration/settings/continuous_integration.html#required-pipeline-configuration) feature is deprecated in GitLab 14.8 for Premium customers and is scheduled for removal in GitLab 15.0. This feature is not deprecated for GitLab Ultimate customers.
 
-    This change to move the feature to GitLab's Ultimate tier is intended to help our features better align with our [pricing philosophy](https://handbook.gitlab.com/handbook/company/pricing/#three-tiers) as we see demand for this feature originating primarily from executives.
+    This change to move the feature to GitLab Ultimate tier is intended to help our features better align with our [pricing philosophy](https://handbook.gitlab.com/handbook/company/pricing/#three-tiers) as we see demand for this feature originating primarily from executives.
 
     This change will also help GitLab remain consistent in its tiering strategy with the other related Ultimate-tier features of:
     [Security policies](https://docs.gitlab.com/ee/user/application_security/policies/) and [compliance framework pipelines](https://docs.gitlab.com/ee/user/project/settings/index.html#compliance-pipeline-configuration).

data/deprecations/14-8-deprecate-projectFingerprint-from-PipelineSecurityReportFinding-GraphQL.yml

@@ -4,10 +4,10 @@
   breaking_change: true  # If this deprecation is a breaking change, set this value to true
   reporter: matt_wilson  # GitLab username of the person reporting the deprecation
   body: |  # Do not modify this line, instead modify the lines below.
-    The `projectFingerprint` field in the [PipelineSecurityReportFinding](https://docs.gitlab.com/ee/api/graphql/reference/index.html#pipelinesecurityreportfinding)
+    The `projectFingerprint` field in the [`PipelineSecurityReportFinding`](https://docs.gitlab.com/ee/api/graphql/reference/index.html#pipelinesecurityreportfinding)
     GraphQL object is being deprecated. This field contains a "fingerprint" of security findings used to determine uniqueness.
     The method for calculating fingerprints has changed, resulting in different values. Going forward, the new values will be
-    exposed in the UUID field. Data previously available in the projectFingerprint field will eventually be removed entirely.
+    exposed in the UUID field. Data previously available in the `projectFingerprint` field will eventually be removed entirely.
 # The following items are not published on the docs page, but may be used in the future.
   stage: secure
   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]

data/deprecations/14-8-protect-cns-chs.yml

@@ -4,7 +4,7 @@
   breaking_change: true
   reporter: sam.white
   body: |  # Do not modify this line, instead modify the lines below.
-    All functionality related to GitLab's Container Network Security and
+    All functionality related to GitLab Container Network Security and
     Container Host Security categories is deprecated in GitLab 14.8 and
     scheduled for removal in GitLab 15.0. Users who need a replacement for this
     functionality are encouraged to evaluate the following open source projects

data/deprecations/14-9-background-upload.yml

@@ -4,7 +4,7 @@
   breaking_change: true
   reporter: fzimmer
   body: |  # Do not modify this line, instead modify the lines below.
-    To reduce the overall complexity and maintenance burden of GitLab's [object storage feature](https://docs.gitlab.com/ee/administration/object_storage.html), support for using `background_upload` to upload files is deprecated and will be fully removed in GitLab 15.0. Review the [15.0 specific changes](https://docs.gitlab.com/omnibus/update/gitlab_15_changes.html) for the [removed background uploads settings for object storage](https://docs.gitlab.com/omnibus/update/gitlab_15_changes.html#removed-background-uploads-settings-for-object-storage).
+    To reduce the overall complexity and maintenance burden of the [object storage feature](https://docs.gitlab.com/ee/administration/object_storage.html), support for using `background_upload` to upload files is deprecated and will be fully removed in GitLab 15.0. Review the [15.0 specific changes](https://docs.gitlab.com/omnibus/update/gitlab_15_changes.html) for the [removed background uploads settings for object storage](https://docs.gitlab.com/omnibus/update/gitlab_15_changes.html#removed-background-uploads-settings-for-object-storage).
 
     This impacts a small subset of object storage providers:
 

data/deprecations/14-9-deprecation-htpassword-authentication-container-registry.yml

-- title: "htpasswd Authentication for the container registry"
+- title: "`htpasswd` Authentication for the container registry"
   announcement_milestone: "14.9"
   removal_milestone: "15.0"
   breaking_change: true

data/deprecations/14-9-system_monitoring.yml

@@ -4,7 +4,7 @@
   breaking_change: true  # If this deprecation is a breaking change, set this value to true
   reporter: abellucci  # GitLab username of the person reporting the deprecation
   body: |  # Do not modify this line, instead modify the lines below.
-    GitLab self-monitoring gives administrators of self-hosted GitLab instances the tools to monitor the health of their instances. This feature is deprecated in GitLab 14.9, and is scheduled for removal in 16.0.
+    GitLab self-monitoring gives administrators of GitLab self-managed instances the tools to monitor the health of their instances. This feature is deprecated in GitLab 14.9, and is scheduled for removal in 16.0.
 # The following items are not published on the docs page, but may be used in the future.
   stage: Monitor  # (optional - may be required in the future) String value of the stage that the feature was created in. e.g., Growth
   tiers: [Core, Premium, Ultimate]  # (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]

data/deprecations/15-10-consul-legacy-metrics-disable.yml

@@ -6,7 +6,7 @@
   stage: enablement  # (required) String value of the stage that the feature was created in. e.g., Growth
   issue_url: https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/7278  # (required) Link to the deprecation issue in GitLab
   body: |  # (required) Do not modify this line, instead modify the lines below.
-    The Consul provided in the GitLab Omnibus package will no longer provide older deprecated Consul metrics starting in GitLab 16.0.
+    The Consul provided in the Linux package will no longer provide older deprecated Consul metrics starting in GitLab 16.0.
 
     In GitLab 14.0, [Consul was updated to 1.9.6](https://gitlab.com/gitlab-org/omnibus-gitlab/-/merge_requests/5344),
     which deprecated some telemetry metrics from being at the `consul.http` path. In GitLab 16.0, the `consul.http` path will be removed.

data/deprecations/15-10-global-id-work-items-route.yml

@@ -10,8 +10,8 @@
 
     Because GitLab supports multiple work item types, a path such as `https://gitlab.com/gitlab-org/gitlab/-/work_items/<global_id>` can display, for example, a [task](https://docs.gitlab.com/ee/user/tasks.html) or an [OKR](https://docs.gitlab.com/ee/user/okrs.html).
 
-    In GitLab 15.10 we added support for using internal IDs (IID) in that path by appending a query param at
+    In GitLab 15.10 we added support for using internal IDs (IID) in that path by appending a query parameter at
     the end (`iid_path`) in the following format: `https://gitlab.com/gitlab-org/gitlab/-/work_items/<iid>?iid_path=true`.
 
-    In GitLab 16.0 we will remove the ability to use a global ID in the work items path. The number at the end of the path will be considered an internal ID (IID) without the need of adding a query param at the end. Only the following format will be supported: `https://gitlab.com/gitlab-org/gitlab/-/work_items/<iid>`.
+    In GitLab 16.0 we will remove the ability to use a global ID in the work items path. The number at the end of the path will be considered an internal ID (IID) without the need of adding a query parameter at the end. Only the following format will be supported: `https://gitlab.com/gitlab-org/gitlab/-/work_items/<iid>`.
   tiers: [Free, Silver, Gold, Core, Premium, Ultimate]

data/deprecations/15-10-grafana-chart.yml

-# This is a template for announcing a feature deprecation or other important planned change.
-#
-# Please refer to the deprecation guidelines to confirm your understanding of GitLab's definitions.
-# https://docs.gitlab.com/ee/development/deprecation_guidelines/#terminology
-#
-# Deprecations and other future breaking changes must be announced at least
-# three releases prior to removal.
-#
-# Breaking changes must happen in a major release.
-#
-# See the OPTIONAL END OF SUPPORT FIELDS section below if an End of Support period also applies.
-#
-# For more information please refer to the handbook documentation here:
-# https://handbook.gitlab.com/handbook/marketing/blog/release-posts/#deprecations-and-other-planned-breaking-change-announcements
-#
-# Please delete this line and above before submitting your merge request.
 #
 # REQUIRED FIELDS
 #

data/deprecations/15-10-helm-chart-updates.yml

-# This is a template for announcing a feature deprecation or other important planned change.
-#
-# Please refer to the deprecation guidelines to confirm your understanding of GitLab's definitions.
-# https://docs.gitlab.com/ee/development/deprecation_guidelines/#terminology
-#
-# Deprecations and other future breaking changes must be announced at least
-# three releases prior to removal.
-#
-# Breaking changes must happen in a major release.
-#
-# See the OPTIONAL END OF SUPPORT FIELDS section below if an End of Support period also applies.
-#
-# For more information please refer to the handbook documentation here:
-# https://handbook.gitlab.com/handbook/marketing/blog/release-posts/#deprecations-and-other-planned-breaking-change-announcements
-#
-# Please delete this line and above before submitting your merge request.
 #
 # REQUIRED FIELDS
 #

data/deprecations/15-10-omniauth-dingtalk.yml

-# Please refer to the deprecation guidelines to confirm your understanding of GitLab's definitions.
-# https://docs.gitlab.com/ee/development/deprecation_guidelines/#terminology
-#
-# Deprecations and other future breaking changes must be announced at least
-# three releases prior to removal.
-#
-# Breaking changes must happen in a major release.
-#
-# See the OPTIONAL END OF SUPPORT FIELDS section below if an End of Support period also applies.
-#
-# For more information please refer to the handbook documentation here:
-# https://handbook.gitlab.com/handbook/marketing/blog/release-posts/#deprecations-and-other-planned-breaking-change-announcements
-#
-# Please delete this line and above before submitting your merge request.
 #
 # REQUIRED FIELDS
 #

data/deprecations/15-11-geo-project-redownload.yml

-# This is a template for announcing a feature deprecation or other important planned change.
-#
-# Please refer to the deprecation guidelines to confirm your understanding of GitLab's definitions.
-# https://docs.gitlab.com/ee/development/deprecation_guidelines/#terminology
-#
-# Deprecations and other future breaking changes must be announced at least
-# three releases prior to removal.
-#
-# Breaking changes must happen in a major release.
-#
-# See the OPTIONAL END OF SUPPORT FIELDS section below if an End of Support period also applies.
-#
-# For more information please refer to the handbook documentation here:
-# https://handbook.gitlab.com/handbook/marketing/blog/release-posts/#deprecations-and-other-planned-breaking-change-announcements
-#
-# Please delete this line and above before submitting your merge request.
 #
 # REQUIRED FIELDS
 #

data/deprecations/15-3-omniauth-cas3.yml

@@ -10,5 +10,5 @@
   issue_url: https://gitlab.com/gitlab-org/gitlab/-/issues/369127  # (required) Link to the deprecation issue in GitLab
   body: |  # (required) Do not modify this line, instead modify the lines below.
     The `omniauth-cas3` gem that provides GitLab with the CAS OmniAuth provider will be removed in our next major
-    release, GitLab 16.0. This gem sees very little use and its lack of upstream maintenance is preventing GitLab's
-    [upgrade to OmniAuth 2.0](https://gitlab.com/gitlab-org/gitlab/-/issues/30073).
+    release, GitLab 16.0. This gem sees very little use and its lack of upstream maintenance is preventing GitLab from
+    [upgrading to OmniAuth 2.0](https://gitlab.com/gitlab-org/gitlab/-/issues/30073).

data/deprecations/15-4-confidence-field-in-graphql.yml

@@ -6,7 +6,7 @@
   stage: govern
   issue_url: https://gitlab.com/gitlab-org/gitlab/-/issues/372332
   body: |
-   In GitLab 15.3, [security report schemas below version 15 were deprecated](https://docs.gitlab.com/ee/update/deprecations.html#security-report-schemas-version-14xx).
-   The `confidence` attribute on vulnerability findings exists only in schema versions before `15-0-0`, and therefore is effectively deprecated since GitLab 15.4 supports schema version `15-0-0`. To maintain consistency
-   between the reports and our public APIs, the `confidence` attribute on any vulnerability-related components of our GraphQL API is now deprecated and will be
-   removed in 17.0.
+    In GitLab 15.3, [security report schemas below version 15 were deprecated](https://docs.gitlab.com/ee/update/deprecations.html#security-report-schemas-version-14xx).
+    The `confidence` attribute on vulnerability findings exists only in schema versions before `15-0-0`, and therefore is effectively deprecated because GitLab 15.4 supports schema version `15-0-0`. To maintain consistency
+    between the reports and our public APIs, the `confidence` attribute on any vulnerability-related components of our GraphQL API is now deprecated and will be
+    removed in 17.0.

data/deprecations/15-4-starboard-directive.yml

@@ -6,4 +6,4 @@
   stage: secure
   issue_url: https://gitlab.com/gitlab-org/gitlab/-/issues/368828
   body: |
-    GitLab's operational container scanning capabilities no longer require starboard to be installed. Consequently, use of the `starboard:` directive in the configuration file for the GitLab agent for Kubernetes is now deprecated and is scheduled for removal in GitLab 16.0. Update your configuration file to use the `container_scanning:` directive.
+    GitLab container scanning capabilities no longer require starboard to be installed. Consequently, use of the `starboard:` directive in the configuration file for the GitLab agent for Kubernetes is now deprecated and is scheduled for removal in GitLab 16.0. Update your configuration file to use the `container_scanning:` directive.

data/deprecations/15-8-conan-search-limited-to-project.yml

@@ -6,6 +6,6 @@
   stage: Package  # (required) String value of the stage that the feature was created in. e.g., Growth
   issue_url: https://gitlab.com/gitlab-org/gitlab/-/issues/384455  # (required) Link to the deprecation issue in GitLab
   body: |  # (required) Do not modify this line, instead modify the lines below.
-    You can use the GitLab Conan repository with [project-level](https://docs.gitlab.com/ee/user/packages/conan_repository/#add-a-remote-for-your-project) or [instance-level](https://docs.gitlab.com/ee/user/packages/conan_repository/#add-a-remote-for-your-instance) endpoints. Each level supports the conan search command. However, the search endpoint for the project level is also returning packages from outside the target project.
+    You can use the GitLab Conan repository with [project-level](https://docs.gitlab.com/ee/user/packages/conan_repository/#add-a-remote-for-your-project) or [instance-level](https://docs.gitlab.com/ee/user/packages/conan_repository/#add-a-remote-for-your-instance) endpoints. Each level supports the Conan search command. However, the search endpoint for the project level is also returning packages from outside the target project.
 
     This unintended functionality is deprecated in GitLab 15.8 and will be removed in GitLab 16.0. The search endpoint for the project level will only return packages from the target project.