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
diff options
context:
space:
mode:
Diffstat (limited to 'doc/.vale/gitlab/AlertBoxStyle.yml')
-rw-r--r--doc/.vale/gitlab/AlertBoxStyle.yml16
1 files changed, 16 insertions, 0 deletions
diff --git a/doc/.vale/gitlab/AlertBoxStyle.yml b/doc/.vale/gitlab/AlertBoxStyle.yml
new file mode 100644
index 00000000000..831d5395fc8
--- /dev/null
+++ b/doc/.vale/gitlab/AlertBoxStyle.yml
@@ -0,0 +1,16 @@
+---
+# Error: gitlab.AlertBoxStyle
+#
+# Makes sure alert boxes follow standard formatting.
+#
+# 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 detailed in the documentation style guide.'
+link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#alert-boxes
+level: error
+scope: raw
+raw:
+ - '((NOTE|TIP|CAUTION|DANGER): \*\*[^:]*\*\*)|'
+ - '((NOTE: \*\*NOTE:\*\*)|(TIP: \*\*TIP:\*\*)|(CAUTION: \*\*CAUTION:\*\*)|(DANGER: \*\*DANGER:\*\*))|'
+ - '((NOTE: \*\*note:\*\*)|(TIP: \*\*tip:\*\*)|(CAUTION: \*\*caution:\*\*)|(DANGER: \*\*danger:\*\*))|'
+ - '((NOTE|TIP|CAUTION|DANGER): \*\*.*\*\*.+)'