diff --git a/.tool-versions b/.tool-versions index 0555aaac4..eaa313545 100644 --- a/.tool-versions +++ b/.tool-versions @@ -1,2 +1,2 @@ ruby 3.1.4 -vale 2.29.6 +vale 3.0.7 diff --git a/doc/.vale/gitlab/HistoryItems.yml b/doc/.vale/gitlab/HistoryItems.yml new file mode 100644 index 000000000..72b4c1e45 --- /dev/null +++ b/doc/.vale/gitlab/HistoryItems.yml @@ -0,0 +1,13 @@ +--- +# Warning: gitlab.HistoryItems +# +# Ensures history items are properly formatted. +# +extends: existence +message: "History items must always start with '> -', one item per line, even if there is only one item." +link: https://docs.gitlab.com/ee/development/documentation/versions.html#add-a-version-history-item +level: error +scope: raw +raw: + - '(?m)(?<=^#+[^\n]*\n\n)> [^-]|' + - '^> - [^\n]*\n[^\n>`]' diff --git a/doc/.vale/gitlab/LatinTerms.yml b/doc/.vale/gitlab/LatinTerms.yml index 0bac0448b..9fbaf278d 100644 --- a/doc/.vale/gitlab/LatinTerms.yml +++ b/doc/.vale/gitlab/LatinTerms.yml @@ -15,3 +15,4 @@ swap: e\. g\.: for example i\.e\.: that is i\. e\.: that is + via: "with', 'through', or 'by using" diff --git a/doc/.vale/gitlab/Prerequisites.yml b/doc/.vale/gitlab/Prerequisites.yml new file mode 100644 index 000000000..239f9277c --- /dev/null +++ b/doc/.vale/gitlab/Prerequisites.yml @@ -0,0 +1,14 @@ +--- +# Error: gitlab.Prerequisites +# +# The "Prerequisites:" line should always be plural. +# +# For a list of all options, see https://vale.sh/docs/topics/styles/ +extends: existence +message: "Pluralize 'Prerequisites', even if it includes only one item." +link: https://docs.gitlab.com/ee/development/documentation/topic_types/task.html#task-prerequisites +level: warning +nonword: true +scope: text +raw: + - '^Prerequisite:' diff --git a/doc/.vale/gitlab/SubstitutionWarning.yml b/doc/.vale/gitlab/SubstitutionWarning.yml index c081ca5a4..8b4d3160e 100644 --- a/doc/.vale/gitlab/SubstitutionWarning.yml +++ b/doc/.vale/gitlab/SubstitutionWarning.yml @@ -30,12 +30,14 @@ swap: ex: "for example" file name: "filename" filesystem: "file system" + fullscreen: "full screen" info: "information" installation from source: self-compiled installation installations from source: self-compiled installations it is recommended: "you should" logged in user: "authenticated user" logged-in user: "authenticated user" + machine-learning: "machine learning" modal dialog: "dialog" modal window: "dialog" modal: "dialog" @@ -47,6 +49,8 @@ swap: once that: "after that" once the: "after the" once you: "after you" + pack file: packfile + pack files: packfiles pop-up window: "dialog" pop-up: "dialog" popup: "dialog" @@ -59,6 +63,6 @@ swap: sub-group: "subgroup" sub-groups: "subgroups" timezone: "time zone" - utilize: "use" + utiliz(?:es?|ing): "use" we recommend: "you should" within: "in" diff --git a/doc/.vale/gitlab/Substitutions.yml b/doc/.vale/gitlab/Substitutions.yml index 10369669c..4950e495e 100644 --- a/doc/.vale/gitlab/Substitutions.yml +++ b/doc/.vale/gitlab/Substitutions.yml @@ -7,48 +7,35 @@ # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: substitution message: "Use '%s' instead of '%s'." -link: https://about.gitlab.com/handbook/communication/#top-misused-terms +link: https://handbook.gitlab.com/handbook/communication/top-misused-terms/ level: error ignorecase: true swap: - codequality: code quality - Customer [Pp]ortal: Customers Portal - disallow: prevent - frontmatter: front matter - GitLabber: GitLab team member - GitLabbers: GitLab team members - GitLab-shell: GitLab Shell - gitlab omnibus: Linux package - param: parameter - params: parameters - pg: PostgreSQL - 'postgres$': PostgreSQL - golang: Go - raketask: Rake task - raketasks: Rake tasks - rspec: RSpec - self hosted: self-managed - self-hosted: self-managed - styleguide: style guide - to login: to log in - can login: can log in - to log-in: to log in - can log-in: can log in - to signin: to sign in - can signin: can sign in - to sign-in: to sign in - can sign-in: can sign in - x509: X.509 - yml: YAML admin user: administrator admin users: administrators administrator permission: administrator access administrator permissions: administrator access administrator role: administrator access - the administrator access level: administrator access + at least the Owner role: the Owner role + can login: can log in + can log-in: can log in + can signin: can sign in + can sign-in: can sign in + codequality: code quality + Customer [Pp]ortal: Customers Portal developer access: the Developer role developer permission: the Developer role developer permissions: the Developer role + disallow: prevent + '(?