summaryrefslogtreecommitdiff
path: root/doc/.vale/gitlab
diff options
context:
space:
mode:
Diffstat (limited to 'doc/.vale/gitlab')
-rw-r--r--doc/.vale/gitlab/Acronyms.yml13
-rw-r--r--doc/.vale/gitlab/Admin.yml6
-rw-r--r--doc/.vale/gitlab/SubstitutionSuggestions.yml2
-rw-r--r--doc/.vale/gitlab/Substitutions.yml3
-rw-r--r--doc/.vale/gitlab/spelling-exceptions.txt155
5 files changed, 174 insertions, 5 deletions
diff --git a/doc/.vale/gitlab/Acronyms.yml b/doc/.vale/gitlab/Acronyms.yml
index 481da94c627..f7077413c9e 100644
--- a/doc/.vale/gitlab/Acronyms.yml
+++ b/doc/.vale/gitlab/Acronyms.yml
@@ -27,6 +27,8 @@ exceptions:
- CNA
- CNAME
- CORE
+ - CVS
+ - FREE
- CPU
- CRIME
- CSRF
@@ -41,12 +43,14 @@ exceptions:
- DSA
- DVCS
- ECDSA
+ - EFS
- EKS
- EOL
- EXIF
- FAQ
- FOSS
- FQDN
+ - FREE
- GCP
- GDK
- GDPR
@@ -90,7 +94,6 @@ exceptions:
- NFS
- NGINX
- NOTE
- - NPM
- NTP
- ONLY
- OWASP
@@ -116,11 +119,13 @@ exceptions:
- RSS
- RVM
- SAML
+ - SAAS
- SAST
- SCIM
- SCP
- SCSS
- SDK
+ - SELF
- SEO
- SHA
- SLA
@@ -128,6 +133,7 @@ exceptions:
- SMTP
- SOC
- SOX
+ - SPDX
- SPF
- SQL
- SSD
@@ -138,11 +144,14 @@ exceptions:
- SVG
- SVN
- TCP
+ - TIFF
- TIP
- TLD
- TLS
- TODO
- TOML
+ - TTL
+ - UDP
- UNIX
- URI
- URL
@@ -157,3 +166,5 @@ exceptions:
- XML
- XSS
- YAML
+ - ZAP
+ - ZIP
diff --git a/doc/.vale/gitlab/Admin.yml b/doc/.vale/gitlab/Admin.yml
index 96325ad2ef4..d74621bde8e 100644
--- a/doc/.vale/gitlab/Admin.yml
+++ b/doc/.vale/gitlab/Admin.yml
@@ -5,9 +5,9 @@
#
# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles
extends: substitution
-message: 'Use "administration", "administrator", "administer", or "Admin Area" instead of "admin" or "admin area".'
+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
-level: warning
+level: suggestion
ignorecase: true
swap:
- 'admin ?\w*': '(?:Admin Area|[Aa]dminist(ration|rator|er|rative))'
+ 'admin ?\w*': '(?:Admin Area|[Aa]dminist(ration|rator|rators|er|rative))'
diff --git a/doc/.vale/gitlab/SubstitutionSuggestions.yml b/doc/.vale/gitlab/SubstitutionSuggestions.yml
index ab6658f0943..eac738d9eec 100644
--- a/doc/.vale/gitlab/SubstitutionSuggestions.yml
+++ b/doc/.vale/gitlab/SubstitutionSuggestions.yml
@@ -18,4 +18,6 @@ swap:
once the: '"after the"'
once you: '"after you"'
since: '"because" or "after"'
+ sub-group: '"subgroup"'
+ sub-groups: '"subgroups"'
within: '"in"'
diff --git a/doc/.vale/gitlab/Substitutions.yml b/doc/.vale/gitlab/Substitutions.yml
index 987785c7a22..b31bead3bcd 100644
--- a/doc/.vale/gitlab/Substitutions.yml
+++ b/doc/.vale/gitlab/Substitutions.yml
@@ -11,6 +11,7 @@ link: https://about.gitlab.com/handbook/communication/#top-misused-terms
level: error
ignorecase: true
swap:
+ codequality: code quality
Customer [Pp]ortal: Customers Portal
frontmatter: front matter
GitLabber: GitLab team member
@@ -20,7 +21,7 @@ swap:
param: parameter
params: parameters
pg: PostgreSQL
- postgres: PostgreSQL
+ 'postgres$': PostgreSQL
raketask: Rake task
raketasks: Rake tasks
rspec: RSpec
diff --git a/doc/.vale/gitlab/spelling-exceptions.txt b/doc/.vale/gitlab/spelling-exceptions.txt
index 6ce0ced52b3..375cecfdee4 100644
--- a/doc/.vale/gitlab/spelling-exceptions.txt
+++ b/doc/.vale/gitlab/spelling-exceptions.txt
@@ -1,20 +1,29 @@
+accessor
+accessors
Akismet
Alertmanager
Algolia
Alibaba
+Aliyun
allowlist
+allowlisted
allowlisting
allowlists
+anonymization
anonymized
Ansible
Anthos
approvers
architected
+architecting
+archiver
+Arel
Artifactory
Asana
Asciidoctor
Assembla
Atlassian
+auditability
Auth0
Authentiq
autocomplete
@@ -31,6 +40,7 @@ autoscaler
autoscales
autoscaling
awardable
+awardables
Axios
Azure
B-tree
@@ -52,8 +62,13 @@ blockquoted
blockquotes
blockquoting
boolean
+booleans
Bootsnap
browsable
+bugfix
+bugfixed
+bugfixes
+bugfixing
Bugzilla
Buildkite
buildpack
@@ -62,9 +77,17 @@ bundler
bundlers
burndown
burnup
+burstable
cacheable
+Caddy
+callstack
+callstacks
+Camo
+canonicalized
CentOS
Certbot
+changeset
+changesets
chai
chatbot
chatbots
@@ -86,6 +109,7 @@ Conda
Consul
Contentful
Corosync
+Coursier
cron
crons
crontab
@@ -96,15 +120,22 @@ crosslinks
Crossplane
CrowdIn
CSV
+cybersecurity
Dangerfile
datetime
Debian
+Decompressor
+decryptable
deduplicate
deduplicated
deduplicates
deduplicating
deduplication
deliverables
+denormalize
+denormalized
+denormalizes
+denormalizing
denylist
denylisting
denylists
@@ -118,11 +149,16 @@ dequarantine
dequarantined
dequarantining
DevOps
+disambiguates
discoverability
+dismissable
Disqus
Divio
Dockerfile
Dockerfiles
+Dockerize
+Dockerized
+Dockerizing
dogfood
dogfooding
dogfoods
@@ -135,6 +171,7 @@ Ecto
Elasticsearch
enablement
enqueued
+enqueues
enum
enums
ETag
@@ -145,20 +182,28 @@ failover
failovers
failsafe
Falco
+falsy
fastlane
+Fastzip
favicon
+favorited
Figma
Filebeat
Fio
firewalled
+firewalling
Flawfinder
Flowdock
Fluentd
Forgerock
+formatters
Fugit
+fuzzer
Gantt
Gemnasium
Gemojione
+Getter
+Getters
gettext
Git
Gitaly
@@ -167,9 +212,11 @@ GitHub
GitLab
gitlabsos
Gitleaks
+Gitpod
Gitter
globals
Gmail
+Godep
Gollum
Google
goroutine
@@ -177,17 +224,20 @@ goroutines
Gosec
Gradle
Grafana
+Grafonnet
gravatar
Gzip
Haml
hardcode
hardcoded
hardcodes
+Haswell
heatmap
heatmaps
Helm
Heroku
Herokuish
+Hexo
HipChat
hostname
hostnames
@@ -199,17 +249,22 @@ http
https
idempotence
idmapper
+Iglu
inclusivity
Ingress
initializer
initializers
+innersource
+innersourcing
interdependencies
interdependency
interruptible
Irker
+issuables
Istio
Jaeger
jasmine-jquery
+Javafuzz
JavaScript
Jenkins
Jenkinsfile
@@ -217,6 +272,7 @@ Jira
jq
jQuery
jsdom
+Jsonnet
JupyterHub
kanban
kanbans
@@ -224,8 +280,11 @@ kaniko
Karma
Kerberos
keyset
+keytab
+keytabs
Kibana
Kinesis
+Klar
Knative
Kramdown
Kroki
@@ -233,13 +292,18 @@ Kubecost
kubectl
Kubernetes
Kubesec
+Kustomize
Laravel
ldapsearch
Lefthook
Leiningen
+libFuzzer
Libravatar
liveness
+Lodash
Lograge
+logrotate
+Logrus
Logstash
lookahead
lookaheads
@@ -250,6 +314,7 @@ loopback
Lucene
Maildir
Mailgun
+Mailroom
Makefile
Makefiles
Markdown
@@ -297,9 +362,14 @@ namespaces
namespacing
namespacings
Nanoc
+negatable
Netlify
Nokogiri
+noteable
+noteables
npm
+nullability
+nullable
Nurtch
nyc
OAuth
@@ -312,6 +382,7 @@ onboarding
OpenID
OpenShift
Opsgenie
+Overcommit
Packagist
parallelization
parallelizations
@@ -319,10 +390,12 @@ passwordless
Patroni
performant
PgBouncer
+pgLoader
Phabricator
phaser
phasers
phpenv
+pipenv
Pipfile
Pipfiles
Piwik
@@ -331,6 +404,7 @@ Poedit
polyfill
polyfills
pooler
+postgres.ai
PostgreSQL
precompile
preconfigure
@@ -362,12 +436,22 @@ pseudocode
pseudonymized
pseudonymizer
Puma
+pytest
Python
Qualys
+queryable
+Quicktime
Rackspace
Raspbian
Rdoc
reachability
+Realplayer
+reauthenticate
+reauthenticated
+reauthenticates
+reauthenticating
+rebalancing
+rebar
rebase
rebased
rebases
@@ -383,6 +467,8 @@ referer
referers
reflog
reflogs
+refspec
+refspecs
reindex
reindexed
reindexes
@@ -402,6 +488,10 @@ resync
resynced
resyncing
resyncs
+retarget
+retargeted
+retargeting
+retargets
reusability
reverified
reverifies
@@ -414,10 +504,12 @@ rsync
rsynced
rsyncing
rsyncs
+Rubinius
Rubix
Rubocop
Rubular
ruleset
+rulesets
runbook
runbooks
runit
@@ -430,19 +522,24 @@ sbt
scatterplot
scatterplots
Schemastore
+scrollable
Sendmail
Sentry
serializer
serializers
serializing
serverless
+sharded
sharding
shfmt
Shibboleth
+Shopify
Sidekiq
+Silverlight
Sisense
Sitespeed
Slack
+Slackbot
Slony
smartcard
smartcards
@@ -455,6 +552,9 @@ spidering
Splunk
SpotBugs
Stackdriver
+Stackprof
+starrer
+starrers
storable
storages
strace
@@ -465,6 +565,8 @@ subfolder
subfolders
subgraph
subgraphs
+subgroup
+subgroups
subkey
subkeys
sublicense
@@ -475,22 +577,44 @@ subnet
subnets
subnetting
subpath
+subproject
+subprojects
subqueried
subqueries
subquery
subquerying
substring
substrings
+subtask
+subtasks
+subtest
+subtests
subtree
subtrees
sudo
+supercookie
+supercookies
+supertype
+supertypes
+swappiness
swimlane
swimlanes
+syncable
+Sysbench
+syscall
+syscalls
syslog
tanuki
tcpdump
+templated
Thanos
+Thoughtbot
+throughputs
Tiller
+timebox
+timeboxed
+timeboxes
+timeboxing
timecop
todos
tokenizer
@@ -498,22 +622,33 @@ Tokenizers
tokenizing
toolchain
toolchains
+toolkit
+toolkits
tooltip
tooltips
transpile
+transpiled
transpiles
transpiling
Trello
+triaged
+triages
triaging
+truthy
+Truststore
Twilio
Twitter
TypeScript
Ubuntu
unapplied
+unapprove
+unapproved
+unapproving
unarchive
unarchived
unarchives
unarchiving
+unary
unassign
unassigning
unassigns
@@ -524,6 +659,7 @@ unchecks
uncomment
uncommented
uncommenting
+uncordon
unencode
unencoded
unencoder
@@ -534,6 +670,8 @@ unindexed
unlink
unlinking
unlinks
+unmappable
+unmapped
unmergeable
unmerged
unmerges
@@ -543,9 +681,11 @@ unoptimize
unoptimized
unoptimizes
unoptimizing
+unpatched
unprioritized
unprotect
unprotected
+unprotecting
unprotects
unprovision
unprovisioned
@@ -554,6 +694,7 @@ unpublish
unpublished
unpublishes
unpublishing
+unpushed
unreferenced
unregister
unregistered
@@ -562,8 +703,12 @@ unreplicated
unresolve
unresolved
unresolving
+unsanitized
unschedule
unscoped
+unshare
+unshared
+unshares
unstage
unstaged
unstages
@@ -574,6 +719,7 @@ unstarted
unstash
unstashed
unstashing
+unsynced
untarred
untracked
untrusted
@@ -583,8 +729,12 @@ unverify
unverifying
uploader
uploaders
+upstreams
+upvote
upvoted
upvotes
+URIs
+Vagrantfile
validator
validators
vendored
@@ -601,6 +751,9 @@ WebdriverIO
Webex
webpack
webserver
+Webservice
+websocket
+websockets
whitepaper
whitepapers
wireframe
@@ -611,9 +764,11 @@ Wireshark
Wordpress
worktree
worktrees
+Worldline
Xcode
Xeon
YouTrack
+Yubico
Zeitwerk
Zendesk
zsh