diff options
Diffstat (limited to 'doc/.vale/gitlab/HeaderGerunds.yml')
| -rw-r--r-- | doc/.vale/gitlab/HeaderGerunds.yml | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/.vale/gitlab/HeaderGerunds.yml b/doc/.vale/gitlab/HeaderGerunds.yml new file mode 100644 index 00000000000..9e5fa19f867 --- /dev/null +++ b/doc/.vale/gitlab/HeaderGerunds.yml @@ -0,0 +1,14 @@ +--- +# Suggestion: 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' |