Skip to content
Snippets Groups Projects
Commit 12bc1515 authored by Evan Read's avatar Evan Read
Browse files

Update project for latest Vale and Markdownlint tooling and rules

parent f4666599
No related branches found
No related tags found
1 merge request!82CI/CD: do not build for MRs
......@@ -23,7 +23,8 @@
code-block-style:
style: "fenced"
emphasis-style: false
strong-style: false
link-fragments: false
reference-links-images: false
proper-names:
names: [
"Akismet",
......
---
# Warning: gitlab.Admin
# Suggestion: gitlab.Admin
#
# Checks for "admin" and recommends using the full word instead. "Admin Area" is OK.
#
......
---
# Suggestion: gitlab.BadPlurals
# Warning: gitlab.BadPlurals
#
# Don't write plural words with the '(s)' construction. "HTTP(S)" is acceptable.
#
......
......@@ -80,6 +80,9 @@
neighbour: neighbor
normalise: normalize
offence: offense
optimise: optimize
optimised: optimized
optimising: optimizing
organise: organize
orientated: oriented
paralyse: paralyze
......
---
# Error: gitlab.EOLWhitespace
# Warning: gitlab.EOLWhitespace
#
# Checks that there is no useless whitespace at the end of lines.
#
......
---
# Suggestion: gitlab.FutureTense
# Warning: gitlab.FutureTense
#
# Checks for use of future tense in sentences. Present tense is strongly preferred.
#
......
---
# Error: gitlab.HeadingContent
# Warning: gitlab.HeadingContent
#
# Checks for generic, unhelpful subheadings.
#
......
---
# Warning: gitlab.HeadingDepth
#
# Checks that there are no headings greater than 3 levels
#
# For a list of all options, see https://vale.sh/docs/topics/styles/
extends: existence
message: 'The subheading "%s" is nested too deeply. Headings deeper than H5 suggest the section or page should be refactored.'
link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#headings-in-markdown
level: warning
scope: raw
raw:
- '(?<=\n)#{5,}\s.*'
......@@ -5,8 +5,8 @@
#
# 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:
......@@ -9,5 +9,5 @@
link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#links-to-internal-documentation
level: error
scope: raw
raw:
- '\[.+\]\([\w\/\.-]+\.html[^)]*\)'
- '\[[^\]]+\]\([^:\)]+(\/(#[^\)]+)?\)|\.html(#.+)?\))'
---
# 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+|$|\.)'
......@@ -10,5 +10,5 @@
level: error
scope: raw
raw:
- '\[[^\]]*?\n[^\]]*?\]\([^\)]*?\)|'
- '\[[^\]]*?\]\([^\)]*?\n[^\)]*\)'
- '\[[^\[\]]*?\n[^\[\]]*?\]\([^\)]*?\)|'
- '\[[^\[\]]*?\]\([^\)]*?\n[^\)]*\)'
---
# Warning: gitlab.OutdatedVersions
# Suggestion: gitlab.OutdatedVersions
#
# Checks for references to versions of GitLab that are no longer supported.
#
......
---
# Warning: gitlab.Possessive
# Error: gitlab.Possessive
#
# The word GitLab should not be used in the possessive form.
#
......
......@@ -299,7 +299,7 @@
# Perform documentation linting on Markdown files
docs-lint markdown:
image: registry.gitlab.com/gitlab-org/gitlab-docs/lint-markdown:alpine-3.16-vale-2.17.0-markdownlint-0.31.1
image: registry.gitlab.com/gitlab-org/gitlab-docs/lint-markdown:alpine-3.16-vale-2.20.1-markdownlint-0.32.2
stage: check
cache: {}
needs: []
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment