forked from docs/team-docs
ci: fix vale pipeline
This commit is contained in:
darknao
parent
fe63036346
commit
31d1f24ebb
33 changed files with 68 additions and 2436 deletions
2
.gitignore
vendored
2
.gitignore
vendored
|
|
@ -1,3 +1,5 @@
|
|||
.vale
|
||||
gl-code-quality-report.json
|
||||
build
|
||||
cache
|
||||
public
|
||||
|
|
|
|||
|
|
@ -36,12 +36,16 @@ code_quality:
|
|||
VARH_REPO: "redhat-documentation/vale-at-red-hat"
|
||||
VARH_BRANCH: "main"
|
||||
before_script:
|
||||
- apk add --no-cache curl asciidoctor python3
|
||||
- |
|
||||
curl -o vale2cc.py \
|
||||
https://raw.githubusercontent.com/${VARH_REPO}/${VARH_BRANCH}/tools/vale2cc.py
|
||||
# - apk update && apk add git
|
||||
- vale sync
|
||||
script:
|
||||
- vale --no-exit --output=JSON . | python3 vale2cc.py > gl-code-quality-report.json
|
||||
# list of updated/modified *.adoc files
|
||||
# - FILES=$(git diff --name-only HEAD~1 HEAD --diff-filter=d "*.adoc")
|
||||
# clean out conditions for wider vale coverage
|
||||
# - sed -i -e 's/ifdef::.*\|ifndef::.*\|ifeval::.*\|endif::.*/ /' ${FILES}
|
||||
# use a template to rearrange the vale JSON output
|
||||
# run vale with `--no-exit` to pass the build with errors
|
||||
- vale --no-exit --minAlertLevel=error --glob='*.adoc' --output="$(pwd)/vale-json.tmpl" . | sed "s/CI_COMMIT_SHA/$CI_COMMIT_SHA/g" > gl-code-quality-report.json
|
||||
artifacts:
|
||||
reports:
|
||||
codequality: gl-code-quality-report.json
|
||||
|
|
|
|||
|
|
@ -1,9 +0,0 @@
|
|||
---
|
||||
extends: existence
|
||||
level: error
|
||||
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/abbreviations/
|
||||
message: "Do not use periods in all-uppercase abbreviations such as '%s'."
|
||||
nonword: true
|
||||
# source: "IBM - Periods with abbreviations, p. 5"
|
||||
tokens:
|
||||
- '\b(?:[A-Z]\.){3,5}'
|
||||
|
|
@ -1,299 +0,0 @@
|
|||
---
|
||||
extends: substitution
|
||||
ignorecase: false
|
||||
level: error
|
||||
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/reference-guide/casesensitiveterms/
|
||||
message: Use '%s' rather than '%s'.
|
||||
# source: "https://redhat-documentation.github.io/supplementary-style-guide/#glossary-terms-conventions"
|
||||
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
|
||||
'[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
|
||||
'A-MQ\sBroker': AMQ Broker
|
||||
'A-MQ\sClients': AMQ Clients
|
||||
'A-MQ\sConsole': AMQ Console
|
||||
'A-MQ\sInterconnect': AMQ Interconnect
|
||||
'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
|
||||
'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
|
||||
'self-hosted\sengine\svirtual\smachine|engine\sVM': Manager virtual machine
|
||||
Appliance Console: Appliance console
|
||||
Applix|ApplixWare: Applixware
|
||||
asciidoctor|AsciiDoctor: Asciidoctor
|
||||
asciidoc|Asciidoc: AsciiDoc
|
||||
assertj|Assertj: AssertJ
|
||||
auto-link|AutoLink: autolink
|
||||
basic authentication|Basic Authentication|basic auth|Basic auth|Basic Auth: Basic HTTP authentication (first instance)|Basic authentication
|
||||
BC: Business Central
|
||||
Bios: BIOS
|
||||
blue print|BluePrint: blueprint
|
||||
bluestore|Blue Store: BlueStore
|
||||
btrfs: Btrfs
|
||||
Capex|capex|capEx: CapEx
|
||||
Capsule server: Capsule Server
|
||||
CD 1: CD #1
|
||||
CDS|Cds: CDs
|
||||
Ceph Ansible: ceph-ansible
|
||||
Ceph block device|Ceph block devices: Ceph Block Device
|
||||
Ceph filesystem|Ceph file system: Ceph File System
|
||||
Ceph monitor: Ceph Monitor
|
||||
Ceph object gateway|Ceph object gateways: Ceph Object Gateway
|
||||
ceph-osd|Object Storage Device|OSD daemon: OSD
|
||||
cephfs: CephFS
|
||||
CGroup|c group: cgroup
|
||||
cidr|Classless Interdomain Routing|Classless Inter-domain Routing: CIDR
|
||||
classic mode: GNOME Classic
|
||||
CloudForms Management Engine|CFME: Red Hat CloudForms|Red Hat CloudForms Appliance
|
||||
command prompt: shell prompt|Command Prompt (Windows product)
|
||||
Composite Content view|composite content view|Composite View|composite view: Composite Content View
|
||||
configmap: config map
|
||||
configuration map: config map
|
||||
Content view|content view: Content View
|
||||
control key|ctrl: Ctrl
|
||||
crush map|crushmap: CRUSH map
|
||||
csv: CSV
|
||||
CygMon|cygmon|CYGMON: Cygmon
|
||||
Data Grid Administration Console: Data Grid Console
|
||||
Data Grid console: Data Grid Console
|
||||
Denial of Service: denial of service
|
||||
Denial-of-Service: denial-of-service
|
||||
Development Preview|Developer preview|dev preview: Developer Preview
|
||||
devops|Devops|Dev-Ops|Dev Ops: DevOps
|
||||
directory server: Directory Server
|
||||
Disk druid|disk druid|diskdruid: Disk Druid
|
||||
dns: DNS
|
||||
DVD burner|burner: DVD writer
|
||||
DWH|data warehouse|Dataware House: Data Warehouse
|
||||
Etcd|ETCD: etcd
|
||||
Exec Shield: Exec-Shield
|
||||
EXIF|exif: Exif
|
||||
Extranet: extranet
|
||||
facter: Facter
|
||||
Faq|faq|F.A.Q: FAQ
|
||||
fault tolerant: fault-tolerant
|
||||
fault-tolerance: fault tolerance
|
||||
fedora project: Fedora™ Project
|
||||
filestore|File Store: FileStore
|
||||
Firewalld|firewallD|FirewallD: firewalld
|
||||
Firewire|firewire: FireWire
|
||||
FlatHub: Flathub
|
||||
FlatPak: Flatpak
|
||||
fortran: Fortran
|
||||
Fqdn|fqdn: FQDN
|
||||
gbps|GBPS: Gbps
|
||||
gb|Gb: GB
|
||||
GDBTK: Insight
|
||||
gid|Gid: GID
|
||||
Gimp|gimp: GIMP
|
||||
git|GIT: Git
|
||||
Gnome|gnome: GNOME
|
||||
Gnu|gnu: GNU
|
||||
Gpl|gpl: GPL
|
||||
Graalvm|graalVM: GraalVM
|
||||
Greenboot|green boots: greenboot
|
||||
Grub: GRUB
|
||||
GTK|Gtk|gtk: GTK+
|
||||
hot rod|HotRod|hotrod: Hot Rod
|
||||
HP Proliant: HP ProLiant
|
||||
HTTP interface: management console
|
||||
hyperthreading|hyper-threading: Hyper-Threading
|
||||
HyperVisor|Hyperviser: hypervisor
|
||||
IA64|ia64: Itanium
|
||||
IBM z Systems: IBM Z
|
||||
Ignite|Fuse Ignite: Fuse Online|Red Hat Fuse Online|Syndesis
|
||||
ignition config: Ignition config
|
||||
Image Builder: image builder
|
||||
INSTALL_DIR|installDir: FUSE_HOME
|
||||
Iops|IOPs: IOPS
|
||||
Ip: IP
|
||||
IPSec: IPsec
|
||||
ipv4|IPV4|Ipv4: IPv4
|
||||
ipv6|IPV6|Ipv6: IPv6
|
||||
iSeries: ISeries
|
||||
iso: ISO
|
||||
Itanium2: Itanium 2
|
||||
jar file: JAR file
|
||||
Jbang|jbang: JBang
|
||||
JBoss Clients: AMQ Clients
|
||||
JBoss Data Grid: Data Grid
|
||||
jetbrains|Jetbrains: JetBrains
|
||||
Junit|junit: JUnit
|
||||
Jvm|jvm: JVM
|
||||
kbase|knowledge base: KIE base
|
||||
kernel-based virtual machine: Kernel-based Virtual Machine
|
||||
kernelspace: kernel space
|
||||
key store: keystore
|
||||
kickstart: Kickstart
|
||||
kie API|Kie API|knowledge API: KIE API
|
||||
kjar|kJAR: KJAR
|
||||
knowledgebase: Knowledgebase
|
||||
ksession|knowledge session: KIE session
|
||||
Kubelet: kubelet
|
||||
kubernetes|k8s: Kubernetes
|
||||
kvm: KVM
|
||||
Lan|lan: LAN
|
||||
Librados|LIBRADOS: librados
|
||||
Librbd|LIBRBD: librbd
|
||||
Lightweight Directory Access Protocol over Secure Socket Layer: LDAPS
|
||||
LINUX|linux: Linux
|
||||
live-backup group: master-slave group
|
||||
Lun|lun: LUN
|
||||
master CA: IdM CA renewal server
|
||||
master server: IdM server and replicas
|
||||
Microprofile|micro-profile: MicroProfile
|
||||
Microsoft Azure Portal: Microsoft Azure portal
|
||||
Microsoft Windows Server: Windows Server
|
||||
MoM|Mom|mom: MOM
|
||||
Mongo\sDB|mongoDB|Mongodb|Mongo-db: MongoDB
|
||||
MS(?!-DOS?)|MSFT|MicroSoft: Microsoft
|
||||
MS-dos|Ms-Dos|ms-dos|MSDOS|msdos: MS-DOS
|
||||
MTLS|m-TLS: mTLS
|
||||
mutual tls|Mutual tls|Mutual TLS: mutual TLS
|
||||
MYSQL|mySQL: MySQL
|
||||
native interface: management CLI
|
||||
network interface card: network interface controller (NIC)
|
||||
objectclass: objectClass
|
||||
Objective-C: Objective C
|
||||
OCP: Red Hat OpenShift Container Platform
|
||||
ODF: Red Hat OpenShift Data Foundation
|
||||
Open InfiniBand|Infiniband: InfiniBand
|
||||
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
|
||||
Organization administrator|Org Admin|org admin: Organization Administrator
|
||||
OS|Operating System: operating system
|
||||
Overcloud: overcloud
|
||||
Podman desktop: Podman Desktop
|
||||
podman: Podman
|
||||
popup|Pop-up: pop-up
|
||||
Posix|posix: POSIX
|
||||
Postscript: PostScript
|
||||
Powershell|powershell: PowerShell
|
||||
PPC|P-PC|PPC64: PowerPC
|
||||
Ppp|ppp: PPP
|
||||
prom|Prom: PROM
|
||||
proof key for code exchange: Proof Key for Code Exchange
|
||||
proof of concepts: proofs of concept
|
||||
Properties editor: Properties View
|
||||
pSeries: IBM eServer System p
|
||||
puppet forge: Puppet Forge
|
||||
puppet: Puppet
|
||||
q & a|q&a|Q & A|Q&A: Q and A
|
||||
qcow2|Qcow2: QCOW2
|
||||
Qdmanage|QDMANAGE: qdmanage
|
||||
Qdstat|QDSTAT: qdstat
|
||||
Qeth|QETH: qeth
|
||||
RAMdisk|ramdisk|RAM-disk: RAM disk
|
||||
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
|
||||
Red Hat Satellite server: Red Hat Satellite Server
|
||||
Red Hat satellite: Red Hat Satellite
|
||||
Redboot|Red Boot: RedBoot
|
||||
redis: Redis
|
||||
RESTEASY|resteasy|Resteasy: RESTEasy
|
||||
RHDS: Red Hat Directory Server
|
||||
RHEL host|RHEL-H: Red Hat Enterprise Linux host
|
||||
RHV: Red Hat Virtualization
|
||||
Rom|rom: ROM
|
||||
rpm: RPM
|
||||
s-record|S-Record|s-Record|SREC: S-record
|
||||
samba|SAMBA: Samba
|
||||
Satellite server: Satellite Server
|
||||
SE-Linux|S-E Linux|SE Linux|selinux: SELinux
|
||||
Shadow Man|ShadowMan: Shadowman
|
||||
Shadow passwords: shadow passwords
|
||||
Shadow utilities: shadow utilities
|
||||
Smallrye: SmallRye
|
||||
smart NIC|Smart-NIC: SmartNIC
|
||||
Smart State|smart state|Smart state|Smartstate|Analysis: SmartState analysis
|
||||
socks: SOCKS
|
||||
software collection|Software collection: Software Collection
|
||||
Source Navigator: Source-Navigator^TM^
|
||||
Spec: spec
|
||||
Spice|spice: SPICE
|
||||
Spring boot: Spring Boot
|
||||
SR IOV: SR-IOV
|
||||
Ssh|ssh: SSH
|
||||
SSL handshake: TLS handshake
|
||||
SSL(?!/TLS): SSL/TLS
|
||||
standard Manager|standard environment: standalone Manager
|
||||
Staroffice|Star Office: StarOffice
|
||||
StartTLS|startTLS: STARTTLS
|
||||
StartX: startx
|
||||
STI|source to image: Source-to-Image (S2I)
|
||||
SU: su
|
||||
Subscription manifest: Subscription Manifest
|
||||
Sys V|System V: SysV
|
||||
system D|system D|SystemD|system d: systemd
|
||||
Technology preview|technology preview: Technology Preview
|
||||
The Operator Lifecycle Manager: Operator Lifecycle Manager
|
||||
Tolapai|Intel Tolapai: Intel(R) EP80579 Integrated Processor
|
||||
ttl: TTL
|
||||
uid: UID
|
||||
ULTRASPARC|UltraSparc: UltraSPARC
|
||||
Unix|unix|UNIX-like: UNIX
|
||||
url: URL
|
||||
urn: URN
|
||||
VCPU|vcpu: vCPU
|
||||
VI: vi
|
||||
VIM|vim: Vim
|
||||
Virtual Desktop Server Management: VDSM
|
||||
virtual-console|Virtual Console: virtual console
|
||||
vlan|vLAN: VLAN
|
||||
VM portal|vm portal|Virtual Machine Portal|User Portal: VM Portal
|
||||
vnic|VNIC|Virtual Network Interface Card: vNIC
|
||||
vnuma|VNUMA: vNUMA node
|
||||
vpn: VPN
|
||||
VS Code|VSCode|VisualStudioCode|VisualStudio Code: Visual Studio Code
|
||||
VT-i|VT: Intel Virtualization Technology
|
||||
wan: WAN
|
||||
wca: WCA
|
||||
web-UI|webUI: web UI
|
||||
Webauthn|webAuthn|WebAuthN: WebAuthn
|
||||
websocket|Websocket: WebSocket
|
||||
Window-Maker|WindowMaker: Window Maker
|
||||
Xemacs: XEmacs
|
||||
xplat-cli|x-plat-cli|xplat cli|x-plat cli|X-PLAT CLI|X-PLAT-CLI|XPLAT-CLI|XPLAT CLI: Microsoft Azure Cross-Platform Command-Line Interface
|
||||
Xp|xp: XP
|
||||
Xterm: xterm
|
||||
|
|
@ -1,14 +0,0 @@
|
|||
---
|
||||
extends: existence
|
||||
level: suggestion
|
||||
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/conjunctions/
|
||||
message: "Do not overuse beginning sentences with '%s'."
|
||||
scope: paragraph
|
||||
# source: https://github.com/redhat-documentation/vale-at-red-hat/tree/main/.vale/styles/RedHat/Conjunctions.yml
|
||||
action:
|
||||
name: remove
|
||||
tokens:
|
||||
- ^And
|
||||
- ^But
|
||||
- ^Or
|
||||
- ^So
|
||||
|
|
@ -1,14 +0,0 @@
|
|||
---
|
||||
extends: substitution
|
||||
ignorecase: true
|
||||
level: warning
|
||||
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/consciouslanguage/
|
||||
message: Use '%s' rather than '%s.'
|
||||
# source: "https://redhat-documentation.github.io/supplementary-style-guide/#conscious-language"
|
||||
action:
|
||||
name: replace
|
||||
swap:
|
||||
blacklist: blocklist
|
||||
whitelist: allowlist
|
||||
master(?! broker): primary|source|initiator|requester|controller|host|director|supplier
|
||||
slave(?! broker): secondary|replica|responder|device|worker|proxy|performer|consumer
|
||||
|
|
@ -1,44 +0,0 @@
|
|||
---
|
||||
extends: substitution
|
||||
ignorecase: true
|
||||
level: suggestion
|
||||
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/contractions/
|
||||
message: "Avoid contractions. Use '%s' rather than '%s.'"
|
||||
# source: "https://redhat-documentation.github.io/supplementary-style-guide/#contractions"
|
||||
action:
|
||||
name: replace
|
||||
swap:
|
||||
"aren't": is not
|
||||
"can't": cannot
|
||||
"couldn't": could not
|
||||
"didn't": did not
|
||||
"doesn't": does not
|
||||
"don't": do not
|
||||
"hasn't": has not
|
||||
"haven't": have not
|
||||
"how'll": how will
|
||||
"how's": how is
|
||||
"isn't": is not
|
||||
"it'll": it will
|
||||
"it's": it is
|
||||
"shouldn't": should not
|
||||
"that'll": that will
|
||||
"that's": that is
|
||||
"they'll": they will
|
||||
"they're": they are
|
||||
"wasn't": was not
|
||||
"we'll": we will
|
||||
"we're": we are
|
||||
"we've": we have
|
||||
"weren't": were not
|
||||
"what'll": what will
|
||||
"what's": what is
|
||||
"when'll": when will
|
||||
"when's": when is
|
||||
"where'll": where will
|
||||
"where's": where is
|
||||
"who'll": who will
|
||||
"who's": who is
|
||||
"why'll": why will
|
||||
"why's": why is
|
||||
"won't": will not
|
||||
|
|
@ -1,183 +0,0 @@
|
|||
---
|
||||
extends: conditional
|
||||
ignorecase: false
|
||||
level: suggestion
|
||||
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/definitions/
|
||||
message: "Define acronyms and abbreviations (such as '%s') on first occurrence if they're likely to be unfamiliar."
|
||||
# source: "IBM - Abbreviations, p. 1"
|
||||
# Ensures that the existence of 'first' implies the existence of 'second'.
|
||||
first: '\b([A-Z]{3,5}s?)\b'
|
||||
second: '\(([A-Z]{3,5}s?)\)'
|
||||
# ... with the exception of these:
|
||||
exceptions:
|
||||
- 'APIs?'
|
||||
- 'CPUs?'
|
||||
- 'CVEs?'
|
||||
- 'DVDs?'
|
||||
- 'GIDs?'
|
||||
- 'NULL'
|
||||
- 'PIDs?'
|
||||
- 'ROMs?'
|
||||
- 'RPMs?'
|
||||
- 'UIDs?'
|
||||
- 'URIs?'
|
||||
- 'URLs?'
|
||||
- ACPI
|
||||
- AIX
|
||||
- ARM
|
||||
- ASCII
|
||||
- ASP
|
||||
- AWS
|
||||
- BIND
|
||||
- BIOS
|
||||
- BMC
|
||||
- CD
|
||||
- CIDR
|
||||
- CLI
|
||||
- CNAME
|
||||
- CSS
|
||||
- CSV
|
||||
- CUPS
|
||||
- DEBUG
|
||||
- DHCP
|
||||
- DNF
|
||||
- DNS
|
||||
- DOM
|
||||
- DOS
|
||||
- DPI
|
||||
- DRL
|
||||
- DSL
|
||||
- EIP
|
||||
- ERROR
|
||||
- FAQ
|
||||
- FQDN
|
||||
- FTP
|
||||
- GAS
|
||||
- GB
|
||||
- GCC
|
||||
- GCJ
|
||||
- GDB
|
||||
- GET
|
||||
- GIF
|
||||
- GIMP
|
||||
- GNOME
|
||||
- GNU
|
||||
- GNUPro
|
||||
- GPL
|
||||
- GPU
|
||||
- GRUB
|
||||
- GTK+
|
||||
- GUI
|
||||
- GUID
|
||||
- HP
|
||||
- HTML
|
||||
- HTTP
|
||||
- HTTPS
|
||||
- IAM
|
||||
- IBM
|
||||
- IDE
|
||||
- IOPS
|
||||
- IOV
|
||||
- IP
|
||||
- ISO
|
||||
- IT
|
||||
- JAR
|
||||
- JPEG
|
||||
- JSON
|
||||
- JSX
|
||||
- JVM
|
||||
- KB
|
||||
- KIE
|
||||
- KVM
|
||||
- LAN
|
||||
- LDAP
|
||||
- LESS
|
||||
- LLDB
|
||||
- LPAR
|
||||
- LUKS
|
||||
- LVM
|
||||
- MAC
|
||||
- MB
|
||||
- MBR
|
||||
- MDS
|
||||
- mTLS
|
||||
- NAT
|
||||
- NET
|
||||
- NFS
|
||||
- NGINX
|
||||
- NIC
|
||||
- NOTE
|
||||
- NTP
|
||||
- NVDA
|
||||
- OEM
|
||||
- OSS
|
||||
- PATH
|
||||
- PC
|
||||
- PDF
|
||||
- PHP
|
||||
- PIN
|
||||
- PNG
|
||||
- POSIX
|
||||
- POST
|
||||
- PPP
|
||||
- PROM
|
||||
- PXE
|
||||
- QCOW2
|
||||
- QEMU
|
||||
- RADOS
|
||||
- RAID
|
||||
- RAM
|
||||
- RBAC
|
||||
- RBD
|
||||
- REPL
|
||||
- REST
|
||||
- RFC
|
||||
- RGW
|
||||
- RHEL
|
||||
- RSA
|
||||
- SAML
|
||||
- SAP
|
||||
- SCM
|
||||
- SCSI
|
||||
- SCSS
|
||||
- SDK
|
||||
- SFTP
|
||||
- SHA
|
||||
- SOCKS
|
||||
- SPEC
|
||||
- SQL
|
||||
- SSD
|
||||
- SSH
|
||||
- SSL
|
||||
- SSSD
|
||||
- SVG
|
||||
- SVN
|
||||
- SWAT
|
||||
- TBD
|
||||
- TCP
|
||||
- TLS
|
||||
- TODO
|
||||
- TTL
|
||||
- UDP
|
||||
- UEFI
|
||||
- UNIX
|
||||
- USB
|
||||
- UTC
|
||||
- UTF
|
||||
- UUID
|
||||
- VAR
|
||||
- VDO
|
||||
- VDSM
|
||||
- VGA
|
||||
- VLAN
|
||||
- VNC
|
||||
- VPN
|
||||
- WAN
|
||||
- WCA
|
||||
- XFS
|
||||
- XML
|
||||
- XSS
|
||||
- YAML
|
||||
- YUM
|
||||
- ZIP
|
||||
- ZTP
|
||||
|
|
@ -1,12 +0,0 @@
|
|||
---
|
||||
extends: existence
|
||||
level: suggestion
|
||||
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/ellipses/
|
||||
message: "Avoid the ellipsis (...) except to indicate omitted words."
|
||||
nonword: true
|
||||
# source: "IBM - Ellipses, p.49"
|
||||
action:
|
||||
name: remove
|
||||
tokens:
|
||||
- '\.\.\.'
|
||||
- "…"
|
||||
|
|
@ -1,15 +0,0 @@
|
|||
---
|
||||
extends: existence
|
||||
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|$)'
|
||||
|
|
@ -1,247 +0,0 @@
|
|||
---
|
||||
extends: capitalization
|
||||
level: suggestion
|
||||
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/headings/
|
||||
match: $sentence
|
||||
message: "Use sentence-style capitalization in '%s'."
|
||||
scope: heading
|
||||
# source: "IBM - Capitalization in headings and titles, p.16"
|
||||
indicators:
|
||||
- ":"
|
||||
exceptions:
|
||||
- API
|
||||
- AWS
|
||||
- Agroal
|
||||
- Annobin
|
||||
- Ansible
|
||||
- Antora
|
||||
- AppData
|
||||
- AsciiDoc
|
||||
- Asciidoctor
|
||||
- AssertJ
|
||||
- Azure
|
||||
- Basic authentication
|
||||
- Basic HTTP authentication
|
||||
- BOM
|
||||
- Bierner
|
||||
- Bitbucket
|
||||
- Bonjour
|
||||
- Bouncy Castle
|
||||
- Btrfs
|
||||
- Bugzilla
|
||||
- CDs
|
||||
- CR
|
||||
- CRD
|
||||
- CRDs
|
||||
- CRs
|
||||
- Camel
|
||||
- CapEx
|
||||
- CentOS
|
||||
- Ceph
|
||||
- Certificate Authorities
|
||||
- Che-Theia
|
||||
- Ciphertext
|
||||
- Civetweb
|
||||
- ClassLoader
|
||||
- Classloader
|
||||
- Cloudbursting
|
||||
- Cloudwashing
|
||||
- CodeReady
|
||||
- Community
|
||||
- ConfigMap
|
||||
- ConfigMaps
|
||||
- Containerfile
|
||||
- Containerfiles
|
||||
- Cookiecutter
|
||||
- Ctrl
|
||||
- Cygmon
|
||||
- DNS
|
||||
- DaemonSet
|
||||
- Datadog
|
||||
- Dev
|
||||
- DevOps
|
||||
- DevWorkspace
|
||||
- Dex
|
||||
- Docker
|
||||
- Dockerfile
|
||||
- Dockerfiles
|
||||
- Dotnet
|
||||
- Dyninst
|
||||
- Eclipse
|
||||
- Electron
|
||||
- Endevor
|
||||
- Endian
|
||||
- Esprima
|
||||
- Exif
|
||||
- Fabrice
|
||||
- Failsafe
|
||||
- Fernflower
|
||||
- Flathub
|
||||
- Flatpak
|
||||
- Flatpak Builder
|
||||
- Fortran
|
||||
- Funqy
|
||||
- GCC
|
||||
- GTKplus
|
||||
- GUI
|
||||
- Git
|
||||
- GitHub
|
||||
- GitHub Action
|
||||
- GitLab
|
||||
- GitLab Code Quality
|
||||
- Gluster
|
||||
- GraalVM
|
||||
- Gradle
|
||||
- GraphQL
|
||||
- Grayscale
|
||||
- GTK
|
||||
- HTTP
|
||||
- HTTPS
|
||||
- Hashicorp
|
||||
- Helgrind
|
||||
- Helm
|
||||
- Hibernate
|
||||
- Homebrew
|
||||
- IBM
|
||||
- IBM Cloud
|
||||
- ID
|
||||
- IDE
|
||||
- IDEs
|
||||
- IDs
|
||||
- IPSec
|
||||
- ISeries
|
||||
- InfiniBand
|
||||
- Infinispan
|
||||
- Intelephense
|
||||
- IntelliJ
|
||||
- Itanium
|
||||
- JAR file
|
||||
- JBang
|
||||
- JUnit
|
||||
- JVM
|
||||
- Jakarta
|
||||
- Jandex
|
||||
- Java
|
||||
- Jave
|
||||
- JetBrains
|
||||
- Jira
|
||||
- Jolokia
|
||||
- Joyent
|
||||
- Kibana
|
||||
- Kind
|
||||
- Knative
|
||||
- Knowledgebase
|
||||
- Kogito
|
||||
- Kompose
|
||||
- Kubespray
|
||||
- Kylin
|
||||
- Laravel
|
||||
- Lombok
|
||||
- Makefile
|
||||
- Mandrel
|
||||
- Mattermost
|
||||
- Maven
|
||||
- MicroProfile
|
||||
- Microsoft
|
||||
- Middleware
|
||||
- Minikube
|
||||
- Minishift
|
||||
- Mirantis
|
||||
- Mockito
|
||||
- MongoDB
|
||||
- MySQL
|
||||
- Nagios
|
||||
- Narayana
|
||||
- Neoverse
|
||||
- NetcoredebugOutput
|
||||
- Netty
|
||||
- Newdoc
|
||||
- Nginx
|
||||
- Node.js
|
||||
- NuGet
|
||||
- OAuth
|
||||
- ORM
|
||||
- OmniSharp
|
||||
- OpEx
|
||||
- OpenID Connect
|
||||
- OpenJDK
|
||||
- OpenRewrite
|
||||
- OpenShift
|
||||
- OpenTracing
|
||||
- PHP
|
||||
- Podman
|
||||
- Podman Desktop
|
||||
- PostScript
|
||||
- PostgreSQL
|
||||
- PowerPC
|
||||
- PowerShell
|
||||
- Productize
|
||||
- Productized
|
||||
- Prometheus
|
||||
- Proof Key for Code Exchange
|
||||
- Pytorch
|
||||
- Qt
|
||||
- Quarkiverse
|
||||
- Quarkus
|
||||
- Quiltflower
|
||||
- Qute
|
||||
- RESTEasy
|
||||
- Red Hat
|
||||
- RedBoot
|
||||
- Redis
|
||||
- Redistributions
|
||||
- SCM
|
||||
- SDK
|
||||
- SELinux
|
||||
- SVG
|
||||
- Sakila
|
||||
- Semeru
|
||||
- Shadowman
|
||||
- SmallRye
|
||||
- Software Development Kit
|
||||
- Software Development Kits
|
||||
- Spotify
|
||||
- StarOffice
|
||||
- Suchow
|
||||
- SysV
|
||||
- System
|
||||
- Technology Preview
|
||||
- Tekton
|
||||
- Telekom
|
||||
- Tensorflow
|
||||
- Texinfo
|
||||
- Toolset
|
||||
- Traefik
|
||||
- URI
|
||||
- URIs
|
||||
- URL
|
||||
- URLs
|
||||
- Uber
|
||||
- UltraSPARC
|
||||
- Vale
|
||||
- Valgrind
|
||||
- Velero
|
||||
- Vert.x
|
||||
- WebAuthn
|
||||
- WebSocket
|
||||
- Webview
|
||||
- Webviews
|
||||
- Wildfly
|
||||
- Window Maker
|
||||
- Windows
|
||||
- Windows Subsystem for Linux
|
||||
- Woopra
|
||||
- Wordpress
|
||||
- XEmacs
|
||||
- Yana
|
||||
- Yeoman
|
||||
- Zowe
|
||||
- cgroup
|
||||
- eServer
|
||||
- mutual TLS
|
||||
- mTLS
|
||||
- qeth
|
||||
- startx
|
||||
- vNIC
|
||||
- vNUMA
|
||||
- xterm
|
||||
|
|
@ -1,8 +0,0 @@
|
|||
---
|
||||
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"
|
||||
tokens:
|
||||
- '(?:[^,]+,){1,}\s\w+\sand'
|
||||
|
|
@ -1,179 +0,0 @@
|
|||
---
|
||||
extends: existence
|
||||
ignorecase: false
|
||||
level: suggestion
|
||||
scope: [list, sentence]
|
||||
link: https://redhat-documentation.github.io/asciidoc-markup-conventions
|
||||
message: "Consider wrapping this Pascal or Camel case term ('%s') in backticks."
|
||||
# source: https://github.com/redhat-documentation/vale-at-red-hat/tree/main/.vale/styles/RedHat/PascalCamelCase.yml
|
||||
tokens:
|
||||
#PascalCase
|
||||
- ([A-Z]+[a-z]+){2,}
|
||||
- ([A-Z]+[a-z]+[A-Z]+){1,}
|
||||
- ([A-Z]+[A-Z]+[a-z]+){1,}
|
||||
#camelCase
|
||||
- ([a-z]+)([A-Z]+[a-z]+){1,}
|
||||
exceptions:
|
||||
- '\b[A-Z]{2,}s?'
|
||||
- 'vCPUs?'
|
||||
- 3scale
|
||||
- AGPLv
|
||||
- AMQ
|
||||
- API
|
||||
- AppStream
|
||||
- AsciiDoc
|
||||
- AssertJ
|
||||
- BaseOS
|
||||
- BitBucket
|
||||
- BlueStore
|
||||
- CaaS
|
||||
- camelCase
|
||||
- CapEx
|
||||
- CentOS
|
||||
- CephFS
|
||||
- CheckTree
|
||||
- ClassLoader
|
||||
- CloudForms
|
||||
- CodeReady
|
||||
- ConfigMaps?
|
||||
- ConnectX
|
||||
- Convert2RHEL
|
||||
- CoreOS
|
||||
- DaemonSet
|
||||
- DDoS
|
||||
- DevOps
|
||||
- DevWorkspace
|
||||
- DNSSec
|
||||
- eServer
|
||||
- eXpress
|
||||
- eXtenSion
|
||||
- FaaS
|
||||
- FCoE
|
||||
- FileStore
|
||||
- FireWire
|
||||
- FreeRADIUS
|
||||
- GbE
|
||||
- GiB
|
||||
- GitHub
|
||||
- GitLab
|
||||
- GitOps
|
||||
- GlusterFS
|
||||
- GNUPro
|
||||
- GnuTLS
|
||||
- GraalVM
|
||||
- GraphQL
|
||||
- GTID
|
||||
- HashBase
|
||||
- HdrHistogram
|
||||
- Helm
|
||||
- HyperShift
|
||||
- IaaS
|
||||
- IBoE
|
||||
- IconBurst
|
||||
- IdM
|
||||
- IKEv
|
||||
- InfiniBand
|
||||
- InnoDB
|
||||
- IntelliJ
|
||||
- IntelliSense
|
||||
- IPoIB
|
||||
- IPsec
|
||||
- IPv
|
||||
- ISeries
|
||||
- JavaScript
|
||||
- JBoss
|
||||
- JetBrains
|
||||
- JUnit
|
||||
- KiB
|
||||
- LangTags
|
||||
- LGPLv
|
||||
- libOSMesa
|
||||
- LibreOffice
|
||||
- libXNVCtrl
|
||||
- LightPulse
|
||||
- LinuxONE
|
||||
- LiquidIO
|
||||
- ManageIQ
|
||||
- MariaDB
|
||||
- MegaRAID
|
||||
- MiB
|
||||
- MicroProfile
|
||||
- MongoDB
|
||||
- MoreUtils
|
||||
- MySQL
|
||||
- NetBIOS
|
||||
- NetcoredebugOutput
|
||||
- NetWeaver
|
||||
- NetworkManager
|
||||
- NetXen
|
||||
- NetXtreme
|
||||
- NFSv
|
||||
- NuGet
|
||||
- NVidia
|
||||
- NVMe
|
||||
- OAuth
|
||||
- objectClass
|
||||
- OmniSharp
|
||||
- OneConnect
|
||||
- OpenEXR
|
||||
- OpenID
|
||||
- OpenIPMI
|
||||
- OpenJDK
|
||||
- OpenRewrite
|
||||
- OpenSCAP
|
||||
- OpenShift
|
||||
- OpenSSH
|
||||
- OpenSSL
|
||||
- OpenStack
|
||||
- OpenTracing
|
||||
- OperatorHub
|
||||
- OpEx
|
||||
- OSBuild
|
||||
- PaaS
|
||||
- PackageKit
|
||||
- PathTools
|
||||
- PCIe
|
||||
- PipeWire
|
||||
- PostgreSQL
|
||||
- PostScript
|
||||
- PowerPC
|
||||
- PowerShell
|
||||
- ProLiant
|
||||
- PulseAudio
|
||||
- PyPA
|
||||
- PyPI
|
||||
- QLogic
|
||||
- ReaR
|
||||
- RedBoot
|
||||
- relaxngDatatype
|
||||
- RESTEasy
|
||||
- RHEL
|
||||
- RoCE
|
||||
- SaaS
|
||||
- SeaBIOS
|
||||
- SELinux
|
||||
- SmallRye
|
||||
- SmartNIC
|
||||
- SmartState
|
||||
- SQLite
|
||||
- StarOffice
|
||||
- STMicroelectronics
|
||||
- SuperLU
|
||||
- SysV
|
||||
- TiB
|
||||
- TuneD
|
||||
- TypeScript
|
||||
- UltraSPARC
|
||||
- USBGuard
|
||||
- vDisk
|
||||
- vHost
|
||||
- vSphere
|
||||
- WebAuthn
|
||||
- WebSocket
|
||||
- WireGuard
|
||||
- XEmacs
|
||||
- xPaaS
|
||||
- XString
|
||||
- XWayland
|
||||
- YouTube
|
||||
- ZCentral
|
||||
|
|
@ -1,186 +0,0 @@
|
|||
---
|
||||
extends: existence
|
||||
ignorecase: true
|
||||
level: suggestion
|
||||
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/passivevoice/
|
||||
message: "'%s' is passive voice. In general, use active voice. Consult the style guide for acceptable use of passive voice."
|
||||
# source: "https://redhat-documentation.github.io/supplementary-style-guide/#prerequisites; IBM - Voice, p.35"
|
||||
raw:
|
||||
- \b(am|are|were|being|is|been|was|be)\b\s*
|
||||
tokens:
|
||||
- '[\w]+ed'
|
||||
- awoken
|
||||
- beat
|
||||
- become
|
||||
- been
|
||||
- begun
|
||||
- bent
|
||||
- beset
|
||||
- bet
|
||||
- bid
|
||||
- bidden
|
||||
- bitten
|
||||
- bled
|
||||
- blown
|
||||
- born
|
||||
- bought
|
||||
- bound
|
||||
- bred
|
||||
- broadcast
|
||||
- broken
|
||||
- brought
|
||||
- built
|
||||
- burnt
|
||||
- burst
|
||||
- cast
|
||||
- caught
|
||||
- chosen
|
||||
- clung
|
||||
- come
|
||||
- cost
|
||||
- crept
|
||||
- cut
|
||||
- dealt
|
||||
- dived
|
||||
- done
|
||||
- drawn
|
||||
- dreamt
|
||||
- driven
|
||||
- drunk
|
||||
- dug
|
||||
- eaten
|
||||
- fallen
|
||||
- fed
|
||||
- felt
|
||||
- fit
|
||||
- fled
|
||||
- flown
|
||||
- flung
|
||||
- forbidden
|
||||
- foregone
|
||||
- forgiven
|
||||
- forgotten
|
||||
- forsaken
|
||||
- fought
|
||||
- found
|
||||
- frozen
|
||||
- given
|
||||
- gone
|
||||
- gotten
|
||||
- ground
|
||||
- grown
|
||||
- heard
|
||||
- held
|
||||
- hidden
|
||||
- hit
|
||||
- hung
|
||||
- hurt
|
||||
- kept
|
||||
- knelt
|
||||
- knit
|
||||
- known
|
||||
- laid
|
||||
- lain
|
||||
- leapt
|
||||
- learnt
|
||||
- led
|
||||
- left
|
||||
- lent
|
||||
- let
|
||||
- lighted
|
||||
- lost
|
||||
- made
|
||||
- meant
|
||||
- met
|
||||
- misspelt
|
||||
- mistaken
|
||||
- mown
|
||||
- overcome
|
||||
- overdone
|
||||
- overtaken
|
||||
- overthrown
|
||||
- paid
|
||||
- pled
|
||||
- proven
|
||||
- put
|
||||
- quit
|
||||
- read
|
||||
- rid
|
||||
- ridden
|
||||
- risen
|
||||
- run
|
||||
- rung
|
||||
- said
|
||||
- sat
|
||||
- sawn
|
||||
- seen
|
||||
- sent
|
||||
- set
|
||||
- sewn
|
||||
- shaken
|
||||
- shaven
|
||||
- shed
|
||||
- shod
|
||||
- shone
|
||||
- shorn
|
||||
- shot
|
||||
- shown
|
||||
- shrunk
|
||||
- shut
|
||||
- slain
|
||||
- slept
|
||||
- slid
|
||||
- slit
|
||||
- slung
|
||||
- smitten
|
||||
- sold
|
||||
- sought
|
||||
- sown
|
||||
- sped
|
||||
- spent
|
||||
- spilt
|
||||
- spit
|
||||
- split
|
||||
- spoken
|
||||
- spread
|
||||
- sprung
|
||||
- spun
|
||||
- stolen
|
||||
- stood
|
||||
- stridden
|
||||
- striven
|
||||
- struck
|
||||
- strung
|
||||
- stuck
|
||||
- stung
|
||||
- stunk
|
||||
- sung
|
||||
- sunk
|
||||
- swept
|
||||
- swollen
|
||||
- sworn
|
||||
- swum
|
||||
- swung
|
||||
- taken
|
||||
- taught
|
||||
- thought
|
||||
- thrived
|
||||
- thrown
|
||||
- thrust
|
||||
- told
|
||||
- torn
|
||||
- trodden
|
||||
- understood
|
||||
- upheld
|
||||
- upset
|
||||
- wed
|
||||
- wept
|
||||
- withheld
|
||||
- withstood
|
||||
- woken
|
||||
- won
|
||||
- worn
|
||||
- wound
|
||||
- woven
|
||||
- written
|
||||
- wrung
|
||||
|
|
@ -1,9 +0,0 @@
|
|||
= README for Rules from the IBM Style Guide
|
||||
|
||||
All rights for the IBM Style Guide belong to IBM.
|
||||
|
||||
Our sources of inspiration:
|
||||
|
||||
* link:https://github.com/errata-ai/IBM[The primary Vale implementation of the IBM Style Guide]
|
||||
|
||||
* https://www.ibm.com/developerworks/library/styleguidelines/index.html[The DeveloperWorks version of the IBM Style Guide]
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
<!-- vale off -->
|
||||
Copyright © 2014–2015, Jordan Suchow, Michael Pacer, and Lara A. Ross
|
||||
All rights reserved.
|
||||
|
||||
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
|
||||
|
||||
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
|
||||
|
||||
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
|
||||
|
||||
3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
|
@ -1,28 +0,0 @@
|
|||
<!-- vale off -->
|
||||
Based on [write-good](https://github.com/btford/write-good).
|
||||
|
||||
> Naive linter for English prose for developers who can't write good and wanna learn to do other stuff good too.
|
||||
|
||||
```
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2014 Brian Ford
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
```
|
||||
|
|
@ -1,12 +0,0 @@
|
|||
---
|
||||
extends: readability
|
||||
grade: 21
|
||||
level: suggestion
|
||||
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/readabilitygrade/
|
||||
message: "Grade level (%s) too high."
|
||||
metrics:
|
||||
- Automated Readability
|
||||
- Coleman-Liau
|
||||
- Flesch-Kincaid
|
||||
- Gunning Fog
|
||||
- SMOG
|
||||
|
|
@ -1,11 +0,0 @@
|
|||
---
|
||||
extends: substitution
|
||||
ignorecase: false
|
||||
level: suggestion
|
||||
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/releasenotes/
|
||||
message: "For release notes, consider using '%s' rather than '%s'."
|
||||
# source: "https://redhat-documentation.github.io/supplementary-style-guide/#release-notes"
|
||||
# swap maps tokens in form of bad: good
|
||||
swap:
|
||||
Now: With this update
|
||||
Previously: Before this update
|
||||
|
|
@ -1,10 +0,0 @@
|
|||
---
|
||||
extends: repetition
|
||||
message: "'%s' is repeated!"
|
||||
level: warning
|
||||
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/repeatedwords/
|
||||
ignorecase: false
|
||||
alpha: true
|
||||
tokens:
|
||||
- '[^\s\.]+'
|
||||
- '[^\s]+'
|
||||
|
|
@ -1,14 +0,0 @@
|
|||
---
|
||||
extends: existence
|
||||
ignorecase: true
|
||||
level: suggestion
|
||||
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/selfreferentialtext/
|
||||
message: "Avoid using self-referential text such as '%s'."
|
||||
# source: "IBM - Audience and medium, p. 22"
|
||||
tokens:
|
||||
- this topic
|
||||
- this module
|
||||
- this assembly
|
||||
- this chapter
|
||||
- this section
|
||||
- this subsection
|
||||
|
|
@ -1,9 +0,0 @@
|
|||
---
|
||||
extends: occurrence
|
||||
level: suggestion
|
||||
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/sentencelength/
|
||||
message: "Try to keep sentences to an average of 32 words or fewer."
|
||||
scope: sentence
|
||||
# source: "IBM - Conversational style"
|
||||
max: 32
|
||||
token: \b(\w+)\b
|
||||
|
|
@ -1,119 +0,0 @@
|
|||
---
|
||||
extends: substitution
|
||||
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"
|
||||
swap:
|
||||
"approximate(?:ly)?": about
|
||||
"objective(?! C?)": aim|goal
|
||||
absent: none|not here
|
||||
abundance: plenty
|
||||
accelerate: speed up
|
||||
accentuate: stress
|
||||
accompany: go with
|
||||
accomplish: carry out|do
|
||||
accorded: given
|
||||
accordingly: so
|
||||
accrue: add
|
||||
accurate: right|exact
|
||||
acquiesce: agree
|
||||
acquire: get|buy
|
||||
"(?<!an |the |IP |IPv[46] |MAC )address": discuss
|
||||
addressees: you
|
||||
adjacent to: next to
|
||||
adjustment: change
|
||||
admissible: allowed
|
||||
advantageous: helpful
|
||||
advise: tell
|
||||
aggregate: total
|
||||
aircraft: plane
|
||||
alleviate: ease
|
||||
allocate: assign|divide
|
||||
alternatively: or
|
||||
alternatives: choices|options
|
||||
ameliorate: improve
|
||||
amend: change
|
||||
anticipate: expect
|
||||
apparent: clear|plain
|
||||
ascertain: discover|find out
|
||||
assistance: help
|
||||
attain: meet
|
||||
attempt: try
|
||||
authorize: allow
|
||||
belated: late
|
||||
bestow: give
|
||||
cease: stop|end
|
||||
collaborate: work together
|
||||
commence: begin
|
||||
compensate: pay
|
||||
component: part
|
||||
comprise: form|include
|
||||
concerning: about
|
||||
confer: give|award
|
||||
consequently: so
|
||||
consolidate: merge
|
||||
constitutes: forms
|
||||
contains: has
|
||||
convene: meet
|
||||
demonstrate: show|prove
|
||||
depart: leave
|
||||
designate: choose
|
||||
desire: want|wish
|
||||
determine: decide|find
|
||||
detrimental: bad|harmful
|
||||
disclose: share|tell
|
||||
discontinue: stop
|
||||
disseminate: send|give
|
||||
eliminate: end
|
||||
elucidate: explain
|
||||
employ: use
|
||||
enclosed: inside|included
|
||||
encounter: meet
|
||||
endeavor: try
|
||||
enumerate: count
|
||||
equitable: fair
|
||||
equivalent: equal
|
||||
exclusively: only
|
||||
expedite: hurry
|
||||
facilitate: ease
|
||||
females: women
|
||||
finalize: complete|finish
|
||||
frequently: often
|
||||
identical: same
|
||||
incorrect: wrong
|
||||
indication: sign
|
||||
initiate: start|begin
|
||||
itemized: listed
|
||||
jeopardize: risk
|
||||
liaise: work with|partner with
|
||||
maintain: keep|support
|
||||
methodology: method
|
||||
modify: change
|
||||
monitor: check|watch
|
||||
multiple: many
|
||||
necessitate: cause
|
||||
notify: tell
|
||||
numerous: many
|
||||
obligate: bind|compel
|
||||
optimum: best|most
|
||||
permit: let
|
||||
portion: part
|
||||
possess: own
|
||||
previous: earlier
|
||||
previously: before
|
||||
prioritize: rank
|
||||
procure: buy
|
||||
provide: give|offer
|
||||
purchase: buy
|
||||
relocate: move
|
||||
solicit: request
|
||||
state-of-the-art: latest
|
||||
subsequent: later|next
|
||||
substantial: large
|
||||
sufficient: enough
|
||||
terminate: end
|
||||
transmit: send
|
||||
utilization: use
|
||||
utilize: use
|
||||
|
|
@ -1,20 +0,0 @@
|
|||
---
|
||||
extends: existence
|
||||
ignorecase: true
|
||||
level: warning
|
||||
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/slash/
|
||||
message: "Use either 'or' or 'and' in '%s'"
|
||||
# source: "IBM - Slashes, p. 68"
|
||||
tokens:
|
||||
- '(?<!/)\w+/\w+'
|
||||
exceptions:
|
||||
- "client/server"
|
||||
- "I/O"
|
||||
- "[Ii]nput/[Oo]utput"
|
||||
- "N/A"
|
||||
- "SSL/TLS"
|
||||
- "upstream/downstream"
|
||||
- "z/OS"
|
||||
- "z/OSMF"
|
||||
- "0/"
|
||||
- "C/C"
|
||||
|
|
@ -1,10 +0,0 @@
|
|||
---
|
||||
extends: existence
|
||||
level: error
|
||||
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/spacing/
|
||||
message: "Keep one space between words in '%s'."
|
||||
nonword: true
|
||||
# source: https://docs.microsoft.com/en-us/style-guide/punctuation/periods
|
||||
tokens:
|
||||
- "[a-z][.?!] {2,}[A-Z]"
|
||||
- "[a-z][.?!][A-Z]"
|
||||
|
|
@ -1,410 +0,0 @@
|
|||
#file: noinspection IncorrectFormatting
|
||||
---
|
||||
extends: spelling
|
||||
level: warning
|
||||
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/spelling/
|
||||
message: "Use correct American English spelling. Did you really mean '%s'?"
|
||||
# source: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/spelling/
|
||||
# A "filter" is a case-sensitive regular expression specifying words to ignore during spell checking.
|
||||
# Spelling rule applies to individual words
|
||||
filters:
|
||||
- '\.NET'
|
||||
- 'I/O'
|
||||
- 'Node\.js'
|
||||
- "[aA]ccessor"
|
||||
- "[aA]llowlist"
|
||||
- "[aA]utostart"
|
||||
- "[bB]ackfilling"
|
||||
- "[bB]ackported"
|
||||
- "[bB]acktrace"
|
||||
- "[bB]indable"
|
||||
- "[bB]oolean"
|
||||
- "[bB]reakpoint"
|
||||
- "[bB]reakpoints"
|
||||
- "[cC]he"
|
||||
- "[cC]lassloading"
|
||||
- "[cC]olocate"
|
||||
- "[cC]onfig"
|
||||
- "[dD]eclaratively"
|
||||
- "[dD]ecompiler"
|
||||
- "[dD]eserialization"
|
||||
- "[dD]esynchronize"
|
||||
- "[dD]esynchronized"
|
||||
- "[dD]ev[wW]orkspace"
|
||||
- "[dD]evfile"
|
||||
- "[dD]evfiles"
|
||||
- "[dD]ownstream"
|
||||
- "[dD]ownstreaming"
|
||||
- "[eE]xposal"
|
||||
- "[Ff]actories"
|
||||
- "[Ff]actory"
|
||||
- "[fF]ailback"
|
||||
- "[fF]ailover"
|
||||
- "[gG]bps"
|
||||
- "[gG]it"
|
||||
- "[gG]rafana"
|
||||
- "[hH]ardcoding"
|
||||
- "[hH]eatmap"
|
||||
- "[hH]ostname"
|
||||
- "[hH]yperconverged"
|
||||
- "[iI]node"
|
||||
- "[iI]tem"
|
||||
- "[jJ]et[bB]rains"
|
||||
- "[jJ]ournald"
|
||||
- "[jJ]ournaling"
|
||||
- "[kK]eycloak"
|
||||
- "[kK]eylime"
|
||||
- "[kK]eyring"
|
||||
- "[kK]eyrings"
|
||||
- "[lL]ibvirt"
|
||||
- "[lL]icensor"
|
||||
- "[lL]iveness"
|
||||
- "[lL]oopback"
|
||||
- "[mM]atrixes"
|
||||
- "[mM]ebibytes"
|
||||
- "[mM]iddleware"
|
||||
- "[mM]illicores"
|
||||
- "[mM]ixin"
|
||||
- "[mM]ixins"
|
||||
- "[mM]odularization"
|
||||
- "[mM]ulticluster"
|
||||
- "[mM]ultihost"
|
||||
- "[mM]ultinode"
|
||||
- "[mM]ultithread"
|
||||
- "[mM]ultitenant"
|
||||
- "[mM]ultiuser"
|
||||
- "[mM]ultizone"
|
||||
- "[nN]amespace"
|
||||
- "[nN]amespaces"
|
||||
- "[oO]nboarding"
|
||||
- "[oO]perator"
|
||||
- "[oO]verridable"
|
||||
- "[pP]reconfigured"
|
||||
- "[pP]regenerated"
|
||||
- "[pP]ulldown"
|
||||
- "[pP]repend"
|
||||
- "[pP]repended"
|
||||
- "[pP]roductize"
|
||||
- "[pP]roductized"
|
||||
- "[rR]eadonly"
|
||||
- "[rR]ebalance"
|
||||
- "[rR]ebalances"
|
||||
- "[rR]ebalancing"
|
||||
- "[rR]ebase"
|
||||
- "[rR]ebased"
|
||||
- "[rR]ecertification"
|
||||
- "[rR]ecertifications"
|
||||
- "[rR]eshard"
|
||||
- "[rR]esharding"
|
||||
- "[rR]eshards"
|
||||
- "[rR]esyncing"
|
||||
- "[rR]ollout"
|
||||
- "[rR]ollouts"
|
||||
- "[rR]oundtable"
|
||||
- "[rR]oundtables"
|
||||
- "[rR]uleset"
|
||||
- "[rR]unlevel"
|
||||
- "[rR]unlevels"
|
||||
- "[rR]untime"
|
||||
- "[rR]untimes"
|
||||
- "[sS]crollbar"
|
||||
- "[sS]erializer"
|
||||
- "[sS]erialization"
|
||||
- "[sS]erializable"
|
||||
- "[sS]erverless"
|
||||
- "[sS]ervlet"
|
||||
- "[sS]harding"
|
||||
- "[sS]ysctl"
|
||||
- "[Ss]u"
|
||||
- "[sS]ubcommand"
|
||||
- "[sS]ubcommands"
|
||||
- "[sS]ubmenu"
|
||||
- "[sS]ubmenus"
|
||||
- "[sS]ubnetwork"
|
||||
- "[sS]ubnetworks"
|
||||
- "[sS]ubpackage"
|
||||
- "[sS]ubpackages"
|
||||
- "[sS]ubpath"
|
||||
- "[sS]ubpaths"
|
||||
- "[sS]ubstep"
|
||||
- "[sS]ubsteps"
|
||||
- "[sS]ubtest"
|
||||
- "[sS]ubtests"
|
||||
- "[sS]ubuser"
|
||||
- "[sS]ubusers"
|
||||
- "[sS]ubvolume"
|
||||
- "[sS]ubvolumes"
|
||||
- "[sS]ystemd"
|
||||
- "[tT]emplated"
|
||||
- "[tT]heia"
|
||||
- "[tT]olerations"
|
||||
- "[tT]raceback"
|
||||
- "[tT]ruststore"
|
||||
- "[uU]ncomment"
|
||||
- "[uU]ndercloud"
|
||||
- "[uU]ninstallation"
|
||||
- "[uU]nmount"
|
||||
- "[uU]nmounting"
|
||||
- "[uU]nported"
|
||||
- "[uU]nstaged"
|
||||
- "[uU]ntrusted"
|
||||
- "[uU]psell"
|
||||
- "[uU]pselling"
|
||||
- "[vV]alidator"
|
||||
- "Let\\'s Encrypt"
|
||||
- adoc
|
||||
- AGPLv
|
||||
- Agroal
|
||||
- Annobin
|
||||
- Ansible
|
||||
- Antora
|
||||
- API
|
||||
- Applixware
|
||||
- Asciidoctor
|
||||
- AssertJ
|
||||
- autolink
|
||||
- aws
|
||||
- AWS
|
||||
- Azure
|
||||
- Bierner
|
||||
- Bitbucket
|
||||
- BOM
|
||||
- Bonjour
|
||||
- Bouncy Castle
|
||||
- btn
|
||||
- Btrfs
|
||||
- Bugzilla
|
||||
- camelCase
|
||||
- CentOS
|
||||
- Ceph
|
||||
- cephfs
|
||||
- cgroup
|
||||
- Che-Theia
|
||||
- Ciphertext
|
||||
- Civetweb
|
||||
- classloader
|
||||
- classpath
|
||||
- Cloudbursting
|
||||
- Cloudwashing
|
||||
- CodeReady
|
||||
- ConfigMaps?
|
||||
- Containerfile
|
||||
- Containerfiles
|
||||
- Cookiecutter
|
||||
- CPUs
|
||||
- CR
|
||||
- CRD
|
||||
- CRDs
|
||||
- CRs
|
||||
- CSIDriver
|
||||
- CSINode
|
||||
- CSVs
|
||||
- Ctrl
|
||||
- CVEs
|
||||
- Cygmon
|
||||
- DaemonSet
|
||||
- Datadog
|
||||
- Dev
|
||||
- DevWorkspace
|
||||
- Dex
|
||||
- DNS
|
||||
- Docker
|
||||
- Dockerfile
|
||||
- Dockerfiles
|
||||
- Dotnet
|
||||
- Dyninst
|
||||
- Endevor
|
||||
- Endian
|
||||
- endif
|
||||
- eServer
|
||||
- Esprima
|
||||
- etcd
|
||||
- Exif
|
||||
- extranet
|
||||
- Fabrice
|
||||
- Facter
|
||||
- Failsafe
|
||||
- FDs
|
||||
- Fernflower
|
||||
- firewalld
|
||||
- Flathub
|
||||
- Flatpak
|
||||
- Fortran
|
||||
- Funqy
|
||||
- GCC
|
||||
- GIDs
|
||||
- GitHub
|
||||
- GitLab
|
||||
- Gluster
|
||||
- GNUPro
|
||||
- GraalVM
|
||||
- Gradle
|
||||
- GraphQL
|
||||
- greenboot
|
||||
- Grayscale
|
||||
- GTIDs?
|
||||
- GUI
|
||||
- Hashicorp
|
||||
- Helgrind
|
||||
- Helm
|
||||
- Homebrew
|
||||
- htmltest
|
||||
- http
|
||||
- HTTP
|
||||
- https
|
||||
- HTTPS
|
||||
- IDE
|
||||
- IDEs
|
||||
- IKEv
|
||||
- Infinispan
|
||||
- Intelephense
|
||||
- IntelliJ
|
||||
- IPsec
|
||||
- ISeries
|
||||
- IPPool
|
||||
- IPsec
|
||||
- IPv
|
||||
- ISVs
|
||||
- Itanium
|
||||
- Jakarta
|
||||
- Jandex
|
||||
- Java
|
||||
- Jave
|
||||
- JBang
|
||||
- JBoss
|
||||
- Jira
|
||||
- Jolokia
|
||||
- Joyent
|
||||
- JUnit
|
||||
- jvm
|
||||
- JVM
|
||||
- Kafka
|
||||
- kbd
|
||||
- keystore
|
||||
- Kibana
|
||||
- Knative
|
||||
- Knowledgebase
|
||||
- Kogito
|
||||
- Kompose
|
||||
- kubelet
|
||||
- Kubespray
|
||||
- Kylin
|
||||
- Laravel
|
||||
- LGPLv
|
||||
- librados
|
||||
- librbd
|
||||
- libOSMesa
|
||||
- Lombok
|
||||
- Makefile
|
||||
- Mattermost
|
||||
- Maven
|
||||
- MicroProfile
|
||||
- Microsoft
|
||||
- Minikube
|
||||
- Minishift
|
||||
- Mirantis
|
||||
- Mockito
|
||||
- MongoDB
|
||||
- Multipath
|
||||
- MySQL
|
||||
- Nagios
|
||||
- Narayana
|
||||
- Neoverse
|
||||
- NetcoredebugOutput
|
||||
- Netty
|
||||
- Newdoc
|
||||
- NFSv
|
||||
- Nginx
|
||||
- npm
|
||||
- NuGet
|
||||
- NVidia
|
||||
- NVMe
|
||||
- OAuth
|
||||
- objectClass
|
||||
- ocp
|
||||
- OmniSharp
|
||||
- OpenID
|
||||
- OpenJDK
|
||||
- OpenRewrite
|
||||
- OpenShift
|
||||
- OpenTracing
|
||||
- OSBuild
|
||||
- osd
|
||||
- OSs
|
||||
- PCIe
|
||||
- PDFs?
|
||||
- PHP
|
||||
- PIDs
|
||||
- Podman
|
||||
- PostgreSQL
|
||||
- PowerShell
|
||||
- Prometheus
|
||||
- proxied
|
||||
- Pytorch
|
||||
- qdmanage
|
||||
- qdstat
|
||||
- qeth
|
||||
- QLogic
|
||||
- Quarkiverse
|
||||
- Quarkus
|
||||
- Quiltflower
|
||||
- Qute
|
||||
- Realtime
|
||||
- Redis
|
||||
- Redistributions
|
||||
- relaxngDatatype
|
||||
- RESTEasy
|
||||
- Restic
|
||||
- Rolfe
|
||||
- Rollup
|
||||
- ROMs
|
||||
- rootful
|
||||
- rootless
|
||||
- RPMs
|
||||
- Sakila
|
||||
- sbt
|
||||
- SCM
|
||||
- SELinux
|
||||
- Semeru
|
||||
- Shadowman
|
||||
- SLAs
|
||||
- SmallRye
|
||||
- Spotify
|
||||
- startx
|
||||
- STMicroelectronics
|
||||
- Suchow
|
||||
- SVG
|
||||
- Symfony
|
||||
- Tekton
|
||||
- Telekom
|
||||
- Tensorflow
|
||||
- Texinfo
|
||||
- Toolset
|
||||
- Traefik
|
||||
- Uber
|
||||
- UIDs
|
||||
- URIs?
|
||||
- url
|
||||
- URLs?
|
||||
- USBGuard
|
||||
- Vale
|
||||
- Valgrind
|
||||
- vDisk
|
||||
- Velero
|
||||
- Vert.x
|
||||
- vHost
|
||||
- VMs
|
||||
- vsix
|
||||
- vSphere
|
||||
- WebAuthn
|
||||
- Webpack
|
||||
- WebSocket
|
||||
- Wildfly
|
||||
- Woopra
|
||||
- Wordpress
|
||||
- XString
|
||||
- XWayland
|
||||
- Yana
|
||||
- Yeoman
|
||||
- ZCentral
|
||||
- Zowe
|
||||
|
|
@ -1,329 +0,0 @@
|
|||
---
|
||||
extends: substitution
|
||||
ignorecase: true
|
||||
level: error
|
||||
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/termserrors/
|
||||
message: "Use '%s' rather than '%s'."
|
||||
# source: "https://redhat-documentation.github.io/supplementary-style-guide/#glossary-terms-conventions; IBM - Appendix C. Word usage, p. 300"
|
||||
action:
|
||||
name: replace
|
||||
# swap maps tokens in form of bad: good
|
||||
swap:
|
||||
"(?:Ctrl|control)-click": press Ctrl and click
|
||||
"(?<!kernel )oops": kernel oops
|
||||
"(?<!make the )transition": "make the transition|move|migrate|change"
|
||||
"(?<!mobile |cell )phone": "telephone|cell phone|mobile phone"
|
||||
"(?<!Mozilla )Firefox": Mozilla Firefox
|
||||
"(?<!Mozilla )Thunderbird": Mozilla Thunderbird
|
||||
"[bB]asic [aA]uth": Basic HTTP authentication (first instance)|Basic authentication
|
||||
"a lot(?: of)?": many|much
|
||||
"AI": Assisted Installer
|
||||
"backward(?:-)?compatible": compatible with earlier versions
|
||||
"bottle neck|bottle-neck": bottleneck
|
||||
"bottom(?:-)?left": lower left|lower-left
|
||||
"bottom(?:-)?right": lower right|lower-right
|
||||
"broad cast|broad-cast": broadcast
|
||||
"down(?:-)?level": earlier|previous|not at the latest level
|
||||
"IPI": installer-provisioned infrastructure
|
||||
"mash(?: )?up": create
|
||||
"non-English(?!-language?)": in languages other than English|non-English-language
|
||||
"pop-up (?:blocker|killer)": software to block pop-up ad windows
|
||||
"re(?:-)?occur": recur
|
||||
"sort(?:-|/)?merge": sort|merge
|
||||
"top(?:-)?left": upper left|upper right|upper-left|upper-right
|
||||
"top(?:-)?right": upper left|upper right|upper-left|upper-right
|
||||
"UPI": user-provisioned infrastructure
|
||||
# "app(?:.)": app
|
||||
'(?<!\/)etc(?!\/)': and so on
|
||||
'(?<!IBM\s)S\/390|S90|S\s390': IBM S/390
|
||||
'(?<!self-)hosted engine(?! host)|hosted-engine(?! host)': self-hosted engine
|
||||
'(?<!virtual )floppy disk': diskette|diskette drive
|
||||
'(?<!virtual )floppy drive': diskette|diskette drive
|
||||
'(?<!virtual )floppy(?!\sdisk|\sdrive)': diskette|diskette drive
|
||||
'(?<!virtual )hard drive': hard disk|hard disk drive
|
||||
'\b(?:eg|e\.g\.)[\s,]': for example
|
||||
'\b(?:ie|i\.e\.)[\s,]': that is
|
||||
'fixed\sdisk\sdrive': hard disk drive
|
||||
'virtual\shard\sdisk': virtual hard drive
|
||||
a number of: several
|
||||
abort: cancel|stop
|
||||
administrate: administer
|
||||
advisor: adviser
|
||||
air wall: air gap
|
||||
all caps: uppercase
|
||||
alright|all right: "correct|as expected"
|
||||
analyse: analyze
|
||||
and/or: a or b|a, b, or both
|
||||
as long as: if|provided that
|
||||
as per: according to|as|as in
|
||||
autodetect: auto-detect
|
||||
back-level: earlier|previous|not at the latest level
|
||||
bi-monthly: bimonthly
|
||||
bi-weekly: biweekly
|
||||
Big Blue: IBM
|
||||
blink: flash
|
||||
blue screen of death: stop error
|
||||
boot diskette: boot disk
|
||||
bootloader: boot loader
|
||||
breadcrumbing: breadcrumb trail
|
||||
bugfix: bug fix
|
||||
builtin|built in: built-in
|
||||
byte code: bytecode
|
||||
canned: preplanned|preconfigured|predefined
|
||||
case insensitive: not case-sensitive
|
||||
catastrophic error: unrecoverable error
|
||||
CBE: Common Base Event
|
||||
CBTS: CICS BTS|BTS
|
||||
CD burner|burner: CD writer
|
||||
centre: center
|
||||
cipher text|cyphertext|cypher text|cipher-text|cypher-text: ciphertext
|
||||
cloud-bursting: cloudbursting
|
||||
cloud-washing: cloudwashing
|
||||
co-locate|collocate: colocate
|
||||
cold backup: offline backup
|
||||
cold boot: hardware restart
|
||||
cold start: hardware restart
|
||||
colour: color
|
||||
comes with: includes
|
||||
comma delimited|commadelimited: comma-delimited
|
||||
comma-delimited values|comma delimited values|comma separated values: comma-separated values
|
||||
command driven|commanddriven: command-driven
|
||||
command-language: command language
|
||||
componentization: component-based development|component model|component architecture|shared components
|
||||
componentize: develop components
|
||||
comprised of: consist of
|
||||
computer farm|computer ranch: server cluster|server farm
|
||||
connect with: connect to
|
||||
container based: container-based
|
||||
containerised: containerized
|
||||
context menu: menu|pop-up menu
|
||||
contextual help: help|context-sensitive help
|
||||
cross site scripting: cross-site scripting
|
||||
crossplatform|cross platform: cross-platform
|
||||
daisy-chain|daisychain: daisy chain
|
||||
datacenter|data-center|data centre|datacentre: data center
|
||||
datamirroring|data-mirroring: data mirroring
|
||||
datapath: data path
|
||||
datum: data
|
||||
de-bug: debug
|
||||
debuggable: debug
|
||||
deconfigure: unconfigure
|
||||
deinstall: uninstall
|
||||
deinstallation: uninstallation
|
||||
demilitarized zone: DMZ
|
||||
demon: daemon
|
||||
deployment configuration: deployment
|
||||
depress: press|type
|
||||
deregister: unregister
|
||||
desire: want|required
|
||||
desire|wish: need
|
||||
desk top|desk-top: desktop
|
||||
destroy: delete from the database
|
||||
details pane: details view
|
||||
different than|different to: different from
|
||||
disklabel|disk-label: disk label
|
||||
dismount: demount|unmount|remove
|
||||
domain mode: managed domain
|
||||
domainname|domain-name: domain name
|
||||
down-load|down load: download
|
||||
down-stream|down stream: downstream
|
||||
downgrade: upgrade|fallback|fall back|rollback|roll back
|
||||
downward compatible: compatible with earlier versions
|
||||
drag and drop: drag
|
||||
drill up: navigate
|
||||
dualboot|dual boot: dual-boot
|
||||
e-fix: fix|interim fix
|
||||
eFix: fix|interim fix
|
||||
emphasise: emphasize
|
||||
end user: user
|
||||
end-user interface: graphical interface|interface
|
||||
enum: data enumeration
|
||||
env: environment
|
||||
EUI: graphical user interface|interface
|
||||
fill in: complete|enter|specify
|
||||
finalise: finalize
|
||||
firm ware|firm-ware: firmware
|
||||
flavor: version|method
|
||||
floating-point: floating point
|
||||
focussed: focused
|
||||
fore-ground|forground: foreground
|
||||
forward compatible: compatible with later versions
|
||||
gray-scale|gray scale: grayscale
|
||||
gzip: compress
|
||||
gzipped: archive|compressed file
|
||||
hard file: hard disk|hard disk drive
|
||||
hardcode: hard code
|
||||
hardcoded: hard-coded
|
||||
healthcheck|health-check: health check
|
||||
helpdesk|help-desk: help desk
|
||||
hence: therefore
|
||||
hosted engine host|hosted-engine host|self-hosted engine host|(?<!self-)hosted engine node|hosted-engine node: self-hosted engine node
|
||||
hostgroup: host group
|
||||
hot-line: hotline
|
||||
hotadd|hot-add: hot add
|
||||
hotplug|hot-plug: hot plug
|
||||
hotswap|hot-swap: hot swap
|
||||
hyper-converged: hyperconverged
|
||||
i-fix: interim fix
|
||||
i-Fix: interim fix
|
||||
IBM's: IBM
|
||||
ifix: interim fix
|
||||
iFix: interim fix
|
||||
in order to: to
|
||||
in other words: for example|that is
|
||||
in spite of: regardless of|despite
|
||||
in the event: in case|if|when
|
||||
inactivate: deactivate
|
||||
information technology: IT
|
||||
insure: ensure
|
||||
Internet address: IP address|URL|Internet email address|web address
|
||||
irrecoverable: unrecoverable
|
||||
keep in mind: remember
|
||||
kernelspace: kernel-space
|
||||
labour: labor
|
||||
laptop: notebook
|
||||
large page|super page: huge page
|
||||
launch: start|open
|
||||
learnt: learned
|
||||
leave out: omit
|
||||
left-hand: left
|
||||
leverage: use
|
||||
line cord: power cable|power cord
|
||||
Linux specific|chip specific: specific
|
||||
live broker: master broker
|
||||
live only: live-only
|
||||
load-balance|load-balancing: load balance
|
||||
look at: examine
|
||||
lots of|bunches of: many
|
||||
main directory: root directory
|
||||
make sure: verify
|
||||
manpage: man page
|
||||
matrices: matrixes
|
||||
memory stick: USB flash drive
|
||||
menu driven|menudriven: menu-driven
|
||||
microcomputer: PC
|
||||
motherboard: system board
|
||||
mouse over: point to|move the mouse pointer over
|
||||
mouse-button|mousebutton: mouse button
|
||||
multi site|multi-site: multisite
|
||||
multi-processing: multiprocessing
|
||||
multi-tenant: multitenant
|
||||
network-centric computing: network computing
|
||||
nonrecoverable: unrecoverable
|
||||
nonsecure|non-secure: insecure
|
||||
notion: concept
|
||||
offline storage: auxiliary storage
|
||||
OK button: OK
|
||||
okay: OK
|
||||
on ramp: access method
|
||||
on the fly: dynamically|as needed|in real time|immediately
|
||||
on the other hand: however|alternatively|conversely
|
||||
on-ramp: access method
|
||||
op-code: opcode
|
||||
openshit: OpenShift
|
||||
open-source|OpenSource|opensource: open source
|
||||
organise: organize
|
||||
organised: organized
|
||||
organising: organizing
|
||||
over-ride|over ride: override
|
||||
pain point: challenge|concern|difficulty|issue
|
||||
parent task: parent process
|
||||
passive broker: slave broker
|
||||
perfcounter: performance counter
|
||||
perimeter network: DMZ
|
||||
plaintext|plain-text|cleartext|clear text: plain text
|
||||
plug in|plug ins: plugin
|
||||
pojo: data model
|
||||
power down: turn off
|
||||
power off: turn off
|
||||
power on: turn on
|
||||
preload: preinstall|preinstalled
|
||||
preloaded: preinstall|preinstalled
|
||||
prepend: add a prefix to
|
||||
proof of concepts: proofs of concept|proofs of concept
|
||||
pseudo ops|pseudoops: pseudo-ops
|
||||
pull-down: pulldown
|
||||
recognise: recognize
|
||||
regex: regular expression
|
||||
remote-access server: remote access server
|
||||
remote-access: remote access
|
||||
right double-click: double right-click
|
||||
right now: now
|
||||
right-hand: right
|
||||
round table: roundtable
|
||||
rule of thumb: rule
|
||||
run level|run-level: runlevel
|
||||
sanity check: test|evaluate|validate|verify
|
||||
sanity test: test|evaluate|validate|verify
|
||||
screensaver: screen saver
|
||||
scroll bar|scroll-bar: scrollbar
|
||||
secondary storage: auxiliary storage
|
||||
selection button: left mouse button
|
||||
send out: emit
|
||||
serial database: nonpartitioned database environment
|
||||
sharename|Sharename: share name
|
||||
shift-click: press Shift and click
|
||||
ship: include|included
|
||||
Simple Object Access Protocol: SOAP
|
||||
single quote mark: single quotation mark
|
||||
single quote: single quotation mark
|
||||
SME routine: session management exit routine
|
||||
snapset|snapsets: snapshot set
|
||||
soundcard|sound-card: sound card
|
||||
specfile: spec file
|
||||
spelt: spelled
|
||||
stand-alone: standalone
|
||||
standalone mode: standalone server
|
||||
start up: start
|
||||
straight forward|straight-forward: straightforward
|
||||
sub version|(?<!Apache )Subversion: sub-version
|
||||
sub-command: subcommand
|
||||
sub-directory: subdirectory
|
||||
sub-menu: submenu
|
||||
sub-package: subpackage
|
||||
sunset: withdraw from service|withdraw from marketing|discontinue|no longer support
|
||||
super-user|super user: superuser
|
||||
swapspace: swap space
|
||||
switch off: turn off
|
||||
switch on: turn on
|
||||
sysprep tool|sysprep process|sysprep function: sysprep
|
||||
tarball: tar file
|
||||
terminate: end|stop
|
||||
text based: text-based
|
||||
textmode|text-mode: text mode
|
||||
the installer: installation program
|
||||
thin provisioned|thinly provisioned|thinly-provisioned: thin-provisioned
|
||||
thru: through|throughput
|
||||
thumbstick: USB flash drive
|
||||
thus: therefore
|
||||
tier-one|tier 1: tier-1
|
||||
timeframe|time-frame: time frame
|
||||
toggle off: toggle
|
||||
touchscreen: touch-sensitive screen
|
||||
trust store: truststore
|
||||
typo: typing error|typographical error
|
||||
uncheck: clear
|
||||
uncompress: decompress
|
||||
undeploy: remove|withdraw
|
||||
unselect: clear|deselect
|
||||
untar: extract
|
||||
unzip: extract|decompress
|
||||
up-grade|up grade: upgrade
|
||||
up-sell: upsell
|
||||
up-selling|up selling: upselling
|
||||
up-stream|up stream: upstream
|
||||
up-time|up time: uptime
|
||||
upward compatible: compatible with later versions
|
||||
utilize: use
|
||||
versus: compared to
|
||||
video-mode|videomode: video mode
|
||||
virtual diskette drive: virtual floppy drive
|
||||
virtual diskette: virtual floppy disk
|
||||
vs: compared to
|
||||
warning notice: attention notice
|
||||
web-enable: enable for the web
|
||||
wish: want
|
||||
wish|would like: want
|
||||
xsite: cross-site replication
|
||||
zero out: zero
|
||||
zonegroup|zone-group: zone group
|
||||
|
|
@ -1,41 +0,0 @@
|
|||
---
|
||||
extends: substitution
|
||||
ignorecase: false
|
||||
level: suggestion
|
||||
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/termssuggestions/
|
||||
message: "Depending on the context, consider using '%s' rather than '%s'."
|
||||
# source: "https://redhat-documentation.github.io/supplementary-style-guide/#glossary-terms-conventions; IBM - Appendix C. Word usage, p. 300"
|
||||
action:
|
||||
name: replace
|
||||
swap:
|
||||
"(?<!,) which": ", which (non restrictive clause preceded by a comma)|that (restrictive clause without a comma)"
|
||||
"(?<!by) using": by using|that uses
|
||||
"(?<!such )as": because|while
|
||||
", that": ", which (non restrictive clause preceded by a comma)|that (restrictive clause without a comma)"
|
||||
"[Bb]are metal|[Bb]are-metal(?! clusters?| compute| configuration| controls?| environments?| equipment| events?| hardware| hosts?| infrastructure| installations?| installers?| machines?| media| nodes?| provisioning| servers?| workers?)": bare metal (noun)|bare-metal (adjective)
|
||||
"shell(?! prompt| script)": shell prompt
|
||||
and so on: "appropriate descriptive wording, unless you list a clear sequence of elements"
|
||||
between: " - ' to indicate a 'range of numbers"
|
||||
Bps|bps: Bps (bytes per second)|bps (bits per second)
|
||||
CD|cd: cd (change directory command)|CD (compact disc)
|
||||
channel: repository
|
||||
client side|client-side: client-side (adjective)| client side (noun)
|
||||
Cloud: cloud
|
||||
code: write
|
||||
crash: fail|lock up|stop|stop responding
|
||||
functionality: functions # IBM
|
||||
Hammer|x86_64|x86-64|x64|64-bit x86: AMD64
|
||||
input|type: enter (followed by the text to enter in monospace) # https://redhat-documentation.github.io/supplementary-style-guide/#text-entry
|
||||
jar: compress|archive (verb)
|
||||
Navigate|navigate: '"click", "select", "browse", or "go to"'
|
||||
recommend: direct users to take the recommended action
|
||||
refer to: see
|
||||
roll-out|roll out|rollout: roll out (verb)|rollout (noun)
|
||||
Router: AMQ Interconnect
|
||||
segfault: segmentation fault
|
||||
tar: compress|archive
|
||||
thru|through: "' - ' (range)|by using|finished|completed"
|
||||
unjar: extract (verb)
|
||||
user space|userspace|user-space: user space (noun)| user-space (modifier)
|
||||
zip: compress
|
||||
information on: information about
|
||||
|
|
@ -1,22 +0,0 @@
|
|||
---
|
||||
extends: substitution
|
||||
ignorecase: true
|
||||
level: warning
|
||||
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/termswarnings/
|
||||
message: "Consider using '%s' rather than '%s' unless updating existing content that uses the term."
|
||||
# source: "https://redhat-documentation.github.io/supplementary-style-guide/#glossary-terms-conventions; IBM - Appendix C. Word usage, p. 300"
|
||||
action:
|
||||
name: replace
|
||||
swap:
|
||||
CRUD: create, retrieve, update, and delete (CRUD)
|
||||
"I(?!/O)": you
|
||||
he|she: you
|
||||
host name: hostname
|
||||
may: might (for possiblity)|can (for ability)
|
||||
on-premises|on-prem|on premise: on-premise|on-site|in-house
|
||||
entitlement: repository|subscription
|
||||
plug-in: plugin
|
||||
sane: accurate|valid|verified
|
||||
tooling: tool|tools
|
||||
via: through|by|from|on|by using
|
||||
BIOS: firmware
|
||||
|
|
@ -1,152 +0,0 @@
|
|||
---
|
||||
extends: existence
|
||||
ignorecase: true
|
||||
level: suggestion
|
||||
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/usage/
|
||||
message: "Verify your use of '%s' with the word usage guidelines."
|
||||
# source: "https://redhat-documentation.github.io/supplementary-style-guide/#glossary-terms-conventions; IBM - Appendix C. Word usage, p. 300"
|
||||
tokens:
|
||||
- "pop-up (?:help|menu)"
|
||||
- "redbook(:s)?"
|
||||
- above
|
||||
- across
|
||||
- actionable
|
||||
- allow
|
||||
- alpha
|
||||
- alphabetic
|
||||
- alphabetical
|
||||
- architect
|
||||
- architected
|
||||
- as well as
|
||||
- assembler
|
||||
- attach
|
||||
- below
|
||||
- best-of-breed
|
||||
- billion
|
||||
- bitness
|
||||
- black box
|
||||
- board
|
||||
- both
|
||||
- bring up
|
||||
- business partner
|
||||
- cache
|
||||
- carry out
|
||||
- catch
|
||||
- central processing unit
|
||||
- check
|
||||
- choose
|
||||
- combination box
|
||||
- combo box
|
||||
- command console
|
||||
- Common Base Event
|
||||
- complete
|
||||
- congratulations
|
||||
- connect
|
||||
- consumability
|
||||
- consume
|
||||
- could
|
||||
- customers
|
||||
- daughterboard
|
||||
- decompress
|
||||
- decompressed
|
||||
- deploy
|
||||
- designed to
|
||||
- display
|
||||
- domestic
|
||||
- done
|
||||
- either
|
||||
- EPUB
|
||||
- execute
|
||||
- fatal
|
||||
- foo
|
||||
- foobar
|
||||
- foreign
|
||||
- free
|
||||
- freeze
|
||||
- fubar
|
||||
- geography
|
||||
- green screen
|
||||
- guarantee
|
||||
- hard boot
|
||||
- hash
|
||||
- hash sign
|
||||
- higher
|
||||
- hit
|
||||
- hover help
|
||||
- illegal
|
||||
- impact
|
||||
- info center
|
||||
- infocenter
|
||||
- information center
|
||||
- ingest
|
||||
- internationalize
|
||||
- invoke
|
||||
- itself
|
||||
- Java Development Kit # IBM
|
||||
- JDK #IBM
|
||||
- kill
|
||||
- latest
|
||||
- legacy
|
||||
- let
|
||||
- like
|
||||
- lite
|
||||
- localize
|
||||
- look and feel
|
||||
- look-and-feel
|
||||
- "(?<!virtual |Podman )machine(?! learning)"
|
||||
- master and slave
|
||||
- migrate
|
||||
- native
|
||||
- new
|
||||
- once
|
||||
- out-of-the-box
|
||||
- overhead
|
||||
- panel
|
||||
- partner
|
||||
- permit
|
||||
- please
|
||||
- pound sign
|
||||
- program temporary fix
|
||||
- proper
|
||||
- pull-down
|
||||
- quote
|
||||
- quoted
|
||||
- repair
|
||||
- reside
|
||||
- respective
|
||||
- respectively
|
||||
- sanity
|
||||
- select
|
||||
- selected
|
||||
- should
|
||||
- simply
|
||||
- since
|
||||
- slave
|
||||
- so
|
||||
- soft boot
|
||||
- Solution Partnership Centers
|
||||
- store
|
||||
- tab
|
||||
- text entry field
|
||||
- text field
|
||||
- themselves
|
||||
- then
|
||||
- there are
|
||||
- there is
|
||||
- this means
|
||||
- throw
|
||||
- throwable
|
||||
- time to value
|
||||
- time-tested
|
||||
- translate
|
||||
- trillion
|
||||
- twistie
|
||||
- twisty
|
||||
- uncompressed
|
||||
- unmount
|
||||
- updatable
|
||||
- very
|
||||
- we
|
||||
- whether or not
|
||||
- while
|
||||
- would
|
||||
|
|
@ -1,8 +0,0 @@
|
|||
---
|
||||
# source: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/userreplacedvalues/
|
||||
extends: substitution
|
||||
message: '%s, rather than %s'
|
||||
level: suggestion
|
||||
scope: raw
|
||||
swap:
|
||||
'__<[a-z_\x60]+-[\x60a-z_-]+>__': Separate words by underscores in user-replaced values
|
||||
|
|
@ -1,4 +0,0 @@
|
|||
{
|
||||
"feed": "https://github.com/redhat-documentation/vale-at-red-hat/releases.atom",
|
||||
"vale_version": ">=2.20.0"
|
||||
}
|
||||
57
vale-json.tmpl
Normal file
57
vale-json.tmpl
Normal file
|
|
@ -0,0 +1,57 @@
|
|||
{{- /* Modify Vale's output https://docs.errata.ai/vale/cli#--output */ -}}
|
||||
|
||||
{{- /* Keep track of our various counts */ -}}
|
||||
|
||||
{{- $e := 0 -}}
|
||||
{{- $w := 0 -}}
|
||||
{{- $s := 0 -}}
|
||||
{{- $f := 0 -}}
|
||||
|
||||
{{- /* Range over the linted files */ -}}
|
||||
|
||||
[
|
||||
{{- range $jdx, $file := .Files -}}
|
||||
|
||||
{{- $f = add1 $f -}}
|
||||
{{- $path := .Path -}}
|
||||
|
||||
{{- /* Range over the file's alerts */ -}}
|
||||
|
||||
{{- if $jdx -}},{{- end -}}
|
||||
{{- range $idx, $a := .Alerts -}}
|
||||
|
||||
{{- $error := "" -}}
|
||||
{{- if eq .Severity "error" -}}
|
||||
{{- $error = "critical" -}}
|
||||
{{- $e = add1 $e -}}
|
||||
{{- else if eq .Severity "warning" -}}
|
||||
{{- $error = "major" -}}
|
||||
{{- $w = add1 $w -}}
|
||||
{{- else -}}
|
||||
{{- $error = "minor" -}}
|
||||
{{- $s = add1 $s -}}
|
||||
{{- end}}
|
||||
|
||||
{{- /* Variables setup */ -}}
|
||||
|
||||
{{- $loc := printf "%d" .Line -}}
|
||||
{{- $check := printf "%s" .Check -}}
|
||||
{{- $message := printf "%s" .Message -}}
|
||||
{{- if $idx -}},{{- end -}}
|
||||
|
||||
{{- /* Output */ -}}
|
||||
|
||||
{
|
||||
"description": "{{$check}}: {{ $message }}",
|
||||
"fingerprint": "CI_COMMIT_SHA",
|
||||
"severity": "{{ $error }}",
|
||||
"location": {
|
||||
"path": "{{ $path }}",
|
||||
"lines": {
|
||||
"begin": {{ $loc }}
|
||||
}
|
||||
}
|
||||
}
|
||||
{{end -}}
|
||||
{{end -}}
|
||||
]
|
||||
Loading…
Add table
Add a link
Reference in a new issue