Merge pull request #30256 from michelle-purcell/fix-vale-alerts

Reduce Vale linter errors on valid technical terms in Quarkus docs
quarkusio · Jan 10, 2023 · f897508 · f897508
2 parents 4395c18 + 3df79a2
commit f897508
Show file tree

Hide file tree

Showing 10 changed files with 33 additions and 3 deletions.
diff --git a/docs/.vale/fixtures/Quarkus/CaseSensitiveTerms/testinvalid.adoc b/docs/.vale/fixtures/Quarkus/CaseSensitiveTerms/testinvalid.adoc
@@ -26,6 +26,8 @@ CygMon
 CYGMON
 Denial of Service
 Denial-of-Service
+Dev Mode
+Dev mode
 Dev Ops
 Dev-Ops
 devops
@@ -64,6 +66,7 @@ gpl
 Gpl
 Graalvm
 graalVM
+GRPC
 Grub
 gtk
 Gtk
@@ -258,6 +261,7 @@ web-UI
 webUI
 Window-Maker
 WindowMaker
+XDS
 Xemacs
 Xterm
 yaml

diff --git a/docs/.vale/fixtures/Quarkus/CaseSensitiveTerms/testvalid.adoc b/docs/.vale/fixtures/Quarkus/CaseSensitiveTerms/testvalid.adoc
@@ -17,6 +17,7 @@ Cygmon
 denial of service
 denial-of-service
 DevOps
+dev mode
 Disk Druid
 DNS
 DVD writer
@@ -37,6 +38,7 @@ GNU
 GPL
 GraalVM
 Gradle
+gRPC
 GRUB
 GTK+
 Hibernate ORM
@@ -149,7 +151,8 @@ web UI
 WebAuthn
 WebSocket
 Window Maker
+xDS
 XEmacs
 xterm
 YAML
-File extension example.yaml must pass.
+File extension example.yaml must pass.
diff --git a/docs/.vale/fixtures/Quarkus/Headings/testvalid.adoc b/docs/.vale/fixtures/Quarkus/Headings/testvalid.adoc
@@ -10,4 +10,5 @@
 == Proof Key for Code Exchange
 == Kogito updates
 == IBM Cloud is a valid product name
-== Spotify, GraphQL, and Quiltflower are proper nouns so uppercase in headings is OK.
+== Spotify, GraphQL, and Quiltflower are proper nouns so uppercase in headings is OK.
+= Using xDS gRPC
diff --git a/docs/.vale/fixtures/Quarkus/Spelling/testvalid.adoc b/docs/.vale/fixtures/Quarkus/Spelling/testvalid.adoc
@@ -70,13 +70,15 @@ CRDs
 CRs
 CSVs
 Ctrl
+customizer
 Cygmon
 DaemonSet
 Datadog
 declaratively
 decompiler
 deserialization
 Dev
+dev
 devfile
 Devfile
 devfiles
@@ -118,7 +120,9 @@ Findability
 Fortran
 Funqy
 Gbps
+gRPC
 GCC
+getters
 Git
 GitHub
 GitLab
@@ -192,6 +196,7 @@ Matrixes
 Mattermost
 Maven
 Mebibytes
+metamodel
 MicroProfile
 Microsoft
 Middleware
@@ -297,6 +302,7 @@ serializable
 Serializer
 Serverless
 servlet
+setters
 Shadowman
 Sharding
 SLA

diff --git a/docs/.vale/fixtures/Quarkus/TermsErrors/testinvalid.adoc b/docs/.vale/fixtures/Quarkus/TermsErrors/testinvalid.adoc
@@ -114,6 +114,7 @@ desire
 desk top
 desk-top
 destroy
+dev
 different than
 different to
 disk-label
@@ -284,6 +285,7 @@ recognise
 remote-access
 remote-access server
 reoccur
+repo
 right double-click
 right now
 right-hand

diff --git a/docs/.vale/fixtures/Quarkus/TermsErrors/testvalid.adoc b/docs/.vale/fixtures/Quarkus/TermsErrors/testvalid.adoc
@@ -81,6 +81,7 @@ demount
 deselect
 desktop
 despite
