From ae6ff6ad9f7a3443b682c6723eeca1ac101de79d Mon Sep 17 00:00:00 2001 From: Michelle Purcell Date: Fri, 28 Jul 2023 17:40:16 +0100 Subject: [PATCH] Reducing vale doc linter style false positives Fixed false positives flagged in PRs with label. remove definitions Removed duplicates removed duplicate Add OTel to spelling --- .../CaseSensitiveTerms/testinvalid.adoc | 1 + .../Quarkus/CaseSensitiveTerms/testvalid.adoc | 5 + .../fixtures/Quarkus/Headings/testvalid.adoc | 6 +- .../fixtures/Quarkus/Spelling/testvalid.adoc | 10 ++ .../styles/Quarkus/CaseSensitiveTerms.yml | 42 ++++---- docs/.vale/styles/Quarkus/Ellipses.yml | 2 +- docs/.vale/styles/Quarkus/Headings.yml | 14 ++- docs/.vale/styles/Quarkus/OxfordComma.yml | 2 +- docs/.vale/styles/Quarkus/Spelling.yml | 98 ++++++++++++++++--- .../.vale/styles/Quarkus/TermsSuggestions.yml | 10 +- docs/.vale/styles/Quarkus/TermsWarnings.yml | 8 +- 11 files changed, 156 insertions(+), 42 deletions(-) diff --git a/docs/.vale/fixtures/Quarkus/CaseSensitiveTerms/testinvalid.adoc b/docs/.vale/fixtures/Quarkus/CaseSensitiveTerms/testinvalid.adoc index 22be1e6921233..cae58431dca66 100644 --- a/docs/.vale/fixtures/Quarkus/CaseSensitiveTerms/testinvalid.adoc +++ b/docs/.vale/fixtures/Quarkus/CaseSensitiveTerms/testinvalid.adoc @@ -88,6 +88,7 @@ IPSec iSeries iso iso image +Istio Service Mesh Itanium2 JBoss.org jetbrains diff --git a/docs/.vale/fixtures/Quarkus/CaseSensitiveTerms/testvalid.adoc b/docs/.vale/fixtures/Quarkus/CaseSensitiveTerms/testvalid.adoc index 9db95617733a5..1d106b17eb960 100644 --- a/docs/.vale/fixtures/Quarkus/CaseSensitiveTerms/testvalid.adoc +++ b/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 diff --git a/docs/.vale/fixtures/Quarkus/Headings/testvalid.adoc b/docs/.vale/fixtures/Quarkus/Headings/testvalid.adoc index 9d543e77c14f8..684dbd0d9e1d4 100644 --- a/docs/.vale/fixtures/Quarkus/Headings/testvalid.adoc +++ b/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 \ No newline at end of file +== 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 \ No newline at end of file diff --git a/docs/.vale/fixtures/Quarkus/Spelling/testvalid.adoc b/docs/.vale/fixtures/Quarkus/Spelling/testvalid.adoc index f6aa4cd2c00eb..db8064a7a9666 100644 --- a/docs/.vale/fixtures/Quarkus/Spelling/testvalid.adoc +++ b/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 diff --git a/docs/.vale/styles/Quarkus/CaseSensitiveTerms.yml b/docs/.vale/styles/Quarkus/CaseSensitiveTerms.yml index a3c3b78cf2b7d..a6479e1f60a79 100644 --- a/docs/.vale/styles/Quarkus/CaseSensitiveTerms.yml +++ b/docs/.vale/styles/Quarkus/CaseSensitiveTerms.yml @@ -9,17 +9,26 @@ action: name: replace swap: "(?