summaryrefslogtreecommitdiff
path: root/doc/.vale
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2020-09-19 01:45:44 +0000
committerGitLab Bot <gitlab-bot@gitlab.com>2020-09-19 01:45:44 +0000
commit85dc423f7090da0a52c73eb66faf22ddb20efff9 (patch)
tree9160f299afd8c80c038f08e1545be119f5e3f1e1 /doc/.vale
parent15c2c8c66dbe422588e5411eee7e68f1fa440bb8 (diff)
downloadgitlab-ce-85dc423f7090da0a52c73eb66faf22ddb20efff9.tar.gz
Add latest changes from gitlab-org/gitlab@13-4-stable-ee
Diffstat (limited to 'doc/.vale')
-rw-r--r--doc/.vale/gitlab/Acronyms.yml20
-rw-r--r--doc/.vale/gitlab/AlertBoxStyle.yml6
-rw-r--r--doc/.vale/gitlab/British.yml3
-rw-r--r--doc/.vale/gitlab/ContractionsDiscard.yml32
-rw-r--r--doc/.vale/gitlab/ContractionsKeep.yml25
-rw-r--r--doc/.vale/gitlab/RelativeLinks.yml2
-rw-r--r--doc/.vale/gitlab/spelling-exceptions.txt60
7 files changed, 59 insertions, 89 deletions
diff --git a/doc/.vale/gitlab/Acronyms.yml b/doc/.vale/gitlab/Acronyms.yml
index ae76162dfcf..d26ce9810d7 100644
--- a/doc/.vale/gitlab/Acronyms.yml
+++ b/doc/.vale/gitlab/Acronyms.yml
@@ -14,21 +14,26 @@ first: '\b([A-Z]{3,5})\b'
second: '(?:\b[A-Z][a-z]+ )+\(([A-Z]{3,5})\)'
# ... with the exception of these:
exceptions:
+ - ANSI
- API
- ARN
- ASCII
- AWS
- CLI
- CNAME
- - CPU
- CORE
+ - CPU
- CSS
- CSV
+ - DAST
- DNS
- EKS
- FAQ
+ - FOSS
+ - GCP
- GDK
- GET
+ - GKE
- GNU
- GPG
- GPL
@@ -38,6 +43,7 @@ exceptions:
- IAM
- IBM
- IDE
+ - IID
- IRC
- ISO
- JSON
@@ -46,6 +52,8 @@ exceptions:
- LESS
- LFS
- LRU
+ - MIME
+ - MVC
- NFS
- NGINX
- NOTE
@@ -56,15 +64,20 @@ exceptions:
- PHP
- POST
- PUT
- - RPC
- RAM
+ - RPC
- RSA
- RSS
+ - RVM
- SAML
+ - SAST
- SCIM
- SCP
- SCSS
+ - SDK
- SHA
+ - SLA
+ - SMTP
- SQL
- SSH
- SSL
@@ -77,11 +90,12 @@ exceptions:
- TODO
- TOML
- UNIX
- - USB
- URI
- URL
+ - USB
- UUID
- VPC
- WIP
+ - WSL
- XML
- YAML
diff --git a/doc/.vale/gitlab/AlertBoxStyle.yml b/doc/.vale/gitlab/AlertBoxStyle.yml
index 8f9e444edc1..06743d95ea9 100644
--- a/doc/.vale/gitlab/AlertBoxStyle.yml
+++ b/doc/.vale/gitlab/AlertBoxStyle.yml
@@ -3,6 +3,12 @@
#
# Makes sure alert boxes follow standard formatting.
#
+# Checks for 4 known issues:
+# - Alert boxes with no colon, or colon outside the bold text
+# - Known incorrect capitalization of the most commonly used alert box text
+# - Alert boxes with the note text on the same line
+# - Alert boxes using blockquote formatting, like "> **Note:**"
+#
# 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.'
diff --git a/doc/.vale/gitlab/British.yml b/doc/.vale/gitlab/British.yml
index 3a0cb321f93..7221d7d24aa 100644
--- a/doc/.vale/gitlab/British.yml
+++ b/doc/.vale/gitlab/British.yml
@@ -67,7 +67,6 @@ swap:
matt: matte
meagre: meager
metre: meter
- mitre: miter
modelling: modeling
moustache: mustache
neighbour: neighbor
@@ -98,6 +97,8 @@ swap:
speciality: specialty
spectre: specter
splendour: splendor
+ standardise: standardize
+ standardised: standardized
sulphur: sulfur
theatre: theater
travelled: traveled
diff --git a/doc/.vale/gitlab/ContractionsDiscard.yml b/doc/.vale/gitlab/ContractionsDiscard.yml
deleted file mode 100644
index 698fda86b5b..00000000000
--- a/doc/.vale/gitlab/ContractionsDiscard.yml
+++ /dev/null
@@ -1,32 +0,0 @@
----
-# Suggestion: gitlab.ContractionsDiscard
-#
-# 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
-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:
-
- # Uncommon contractions are not ok
- aren't: are not
- couldn't: could not
- didn't: did not
- doesn't: does not
- hasn't: has not
- how's: how is
- isn't: is not
- shouldn't: should not
- they're: they are
- wasn't: was not
- weren't: were not
- we've: we have
- what's: what is
- when's: when is
- 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
deleted file mode 100644
index eeaf65e0829..00000000000
--- a/doc/.vale/gitlab/ContractionsKeep.yml
+++ /dev/null
@@ -1,25 +0,0 @@
----
-# 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/RelativeLinks.yml b/doc/.vale/gitlab/RelativeLinks.yml
index f7407375b84..7af20d8226f 100644
--- a/doc/.vale/gitlab/RelativeLinks.yml
+++ b/doc/.vale/gitlab/RelativeLinks.yml
@@ -10,4 +10,4 @@ link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#links
level: error
scope: raw
raw:
- - '\[.+\]\(https?:\/\/docs\.gitlab\.com\/ee.*\)'
+ - '\[.+\]\(https?:\/\/docs\.gitlab\.com\/[ce]e.*\)'
diff --git a/doc/.vale/gitlab/spelling-exceptions.txt b/doc/.vale/gitlab/spelling-exceptions.txt
index 1301e8c4ca1..bf816afdfab 100644
--- a/doc/.vale/gitlab/spelling-exceptions.txt
+++ b/doc/.vale/gitlab/spelling-exceptions.txt
@@ -76,6 +76,7 @@ Citus
clonable
Cloudwatch
Cobertura
+Codepen
Cognito
colocated
colocating
@@ -121,8 +122,8 @@ Disqus
Dockerfile
Dockerfiles
dogfood
-dogfoods
dogfooding
+dogfoods
dotenv
downvoted
downvotes
@@ -200,9 +201,9 @@ interdependency
interruptible
Irker
Istio
+Jaeger
jasmine-jquery
JavaScript
-Jaeger
Jenkins
Jenkinsfile
Jira
@@ -214,6 +215,7 @@ kanbans
Kaniko
Karma
Kerberos
+keyset
Kibana
Kinesis
Knative
@@ -258,14 +260,14 @@ middlewares
migratus
Minikube
MinIO
-mitmproxy
+misconfiguration
+misconfigurations
misconfigure
misconfigured
misconfigures
-misconfiguration
-misconfigurations
misconfiguring
mitigations
+mitmproxy
mixin
mixins
mockup
@@ -282,15 +284,16 @@ namespaces
namespacing
namespacings
Nanoc
+Netlify
NGINX
Nokogiri
npm
Nurtch
OAuth
-Okta
offboarded
offboarding
offboards
+Okta
OmniAuth
onboarding
OpenID
@@ -301,12 +304,12 @@ parallelizations
passwordless
Patroni
performant
+PgBouncer
phaser
phasers
Pipfile
Pipfiles
Piwik
-PgBouncer
plaintext
Poedit
polyfill
@@ -347,12 +350,12 @@ rebase
rebased
rebases
rebasing
-Redcarpet
-Redis
-Redmine
reCAPTCHA
+Redcarpet
redirection
redirections
+Redis
+Redmine
refactorings
referer
referers
@@ -370,21 +373,21 @@ repurposing
requeue
requeued
requeues
-reusability
Restlet
+resync
resynced
resyncing
resyncs
+reusability
+reverified
+reverifies
+reverify
rollout
rollouts
rsync
rsynced
rsyncing
rsyncs
-resync
-reverified
-reverifies
-reverify
Rubix
Rubocop
Rubular
@@ -397,21 +400,22 @@ runtimes
Salesforce
SAML
sandboxing
+sanitization
sbt
scatterplot
scatterplots
+Schemastore
Sendmail
Sentry
+serializer
+serializers
+serializing
serverless
-Sidekiq
-Sisense
sharding
shfmt
Shibboleth
-sanitization
-serializer
-serializers
-serializing
+Sidekiq
+Sisense
Sitespeed
Slack
Slony
@@ -431,7 +435,6 @@ strace
strikethrough
strikethroughs
stunnel
-subpath
subfolder
subfolders
subgraph
@@ -443,14 +446,15 @@ sublicensing
subnet
subnets
subnetting
-subtree
-subtrees
+subpath
subqueried
subqueries
subquery
subquerying
substring
substrings
+subtree
+subtrees
syslog
tcpdump
Tiller
@@ -465,9 +469,9 @@ tooltip
tooltips
Trello
triaging
-TypeScript
Twilio
Twitter
+TypeScript
Ubuntu
unapplied
unarchive
@@ -504,8 +508,8 @@ unoptimizes
unoptimizing
unprioritized
unprotect
-unprotects
unprotected
+unprotects
unpublish
unpublished
unpublishes
@@ -524,6 +528,8 @@ unstage
unstaged
unstages
unstaging
+unstar
+unstars
unstarted
unstash
unstashed
@@ -558,8 +564,8 @@ webserver
whitepaper
whitepapers
wireframe
-wireframes
wireframed
+wireframes
wireframing
Wireshark
Wordpress