Merge pull request #402 from aireilly/brian-vale-pr

Add Vale checks to the SSG

Author: lahinson

.github/workflows/vale-on-pull.yml

@@ -0,0 +1,19 @@
+---
+name: Linting with Vale on pull request
+on: [pull_request]
+
+jobs:
+  vale:
+    name: runner / vale
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: errata-ai/vale-action@reviewdog
+        with:
+          filter_mode: added
+          vale_flags: "--no-exit --minAlertLevel=error --glob=*.adoc"
+          reporter: github-pr-review
+          fail_on_error: false
+        env:
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+          REVIEWDOG_GITHUB_API_TOKEN: ${{secrets.GITHUB_TOKEN}}

.gitignore

@@ -3,3 +3,5 @@ main*.html
 index.html
 assets
 pdf-assets
+.vale/styles/AsciiDoc
+.vale/styles/RedHat

.vale.ini

@@ -0,0 +1,46 @@
+StylesPath = .vale/styles
+
+MinAlertLevel = suggestion
+
+Packages = RedHat, AsciiDoc
+
+IgnoredClasses = vale-ignore
+
+Vocab = SSG
+
+[[!.]*.adoc]
+BasedOnStyles = RedHat, AsciiDoc
+
+# Use local SSG Vocab terms
+Vale.Terms = YES
+Vale.Avoid = YES
+
+# NO prevents the rule from being used
+RedHat.Abbreviations = YES
+RedHat.CaseSensitiveTerms = NO
+RedHat.Conjunctions = YES
+RedHat.ConsciousLanguage = NO
+RedHat.Contractions = YES
+RedHat.Definitions = NO
+RedHat.DoNotUseTerms = NO
+RedHat.Ellipses = YES
+RedHat.HeadingPunctuation = YES
+RedHat.Headings = NO
+RedHat.Hyphens  = YES
+RedHat.OxfordComma = YES
+RedHat.PascalCamelCase = NO
+RedHat.PassiveVoice = NO
+RedHat.ReadabilityGrade = YES
+RedHat.ReleaseNotes = YES
+RedHat.RepeatedWords = YES
+RedHat.SelfReferentialText  = YES
+RedHat.SentenceLength = YES
+RedHat.SimpleWords = NO
+RedHat.Slash = YES
+RedHat.Spacing = YES
+RedHat.Spelling = YES
+RedHat.TermsErrors = YES
+RedHat.TermsSuggestions = YES
+RedHat.TermsWarnings = YES
+RedHat.Usage = YES
+RedHat.UserReplacedValues = YES

.vale/styles/Vocab/SSG/accept.txt

@@ -0,0 +1,184 @@
+# Add terms that have a corresponding incorrectly capitalized form to reject.txt.
+# Regex terms added to accept.txt are ignored by the Vale linter and override RedHat Vale rules.
+
+[cC]loudbursting
+[cC]loudwashing
+[Dd]atagram
+[Ee]xtranet
+[fF]utex
+[Gg]pl
+[Ii][Oo]
+[Ll]inux
+[Mm]odcluster
+[Mm]utex
+[Pp]ico
+[Pp]luggable
+[Rr]emoting
+[rR]ulebook
+[Ss]oftcopy
+[Ss]ysprep
+[Tt]hunderbird
+[Vv]irtualized
+AppStream
+autodetect
+autoscaler
+AZs
+BIOSes
+Bootloader
+bpp
+callout
+CAs
+CCSPs
+Cgroups
+ciphertext
+classful
+cleartext
+context_path
+crawlable
+datacenters
+DCs
+deduped
+denylist
+DSLs
+eCos
+EE
+ee
+EIPs
+embeddable
+Enterpise
+ess
+facto
+FireWire
+fluentd
+followable
+Gartner
+gcc
+GCC
+gcj
+GCJ
+GDB
+gbd
+grayscale
+Gtk
+gtk
+GTK
+Guestfish
+Hoffer
+hostfile
+html
+HTML
+IDPs
+indexless
+Ipsilon
+iSeries
+ISO/IEC
+javascript
+JavaScript
+jaxrs
+jca
+JCA
+JDR
+jdr
+jgroups
+JGroups
+JMX
+jmx
+JPA
+jpa
+JSF
+jsf
+jsvc
+Karaf
+Katello
+kbps
+kerberize
+kerberized
+KJARs
+LANs
+linter
+lookups
+MBean
+MBps
+Mbps
+Merced
+Microcontainer
+microkernel
+Microsystems
+monospace
+Mozilla Firefox
+multicast
+OEMs?
+OSDs?
+OSGi
+OSTree
+oVirt
+paravirtualized
+passlist
+PL/SQL
+plaintext
+pojo subsystem
+POJO subsystem
+Portman
+premaster
+pSeries
+publish/subscribe
+Puppetize
+Qpid
+RBD
+rbd
+read/write
+rebrand
+redhat
+remoting subsystem
+rpm-ostree
+RTS
+rts
+S/390
+S3/Swift
+SAR
+sar
+SCL
+scriptlet
+sharded
+SIDs
+SkyDNS
+SmartProxy
+smbclient
+softirqs?
+Solaris
+sos
+sos report
+sosreport
+spacebar
+sparsify
+Sybase
+sysreport
+Tcl/Tk
+Telecom
+TGTs?
+toolchain
+toolset
+unencrypted
+unicast
+URI
+URL
+URN
+userspace
+VCs
+WCAs?
+webadmin
+WebAIM
+webopedia
+webservices
+WWW
+www
+XEmacs
+xemacs
+Xen
+Xplat
+xsession
+XTS
+xts
+Yubikey
+z/Architecture
+zSeries

.vale/styles/Vocab/SSG/reject.txt

@@ -0,0 +1,2 @@
+# Regex terms added to reject.txt are highlighted as errors by the Vale linter and override RedHat Vale rules.
+# Add terms that have a corresponding correctly capitalized form to accept.txt.

GUIDELINES.adoc

@@ -16,6 +16,7 @@ Use the following template for glossary entries:
 
 *Use it*: <yes/no/with caution>
 
+[.vale-ignore]
 *Incorrect forms*: <incorrect_form>
 
 *See also*: xref:<another_term_id>[<another_term>]