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>2020-05-20 17:34:42 +0300
committerGitLab Bot <gitlab-bot@gitlab.com>2020-05-20 17:34:42 +0300
commit9f46488805e86b1bc341ea1620b866016c2ce5ed (patch)
treef9748c7e287041e37d6da49e0a29c9511dc34768 /doc/.vale
parentdfc92d081ea0332d69c8aca2f0e745cb48ae5e6d (diff)
Add latest changes from gitlab-org/gitlab@13-0-stable-ee
Diffstat (limited to 'doc/.vale')
-rw-r--r--doc/.vale/gitlab/BadgeCapitalization.yml42
-rw-r--r--doc/.vale/gitlab/British.yml106
-rw-r--r--doc/.vale/gitlab/Contractions.yml2
-rw-r--r--doc/.vale/gitlab/Profanity.yml30
-rw-r--r--doc/.vale/gitlab/ReferenceLinks.yml10
-rw-r--r--doc/.vale/gitlab/SubstitutionWarning.yml16
-rw-r--r--doc/.vale/gitlab/Substitutions.yml9
-rw-r--r--doc/.vale/gitlab/spelling-exceptions.txt44
8 files changed, 257 insertions, 2 deletions
diff --git a/doc/.vale/gitlab/BadgeCapitalization.yml b/doc/.vale/gitlab/BadgeCapitalization.yml
new file mode 100644
index 00000000000..7e68a06b4d5
--- /dev/null
+++ b/doc/.vale/gitlab/BadgeCapitalization.yml
@@ -0,0 +1,42 @@
+---
+# Verifies that badges are not lower case, which won't render properly.
+#
+# For a list of all options, see https://errata-ai.github.io/vale/styles/
+extends: existence
+message: 'Badge "%s" must be capitalized.'
+link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#product-badges
+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\)\*\*)'
diff --git a/doc/.vale/gitlab/British.yml b/doc/.vale/gitlab/British.yml
new file mode 100644
index 00000000000..943e85beba1
--- /dev/null
+++ b/doc/.vale/gitlab/British.yml
@@ -0,0 +1,106 @@
+---
+# Checks for use of some of the top misused terms at GitLab.
+#
+# For a list of all options, see https://errata-ai.github.io/vale/styles/
+extends: substitution
+message: 'Use the American spelling "%s" instead of the British "%s".'
+link: https://about.gitlab.com/handbook/communication/#top-misused-terms
+level: error
+ignorecase: true
+swap:
+ aeon: eon
+ aeroplane: airplane
+ ageing: aging
+ aluminium: aluminum
+ anaemia: anemia
+ anaesthesia: anesthesia
+ analyse: analyze
+ annexe: annex
+ apologise: apologize
+ behaviour: behavior
+ busses: buses
+ calibre: caliber
+ centre: center
+ cheque: check
+ civilisation: civilization
+ civilise: civilize
+ colour: color
+ cosy: cozy
+ cypher: cipher
+ dependant: dependent
+ defence: defense
+ distil: distill
+ draught: draft
+ encyclopaedia: encyclopedia
+ enquiry: inquiry
+ enrol: enroll
+ enrolment: enrollment
+ enthral: enthrall
+ # equalled: equaled // Under discussion
+ # equalling: equaling // Under discussion
+ favourite: favorite
+ fibre: fiber
+ fillet: filet
+ flavour: flavor
+ furore: furor
+ fulfil: fulfill
+ gaol: jail
+ grey: gray
+ humour: humor
+ honour: honor
+ initialled: initialed
+ initialling: initialing
+ instil: instill
+ jewellery: jewelry
+ labelling: labeling
+ labelled: labeled
+ labour: labor
+ libellous: libelous
+ licence: license
+ likeable: likable
+ liveable: livable
+ lustre: luster
+ manoeuvre: maneuver
+ marvellous: marvelous
+ matt: matte
+ meagre: meager
+ metre: meter
+ mitre: miter
+ modelling: modeling
+ moustache: mustache
+ neighbour: neighbor
+ normalise: normalize
+ offence: offense
+ organise: organize
+ orientated: oriented
+ paralyse: paralyze
+ plough: plow
+ pretence: pretense
+ programme: program
+ pyjamas: pajamas
+ rateable: ratable
+ realise: realize
+ recognise: recognize
+ reconnoitre: reconnoiter
+ rumour: rumor
+ sabre: saber
+ saleable: salable
+ saltpetre: saltpeter
+ sceptic: skeptic
+ sepulchre: sepulcher
+ signalling: signaling
+ sizeable: sizable
+ skilful: skillful
+ sombre: somber
+ smoulder: smolder
+ speciality: specialty
+ spectre: specter
+ splendour: splendor
+ sulphur: sulfur
+ theatre: theater
+ travelled: traveled
+ traveller: traveler
+ travelling: traveling
+ unshakeable: unshakable
+ wilful: willful
+ yoghurt: yogurt
diff --git a/doc/.vale/gitlab/Contractions.yml b/doc/.vale/gitlab/Contractions.yml
index 5f389bd1ea4..f4ec24742da 100644
--- a/doc/.vale/gitlab/Contractions.yml
+++ b/doc/.vale/gitlab/Contractions.yml
@@ -3,7 +3,7 @@
#
# For a list of all options, see https://errata-ai.github.io/vale/styles/
extends: substitution
-message: Use "%s" instead of "%s" in most cases.
+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
diff --git a/doc/.vale/gitlab/Profanity.yml b/doc/.vale/gitlab/Profanity.yml
new file mode 100644
index 00000000000..c386b23e52c
--- /dev/null
+++ b/doc/.vale/gitlab/Profanity.yml
@@ -0,0 +1,30 @@
+---
+extends: existence
+message: "Remove profanity: '%s'"
+ignorecase: true
+level: error
+tokens:
+ - 'arse(hole)?'
+ - 'ass(hole)?'
+ - 'bastard'
+ - 'bitch'
+ - 'bloody'
+ - 'bollocks'
+ - 'bugger'
+ - 'cocksucker'
+ - 'crap'
+ - 'cunt'
+ - 'damn'
+ - 'eff(ing)?'
+ - 'fart'
+ - 'fuck(er|ing)?'
+ - 'goddamn(it?|ed)'
+ - 'hell'
+ - 'horseshit'
+ - 'motherfuck(ers?|ing)'
+ - 'piss(ing)?'
+ - 'shit'
+ - 'tits'
+ - 'turd'
+ - 'twat'
+ - 'wank(er|ing)?'
diff --git a/doc/.vale/gitlab/ReferenceLinks.yml b/doc/.vale/gitlab/ReferenceLinks.yml
new file mode 100644
index 00000000000..35a657710de
--- /dev/null
+++ b/doc/.vale/gitlab/ReferenceLinks.yml
@@ -0,0 +1,10 @@
+# Checks for the presence of reference-style links that must be inline.
+#
+# For a list of all options, see https://errata-ai.github.io/vale/styles/
+extends: existence
+message: 'Link "%s" must be inline.'
+link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#basic-link-criteria
+level: error
+scope: raw
+raw:
+ - '\n\[.*\]: .*'
diff --git a/doc/.vale/gitlab/SubstitutionWarning.yml b/doc/.vale/gitlab/SubstitutionWarning.yml
new file mode 100644
index 00000000000..fe690d708ed
--- /dev/null
+++ b/doc/.vale/gitlab/SubstitutionWarning.yml
@@ -0,0 +1,16 @@
+---
+# Warns against using common shorthand for terms.
+# For substitutions flagged as errors, see Substitutions.yml
+#
+# For a list of all options, see https://errata-ai.github.io/vale/styles/
+extends: substitution
+message: 'If possible, use "%s" instead of "%s".'
+link: https://about.gitlab.com/handbook/communication/#top-misused-terms
+level: warning
+ignorecase: true
+swap:
+ admin: administrator
+ config: configuration
+ distro: distribution
+ info: information
+ repo: repository
diff --git a/doc/.vale/gitlab/Substitutions.yml b/doc/.vale/gitlab/Substitutions.yml
index 44b96d1a5e3..b9c0dbecf31 100644
--- a/doc/.vale/gitlab/Substitutions.yml
+++ b/doc/.vale/gitlab/Substitutions.yml
@@ -1,5 +1,6 @@
---
# Checks for use of some of the top misused terms at GitLab.
+# For substitutions only flagged as warnings, see SubstitutionWarning.yml
#
# For a list of all options, see https://errata-ai.github.io/vale/styles/
extends: substitution
@@ -9,8 +10,16 @@ level: error
ignorecase: true
swap:
GitLabber: GitLab team member
+ gitlab omnibus: Omnibus GitLab
param: parameter
params: parameters
+ pg: PostgreSQL
postgres: PostgreSQL
+ raketask: Rake task
+ raketasks: Rake tasks
+ rspec: RSpec
self hosted: self-managed
self-hosted: self-managed
+ styleguide: style guide
+ x509: X.509
+ yaml: YAML
diff --git a/doc/.vale/gitlab/spelling-exceptions.txt b/doc/.vale/gitlab/spelling-exceptions.txt
index 3451219c267..c5e89f72043 100644
--- a/doc/.vale/gitlab/spelling-exceptions.txt
+++ b/doc/.vale/gitlab/spelling-exceptions.txt
@@ -55,6 +55,7 @@ CentOS
Chatops
Citrix
Cloudwatch
+Cobertura
Cognito
colocated
colocating
@@ -85,9 +86,11 @@ discoverability
Disqus
Dockerfile
Dockerfiles
+dotenv
downvoted
downvotes
Dpl
+Dreamweaver
Elasticsearch
enablement
enqueued
@@ -98,6 +101,7 @@ failovers
failsafe
favicon
firewalled
+Flawfinder
Flowdock
Fluentd
Forgerock
@@ -109,15 +113,20 @@ Gitea
GitHub
GitLab
gitlabsos
+Gitleaks
Gitter
Gmail
Google
+Gosec
Gradle
Grafana
gravatar
+Gzip
hardcode
hardcoded
hardcodes
+heatmap
+heatmaps
Helm
Heroku
Herokuish
@@ -130,11 +139,13 @@ hotfixes
hotfixing
http
https
+idempotence
Ingress
initializer
initializers
interdependencies
interdependency
+interruptible
Irker
Istio
jasmine-jquery
@@ -152,6 +163,7 @@ Kibana
Knative
Kramdown
Kubernetes
+Kubesec
Laravel
LDAP
Libravatar
@@ -173,6 +185,7 @@ mergeable
Microsoft
middleware
middlewares
+Minikube
MinIO
mitmproxy
misconfigure
@@ -192,6 +205,8 @@ namespaced
namespaces
Nanoc
NGINX
+npm
+Nurtch
OAuth
Okta
offboarded
@@ -204,10 +219,13 @@ Packagist
parallelization
parallelizations
performant
+Pipfile
+Pipfiles
Piwik
PgBouncer
plaintext
PostgreSQL
+precompile
preconfigure
preconfigured
preconfigures
@@ -232,10 +250,12 @@ Qualys
Rackspace
Raketask
Raketasks
+reachability
rebase
rebased
rebases
rebasing
+Redcarpet
Redis
Redmine
reCAPTCHA
@@ -246,6 +266,7 @@ reindexed
reindexes
reindexing
relicensing
+remediations
Repmgr
Repmgrd
requeue
@@ -265,6 +286,7 @@ resync
reverified
reverifies
reverify
+Rubix
runbook
runbooks
runit
@@ -272,26 +294,36 @@ runtime
runtimes
Salesforce
SAML
+sbt
Sendmail
Sentry
serverless
Sidekiq
sharding
+shfmt
Shibboleth
sanitization
serializer
serializers
serializing
+Sitespeed
Slack
Slony
SMTP
-Sourcegraph
+Sobelow
+spidering
Splunk
+SpotBugs
SSH
storable
strace
+strikethrough
+strikethroughs
+subpath
subfolder
subfolders
+subgraph
+subgraphs
sublicense
sublicensed
sublicenses
@@ -305,6 +337,8 @@ subqueried
subqueries
subquery
subquerying
+substring
+substrings
syslog
Tiller
todos
@@ -331,6 +365,7 @@ unchecking
unchecks
uncomment
uncommented
+uncommenting
unencode
unencoded
unencoder
@@ -349,20 +384,27 @@ unoptimize
unoptimized
unoptimizes
unoptimizing
+unprioritized
unprotect
unprotects
unprotected
unpublish
unpublished
unpublishes
+unpublishing
unreferenced
unresolve
unresolved
unresolving
+unschedule
unstage
unstaged
unstages
unstaging
+unstash
+unstashed
+unstashing
+untarred
untracked
untrusted
unverified