summaryrefslogtreecommitdiff
path: root/doc/.vale/gitlab/AlertBoxStyle.yml
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2020-12-17 11:59:07 +0000
committerGitLab Bot <gitlab-bot@gitlab.com>2020-12-17 11:59:07 +0000
commit8b573c94895dc0ac0e1d9d59cf3e8745e8b539ca (patch)
tree544930fb309b30317ae9797a9683768705d664c4 /doc/.vale/gitlab/AlertBoxStyle.yml
parent4b1de649d0168371549608993deac953eb692019 (diff)
downloadgitlab-ce-8b573c94895dc0ac0e1d9d59cf3e8745e8b539ca.tar.gz
Add latest changes from gitlab-org/gitlab@13-7-stable-eev13.7.0-rc42
Diffstat (limited to 'doc/.vale/gitlab/AlertBoxStyle.yml')
-rw-r--r--doc/.vale/gitlab/AlertBoxStyle.yml13
1 files changed, 8 insertions, 5 deletions
diff --git a/doc/.vale/gitlab/AlertBoxStyle.yml b/doc/.vale/gitlab/AlertBoxStyle.yml
index d15757d38fc..bdf66236ef2 100644
--- a/doc/.vale/gitlab/AlertBoxStyle.yml
+++ b/doc/.vale/gitlab/AlertBoxStyle.yml
@@ -1,18 +1,21 @@
---
# Error: gitlab.AlertBoxStyle
#
-# Makes sure alert boxes follow standard formatting.
+# Makes sure alert boxes are used with block quotes.
#
-# Checks for 2 formatting issues:
+# Checks for 3 formatting issues:
+# - Alert boxes inside a block quote (">")
# - Alert boxes with the note text on the same line
-# - Alert boxes using blockquote formatting, like "> **Note:**"
+# - Alert boxes using words other than "NOTE" or "WARNING"
#
# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles
extends: existence
message: 'Alert box "%s" must use the formatting in the style guide.'
link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#alert-boxes
level: error
+nonword: true
scope: raw
raw:
- - '(\n(NOTE|TIP|CAUTION|DANGER): \*\*.*\*\*.+)|'
- - '((\n[> ]*(\*){1,2}(NOTE|Note|note|TIP|Tip|tip|CAUTION|Caution|caution|DANGER|Danger|danger):(\*){1,2}))'
+ - '(\n *\> *(?:NOTE|WARNING)|'
+ - '\n(NOTE):[^\n]|' # Adding "WARNING" here causes a false positive
+ - '\n *(?:> )?\**(Note|note|TIP|Tip|tip|CAUTION|Caution|caution|DANGER|Danger|danger|warning):.*)' ## Adding "Warning" here causes a false positive