+dev mode
 develop components
 different from
 difficulty
@@ -236,6 +237,7 @@ remember
 remote access
 remote access server
 remove
+repository
 required
 retry
 right

diff --git a/docs/.vale/styles/Quarkus/CaseSensitiveTerms.yml b/docs/.vale/styles/Quarkus/CaseSensitiveTerms.yml
@@ -27,6 +27,7 @@ swap:
   CygMon|cygmon|CYGMON: Cygmon
   Denial of Service: denial of service
   Denial-of-Service: denial-of-service
+  Dev mode|Dev Mode: dev mode
   devops|Devops|Dev-Ops|Dev Ops: DevOps
   Dev services|DevServices: Dev Services
   Disk druid|disk druid|diskdruid: Disk Druid
@@ -50,6 +51,7 @@ swap:
   Gpl|gpl: GPL
   gradle: Gradle
   Graalvm|graalVM: GraalVM
+  GRPC|grpc: gRPC
   Grub: GRUB
   GTK|Gtk|gtk: GTK+
   HP Proliant: HP ProLiant
@@ -160,6 +162,7 @@ swap:
   Webauthn|webAuthn|WebAuthN: WebAuthn
   websocket|Websocket: WebSocket
   Window-Maker|WindowMaker: Window Maker
+  XDS|xds: xDS
   Xemacs: XEmacs
   Xterm: xterm
   '(?<!\.)yaml|Yaml': YAML
diff --git a/docs/.vale/styles/Quarkus/Headings.yml b/docs/.vale/styles/Quarkus/Headings.yml
@@ -87,6 +87,7 @@ exceptions:
   - Gradle
   - GraphQL
   - Grayscale
+  - gRPC
   - GTKplus
   - GUI
   - Hashicorp
@@ -218,6 +219,7 @@ exceptions:
   - Window Maker
   - Woopra
   - Wordpress
+  - xDS
   - XEmacs
   - xterm
   - Yana

diff --git a/docs/.vale/styles/Quarkus/Spelling.yml b/docs/.vale/styles/Quarkus/Spelling.yml
@@ -27,9 +27,11 @@ filters:
   - "[cC]lasspath"
   - "[cC]olocate"
   - "[cC]onfig"
+  - "[cC]ustomizer"
   - "[dD]eclaratively"
   - "[dD]ecompiler"
   - "[dD]eserialization"
+  - "[dD]ev"
   - "[dD]ev[wW]orkspace"
   - "[dD]evfile"
   - "[dD]evfiles"
@@ -42,6 +44,7 @@ filters:
   - "[fF]ailover"
   - "[fF]indability"
   - "[gG]bps"
+  - "[gG]etter"
   - "[gG]it"
   - "[gG]rafana"
   - "[hH]ardcoding"
@@ -63,6 +66,7 @@ filters:
   - "[lL]oopback"
   - "[mM]atrixes"
   - "[mM]ebibytes"
+  - "[mM]etamodel"
   - "[mM]iddleware"
   - "[mM]illicores"
   - "[mM]ixin"
@@ -116,6 +120,7 @@ filters:
   - "[sS]erializable"
   - "[sS]erverless"
   - "[sS]ervlet"
+  - "[sS]etter"
   - "[sS]harding"
   - "[sS]ysctl"
   - "[Ss]u"

diff --git a/docs/.vale/styles/Quarkus/TermsErrors.yml b/docs/.vale/styles/Quarkus/TermsErrors.yml
@@ -101,6 +101,7 @@ swap:
   desire|wish: need
   desk top|desk-top: desktop
   destroy: delete from the database
+  dev(?!.mode): "developer' or 'development"
   different than|different to: different from
   disklabel|disk-label: disk label
   dismount: demount|unmount|remove
@@ -229,6 +230,7 @@ swap:
   recognise: recognize
   remote-access server: remote access server
   remote-access: remote access
+  repo: repository
   right double-click: double right-click
   right now: now
   right-hand: right
@@ -288,4 +290,4 @@ swap:
   via: through
   vs: compared to
   wish: want
-  wish|would like: want
+  wish|would like: want