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
diff options
context:
space:
mode:
Diffstat (limited to 'doc/.vale/gitlab')
-rw-r--r--doc/.vale/gitlab/Acronyms.yml1
-rw-r--r--doc/.vale/gitlab/AlertBoxStyle.yml8
-rw-r--r--doc/.vale/gitlab/ContractionsDiscard.yml (renamed from doc/.vale/gitlab/Contractions.yml)17
-rw-r--r--doc/.vale/gitlab/ContractionsKeep.yml25
-rw-r--r--doc/.vale/gitlab/FutureTense.yml8
-rw-r--r--doc/.vale/gitlab/OutdatedVersions.yml2
-rw-r--r--doc/.vale/gitlab/spelling-exceptions.txt6
7 files changed, 43 insertions, 24 deletions
diff --git a/doc/.vale/gitlab/Acronyms.yml b/doc/.vale/gitlab/Acronyms.yml
index d166e71491c..c347c663bbf 100644
--- a/doc/.vale/gitlab/Acronyms.yml
+++ b/doc/.vale/gitlab/Acronyms.yml
@@ -68,6 +68,7 @@ exceptions:
- SSH
- SSL
- SSO
+ - SVG
- SVN
- TCP
- TIP
diff --git a/doc/.vale/gitlab/AlertBoxStyle.yml b/doc/.vale/gitlab/AlertBoxStyle.yml
index 831d5395fc8..8f9e444edc1 100644
--- a/doc/.vale/gitlab/AlertBoxStyle.yml
+++ b/doc/.vale/gitlab/AlertBoxStyle.yml
@@ -5,12 +5,12 @@
#
# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles
extends: existence
-message: 'Alert box "%s" must use the formatting detailed in the documentation style guide.'
+message: 'Alert box "%s" must use the formatting in the style guide.'
link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#alert-boxes
level: error
scope: raw
raw:
- '((NOTE|TIP|CAUTION|DANGER): \*\*[^:]*\*\*)|'
- - '((NOTE: \*\*NOTE:\*\*)|(TIP: \*\*TIP:\*\*)|(CAUTION: \*\*CAUTION:\*\*)|(DANGER: \*\*DANGER:\*\*))|'
- - '((NOTE: \*\*note:\*\*)|(TIP: \*\*tip:\*\*)|(CAUTION: \*\*caution:\*\*)|(DANGER: \*\*danger:\*\*))|'
- - '((NOTE|TIP|CAUTION|DANGER): \*\*.*\*\*.+)'
+ - '((NOTE: \*\*(NOTE|note):\*\*)|(TIP: \*\*(TIP|tip):\*\*)|(CAUTION: \*\*(CAUTION|caution):\*\*)|(DANGER: \*\*(DANGER|danger):\*\*))|'
+ - '((NOTE|TIP|CAUTION|DANGER): \*\*.*\*\*.+)|'
+ - '((\n[> ]*(\*){1,2}(NOTE|Note|note|TIP|Tip|tip|CAUTION|Caution|caution|DANGER|Danger|danger):(\*){1,2}))'
diff --git a/doc/.vale/gitlab/Contractions.yml b/doc/.vale/gitlab/ContractionsDiscard.yml
index dc48b876f40..698fda86b5b 100644
--- a/doc/.vale/gitlab/Contractions.yml
+++ b/doc/.vale/gitlab/ContractionsDiscard.yml
@@ -1,7 +1,7 @@
---
-# Suggestion: gitlab.Contractions
+# Suggestion: gitlab.ContractionsDiscard
#
-# Checks for use of common and uncommon contractions.
+# Suggests a list of agreed-upon contractions to discard.
#
# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles
extends: substitution
@@ -12,18 +12,6 @@ nonword: false
ignorecase: true
swap:
- # Common contractions are ok
- it is: it's
- can not: can't
- cannot: can't
- do not: don't
- have not: haven't
- that is: that's
- we are: we're
- would not: wouldn't
- you are: you're
- you have: you've
-
# Uncommon contractions are not ok
aren't: are not
couldn't: could not
@@ -42,4 +30,3 @@ swap:
where's: where is
who's: who is
why's: why is
-
diff --git a/doc/.vale/gitlab/ContractionsKeep.yml b/doc/.vale/gitlab/ContractionsKeep.yml
new file mode 100644
index 00000000000..eeaf65e0829
--- /dev/null
+++ b/doc/.vale/gitlab/ContractionsKeep.yml
@@ -0,0 +1,25 @@
+---
+# Suggestion: gitlab.ContractionsKeep
+#
+# Suggests a list of agreed-upon contractions to keep.
+#
+# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles
+extends: substitution
+message: 'Use "%s" instead of "%s", for a friendly, informal tone.'
+link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#language
+level: suggestion
+nonword: false
+ignorecase: true
+swap:
+
+ # Common contractions are ok
+ it is: it's
+ can not: can't
+ cannot: can't
+ do not: don't
+ have not: haven't
+ that is: that's
+ we are: we're
+ would not: wouldn't
+ you are: you're
+ you have: you've
diff --git a/doc/.vale/gitlab/FutureTense.yml b/doc/.vale/gitlab/FutureTense.yml
index a53a7dd29cc..4a74ee87331 100644
--- a/doc/.vale/gitlab/FutureTense.yml
+++ b/doc/.vale/gitlab/FutureTense.yml
@@ -11,7 +11,7 @@ ignorecase: true
level: warning
link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#language-to-avoid
raw:
- - "(going to( |\n|[[:punct:]])[a-zA-Z]*|"
- - "will( |\n|[[:punct:]])[a-zA-Z]*|"
- - "won't( |\n|[[:punct:]])[a-zA-Z]*|"
- - "[a-zA-Z]*'ll( |\n|[[:punct:]])[a-zA-Z]*)"
+ - "(going to( |\n|[[:punct:]])[a-zA-Z]*|"
+ - "will( |\n|[[:punct:]])[a-zA-Z]*|"
+ - "won't( |\n|[[:punct:]])[a-zA-Z]*|"
+ - "[a-zA-Z]*'ll( |\n|[[:punct:]])[a-zA-Z]*)"
diff --git a/doc/.vale/gitlab/OutdatedVersions.yml b/doc/.vale/gitlab/OutdatedVersions.yml
index 3252481a523..1bc0bf58f90 100644
--- a/doc/.vale/gitlab/OutdatedVersions.yml
+++ b/doc/.vale/gitlab/OutdatedVersions.yml
@@ -3,7 +3,7 @@
#
# Checks for references to versions of GitLab that are no longer supported.
#
-# For a list of all options, see https://errata-ai.github.io/vale/styles/
+# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles
extends: existence
message: 'Can this reference to "%s" be refactored?'
link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#importance-of-referencing-gitlab-versions-and-tiers
diff --git a/doc/.vale/gitlab/spelling-exceptions.txt b/doc/.vale/gitlab/spelling-exceptions.txt
index 28da80557ec..1301e8c4ca1 100644
--- a/doc/.vale/gitlab/spelling-exceptions.txt
+++ b/doc/.vale/gitlab/spelling-exceptions.txt
@@ -191,6 +191,7 @@ http
https
idempotence
idmapper
+inclusivity
Ingress
initializer
initializers
@@ -308,6 +309,8 @@ Piwik
PgBouncer
plaintext
Poedit
+polyfill
+polyfills
pooler
PostgreSQL
precompile
@@ -330,6 +333,7 @@ profiler
Prometheus
proxied
proxies
+proxyable
proxying
pseudonymized
pseudonymizer
@@ -384,6 +388,7 @@ reverify
Rubix
Rubocop
Rubular
+ruleset
runbook
runbooks
runit
@@ -464,6 +469,7 @@ TypeScript
Twilio
Twitter
Ubuntu
+unapplied
unarchive
unarchived
unarchives