summaryrefslogtreecommitdiff
path: root/doc/.vale/gitlab/VersionText.yml
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2022-08-18 08:17:02 +0000
committerGitLab Bot <gitlab-bot@gitlab.com>2022-08-18 08:17:02 +0000
commitb39512ed755239198a9c294b6a45e65c05900235 (patch)
treed234a3efade1de67c46b9e5a38ce813627726aa7 /doc/.vale/gitlab/VersionText.yml
parentd31474cf3b17ece37939d20082b07f6657cc79a9 (diff)
downloadgitlab-ce-b39512ed755239198a9c294b6a45e65c05900235.tar.gz
Add latest changes from gitlab-org/gitlab@15-3-stable-eev15.3.0-rc42
Diffstat (limited to 'doc/.vale/gitlab/VersionText.yml')
-rw-r--r--doc/.vale/gitlab/VersionText.yml18
1 files changed, 7 insertions, 11 deletions
diff --git a/doc/.vale/gitlab/VersionText.yml b/doc/.vale/gitlab/VersionText.yml
index 68753de60aa..571fba52ab7 100644
--- a/doc/.vale/gitlab/VersionText.yml
+++ b/doc/.vale/gitlab/VersionText.yml
@@ -1,23 +1,19 @@
---
# Error: gitlab.VersionText
#
-# Checks that version text is formatted correctly.
+# Checks that multi-line version text is formatted correctly.
#
-# Specifically looks for either of the following that is immediately followed on the next line
-# by content, which will break rendering:
+# Specifically, looks for multi-line version text that doesn't use `-` to make it a list.
+# For example:
#
-# - `> Introduced` (version text without a link)
-# - `> [Introduced` (version text with a link)
-#
-# Because it excludes the prefix `> - `, it doesn't look for multi-line version text, for which
-# content immediately on the next line is ok. However, this will often highlight where multi-line
-# version text is attempted without `-` characters.
+# - `> Introduced in GitLab 14.0.
+# - `> Removed in GitLab 15.0.
#
# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles
extends: existence
-message: 'This introduced-in line is not formatted correctly.'
+message: 'This introduced-in section is not formatted correctly. Each entry must start with `> -` and long entries must be on one line.'
link: https://docs.gitlab.com/ee/development/documentation/versions.html
level: error
scope: raw
raw:
- - '> \[?Introduced.+\n[^\n]'
+ - '\n#.*\n\n> [^-].+\n[^\n`]'