diff options
Diffstat (limited to 'doc/.vale/gitlab')
-rw-r--r-- | doc/.vale/gitlab/Acronyms.yml | 1 | ||||
-rw-r--r-- | doc/.vale/gitlab/LatinTerms.yml | 2 | ||||
-rw-r--r-- | doc/.vale/gitlab/ReadingLevel.yml | 12 | ||||
-rw-r--r-- | doc/.vale/gitlab/SubstitutionWarning.yml | 2 | ||||
-rw-r--r-- | doc/.vale/gitlab/Wordy.yml | 13 | ||||
-rw-r--r-- | doc/.vale/gitlab/spelling-exceptions.txt | 10 |
6 files changed, 37 insertions, 3 deletions
diff --git a/doc/.vale/gitlab/Acronyms.yml b/doc/.vale/gitlab/Acronyms.yml index bc8f38fe5e2..2d4d0c6909f 100644 --- a/doc/.vale/gitlab/Acronyms.yml +++ b/doc/.vale/gitlab/Acronyms.yml @@ -70,6 +70,7 @@ exceptions: - HDD - HEAD - HIPAA + - HLL - HTML - HTTP - HTTPS diff --git a/doc/.vale/gitlab/LatinTerms.yml b/doc/.vale/gitlab/LatinTerms.yml index 79ba4c17651..12553a801a1 100644 --- a/doc/.vale/gitlab/LatinTerms.yml +++ b/doc/.vale/gitlab/LatinTerms.yml @@ -15,5 +15,3 @@ swap: e\. g\.: for example i\.e\.: that is i\. e\.: that is - etc\.: and so on - et cetera: and so on diff --git a/doc/.vale/gitlab/ReadingLevel.yml b/doc/.vale/gitlab/ReadingLevel.yml new file mode 100644 index 00000000000..0099e70ec8f --- /dev/null +++ b/doc/.vale/gitlab/ReadingLevel.yml @@ -0,0 +1,12 @@ +--- +# Suggestion: gitlab.ReadingLevel +# +# 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." +level: suggestion +grade: 8 +metrics: + - Flesch-Kincaid diff --git a/doc/.vale/gitlab/SubstitutionWarning.yml b/doc/.vale/gitlab/SubstitutionWarning.yml index 50ac97bc227..885b58cc937 100644 --- a/doc/.vale/gitlab/SubstitutionWarning.yml +++ b/doc/.vale/gitlab/SubstitutionWarning.yml @@ -17,7 +17,9 @@ swap: file name: filename filesystem: file system info: information + need to: must repo: repository + timezone: time zone utilize: use administrator access: the Administrator role administrator permission: the Administrator role diff --git a/doc/.vale/gitlab/Wordy.yml b/doc/.vale/gitlab/Wordy.yml new file mode 100644 index 00000000000..7818ecbb74a --- /dev/null +++ b/doc/.vale/gitlab/Wordy.yml @@ -0,0 +1,13 @@ +--- +# Suggestion: gitlab.Wordy +# +# Suggests shorter versions of wordy phrases. +# +# For a list of all options, see https://docs.errata.ai/vale/styles +extends: substitution +message: 'Be concise: "%s" is less wordy than "%s".' +link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html +level: suggestion +ignorecase: true +swap: + in order to: to diff --git a/doc/.vale/gitlab/spelling-exceptions.txt b/doc/.vale/gitlab/spelling-exceptions.txt index 0520fd53c16..43ff584b550 100644 --- a/doc/.vale/gitlab/spelling-exceptions.txt +++ b/doc/.vale/gitlab/spelling-exceptions.txt @@ -14,11 +14,13 @@ anonymized Ansible Anthos Apdex +Apparmor approvers architected architecting archiver Arel +arity Artifactory Asana Asciidoctor @@ -27,6 +29,7 @@ Atlassian auditability Auth0 Authentiq +Authy autocomplete autocompleted autocompletes @@ -128,6 +131,7 @@ CrowdIn CSV cybersecurity Dangerfile +Datadog datasource datasources datetime @@ -184,6 +188,7 @@ enum enums ETag Excon +exfiltration expirable Facebook failover @@ -200,6 +205,7 @@ Filebeat Fio firewalled firewalling +fixup Flawfinder Flowdock Fluentd @@ -244,6 +250,7 @@ Haswell heatmap heatmaps Helm +Helmfile Heroku Herokuish Hexo @@ -269,7 +276,7 @@ innersourcing interdependencies interdependency interruptible -Irker +irker issuables Istio Jaeger @@ -686,6 +693,7 @@ unary unassign unassigning unassigns +unban uncheck unchecked unchecking |