Merge pull request #35092 from michelle-purcell/july-vale-rule-tweaks

Quarkus rules for the Vale linter: Fix false positive messages and enhance regular expression of some rules

docs/.vale/fixtures/Quarkus/CaseSensitiveTerms/testinvalid.adoc

@@ -88,6 +88,7 @@ IPSec
 iSeries
 iso
 iso image
+Istio Service Mesh
 Itanium2
 JBoss.org
 jetbrains

docs/.vale/fixtures/Quarkus/CaseSensitiveTerms/testvalid.adoc

@@ -26,6 +26,7 @@ Exif
 FAQ
 Fedora™ Project
 Fortran
+Fluentd
 FQDN
 GB
 Gbps
@@ -38,6 +39,7 @@ GNU
 GPL
 GraalVM
 Gradle
+Graylog
 gRPC
 GRUB
 GTK+
@@ -60,9 +62,11 @@ IPsec
 ISeries
 ISO
 ISO image
+Istio service mesh
 Itanium
 Itanium 2
 JBoss Community
+JBoss Logging
 JetBrains
 JUnit
 JVM
@@ -72,6 +76,7 @@ Kickstart
 KVM
 LAN
 Linux
+Logstash
 Mandrel
 MicroProfile
 Microsoft

docs/.vale/fixtures/Quarkus/Headings/testvalid.adoc

@@ -11,4 +11,8 @@
 == Kogito updates
 == IBM Cloud is a valid product name
 == Spotify, GraphQL, and Quiltflower are proper nouns so uppercase in headings is OK.
-= Using xDS gRPC
+== Use xDS gRPC
+== Use JBoss Logging for application logging
+== JBoss Logging API
+== A heading about Graylog, Logstash, or Fluentd open-source software
+== About the Istio service mesh

docs/.vale/fixtures/Quarkus/Spelling/testvalid.adoc

@@ -72,11 +72,14 @@ CSVs
 Ctrl
 customizer
 Cygmon
+datasource
+datasources
 DaemonSet
 Datadog
 declaratively
 decompiler
 deserialization
+deserialized
 Dev
 dev
 devfile
@@ -117,9 +120,11 @@ Failsafe
 Fernflower
 findability
 Findability
+Fluentd
 Fortran
 Funqy
 Gbps
+Graylog
 gRPC
 GCC
 getters
@@ -154,6 +159,7 @@ Infinispan
 Inode
 Intelephense
 IntelliJ
+Istio
 Itanium
 Item
 Jakarta
@@ -189,6 +195,7 @@ libvirt
 Libvirt
 Licensor
 Liveness
+Logstash
 Lombok
 Loopback
 Makefile
@@ -241,6 +248,7 @@ OpenShift
 OpenTracing
 Operator
 osd
+OTel
 overridable
 PHP
 Podman
@@ -330,6 +338,8 @@ Subusers
 Subvolume
 Subvolumes
 Suchow
+Syslog
+syslog
 Symfony
 SVG
 Systemd

docs/.vale/styles/Quarkus/CaseSensitiveTerms.yml

@@ -9,17 +9,26 @@ action:
   name: replace
 swap:
   "(?<!/)var": VAR
-  # Bind: BIND
+  "(?<!Business )Resource Planner|(?<!Business Resource )Planner": Business Resource Planner
+  "(?<!Microsoft )Azure": Microsoft Azure
+  "(?<!Microsoft Azure )On-Demand Marketplace": Microsoft Azure On-Demand Marketplace
+  "(?<!Red Hat )Customer Portal": Red Hat Customer Portal
+  "(?<!Red Hat )JBoss Enterprise Application Platform": Red Hat JBoss Enterprise Application Platform
+  "(?<!Red Hat )OpenStack Platform|RHOS|RH-OSP": Red Hat OpenStack Platform
+  "(?<!Red Hat JBoss )BRMS(?! engine)": inference engine
+  "(?<!Red Hat JBoss )BRMS|BRM|(?<!Red Hat )JBoss BRMS": Red Hat JBoss BRMS
+  "[dD]ay-0|day 0": Day 0
+  "[dD]ay-1|day 1": Day 1
+  "[dD]ay-2|day 2": Day 2
+  "BPMS|(?<!Red Hat )JBoss BPMS|(?<!Red Hat JBoss )BPM(?! Suite)": Red Hat JBoss BPM Suite
+  "DM(?![ -]Multipath)|directory manager": Directory Manager
+  "JBoss Broker|Red Hat Broker|The AMQ Broker": AMQ Broker
+  "JBoss Console|Red Hat Console": AMQ Console
+  "Kernel(?!-based Virtual Machine)": kernel
+  "OCM|(?<!Red Hat OpenShift )Cluster Manager|(?<!Red Hat )OpenShift Cluster Manager|the OpenShift Cluster Manager": Red Hat OpenShift Cluster Manager
+  "OD": Red Hat OpenShift Dedicated
   '(?<!\.)yaml|Yaml': YAML
