Skip to content

Commit

Permalink
vale: sync, remove some duplicate rules, disable "Readability"
Browse files Browse the repository at this point in the history
  • Loading branch information
minijackson committed Aug 25, 2023
1 parent 4df59ba commit 4e166db
Show file tree
Hide file tree
Showing 23 changed files with 150 additions and 145 deletions.
29 changes: 26 additions & 3 deletions .vale.ini
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ MinAlertLevel = suggestion
Vocab = EPNix

# External packages
Packages = alex, Google, Microsoft, proselint, Readability, RedHat, write-good
Packages = alex, Google, Microsoft, proselint, RedHat, write-good
# Only Markdown and .txt files; change to whatever you're using.
[*.md]
# List of styles to load.
Expand All @@ -20,7 +20,30 @@ RedHat.Contractions = NO
# Already done by Microsoft.We
Google.We = NO

# ??? corresponds to 7th grade -> 12-13 years old
Readability.AutomatedReadability = YES
# Already done by Vale.Spelling
RedHat.Spelling = NO

# Already done by RedHat.PassiveVoice
Google.Passive = NO
Microsoft.Passive = NO
write-good.Passive = NO

# Already done by RedHat.Definitions
Microsoft.Acronyms = NO
Google.Acronyms = NO

# Already done by RedHat.Headings
Google.Headings = NO
Microsoft.Headings = NO

# Already done by Microsoft.SentenceLength, which is shorter
RedHat.SentenceLength = NO

# Already done by RedHat.Ellipses
Google.Ellipses = NO
Microsoft.Ellipses = NO

# Already done by Microsoft.Quotes
Google.Quotes = NO

write-good.E-Prime = NO
8 changes: 0 additions & 8 deletions doc/vale/Readability/AutomatedReadability.yml

This file was deleted.

8 changes: 0 additions & 8 deletions doc/vale/Readability/ColemanLiau.yml

This file was deleted.

8 changes: 0 additions & 8 deletions doc/vale/Readability/FleschKincaid.yml

This file was deleted.

8 changes: 0 additions & 8 deletions doc/vale/Readability/FleschReadingEase.yml

This file was deleted.

8 changes: 0 additions & 8 deletions doc/vale/Readability/GunningFog.yml

This file was deleted.

17 changes: 0 additions & 17 deletions doc/vale/Readability/LIX.yml

This file was deleted.

8 changes: 0 additions & 8 deletions doc/vale/Readability/SMOG.yml

This file was deleted.

4 changes: 0 additions & 4 deletions doc/vale/Readability/meta.json

This file was deleted.

