From edaa33dee2ff2f7ea3fac488d41558eb5f86d68c Mon Sep 17 00:00:00 2001 From: GitLab Bot Date: Thu, 20 Jan 2022 09:16:11 +0000 Subject: Add latest changes from gitlab-org/gitlab@14-7-stable-ee --- doc/.vale/gitlab/ReadingLevel.yml | 12 ++++++------ doc/.vale/gitlab/SubstitutionWarning.yml | 1 + doc/.vale/gitlab/Uppercase.yml | 2 ++ doc/.vale/gitlab/spelling-exceptions.txt | 4 +++- doc/.vale/vale.tmpl | 2 +- 5 files changed, 13 insertions(+), 8 deletions(-) (limited to 'doc/.vale') diff --git a/doc/.vale/gitlab/ReadingLevel.yml b/doc/.vale/gitlab/ReadingLevel.yml index 2e78c3ef36c..cd7597ee8dc 100644 --- a/doc/.vale/gitlab/ReadingLevel.yml +++ b/doc/.vale/gitlab/ReadingLevel.yml @@ -3,11 +3,11 @@ # # Checks the Flesch-Kincaid reading level. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles -extends: readability -message: "Grade level (%s) is high. To lower the score, use shorter sentences and words." +# https://docs.errata.ai/vale/styles#metric +extends: metric +message: "The grade level - %s - refers to how hard the content is to understand. Aim for 8th grade or lower by using shorter sentences and words." link: https://docs.gitlab.com/ee/development/documentation/testing.html#vale-readability-score level: suggestion -grade: 8 -metrics: - - Flesch-Kincaid +formula: | + (0.39 * (words / sentences)) + (11.8 * (syllables / words)) - 15.59 +condition: "> 1" diff --git a/doc/.vale/gitlab/SubstitutionWarning.yml b/doc/.vale/gitlab/SubstitutionWarning.yml index fefc0f85cf4..8000328a20c 100644 --- a/doc/.vale/gitlab/SubstitutionWarning.yml +++ b/doc/.vale/gitlab/SubstitutionWarning.yml @@ -11,6 +11,7 @@ link: https://about.gitlab.com/handbook/communication/#top-misused-terms level: warning ignorecase: true swap: + click: select code base: codebase config: configuration distro: distribution diff --git a/doc/.vale/gitlab/Uppercase.yml b/doc/.vale/gitlab/Uppercase.yml index ae011748748..c9021dc862e 100644 --- a/doc/.vale/gitlab/Uppercase.yml +++ b/doc/.vale/gitlab/Uppercase.yml @@ -53,6 +53,7 @@ exceptions: - EOL - EXIF - FAQ + - FIDO - FIFO - FIPS - FLAG @@ -179,6 +180,7 @@ exceptions: - TLS - TODO - TOML + - TOTP - TTL - UID - UDP diff --git a/doc/.vale/gitlab/spelling-exceptions.txt b/doc/.vale/gitlab/spelling-exceptions.txt index 5ed8dc92249..98254c2259b 100644 --- a/doc/.vale/gitlab/spelling-exceptions.txt +++ b/doc/.vale/gitlab/spelling-exceptions.txt @@ -9,6 +9,7 @@ allowlist allowlisted allowlisting allowlists +AlmaLinux anonymization anonymized Ansible @@ -220,6 +221,7 @@ Fluentd Flycheck Forgerock formatters +Fortinet Fugit fuzzer Gantt @@ -364,7 +366,7 @@ Microsoft middleware middlewares migratus -Minikube +minikube MinIO misconfiguration misconfigurations diff --git a/doc/.vale/vale.tmpl b/doc/.vale/vale.tmpl index 36dfbd6b778..8a6c6e5157d 100644 --- a/doc/.vale/vale.tmpl +++ b/doc/.vale/vale.tmpl @@ -48,4 +48,4 @@ {{end -}} {{end -}} -{{- $e}} {{"errors" | red}}, {{$w}} {{"warnings" | yellow}}, and {{$s}} {{"suggestions" | blue}} found in {{$f}} {{$f | int | plural "file" "files"}}. +{{- $e}} {{"errors" | red}}, {{$w}} {{"warnings" | yellow}}, and {{$s}} {{"suggestions" | blue}} found. -- cgit v1.2.3