mirror of https://github.com/docker/docs.git
chore: fix/remove broken vale rules
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
This commit is contained in:
David Karlsson
parent
e6301f1ba2
commit
a910fdb6dc
|
|
@ -0,0 +1,8 @@
|
|||
[*.md]
|
||||
# Exclude `{{< ... >}}`, `{{% ... %}}`, [Who]({{< ... >}})
|
||||
TokenIgnores = ({{[%<] .* [%>]}}.*?{{[%<] ?/.* [%>]}}), \
|
||||
(\[.+\]\({{< .+ >}}\))
|
||||
|
||||
# Exclude `{{< myshortcode `This is some <b>HTML</b>, ... >}}`
|
||||
BlockIgnores = (?sm)^({{[%<] [^{]*? [%>]}})\n$, \
|
||||
(?s) *({{< highlight [^>]* ?>}}.*?{{< ?/ ?highlight >}})
|
||||
|
|
@ -3,4 +3,5 @@ message: "Consider removing '%s'."
|
|||
ignorecase: true
|
||||
level: warning
|
||||
tokens:
|
||||
- Please
|
||||
- Please
|
||||
- At this time
|
||||
|
|
|
|||
|
|
@ -1,8 +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: "Only use bold for UI elements."
|
||||
link: https://docs.docker.com/contribute/checklist/
|
||||
level: suggestion
|
||||
scope: strong
|
||||
raw: "^[^A-Z].*"
|
||||
|
|
@ -1,12 +0,0 @@
|
|||
extends: existence
|
||||
message: "Indent nested code blocks by 3 spaces and double-nested code blocks by 5 spaces."
|
||||
link: https://docs.docker.com/contribute/style/formatting/#best-practice-for-commands
|
||||
level: warning
|
||||
scope: raw
|
||||
# check for 1, 2, 4, 6 or more spaces at start of line before code fence (```)
|
||||
# If not indented by 3 spaces at first level or 5 spaces at second level, then a hidden space is inserted and copied by the copy code feature.
|
||||
raw:
|
||||
- '(?m:^[ ]{1}\`\`\`)|'
|
||||
- '(?m:^[ ]{2}\`\`\`)|'
|
||||
- '(?m:^[ ]{4}\`\`\`)|'
|
||||
- '(?m:^[ ]{6,}\`\`\`)'
|
||||
|
|
@ -22,7 +22,7 @@ swap:
|
|||
|
||||
should not: shouldn't
|
||||
|
||||
'that is(?!\.)': that's
|
||||
'that is(?!\.,)': that's
|
||||
'that''s(?=\.)': that is
|
||||
|
||||
'they are(?!\.)': they're
|
||||
|
|
|
|||
|
|
@ -1,8 +0,0 @@
|
|||
extends: existence
|
||||
message: "Avoid using words like '%s', the docs should describe the product as is."
|
||||
link: https://docs.docker.com/contribute/style/recommended-words/
|
||||
level: warning
|
||||
ignorecase: true
|
||||
tokens:
|
||||
- At this time
|
||||
- Currently
|
||||
|
|
@ -2,9 +2,7 @@ extends: existence
|
|||
message: "Avoid generic calls to action: '%s'"
|
||||
link: https://docs.docker.com/contribute/style/formatting/#links
|
||||
level: warning
|
||||
scope: link
|
||||
scope: raw
|
||||
ignorecase: true
|
||||
tokens:
|
||||
- click here
|
||||
- find out more
|
||||
- learn more
|
||||
raw:
|
||||
- \[(click here|(find out|learn) more)\]
|
||||
|
|
|
|||
|
|
@ -1,20 +0,0 @@
|
|||
# This catch-all pattern uses raw which means it
|
||||
# will match in code, too. Kept for reference.
|
||||
#
|
||||
# extends: existence
|
||||
# message: Use italics sparingly.
|
||||
# level: suggestion
|
||||
# scope: raw
|
||||
# raw:
|
||||
# - '[\*_]'
|
||||
# - '.*?'
|
||||
# - '[\*_]'
|
||||
# - '(?=[$\s])'
|
||||
extends: existence
|
||||
message: Use italics sparingly.
|
||||
level: suggestion
|
||||
scope: emphasis
|
||||
tokens:
|
||||
- "[^-]+"
|
||||
# This is strange, but vale would match front matter section
|
||||
# as italics if I just used a .* pattern
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
extends: occurrence
|
||||
message: "Try to keep link text short (< 5 words)."
|
||||
scope: link
|
||||
link: https://docs.docker.com/contribute/style/formatting/#links
|
||||
level: suggestion
|
||||
max: 5
|
||||
token: \b(\w+)\b
|
||||
|
|
@ -1,8 +0,0 @@
|
|||
extends: existence
|
||||
message: "Don't use end punctuation in links."
|
||||
link: https://docs.docker.com/contribute/style/formatting/#links
|
||||
nonword: true
|
||||
level: warning
|
||||
scope: link
|
||||
tokens:
|
||||
- '[a-z0-9][.?!](?:\s|$)'
|
||||
|
|
@ -4,4 +4,4 @@ scope: sentence
|
|||
level: suggestion
|
||||
nonword: true
|
||||
tokens:
|
||||
- '(?:[^\s,]+,){1,} \w+ (?:and|or) \w+[.?!]'
|
||||
- '(?:[^\s,]+,){1,}\s\w+\s(?:and|or)\s\w+[.?!]'
|
||||
|
|
|
|||
|
|
@ -6,4 +6,3 @@ match: $sentence
|
|||
exceptions:
|
||||
- Vocab/Docker/accept.txt
|
||||
- Vocab/Technology/accept.txt
|
||||
- Vocab/Industry/accept.txt
|
||||
|
|
|
|||
|
|
@ -6,11 +6,19 @@ 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
|
||||
(?:drop down|dropdown): drop-down
|
||||
(?:log out|logout): sign out
|
||||
(?:sign on|log on|log in|logon|login): sign in
|
||||
above: previous
|
||||
adaptor: adapter
|
||||
(?:account name|accountname|user name): username
|
||||
administrate: administer
|
||||
admin: administrator
|
||||
administrate: administer
|
||||
afterwards: afterward
|
||||
allow: let
|
||||
allows: lets
|
||||
|
|
@ -28,24 +36,20 @@ swap:
|
|||
click: select
|
||||
deselect: clear
|
||||
disable: turn off|toggle off
|
||||
(?:drop down|dropdown): drop-down
|
||||
'\b(?:eg|e\.g\.)[\s,]': for example
|
||||
enable: turn on|toggle on
|
||||
ergo: therefore
|
||||
execute: run
|
||||
gb: GB
|
||||
gbps: Gbps
|
||||
'\b(?:ie|i\.e\.)[\s,]': that is
|
||||
kb: KB
|
||||
keypress: keystroke
|
||||
(?:log out|logout): sign out
|
||||
mb: MB
|
||||
mutices: mutexes
|
||||
paas: PaaS
|
||||
pb: PB
|
||||
repo: repository
|
||||
scan: analyze
|
||||
scroll: navigate
|
||||
(?:sign on|log on|log in|logon|login): sign in
|
||||
tb: TB
|
||||
vs: versus
|
||||
wish: want
|
||||
|
|
|
|||
|
|
@ -1,12 +0,0 @@
|
|||
extends: substitution
|
||||
message: "Consider using '%s' instead of '%s'"
|
||||
link: https://docs.docker.com/contribute/style/terminology/
|
||||
level: suggestion
|
||||
action:
|
||||
name: replace
|
||||
swap:
|
||||
'(?<!Docker )[Hh]ub': Docker Hub
|
||||
'(?<!Docker )[Ss]cout': Docker Scout
|
||||
scan: analyze
|
||||
Scan: Analyze
|
||||
'[Kk]8[Ss]': Kubernetes
|
||||
|
|
@ -1,74 +0,0 @@
|
|||
ARM
|
||||
AWS
|
||||
Amazon
|
||||
Ambassador
|
||||
Anchore
|
||||
Apple
|
||||
Artifactory
|
||||
Azure( Blob Storage)?
|
||||
BusyBox
|
||||
CentOS
|
||||
Ceph
|
||||
CloudFront
|
||||
CNCF
|
||||
Codefresh
|
||||
CouchDB
|
||||
Couchbase
|
||||
Ddosify
|
||||
Django
|
||||
Fargate
|
||||
Fedora
|
||||
Flink
|
||||
Gefyra
|
||||
GeoNetwork
|
||||
GitHub( Actions)?
|
||||
Google
|
||||
Intel
|
||||
JFrog
|
||||
JetBrains
|
||||
Kubernetes
|
||||
LTS
|
||||
Lightstreamer
|
||||
Linux
|
||||
Logstash
|
||||
Mac
|
||||
Mail(chimp|gun)
|
||||
Microsoft
|
||||
MySQL
|
||||
Nginx
|
||||
Nuxeo
|
||||
OAuth
|
||||
OCI
|
||||
Okta
|
||||
Postgres
|
||||
PowerShell
|
||||
Python
|
||||
QEMU
|
||||
RHEL
|
||||
Raspbian
|
||||
S3
|
||||
SBOMs?
|
||||
SLES
|
||||
SLSA
|
||||
SPDX
|
||||
SQLite
|
||||
Slack
|
||||
Snyk
|
||||
Solr
|
||||
SonarQube
|
||||
Syft
|
||||
Telepresence
|
||||
TLS
|
||||
Twilio
|
||||
Ubuntu
|
||||
WSL
|
||||
Wasm
|
||||
Windows
|
||||
XWiki
|
||||
Zsh
|
||||
kubefwd
|
||||
ktunnel
|
||||
macOS
|
||||
minikube
|
||||
sandbox
|
||||
sandboxed
|
||||
|
|
@ -1,27 +1,94 @@
|
|||
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
|
||||
GRUB
|
||||
GeoNetwork
|
||||
Git
|
||||
GitHub( Actions)?
|
||||
Google
|
||||
HTTP
|
||||
IPs?
|
||||
IPv[46]
|
||||
IPvlan
|
||||
Intel
|
||||
JFrog
|
||||
JPEG
|
||||
JetBrains
|
||||
Kubernetes
|
||||
LTS
|
||||
Lightstreamer
|
||||
Linux
|
||||
Logstash
|
||||
MAC
|
||||
RPM
|
||||
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
|
||||
TCP
|
||||
TLS
|
||||
Telepresence
|
||||
Twilio
|
||||
UDP
|
||||
Ubuntu
|
||||
Unix
|
||||
VLAN
|
||||
VM
|
||||
WSL
|
||||
Wasm
|
||||
Windows
|
||||
XWiki
|
||||
Zsh
|
||||
[Ll]oopback
|
||||
[Nn]ameserver
|
||||
[Nn]amespace
|
||||
|
|
@ -31,18 +98,21 @@ containerd
|
|||
deserialization
|
||||
deserialize
|
||||
filepath
|
||||
firewalld
|
||||
filetype
|
||||
firewalld
|
||||
glibc
|
||||
goroutine
|
||||
hostname
|
||||
inotify
|
||||
iptables
|
||||
kubectl
|
||||
kubefwd
|
||||
kubelet
|
||||
lookup
|
||||
macOS
|
||||
macvlan
|
||||
mfsymlinks
|
||||
minikube
|
||||
musl
|
||||
osquery
|
||||
osxfs
|
||||
|
|
@ -51,6 +121,7 @@ proxying
|
|||
real-time
|
||||
runc
|
||||
runtime
|
||||
sandbox(ed)?
|
||||
stdin
|
||||
stdout
|
||||
subnet
|
||||
|
|
|
|||
Loading…
Reference in New Issue