mirror of https://github.com/docker/docs.git
chore: vale styles cleanup
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
This commit is contained in:
parent
a750614b96
commit
1ebdffea52
|
|
@ -5,11 +5,15 @@ level: warning
|
|||
ignorecase: false
|
||||
# Ensures that the existence of 'first' implies the existence of 'second'.
|
||||
first: '\b([A-Z]{3,5})\b'
|
||||
second: '(?:\b[A-Z][a-z]+(?: |\n))+\(([A-Z]{3,5})\)'
|
||||
second: '(?:\b[A-Za-z]+(?: |\n))+\(([A-Z]{3,5})\)'
|
||||
# ... with the exception of these:
|
||||
exceptions:
|
||||
- API
|
||||
- BIOS
|
||||
- FUSE
|
||||
- ARM
|
||||
- ASP
|
||||
- AWS
|
||||
- CLI
|
||||
- CPU
|
||||
- CSS
|
||||
|
|
@ -43,6 +47,7 @@ exceptions:
|
|||
- PATH
|
||||
- PDF
|
||||
- PHP
|
||||
- POSIX
|
||||
- POST
|
||||
- RAM
|
||||
- REPL
|
||||
|
|
@ -62,6 +67,7 @@ exceptions:
|
|||
- URL
|
||||
- USB
|
||||
- UTF
|
||||
- WSL
|
||||
- XML
|
||||
- XSS
|
||||
- YAML
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
extends: existence
|
||||
message: "Consider removing '%s'."
|
||||
ignorecase: true
|
||||
level: warning
|
||||
level: suggestion
|
||||
tokens:
|
||||
- abnormally
|
||||
- absentmindedly
|
||||
|
|
|
|||
|
|
@ -5,3 +5,4 @@ level: warning
|
|||
tokens:
|
||||
- Please
|
||||
- At this time
|
||||
- Currently
|
||||
|
|
|
|||
|
|
@ -3,14 +3,12 @@ message: "Consider using '%s' instead of '%s'."
|
|||
ignorecase: true
|
||||
level: suggestion
|
||||
swap:
|
||||
accelerate: speed up
|
||||
accentuate: stress
|
||||
accompany: go with
|
||||
accomplish: carry out|do
|
||||
accorded: given
|
||||
accordingly: so
|
||||
accrue: add
|
||||
accurate: right|exact
|
||||
acquiesce: agree
|
||||
acquire: get|buy
|
||||
addressees: you
|
||||
|
|
@ -38,13 +36,11 @@ swap:
|
|||
confer: give|award
|
||||
consequently: so
|
||||
consolidate: merge
|
||||
constitutes: forms
|
||||
convene: meet
|
||||
demonstrate: show|prove
|
||||
depart: leave
|
||||
designate: choose
|
||||
desire: want|wish
|
||||
determine: decide|find
|
||||
detrimental: bad|harmful
|
||||
disclose: share|tell
|
||||
discontinue: stop
|
||||
|
|
@ -60,7 +56,6 @@ swap:
|
|||
equivalent: equal
|
||||
exclusively: only
|
||||
expedite: hurry
|
||||
facilitate: ease
|
||||
females: women
|
||||
finalize: complete|finish
|
||||
illustrate: show
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
extends: substitution
|
||||
message: "Consider using '%s' instead of '%s'."
|
||||
level: warning
|
||||
level: suggestion
|
||||
ignorecase: false
|
||||
action:
|
||||
name: replace
|
||||
|
|
|
|||
|
|
@ -3,6 +3,6 @@ message: "Use sentence case for headings: '%s'."
|
|||
level: warning
|
||||
scope: heading
|
||||
match: $sentence
|
||||
exceptions:
|
||||
- Vocab/Docker/accept.txt
|
||||
- Vocab/Technology/accept.txt
|
||||
threshold: 0.4
|
||||
indicators:
|
||||
- ":"
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
extends: existence
|
||||
message: "Use the Oxford comma in '%s'."
|
||||
scope: sentence
|
||||
level: suggestion
|
||||
level: warning
|
||||
nonword: true
|
||||
tokens:
|
||||
- '(?:[^\s,]+,){1,}\s\w+\s(?:and|or)\s\w+[.?!]'
|
||||
|
|
|
|||
|
|
@ -6,9 +6,6 @@ level: suggestion
|
|||
action:
|
||||
name: replace
|
||||
swap:
|
||||
'(?<!Docker)\s Hub': Docker Hub
|
||||
'(?<!Docker)\sScout': Docker Scout
|
||||
k8s: Kubernetes
|
||||
'\b(?:eg|e\.g\.)[\s,]': for example
|
||||
'\b(?:ie|i\.e\.)[\s,]': that is
|
||||
(?:account name|accountname|user name): username
|
||||
|
|
@ -29,27 +26,17 @@ swap:
|
|||
anti-spyware: antispyware
|
||||
anti-virus: antivirus
|
||||
appendixes: appendices
|
||||
assembler: assembly language
|
||||
assembler: assembly
|
||||
below: following
|
||||
check box: checkbox
|
||||
check boxes: checkboxes
|
||||
click: select
|
||||
deselect: clear
|
||||
disable: turn off|toggle off
|
||||
enable: turn on|toggle on
|
||||
ergo: therefore
|
||||
execute: run
|
||||
gb: GB
|
||||
gbps: Gbps
|
||||
kb: KB
|
||||
keypress: keystroke
|
||||
mb: MB
|
||||
mutices: mutexes
|
||||
paas: PaaS
|
||||
pb: PB
|
||||
repo: repository
|
||||
scan: analyze
|
||||
scroll: navigate
|
||||
tb: TB
|
||||
vs: versus
|
||||
wish: want
|
||||
|
|
@ -1,7 +1,10 @@
|
|||
extends: existence
|
||||
message: "'%s' should have one space."
|
||||
level: error
|
||||
scope:
|
||||
- list
|
||||
- heading
|
||||
- paragraph
|
||||
nonword: true
|
||||
tokens:
|
||||
- "[a-z][.?!] {2,}[A-Z]"
|
||||
- "[a-z][.?!][A-Z]"
|
||||
- " {2,}"
|
||||
|
|
|
|||
|
|
@ -1,10 +0,0 @@
|
|||
# Checks for use of bold that doesn't start with a capital letter
|
||||
# which might indicate a reference to something other than a UI label
|
||||
extends: existence
|
||||
message: "Check for correct usage of tab versus view"
|
||||
link: https://docs.docker.com/contribute/recommended-words/
|
||||
level: suggestion
|
||||
ignorecase: true
|
||||
tokens:
|
||||
- tab
|
||||
- view
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
extends: substitution
|
||||
message: "Use '%s' instead of '%s'."
|
||||
ignorecase: true
|
||||
level: error
|
||||
level: warning
|
||||
action:
|
||||
name: replace
|
||||
swap:
|
||||
|
|
|
|||
|
|
@ -0,0 +1,10 @@
|
|||
extends: substitution
|
||||
message: "Use '%s' instead of '%s'"
|
||||
link: https://docs.docker.com/contribute/style/recommended-words/
|
||||
level: error
|
||||
swap:
|
||||
(?:kilobytes?|KB): kB
|
||||
gigabytes?: GB
|
||||
megabyte?: MB
|
||||
petabytes?: PB
|
||||
terrabytes?: TB
|
||||
|
|
@ -1,30 +1,167 @@
|
|||
(Certified|Verified) Publisher( Program)?
|
||||
Docker-Sponsored Open Source
|
||||
A?GPLv3
|
||||
APIs?
|
||||
ARM
|
||||
AWS
|
||||
Amazon
|
||||
Ambassador
|
||||
Anchore
|
||||
Apple
|
||||
Artifactory
|
||||
Autobuild
|
||||
Autotest
|
||||
Azure
|
||||
BuildKit
|
||||
BusyBox
|
||||
CNCF
|
||||
CVEs?
|
||||
CentOS
|
||||
Ceph
|
||||
Chrome
|
||||
Chrome DevTools
|
||||
CloudFront
|
||||
Codefresh
|
||||
CouchDB
|
||||
Couchbase
|
||||
DHCP
|
||||
DNS
|
||||
DSOS
|
||||
DVP
|
||||
Ddosify
|
||||
Dev Environments?
|
||||
Django
|
||||
Docker
|
||||
Dockerize
|
||||
Dockerizing
|
||||
Docker Build Cloud
|
||||
Docker Business
|
||||
Docker Dasboard
|
||||
Docker Desktop
|
||||
Docker Engine
|
||||
Docker Hub
|
||||
Docker Team
|
||||
Docker Extension
|
||||
Docker Hub
|
||||
Docker Scout
|
||||
Docker Team
|
||||
Docker-Sponsored Open Source
|
||||
Dockerfile
|
||||
Dockerize
|
||||
Dockerizing
|
||||
Ethernet
|
||||
Fargate
|
||||
Fedora
|
||||
Flink
|
||||
GPG
|
||||
GPUs?
|
||||
GRUB
|
||||
GeoNetwork
|
||||
Git
|
||||
GitHub( Actions)?
|
||||
Google
|
||||
HTTP
|
||||
HyperKit
|
||||
IPs?
|
||||
IPv[46]
|
||||
IPvlan
|
||||
Intel
|
||||
JFrog
|
||||
JetBrains
|
||||
Kitematic
|
||||
Kubernetes
|
||||
LTS
|
||||
Linux
|
||||
LinuxKit
|
||||
Official Images?
|
||||
Sponsored (OSS|Open Source Software)
|
||||
Swarm
|
||||
Swarm Mode
|
||||
Logstash
|
||||
MAC
|
||||
Mac
|
||||
Mail(chimp|gun)
|
||||
Microsoft
|
||||
MySQL
|
||||
Nginx
|
||||
Nuxeo
|
||||
OAuth
|
||||
OCI
|
||||
Okta
|
||||
Postgres
|
||||
PowerShell
|
||||
Python
|
||||
QEMU
|
||||
RHEL
|
||||
RPM
|
||||
S3
|
||||
SARIF
|
||||
SBOMs?
|
||||
SDKs?
|
||||
SLES
|
||||
SLSA
|
||||
SPDX
|
||||
SQLite
|
||||
SSO
|
||||
Slack
|
||||
Snyk
|
||||
Solr
|
||||
SonarQube
|
||||
Syft
|
||||
Sysdig
|
||||
TCP
|
||||
TLS
|
||||
UDP
|
||||
URLs?
|
||||
Ubuntu
|
||||
Unix
|
||||
VLAN
|
||||
VM
|
||||
VMware
|
||||
WSL
|
||||
Wasm
|
||||
Windows
|
||||
Zsh
|
||||
[Bb]uildx
|
||||
[Cc]ompose
|
||||
[Dd]istros
|
||||
[Ff]ilepaths?
|
||||
[Ff]iletypes?
|
||||
[GgCc]oroutine
|
||||
[Hh]ostname
|
||||
[Ll]oopback
|
||||
[Mm]oby
|
||||
dockerd
|
||||
[Pp]aravirtualization
|
||||
[Pp]roxying
|
||||
[Rr]eal-time
|
||||
[Rr]untimes?
|
||||
[Ss]andbox(ed)?
|
||||
[Ss]wappable
|
||||
[Ss]warm
|
||||
[Vv]irtualize
|
||||
[Ww]alkthrough
|
||||
cgroup
|
||||
config
|
||||
containerd
|
||||
deserialization
|
||||
deserialize
|
||||
dockerignore
|
||||
Docker Hub Vulnerability Scanning
|
||||
Docker Vulnerability Scanning
|
||||
Basic vulnerability scanning
|
||||
firewalld
|
||||
gRPC
|
||||
glibc
|
||||
inotify
|
||||
iptables
|
||||
kubectl
|
||||
kubefwd
|
||||
kubelet
|
||||
lookup
|
||||
macOS
|
||||
macvlan
|
||||
mfsymlinks
|
||||
minikube
|
||||
musl
|
||||
nameserver
|
||||
namespace
|
||||
npm
|
||||
osquery
|
||||
osxfs
|
||||
runc
|
||||
stdin
|
||||
stdout
|
||||
subnet
|
||||
systemd
|
||||
ufw
|
||||
umask
|
||||
ungated
|
||||
vSphere
|
||||
virtiofs
|
||||
|
|
|
|||
|
|
@ -1,139 +0,0 @@
|
|||
AGPLv3
|
||||
APIs?
|
||||
ARM
|
||||
AWS
|
||||
Amazon
|
||||
Ambassador
|
||||
Anchore
|
||||
Apple
|
||||
Artifactory
|
||||
Azure( Blob Storage)?
|
||||
BusyBox
|
||||
CNCF
|
||||
CVEs?
|
||||
CentOS
|
||||
Ceph
|
||||
CloudFront
|
||||
Codefresh
|
||||
CouchDB
|
||||
Couchbase
|
||||
DHCP
|
||||
DNS
|
||||
Ddosify
|
||||
Django
|
||||
Ethernet
|
||||
Fargate
|
||||
Fedora
|
||||
Flink
|
||||
GPG
|
||||
GPLv3
|
||||
GRUB
|
||||
GeoNetwork
|
||||
Git
|
||||
GitHub( Actions)?
|
||||
Google
|
||||
HTTP
|
||||
IPs?
|
||||
IPv[46]
|
||||
IPvlan
|
||||
Intel
|
||||
JFrog
|
||||
JPEG
|
||||
JetBrains
|
||||
Kubernetes
|
||||
LTS
|
||||
Lightstreamer
|
||||
Linux
|
||||
Logstash
|
||||
MAC
|
||||
Mac
|
||||
Mail(chimp|gun)
|
||||
Microsoft
|
||||
MySQL
|
||||
Nginx
|
||||
Nuxeo
|
||||
OAuth
|
||||
OCI
|
||||
Okta
|
||||
PNG
|
||||
Postgres
|
||||
PowerShell
|
||||
Python
|
||||
QEMU
|
||||
RHEL
|
||||
RPM
|
||||
Raspbian
|
||||
S3
|
||||
SARIF
|
||||
SBOMs?
|
||||
SDKs?
|
||||
SLES
|
||||
SLSA
|
||||
SPDX
|
||||
SQLite
|
||||
SSO
|
||||
Slack
|
||||
Snyk
|
||||
Solr
|
||||
SonarQube
|
||||
Syft
|
||||
Sysdig
|
||||
TCP
|
||||
TLS
|
||||
Telepresence
|
||||
Twilio
|
||||
UDP
|
||||
Ubuntu
|
||||
Unix
|
||||
VLAN
|
||||
VM
|
||||
WSL
|
||||
Wasm
|
||||
Windows
|
||||
XWiki
|
||||
Zsh
|
||||
[Ll]oopback
|
||||
[Nn]ameserver
|
||||
[Nn]amespace
|
||||
cgroup
|
||||
config
|
||||
containerd
|
||||
deserialization
|
||||
deserialize
|
||||
filepath
|
||||
filetype
|
||||
firewalld
|
||||
glibc
|
||||
goroutine
|
||||
hostname
|
||||
inotify
|
||||
iptables
|
||||
kubectl
|
||||
kubefwd
|
||||
kubelet
|
||||
lookup
|
||||
macOS
|
||||
macvlan
|
||||
mfsymlinks
|
||||
minikube
|
||||
musl
|
||||
npm
|
||||
osquery
|
||||
osxfs
|
||||
paravirtualization
|
||||
proxying
|
||||
real-time
|
||||
runc
|
||||
runtime
|
||||
sandbox(ed)?
|
||||
stdin
|
||||
stdout
|
||||
subnet
|
||||
swappable
|
||||
systemd
|
||||
ufw
|
||||
umask
|
||||
ungated
|
||||
virtiofs
|
||||
virtualize
|
||||
walkthrough
|
||||
Loading…
Reference in New Issue