Uploaded image for project: 'Quarkus Documentation'
  1. Quarkus Documentation
  2. QDOCS-59

Add commonly used Java & programming words to vale spelling exception

XMLWordPrintable

    • Icon: Task Task
    • Resolution: Done
    • Icon: Major Major
    • None
    • None
    • None

      The following names/services/components are regularly used in Java programming documentation in the Software industry but flag as spelling or capitalization errors by the default Vale spell checker.

      This impacts vale running on product docs AND on the upstream docs.

      Words to get added to spelling and capitalization exception lists to reduce the noise in the vale linter output for Quarkus.

      ClassLoader
      classpath
      foobar - THIS ONE WAS REJECTED DUE TO IBM STYLE GUIDELINE DO NOT USE DUE TO PROFANITY.
      GraalVM
      Hibernate ORM
      Infinispan
      JUnit
      Kafka
      Mandrel
      Maven Failsafe
      MicroProfile
      MongoDB
      mutual TLS or mTLS
      OpenID
      RESTEasy
      SmallRye
      WebAuthn
      This PR adds those proper nouns to the spelling, heading, and capitalization style rules.

      Fixes:
      Lots of false positives, particularly in Runtimes product docs, for example, Red Hat build of Quarkus.

              mpurcell@redhat.com Michelle Purcell
              mpurcell@redhat.com Michelle Purcell
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated:
                Resolved: