diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-03-24 03:09:28 +0000 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-03-24 03:09:28 +0000 |
commit | be2f4c5788975597dd7be1c8a3525549770c1216 (patch) | |
tree | 083ed0d7e29e26d479c00e00d9cb89d74ebbb0ef /doc/.vale | |
parent | 2711c26beaca6c3a5a3be4b65e01557faf0185b6 (diff) | |
download | gitlab-ce-be2f4c5788975597dd7be1c8a3525549770c1216.tar.gz |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/.vale')
-rw-r--r-- | doc/.vale/gitlab/Substitutions.yml | 3 | ||||
-rw-r--r-- | doc/.vale/gitlab/VersionText.yml | 21 |
2 files changed, 23 insertions, 1 deletions
diff --git a/doc/.vale/gitlab/Substitutions.yml b/doc/.vale/gitlab/Substitutions.yml index b32a03e17d5..1d4f8faf03f 100644 --- a/doc/.vale/gitlab/Substitutions.yml +++ b/doc/.vale/gitlab/Substitutions.yml @@ -3,7 +3,7 @@ # # For a list of all options, see https://errata-ai.github.io/vale/styles/ extends: substitution -message: Use "%s" instead of "%s". +message: 'Use "%s" instead of "%s".' link: https://about.gitlab.com/handbook/communication/#top-misused-terms level: error ignorecase: true @@ -11,3 +11,4 @@ swap: GitLabber: GitLab team member self hosted: self-managed self-hosted: self-managed + postgres: PostgreSQL diff --git a/doc/.vale/gitlab/VersionText.yml b/doc/.vale/gitlab/VersionText.yml new file mode 100644 index 00000000000..c572a1a926c --- /dev/null +++ b/doc/.vale/gitlab/VersionText.yml @@ -0,0 +1,21 @@ +--- +# Checks that version text is formatted correctly. +# +# Specifically looks for either of the following that is immediately followed on the next line +# by content, which will break rendering: +# +# - `> Introduced` (version text without a link) +# - `> [Introduced` (version text with a link) +# +# Because it excludes `-`, it doesn't look for multi-line version text, for which content +# immediately on the next line is ok. However, this will often highlight where multi-line version +# text is attempted without `-` characters. +# +# For a list of all options, see https://errata-ai.github.io/vale/styles/ +extends: existence +message: '"%s" is not formatted correctly.' +link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#text-for-documentation-requiring-version-text +level: error +scope: raw +raw: + - '> (- ){0}\[?Introduced.+\n.+' |