-  '(?<!Business )Resource Planner|(?<!Business Resource )Planner': Business Resource Planner
-  '(?<!JBoss )EAP|(?<!Red Hat )JBoss(?!\sCommunity|\sBroker|\sClients|\sConsole|\sAMQ|\sData\sGrid|\sBRMS|\sBPMS|\sEnterprise\sApplication\sPlatform|\.org|\sInterconnect|\sEAP|\sBPM\sSuite)': JBoss EAP
-  '(?<!Microsoft Azure )On-Demand Marketplace': Microsoft Azure On-Demand Marketplace
   '(?<!Realtime )Decision\sServer': Realtime Decision Server
-  '(?<!Red Hat )Customer Portal': Red Hat Customer Portal
-  '(?<!Red Hat )JBoss Enterprise Application Platform': Red Hat JBoss Enterprise Application Platform
-  '(?<!Red Hat )OpenStack Platform|RHOS|RH-OSP': Red Hat OpenStack Platform
-  '(?<!Red Hat JBoss )BRMS(?! engine)': inference engine
-  '(?<!Red Hat JBoss )BRMS|BRM|(?<!Red Hat )JBoss BRMS': Red Hat JBoss BRMS
   '[nN]odejs|[nN]ode\.JS|node\.js': Node.js
   '\s\.Net Core|\s\.Net|\s\.NET\sCore|dotNet': .NET
   'A-MQ(?!\sBroker|\sClient|\sConsole|\sInterconnect)': AMQ
@@ -30,20 +39,14 @@ swap:
   'ack\spacket|ACK(?!\sflag)|ack': ACK flag
   'ActiveMQ\sArtemis|ActiveMQ(?!\sArtemis)': built-in messaging|JBoss EAP built-in messaging|JBoss EAP messaging
   'Admin\sPortal|webadmin\sportal|webadmin|Administrator\sPortal|Administration\sportal': Administration Portal
-  'BPMS|(?<!Red Hat )JBoss BPMS|(?<!Red Hat JBoss )BPM(?! Suite)': Red Hat JBoss BPM Suite
   'BRMS\sengine': inference engine
   'GUI\seditor|Business\sCentral\seditor': guided editor
-  'JBoss Broker|Red Hat Broker|The AMQ Broker': AMQ Broker
-  'JBoss Console|Red Hat Console': AMQ Console
   'JBoss\.org': JBoss Community
   'JBoss\sAMQ': AMQ
   'JBoss\sInterconnect': AMQ Interconnect
-  'Kernel(?!-based Virtual Machine)': kernel
   'Kie(?!\sServer)': KIE
   'Kie\sServer': Intelligent Process Server
   'O\.K\.D|okd|OpenShift Kubernetes Distribution|OpenShift\sOrigin': OKD
-  'OCM|(?<!Red Hat OpenShift )Cluster Manager|(?<!Red Hat )OpenShift Cluster Manager|the OpenShift Cluster Manager': Red Hat OpenShift Cluster Manager
-  'OD': Red Hat OpenShift Dedicated
   'Red\sHat\sInterconnect': AMQ Interconnect
   'Red\sHat\sVirtualization\sHypervisor|RHV\sHost|RHV-H': Red Hat Virtualization Host
   'RHVM|RHV-M|RHV\sManager': Red Hat Virtualization Manager
@@ -116,7 +119,6 @@ swap:
   Fqdn|fqdn: FQDN
   gb|Gb: GB
   gbps|GBPS: Gbps
-  gb|Gb: GB
   GDBTK: Insight
   gid|Gid: GID
   Gimp|gimp: GIMP
@@ -139,6 +141,8 @@ swap:
   IBM z Systems: IBM Z
   Ignite|Fuse Ignite: Fuse Online|Red Hat Fuse Online|Syndesis
   ignition config: Ignition config
