From 1ebdffea523df5d7ca1abad2d9bd163ebc6eb1f9 Mon Sep 17 00:00:00 2001
From: David Karlsson <35727626+dvdksn@users.noreply.github.com>
Date: Thu, 15 Feb 2024 14:13:05 +0100
Subject: [PATCH] chore: vale styles cleanup

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
---
 .github/vale/Docker/Acronyms.yml              |   8 +-
 .github/vale/Docker/Adverbs.yml               |   2 +-
 .github/vale/Docker/Avoid.yml                 |   1 +
 .github/vale/Docker/ComplexWords.yml          |   5 -
 .github/vale/Docker/Contractions.yml          |   2 +-
 ...ntenceCase.yml => HeadingSentenceCase.yml} |   6 +-
 .github/vale/Docker/OxfordComma.yml           |   2 +-
 .../{Substitute.yml => RecommendedWords.yml}  |  15 +-
 .github/vale/Docker/Spacing.yml               |   7 +-
 .github/vale/Docker/UIElement.yml             |  10 --
 .github/vale/Docker/URLFormat.yml             |   2 +-
 .github/vale/Docker/Units.yml                 |  10 ++
 .../config/vocabularies/Docker/accept.txt     | 165 ++++++++++++++++--
 .../config/vocabularies/Technology/accept.txt | 139 ---------------
 .vale.ini                                     |   2 +-
 15 files changed, 183 insertions(+), 193 deletions(-)
 rename .github/vale/Docker/{SentenceCase.yml => HeadingSentenceCase.yml} (62%)
 rename .github/vale/Docker/{Substitute.yml => RecommendedWords.yml} (79%)
 delete mode 100644 .github/vale/Docker/UIElement.yml
 create mode 100644 .github/vale/Docker/Units.yml
 delete mode 100644 .github/vale/config/vocabularies/Technology/accept.txt

diff --git a/.github/vale/Docker/Acronyms.yml b/.github/vale/Docker/Acronyms.yml
index 4545ddf1a8..a2054405f6 100644
--- a/.github/vale/Docker/Acronyms.yml
+++ b/.github/vale/Docker/Acronyms.yml
@@ -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
diff --git a/.github/vale/Docker/Adverbs.yml b/.github/vale/Docker/Adverbs.yml
index 753f36cecc..30c5984d80 100644
--- a/.github/vale/Docker/Adverbs.yml
+++ b/.github/vale/Docker/Adverbs.yml
@@ -1,7 +1,7 @@
 extends: existence
 message: "Consider removing '%s'."
 ignorecase: true
-level: warning
+level: suggestion
 tokens:
   - abnormally
   - absentmindedly
diff --git a/.github/vale/Docker/Avoid.yml b/.github/vale/Docker/Avoid.yml
index b648bfffaf..bf4cb5f929 100644
--- a/.github/vale/Docker/Avoid.yml
+++ b/.github/vale/Docker/Avoid.yml
@@ -5,3 +5,4 @@ level: warning
 tokens:
   - Please
   - At this time
+  - Currently
diff --git a/.github/vale/Docker/ComplexWords.yml b/.github/vale/Docker/ComplexWords.yml
index 03af01a343..42934e7e46 100644
--- a/.github/vale/Docker/ComplexWords.yml
+++ b/.github/vale/Docker/ComplexWords.yml
@@ -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
diff --git a/.github/vale/Docker/Contractions.yml b/.github/vale/Docker/Contractions.yml
index 5cb6ad02a3..927ac819e6 100644
--- a/.github/vale/Docker/Contractions.yml
+++ b/.github/vale/Docker/Contractions.yml
@@ -1,6 +1,6 @@
 extends: substitution
 message: "Consider using '%s' instead of '%s'."
-level: warning
+level: suggestion
 ignorecase: false
 action:
   name: replace
diff --git a/.github/vale/Docker/SentenceCase.yml b/.github/vale/Docker/HeadingSentenceCase.yml
similarity index 62%
rename from .github/vale/Docker/SentenceCase.yml
rename to .github/vale/Docker/HeadingSentenceCase.yml
index 17c2b339ed..b5edebee1b 100644
--- a/.github/vale/Docker/SentenceCase.yml
+++ b/.github/vale/Docker/HeadingSentenceCase.yml
@@ -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:
+  - ":"
diff --git a/.github/vale/Docker/OxfordComma.yml b/.github/vale/Docker/OxfordComma.yml
index 1b121ec09e..57124a6e05 100644
--- a/.github/vale/Docker/OxfordComma.yml
+++ b/.github/vale/Docker/OxfordComma.yml
@@ -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+[.?!]'
diff --git a/.github/vale/Docker/Substitute.yml b/.github/vale/Docker/RecommendedWords.yml
similarity index 79%
rename from .github/vale/Docker/Substitute.yml
rename to .github/vale/Docker/RecommendedWords.yml
index dcf8891b4d..35159807cf 100644
--- a/.github/vale/Docker/Substitute.yml
+++ b/.github/vale/Docker/RecommendedWords.yml
@@ -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
diff --git a/.github/vale/Docker/Spacing.yml b/.github/vale/Docker/Spacing.yml
index 81d79e2c10..5c6d52af59 100644
--- a/.github/vale/Docker/Spacing.yml
+++ b/.github/vale/Docker/Spacing.yml
@@ -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,}"
diff --git a/.github/vale/Docker/UIElement.yml b/.github/vale/Docker/UIElement.yml
deleted file mode 100644
index 04d39108c5..0000000000
--- a/.github/vale/Docker/UIElement.yml
+++ /dev/null
@@ -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
\ No newline at end of file
diff --git a/.github/vale/Docker/URLFormat.yml b/.github/vale/Docker/URLFormat.yml
index c81b486c4c..ace679768d 100644
--- a/.github/vale/Docker/URLFormat.yml
+++ b/.github/vale/Docker/URLFormat.yml
@@ -1,7 +1,7 @@
 extends: substitution
 message: "Use '%s' instead of '%s'."
 ignorecase: true
-level: error
+level: warning
 action:
   name: replace
 swap:
diff --git a/.github/vale/Docker/Units.yml b/.github/vale/Docker/Units.yml
new file mode 100644
index 0000000000..5ad058f09c
--- /dev/null
+++ b/.github/vale/Docker/Units.yml
@@ -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
diff --git a/.github/vale/config/vocabularies/Docker/accept.txt b/.github/vale/config/vocabularies/Docker/accept.txt
index 15788d2708..a9dbdd0c0a 100644
--- a/.github/vale/config/vocabularies/Docker/accept.txt
+++ b/.github/vale/config/vocabularies/Docker/accept.txt
@@ -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
\ No newline at end of file
+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
diff --git a/.github/vale/config/vocabularies/Technology/accept.txt b/.github/vale/config/vocabularies/Technology/accept.txt
deleted file mode 100644
index b44beaa9b1..0000000000
--- a/.github/vale/config/vocabularies/Technology/accept.txt
+++ /dev/null
@@ -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
diff --git a/.vale.ini b/.vale.ini
index 8c33cf516b..f88084e158 100644
--- a/.vale.ini
+++ b/.vale.ini
@@ -1,7 +1,7 @@
 StylesPath = .github/vale
 MinAlertLevel = suggestion
 
-Vocab = Docker, Technology
+Vocab = Docker
 
 Packages = Hugo