From 7528a05d07a5d2e70e9c1aea9a26c81041b7d507 Mon Sep 17 00:00:00 2001 From: Marcel Amirault <mamirault@gitlab.com> Date: Thu, 1 Feb 2024 16:58:05 +0000 Subject: [PATCH] Expand version history rule to catch more issues --- doc/.vale/gitlab/HistoryItems.yml | 11 ++++++----- doc/administration/auth/ldap/index.md | 2 +- doc/ci/environments/index.md | 2 +- doc/ci/yaml/index.md | 7 +++++-- doc/development/pipelines/index.md | 2 +- .../configuration/enabling_the_analyzer.md | 2 +- .../browser/configuration/enabling_the_analyzer.md | 6 ++---- doc/user/okrs.md | 2 +- doc/user/project/merge_requests/approvals/rules.md | 2 +- doc/user/tasks.md | 2 +- 10 files changed, 20 insertions(+), 18 deletions(-) diff --git a/doc/.vale/gitlab/HistoryItems.yml b/doc/.vale/gitlab/HistoryItems.yml index 59a703565f39f..72b4c1e4503af 100644 --- a/doc/.vale/gitlab/HistoryItems.yml +++ b/doc/.vale/gitlab/HistoryItems.yml @@ -1,12 +1,13 @@ --- -# Warning: gitlab.VersionHistory +# Warning: gitlab.HistoryItems # -# Ensures version history items are properly formatted. +# Ensures history items are properly formatted. # extends: existence -message: "Version history items should always start with '> -', even if there is only one item." +message: "History items must always start with '> -', one item per line, even if there is only one item." link: https://docs.gitlab.com/ee/development/documentation/versions.html#add-a-version-history-item -level: warning +level: error scope: raw raw: - - '(?m)(?<=^#+[^\n]*\n\n)> [^-]' + - '(?m)(?<=^#+[^\n]*\n\n)> [^-]|' + - '^> - [^\n]*\n[^\n>`]' diff --git a/doc/administration/auth/ldap/index.md b/doc/administration/auth/ldap/index.md index 3f0faa1744c30..a199e4e0fddd1 100644 --- a/doc/administration/auth/ldap/index.md +++ b/doc/administration/auth/ldap/index.md @@ -276,7 +276,7 @@ After configuring LDAP, to test the configuration, use the ### Basic configuration settings -> The `hosts` configuration setting was [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/139) in GitLab 14.7. +> - The `hosts` configuration setting was [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/139) in GitLab 14.7. The following basic settings are available: diff --git a/doc/ci/environments/index.md b/doc/ci/environments/index.md index 0de4b1803e64c..f58ae94ea5f89 100644 --- a/doc/ci/environments/index.md +++ b/doc/ci/environments/index.md @@ -471,7 +471,7 @@ stop_review: #### Run a pipeline job when environment is stopped -> Feature flag `environment_stop_actions_include_all_finished_deployments` [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/435128) in GitLab 16.9. Disabled by default. +> - Feature flag `environment_stop_actions_include_all_finished_deployments` [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/435128) in GitLab 16.9. Disabled by default. FLAG: On self-managed GitLab, by default this feature is not available. To make it available, an administrator can [enable the feature flag](../../administration/feature_flags.md) named `environment_stop_actions_include_all_finished_deployments`. diff --git a/doc/ci/yaml/index.md b/doc/ci/yaml/index.md index 09cdbfe506d4d..cce74c978c56a 100644 --- a/doc/ci/yaml/index.md +++ b/doc/ci/yaml/index.md @@ -2441,9 +2441,12 @@ job1: - [GitLab Runner configuration](https://docs.gitlab.com/runner/configuration/advanced-configuration.html#the-runners-section) -### `identity_provider` **(EXPERIMENT)** +### `identity_provider` -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/142054) in GitLab 16.9. This feature is an [Experiment](../../policy/experiment-beta-support.md). +DETAILS: +**Status:** Experiment + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/142054) in GitLab 16.9. This feature is an [Experiment](../../policy/experiment-beta-support.md). FLAG: On GitLab.com, this feature is not available. diff --git a/doc/development/pipelines/index.md b/doc/development/pipelines/index.md index ade47da610d1d..12129957bcf72 100644 --- a/doc/development/pipelines/index.md +++ b/doc/development/pipelines/index.md @@ -587,7 +587,7 @@ If these commands return `undercover: ✅ No coverage is missing in latest chang ### `pajamas_adoption` job -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/141368) in GitLab 16.8. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/141368) in GitLab 16.8. The `pajamas_adoption` job runs the [Pajamas Adoption Scanner](https://gitlab-org.gitlab.io/frontend/pajamas-adoption-scanner/) in merge requests to prevent regressions in the adoption of the [Pajamas Design System](https://design.gitlab.com/). diff --git a/doc/user/application_security/api_fuzzing/configuration/enabling_the_analyzer.md b/doc/user/application_security/api_fuzzing/configuration/enabling_the_analyzer.md index 69d4f64f9f14c..790f75745cf83 100644 --- a/doc/user/application_security/api_fuzzing/configuration/enabling_the_analyzer.md +++ b/doc/user/application_security/api_fuzzing/configuration/enabling_the_analyzer.md @@ -876,7 +876,7 @@ reported. ### View details of an API Fuzzing vulnerability -> Introduced in GitLab 13.7. +> - Introduced in GitLab 13.7. Faults detected by API Fuzzing occur in the live web application, and require manual investigation to determine if they are vulnerabilities. Fuzzing faults are included as vulnerabilities with a diff --git a/doc/user/application_security/dast/browser/configuration/enabling_the_analyzer.md b/doc/user/application_security/dast/browser/configuration/enabling_the_analyzer.md index 03e7f3cc52af9..8317cbe783372 100644 --- a/doc/user/application_security/dast/browser/configuration/enabling_the_analyzer.md +++ b/doc/user/application_security/dast/browser/configuration/enabling_the_analyzer.md @@ -15,10 +15,8 @@ To run a DAST scan: ## Create a DAST CI/CD job -> - This template was [updated](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/62597) to DAST_VERSION: 2 in - GitLab 14.0. -> - This template was [updated](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/87183) to DAST_VERSION: 3 in - GitLab 15.0. +> - This template was [updated](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/62597) to DAST_VERSION: 2 in GitLab 14.0. +> - This template was [updated](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/87183) to DAST_VERSION: 3 in GitLab 15.0. To add DAST scanning to your application, use the DAST job defined in the GitLab DAST CI/CD template file. Updates to the template are provided with GitLab diff --git a/doc/user/okrs.md b/doc/user/okrs.md index f6aa738e8f40e..b68f5c53fd4bc 100644 --- a/doc/user/okrs.md +++ b/doc/user/okrs.md @@ -485,7 +485,7 @@ system note in the OKR's comments, for example: ## Lock discussion -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/398649) in GitLab 16.9 [with a flag](../administration/feature_flags.md) named `work_items_mvc`. Disabled by default. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/398649) in GitLab 16.9 [with a flag](../administration/feature_flags.md) named `work_items_mvc`. Disabled by default. FLAG: On self-managed GitLab, by default this feature is not available. To make it available, an administrator can [enable the feature flag](../administration/feature_flags.md) named `work_items_mvc`. diff --git a/doc/user/project/merge_requests/approvals/rules.md b/doc/user/project/merge_requests/approvals/rules.md index ec2098be07024..0d1ac036d3df2 100644 --- a/doc/user/project/merge_requests/approvals/rules.md +++ b/doc/user/project/merge_requests/approvals/rules.md @@ -34,7 +34,7 @@ use the default approval rules from the target (upstream) project, not the sourc ## Add an approval rule -> Approval rules for all protected branches introduced in GitLab 15.3. +> - Approval rules for all protected branches introduced in GitLab 15.3. Prerequisites: diff --git a/doc/user/tasks.md b/doc/user/tasks.md index 2d3fe4a2e4d4f..86dd1b4a77415 100644 --- a/doc/user/tasks.md +++ b/doc/user/tasks.md @@ -492,7 +492,7 @@ system note in the task's comments, for example: ## Lock discussion -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/398649) in GitLab 16.9 [with a flag](../administration/feature_flags.md) named `work_items_mvc`. Disabled by default. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/398649) in GitLab 16.9 [with a flag](../administration/feature_flags.md) named `work_items_mvc`. Disabled by default. FLAG: On self-managed GitLab, by default this feature is not available. To make it available, an administrator can [enable the feature flag](../administration/feature_flags.md) named `work_items_mvc`. -- GitLab