Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/doc/.vale
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2020-12-16 06:09:46 +0300
committerGitLab Bot <gitlab-bot@gitlab.com>2020-12-16 06:09:46 +0300
commit6aaf8cf6f4a561152e9b08b4a6470ad88195cd2f (patch)
tree9f7f10bb03e3f71e9bdce6c07631a17cd2152aca /doc/.vale
parenteba30e2ad821f653970486c4122fcca22cee27d9 (diff)
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/.vale')
-rw-r--r--doc/.vale/gitlab/AlertBoxStyle.yml21
1 files changed, 21 insertions, 0 deletions
diff --git a/doc/.vale/gitlab/AlertBoxStyle.yml b/doc/.vale/gitlab/AlertBoxStyle.yml
new file mode 100644
index 00000000000..bdf66236ef2
--- /dev/null
+++ b/doc/.vale/gitlab/AlertBoxStyle.yml
@@ -0,0 +1,21 @@
+---
+# Error: gitlab.AlertBoxStyle
+#
+# Makes sure alert boxes are used with block quotes.
+#
+# Checks for 3 formatting issues:
+# - Alert boxes inside a block quote (">")
+# - Alert boxes with the note text on the same line
+# - 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|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