Commit 59d05aaf authored by Craig Norris's avatar Craig Norris

Merge branch 'docs-test-vale-header-gerunds' into 'master'

Add a vale rule to avoid gerunds in headers

See merge request gitlab-org/gitlab!65114
parents 934f3cf2 06464f8a
---
# Error: gitlab.HeaderGerunds
#
# Checks for headers that start with gerunds (ing words).
# Related to: https://docs.gitlab.com/ee/development/documentation/structure.html
#
# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles
extends: substitution
message: 'Can this header start with an imperative verb, instead of a gerund (ing word)?'
link: https://docs.gitlab.com/ee/development/documentation/styleguide/#heading-titles
level: suggestion
scope: heading
swap:
- '^\w*ing.*': 'Troubleshooting'
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment