Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/doc/.vale
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2022-12-08 12:09:25 +0300
committerGitLab Bot <gitlab-bot@gitlab.com>2022-12-08 12:09:25 +0300
commitef44feb7fa697e96b7011aa45ea3ca7e5087a490 (patch)
tree5b818185d150eaa8e4d9a28a28f62940de598c57 /doc/.vale
parent935bc5955fb3d740f1cc2b380665bbc8875a68b6 (diff)
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/.vale')
-rw-r--r--doc/.vale/gitlab/SubstitutionSuggestions.yml30
-rw-r--r--doc/.vale/gitlab/SubstitutionWarning.yml27
-rw-r--r--doc/.vale/gitlab/Substitutions.yml2
3 files changed, 23 insertions, 36 deletions
diff --git a/doc/.vale/gitlab/SubstitutionSuggestions.yml b/doc/.vale/gitlab/SubstitutionSuggestions.yml
deleted file mode 100644
index 123b4a30625..00000000000
--- a/doc/.vale/gitlab/SubstitutionSuggestions.yml
+++ /dev/null
@@ -1,30 +0,0 @@
----
-# Suggestion: gitlab.SubstitutionSuggestions
-#
-# Suggests better options for frequently misused terms that are often - but not always - incorrect.
-# SubstitutionWarning.yml and Substitutions.yml also exist.
-#
-# For a list of all options, see https://vale.sh/docs/topics/styles/
-extends: substitution
-message: "Consider '%s' instead of '%s'."
-link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html
-level: suggestion
-ignorecase: true
-swap:
- active user: "billable user"
- active users: "billable users"
- docs: "documentation"
- e-mail: "email"
- GLFM: "GitLab Flavored Markdown"
- it is recommended: "you should"
- we recommend: "you should"
- navigate: go
- OAuth2: "OAuth 2.0"
- once that: "after that"
- once the: "after the"
- once you: "after you"
- since: "because' or 'after"
- sub-group: "subgroup"
- sub-groups: "subgroups"
- within: "in"
- ex: "for example"
diff --git a/doc/.vale/gitlab/SubstitutionWarning.yml b/doc/.vale/gitlab/SubstitutionWarning.yml
index 8d6c18c1520..383ae38da16 100644
--- a/doc/.vale/gitlab/SubstitutionWarning.yml
+++ b/doc/.vale/gitlab/SubstitutionWarning.yml
@@ -1,16 +1,18 @@
---
# Warning: gitlab.SubstitutionWarning
#
-# Checks for misused terms or common shorthand that should never be used at GitLab, but can't be flagged as errors.
-# Substitutions.yml and SubstitionSuggestions.yml also exist.
+# Checks for misused terms or common shorthand that should not be used at GitLab, but can't be flagged as errors.
+# Substitutions.yml also exists.
#
# For a list of all options, see https://vale.sh/docs/topics/styles/
extends: substitution
-message: "If possible, use %s instead of '%s'."
-link: https://about.gitlab.com/handbook/communication/#top-misused-terms
+message: "Use '%s' instead of '%s' when possible."
+link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html
level: warning
ignorecase: true
swap:
+ active user: "billable user"
+ active users: "billable users"
air(?:-| )?gapped: "offline environment"
bullet: "list item"
click: "select"
@@ -19,11 +21,26 @@ swap:
deselect: "clear"
deselected: "cleared"
distro: "distribution"
+ docs: "documentation"
+ e-mail: "email"
+ ex: "for example"
file name: "filename"
filesystem: "file system"
- GFM: "'GitLab Flavored Markdown' or 'GitHub Flavored Markdown'"
+ GLFM: "GitLab Flavored Markdown"
+ GFM: "GitLab Flavored Markdown' or 'GitHub Flavored Markdown"
info: "information"
+ it is recommended: "you should"
n/a: "not applicable"
+ navigate to: "go to"
+ OAuth2: "OAuth 2.0"
+ once that: "after that"
+ once the: "after the"
+ once you: "after you"
repo: "repository"
+ since: "because' or 'after"
+ sub-group: "subgroup"
+ sub-groups: "subgroups"
timezone: "time zone"
utilize: "use"
+ we recommend: "you should"
+ within: "in"
diff --git a/doc/.vale/gitlab/Substitutions.yml b/doc/.vale/gitlab/Substitutions.yml
index 1205795233f..675abc6ef6d 100644
--- a/doc/.vale/gitlab/Substitutions.yml
+++ b/doc/.vale/gitlab/Substitutions.yml
@@ -2,7 +2,7 @@
# Error: gitlab.Substitutions
#
# Checks for misused terms that should never be used at GitLab.
-# SubstitutionWarning.yml and SubstitionSuggestions.yml also exist.
+# SubstitutionWarning.yml also exists.
#
# For a list of all options, see https://vale.sh/docs/topics/styles/
extends: substitution