diff options
Diffstat (limited to 'doc/.vale')
-rw-r--r-- | doc/.vale/gitlab/British.yml | 3 | ||||
-rw-r--r-- | doc/.vale/gitlab/InternalLinkExtension.yml | 4 | ||||
-rw-r--r-- | doc/.vale/gitlab/Markdown_emoji.yml | 13 |
3 files changed, 18 insertions, 2 deletions
diff --git a/doc/.vale/gitlab/British.yml b/doc/.vale/gitlab/British.yml index f724eb19fa9..c63cbd917c7 100644 --- a/doc/.vale/gitlab/British.yml +++ b/doc/.vale/gitlab/British.yml @@ -80,6 +80,9 @@ swap: neighbour: neighbor normalise: normalize offence: offense + optimise: optimize + optimised: optimized + optimising: optimizing organise: organize orientated: oriented paralyse: paralyze diff --git a/doc/.vale/gitlab/InternalLinkExtension.yml b/doc/.vale/gitlab/InternalLinkExtension.yml index 5783c4347a9..52142b50dfc 100644 --- a/doc/.vale/gitlab/InternalLinkExtension.yml +++ b/doc/.vale/gitlab/InternalLinkExtension.yml @@ -5,9 +5,9 @@ # # For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles extends: existence -message: 'Link "%s" must use the .md file extension.' +message: 'Link "%s" must link directly to a file and use the .md file extension.' link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#links-to-internal-documentation level: error scope: raw raw: - - '\[.+\]\([\w\/\.-]+\.html[^)]*\)' + - '\[[^\]]+\]\([^:\)]+(\/(#[^\)]+)?\)|\.html(#.+)?\))' diff --git a/doc/.vale/gitlab/Markdown_emoji.yml b/doc/.vale/gitlab/Markdown_emoji.yml new file mode 100644 index 00000000000..ac0dab2d69d --- /dev/null +++ b/doc/.vale/gitlab/Markdown_emoji.yml @@ -0,0 +1,13 @@ +--- +# Warning: gitlab.Markdown_emoji +# +# Check for use of GLFM emoji syntax (https://docs.gitlab.com/ee/user/markdown.html#emojis), which doesn't render correctly in documentation. +# +# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +extends: existence +message: 'This appears to be GLFM emoji syntax. Replace "%s" with GitLab SVGs or Unicode emojis.' +link: https://docs.gitlab.com/ee/development/documentation/styleguide/#gitlab-svg-icons +level: warning +scope: text +raw: + - '(?:\s+|^):[a-zA-Z0-9\-_\+]+:(?:\s+|$|\.)' |