30 changes: 16 additions & 14 deletions doc/vale/RedHat/CaseSensitiveTerms.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,27 @@ action:
name: replace
swap:
"(?<!/)var": VAR
# Bind: BIND
'(?<!\.)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": Microsoft Azure
"(?<!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
"[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
'(?<!JBoss )EAP|(?<!Red Hat )JBoss(?!\sCommunity|\sBroker|\sClients|\sConsole|\sAMQ|\sData\sGrid|\sBRMS|\sBPMS|\sEnterprise\sApplication\sPlatform|\.org|\sInterconnect|\sEAP|\sBPM\sSuite)': JBoss EAP
'(?<!Realtime )Decision\sServer': Realtime Decision Server
'[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
Expand All @@ -31,24 +40,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
"[dD]ay-0|day 0": Day 0
"[dD]ay-1|day 1": Day 1
"[dD]ay-2|day 2": Day 2
"DM(?![ -]Multipath)|directory manager": Directory Manager
'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
Expand Down Expand Up @@ -126,6 +125,7 @@ swap:
Gnu|gnu: GNU
Gpl|gpl: GPL
Graalvm|graalVM: GraalVM
grpc|GRPC: gRPC
Greenboot|green boots: greenboot
Grub: GRUB
GTK|Gtk|gtk: GTK+
Expand All @@ -139,6 +139,7 @@ swap:
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
Expand Down Expand Up @@ -199,6 +200,7 @@ swap:
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
Expand Down
3 changes: 3 additions & 0 deletions doc/vale/RedHat/Definitions.yml
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ exceptions:
- DRL
- DSL
- EIP
- ELB
- ERROR
- FAQ
- FQDN
Expand Down Expand Up @@ -121,12 +122,14 @@ exceptions:
- POST
- PPP
- PROM
- PTP
- PXE
- QCOW2
- QEMU
- RADOS
- RAID
- RAM
- RAN
- RBAC
- RBD
- REPL
Expand Down
12 changes: 4 additions & 8 deletions doc/vale/RedHat/HeadingPunctuation.yml
Original file line number Diff line number Diff line change
@@ -1,15 +1,11 @@
---
extends: existence
extends: substitution
level: warning
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/headingpunctuation/
message: "Do not use end punctuation in headings."
nonword: true
scope: heading
# source: "IBM - Periods in headings and titles, p. 61"
action:
name: edit
params:
- remove
- ".?!"
tokens:
- '[a-z0-9][.?!](?:\s|$)'
name: replace
swap:
'[.?!]$': ''
10 changes: 10 additions & 0 deletions doc/vale/RedHat/Headings.yml
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,8 @@ exceptions:
- Flathub
- Flatpak
- Flatpak Builder
- Fluentd
- Flyway
- Fortran
- Funqy
- GCC
Expand All @@ -93,6 +95,7 @@ exceptions:
- GraalVM
- Gradle
- GraphQL
- Graylog
- Grayscale
- GTK
- HTTP
Expand All @@ -114,9 +117,12 @@ exceptions:
- Infinispan
- Intelephense
- IntelliJ
- Istio
- Itanium
- JAR file
- JBang
- JBoss Log Manager
- JBoss Logging
- JUnit
- JVM
- Jakarta
Expand All @@ -136,6 +142,7 @@ exceptions:
- Kubespray
- Kylin
- Laravel
- Logstash
- Lombok
- Makefile
- Mandrel
Expand Down Expand Up @@ -226,6 +233,7 @@ exceptions:
- WebSocket
- Webview
- Webviews
- WebView
- Wildfly
- Window Maker
- Windows
Expand All @@ -238,10 +246,12 @@ exceptions:
- Zowe
- cgroup
- eServer
- gRPC
- mutual TLS
- mTLS
- qeth
- startx
- vNIC
- vNUMA
- xDS
- xterm
5 changes: 3 additions & 2 deletions doc/vale/RedHat/OxfordComma.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ extends: existence
level: suggestion
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/oxfordcomma/
message: "Use the Oxford comma in '%s'."
# source: "IBM - Commas between clauses, p.45"
scope: sentence
nonword: true
tokens:
- '(?:[^,]+,){1,}\s\w+\sand'
- '(?:[^\s,]+,){1,} \w+ (?:and|or) \w+[.?!]'
2 changes: 2 additions & 0 deletions doc/vale/RedHat/PascalCamelCase.yml
Original file line number Diff line number Diff line change
Expand Up @@ -120,11 +120,13 @@ exceptions:
- OpenIPMI
- OpenJDK
- OpenRewrite
- OpenRAN
- OpenSCAP
- OpenShift
- OpenSSH
- OpenSSL
- OpenStack
- OpenTelemetry
- OpenTracing
- OperatorHub
- OpEx
Expand Down
3 changes: 2 additions & 1 deletion doc/vale/RedHat/SimpleWords.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ ignorecase: true
level: suggestion
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/simplewords/
message: "Use simple language. Consider using '%s' rather than '%s'."
# source: "IBM - Conversational style; http://www.plainlanguage.gov/howto/wordsuggestions/simplewords.cfm"
action:
name: replace
swap:
"approximate(?:ly)?": about
"objective(?! C?)": aim|goal
Expand Down
2 changes: 2 additions & 0 deletions doc/vale/RedHat/Slash.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,5 @@ exceptions:
- "z/OSMF"
- "0/"
- "C/C"
- "TCP/IP"
- '\d{1,4}\/\d{1,4}'
Loading

0 comments on commit 4e166db

Please sign in to comment.