summaryrefslogtreecommitdiff
path: root/doc/.vale
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2021-03-16 18:18:33 +0000
committerGitLab Bot <gitlab-bot@gitlab.com>2021-03-16 18:18:33 +0000
commitf64a639bcfa1fc2bc89ca7db268f594306edfd7c (patch)
treea2c3c2ebcc3b45e596949db485d6ed18ffaacfa1 /doc/.vale
parentbfbc3e0d6583ea1a91f627528bedc3d65ba4b10f (diff)
downloadgitlab-ce-f64a639bcfa1fc2bc89ca7db268f594306edfd7c.tar.gz
Add latest changes from gitlab-org/gitlab@13-10-stable-eev13.10.0-rc40
Diffstat (limited to 'doc/.vale')
-rw-r--r--doc/.vale/gitlab/Admin.yml2
-rw-r--r--doc/.vale/gitlab/AlertBoxStyle.yml2
-rw-r--r--doc/.vale/gitlab/BadgeCapitalization.yml33
-rw-r--r--doc/.vale/gitlab/DefaultBranch.yml14
-rw-r--r--doc/.vale/gitlab/RelativeLinksDoubleSlashes.yml13
-rw-r--r--doc/.vale/gitlab/SubstitutionSuggestions.yml1
-rw-r--r--doc/.vale/gitlab/spelling-exceptions.txt31
7 files changed, 62 insertions, 34 deletions
diff --git a/doc/.vale/gitlab/Admin.yml b/doc/.vale/gitlab/Admin.yml
index d74621bde8e..560752594d5 100644
--- a/doc/.vale/gitlab/Admin.yml
+++ b/doc/.vale/gitlab/Admin.yml
@@ -6,7 +6,7 @@
# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles
extends: substitution
message: 'Verify this use of the word "admin". Can it be updated to "administration", "administrator", "administer", or "Admin Area"?'
-link: https://docs.gitlab.com/ee/development/documentation/styleguide.html
+link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html
level: suggestion
ignorecase: true
swap:
diff --git a/doc/.vale/gitlab/AlertBoxStyle.yml b/doc/.vale/gitlab/AlertBoxStyle.yml
index 92c3a16cab8..5912c4707fd 100644
--- a/doc/.vale/gitlab/AlertBoxStyle.yml
+++ b/doc/.vale/gitlab/AlertBoxStyle.yml
@@ -10,7 +10,7 @@
# 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 in the style guide.'
-link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#alert-boxes
+link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#alert-boxes
level: error
nonword: true
scope: raw
diff --git a/doc/.vale/gitlab/BadgeCapitalization.yml b/doc/.vale/gitlab/BadgeCapitalization.yml
index 3da5831ed56..89d6f509d63 100644
--- a/doc/.vale/gitlab/BadgeCapitalization.yml
+++ b/doc/.vale/gitlab/BadgeCapitalization.yml
@@ -10,35 +10,4 @@ link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html
level: error
scope: raw
raw:
- - '(\*\*\(Core\)\*\*|'
- - '\*\*\(core\)\*\*|'
- - '\*\*\(Starter\)\*\*|'
- - '\*\*\(starter\)\*\*|'
- - '\*\*\(Premium\)\*\*|'
- - '\*\*\(premium\)\*\*|'
- - '\*\*\(Ultimate\)\*\*|'
- - '\*\*\(ultimate\)\*\*|'
- - '\*\*\(Core Only\)\*\*|'
- - '\*\*\(Core only\)\*\*|'
- - '\*\*\(core only\)\*\*|'
- - '\*\*\(Starter Only\)\*\*|'
- - '\*\*\(Starter only\)\*\*|'
- - '\*\*\(starter only\)\*\*|'
- - '\*\*\(Premium Only\)\*\*|'
- - '\*\*\(Premium only\)\*\*|'
- - '\*\*\(premium only\)\*\*|'
- - '\*\*\(Ultimate Only\)\*\*|'
- - '\*\*\(Ultimate only\)\*\*|'
- - '\*\*\(ultimate only\)\*\*|'
- - '\*\*\(Free Only\)\*\*|'
- - '\*\*\(Free only\)\*\*|'
- - '\*\*\(free only\)\*\*|'
- - '\*\*\(Bronze Only\)\*\*|'
- - '\*\*\(Bronze only\)\*\*|'
- - '\*\*\(bronze only\)\*\*|'
- - '\*\*\(Silver Only\)\*\*|'
- - '\*\*\(Silver only\)\*\*|'
- - '\*\*\(silver only\)\*\*|'
- - '\*\*\(Gold Only\)\*\*|'
- - '\*\*\(Gold only\)\*\*|'
- - '\*\*\(gold only\)\*\*)'
+ - '\*\*\(([Ff]ree|[Pp]remium|[Uu]ltimate)( [Ss](elf|ass))?\)\*\*'
diff --git a/doc/.vale/gitlab/DefaultBranch.yml b/doc/.vale/gitlab/DefaultBranch.yml
new file mode 100644
index 00000000000..4bc68433c6d
--- /dev/null
+++ b/doc/.vale/gitlab/DefaultBranch.yml
@@ -0,0 +1,14 @@
+---
+# Warning: gitlab.DefaultBranch
+#
+# Do not refer to the default branch as the "master" branch, if possible.
+#
+# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles
+extends: existence
+message: 'Use "default branch" or `main` instead of `master`, when possible.'
+level: warning
+ignorecase: true
+link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html
+scope: raw
+raw:
+ - '\`master\`'
diff --git a/doc/.vale/gitlab/RelativeLinksDoubleSlashes.yml b/doc/.vale/gitlab/RelativeLinksDoubleSlashes.yml
new file mode 100644
index 00000000000..ce6ce8b5691
--- /dev/null
+++ b/doc/.vale/gitlab/RelativeLinksDoubleSlashes.yml
@@ -0,0 +1,13 @@
+---
+# Error: gitlab.RelativeLinksDoubleSlashes
+#
+# Checks for the presence of double slashes in relative URLs.
+#
+# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles
+extends: existence
+message: 'Relative links must not include a double slash.'
+link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#links-to-internal-documentation
+level: error
+scope: raw
+raw:
+ - '\.//'
diff --git a/doc/.vale/gitlab/SubstitutionSuggestions.yml b/doc/.vale/gitlab/SubstitutionSuggestions.yml
index eac738d9eec..d2b8b37b301 100644
--- a/doc/.vale/gitlab/SubstitutionSuggestions.yml
+++ b/doc/.vale/gitlab/SubstitutionSuggestions.yml
@@ -14,6 +14,7 @@ swap:
active user: '"billable user"'
active users: '"billable users"'
docs: '"documentation"'
+ GFM: '"GitLab Flavored Markdown"'
once that: '"after that"'
once the: '"after the"'
once you: '"after you"'
diff --git a/doc/.vale/gitlab/spelling-exceptions.txt b/doc/.vale/gitlab/spelling-exceptions.txt
index 375cecfdee4..88d1d2555f1 100644
--- a/doc/.vale/gitlab/spelling-exceptions.txt
+++ b/doc/.vale/gitlab/spelling-exceptions.txt
@@ -41,6 +41,7 @@ autoscales
autoscaling
awardable
awardables
+Ayoa
Axios
Azure
B-tree
@@ -56,6 +57,7 @@ backtracing
badging
Bamboo
Bazel
+Bhyve
Bitbucket
blockquote
blockquoted
@@ -89,6 +91,7 @@ Certbot
changeset
changesets
chai
+ChaosKube
chatbot
chatbots
ChatOps
@@ -111,6 +114,8 @@ Contentful
Corosync
Coursier
cron
+cronjob
+cronjobs
crons
crontab
crontabs
@@ -122,6 +127,8 @@ CrowdIn
CSV
cybersecurity
Dangerfile
+datasource
+datasources
datetime
Debian
Decompressor
@@ -280,6 +287,7 @@ kaniko
Karma
Kerberos
keyset
+keyspace
keytab
keytabs
Kibana
@@ -350,6 +358,7 @@ mixins
mockup
mockups
ModSecurity
+Monokai
monorepo
monorepos
multiline
@@ -373,6 +382,7 @@ nullable
Nurtch
nyc
OAuth
+Octokit
offboarded
offboarding
offboards
@@ -404,9 +414,11 @@ Poedit
polyfill
polyfills
pooler
+postfixed
postgres.ai
PostgreSQL
precompile
+precompiled
preconfigure
preconfigured
preconfigures
@@ -421,6 +433,7 @@ prepend
prepended
prepending
prepends
+prepopulated
Prettifier
Pritaly
Priyanka
@@ -443,6 +456,7 @@ queryable
Quicktime
Rackspace
Raspbian
+rbtrace
Rdoc
reachability
Realplayer
@@ -477,6 +491,7 @@ reinitialize
reinitializing
relicensing
remediations
+replicables
repmgr
repmgrd
repurposing
@@ -519,10 +534,12 @@ Salesforce
sandboxing
sanitization
sbt
+scalers
scatterplot
scatterplots
Schemastore
scrollable
+Semgrep
Sendmail
Sentry
serializer
@@ -538,11 +555,13 @@ Sidekiq
Silverlight
Sisense
Sitespeed
+skippable
Slack
Slackbot
Slony
smartcard
smartcards
+snapshotting
Sobelow
Solarized
Sourcegraph
@@ -561,6 +580,9 @@ strace
strikethrough
strikethroughs
stunnel
+stylelint
+subchart
+subcharts
subfolder
subfolders
subgraph
@@ -620,12 +642,14 @@ todos
tokenizer
Tokenizers
tokenizing
+tolerations
toolchain
toolchains
toolkit
toolkits
tooltip
tooltips
+transactionally
transpile
transpiled
transpiles
@@ -634,6 +658,7 @@ Trello
triaged
triages
triaging
+Trivy
truthy
Truststore
Twilio
@@ -665,6 +690,9 @@ unencoded
unencoder
unencodes
unencrypted
+unfollow
+unfollowed
+unfollows
Unicorn
unindexed
unlink
@@ -703,6 +731,7 @@ unreplicated
unresolve
unresolved
unresolving
+unreviewed
unsanitized
unschedule
unscoped
@@ -720,6 +749,7 @@ unstash
unstashed
unstashing
unsynced
+unsynchronized
untarred
untracked
untrusted
@@ -772,3 +802,4 @@ Yubico
Zeitwerk
Zendesk
zsh
+Zstandard