diff options
Diffstat (limited to 'doc/.vale/gitlab/AlertBoxCaution.yml')
-rw-r--r-- | doc/.vale/gitlab/AlertBoxCaution.yml | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/.vale/gitlab/AlertBoxCaution.yml b/doc/.vale/gitlab/AlertBoxCaution.yml new file mode 100644 index 00000000000..49d4dc62ab5 --- /dev/null +++ b/doc/.vale/gitlab/AlertBoxCaution.yml @@ -0,0 +1,14 @@ +--- +# Error: gitlab.AlertBoxCaution +# +# Makes sure CAUTION: alert boxes follow standard formatting. +# +# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +extends: substitution +message: "CAUTION: alert boxes must be of the format 'CAUTION: **Caution:**'. 'Caution' can be replaced with 'Warning' or 'Important'." +link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#alert-boxes +level: warning +nonword: true +scope: raw +swap: + 'CAUTION: *?\*\*.*\*\*': 'CAUTION: \*\*(?:Caution|Warning|Important):\*\*' |