+  Image Builder: image builder
+  Istio Service Mesh : Istio service mesh
   INSTALL_DIR|installDir: FUSE_HOME
   Iops|IOPs: IOPS
   Ip: IP
@@ -194,13 +198,14 @@ swap:
   OCP: Red Hat OpenShift Container Platform
   ODF: Red Hat OpenShift Data Foundation
   Open InfiniBand|Infiniband: InfiniBand
-  openid connect|Openid Connect: OpenID Connect
-  Open InfiniBand|Infiniband: InfiniBand
   Open JDK|openjdk|JDK: OpenJDK
+  openid connect|Openid Connect: OpenID Connect
+  openrewrite|Openrewrite|Open Rewrite: OpenRewrite
   Openshift online|OO: Red Hat OpenShift Online
   Operating Environment: operating environment
   Operator Hub|Operator hub|Operatorhub|operatorhub: OperatorHub
   Opex|Opex|OPEX|opEx: OpEx
+  ORAN: O-RAN
   Organization administrator|Org Admin|org admin: Organization Administrator
   OS|Operating System: operating system
   Overcloud: overcloud
@@ -229,7 +234,6 @@ swap:
   Ram|ram: RAM
   RAW: raw
   Red Hat JBoss Data Grid|JDG: Red Hat Data Grid
-  Red Hat JBoss EAP: Red Hat JBoss Enterprise Application Platform
   Red Hat Network Satellite server: Red Hat Network Satellite Server
   Red Hat Proxy: Red Hat Network Proxy Server
   Red Hat Satellite Capsule server: Red Hat Satellite Capsule Server

docs/.vale/styles/Quarkus/Ellipses.yml

@@ -1,7 +1,7 @@
 ---
 extends: existence
 level: suggestion
-link: https://developers.google.com/style/ellipses?hl=en
+link: https://github.com/quarkusio/quarkus/blob/main/docs/src/main/asciidoc/doc-reference.adoc
 message: "Avoid the ellipsis (...) except to indicate omitted words. Insert a space before and after an ellipsis."
 nonword: true
 # source: Quarkus contributor guide

docs/.vale/styles/Quarkus/Headings.yml

@@ -24,6 +24,7 @@ exceptions:
   - Azure
   - Basic authentication
   - Basic HTTP authentication
+  - BOM
   - Bierner
   - Bitbucket
   - BOM
@@ -82,8 +83,10 @@ exceptions:
   - Flathub
   - Flatpak
   - Flatpak Builder
+  - Fluentd
   - Fortran
   - Funqy
+  - gRPC
   - GCC
   - GTKplus
   - GUI
@@ -96,6 +99,7 @@ exceptions:
   - GraalVM
   - Gradle
   - GraphQL
+  - Graylog
   - Grayscale
   - GTK
   - HTTP
@@ -117,14 +121,18 @@ exceptions:
   - Infinispan
   - Intelephense
   - IntelliJ
+  - Istio
   - Itanium
   - JAR file
+  - JBang
   - JUnit
   - JVM
   - Jakarta
   - Jandex
   - Java
   - Jave
+  - JBoss Log Manager
+  - JBoss Logging
   - JetBrains
   - Jira
   - Jolokia
@@ -138,6 +146,7 @@ exceptions:
   - Kubespray
   - Kylin
   - Laravel
+  - Logstash
   - Lombok
   - Makefile
   - Mandrel
@@ -167,6 +176,7 @@ exceptions:
   - OpEx
   - OpenID Connect
   - OpenJDK
+  - OpenRewrite
   - OpenShift
   - OpenTracing
   - PHP
@@ -184,7 +194,6 @@ exceptions:
   - Qt
   - Quarkiverse
   - Quarkus
-  - Quarkus Security
   - Quiltflower
   - Qute
   - RESTEasy
@@ -246,4 +255,5 @@ exceptions:
   - startx
   - vNIC
   - vNUMA
-  - xterm
+  - xDS
+  - xterm

docs/.vale/styles/Quarkus/OxfordComma.yml

@@ -5,4 +5,4 @@ link: https://github.com/quarkusio/quarkus/blob/main/docs/src/main/asciidoc/doc-
 message: "Use the Oxford comma in '%s'."
 # source: Quarkus contributor guide
 tokens:
-  - '(?:[^,]+,){1,}\s\w+\sand'
+  - '(?:[^\s,]+,){1,} \w+ (?:and|or) \w+[.?!]'