Skip to content

Commit b1ade8c

Browse files
Merge pull request #60420 from aireilly/adding-vale-vocab
2 parents ced31b9 + 973a4db commit b1ade8c

File tree

5 files changed

+40
-3
lines changed

5 files changed

+40
-3
lines changed

.gitignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,6 @@ dev_guide/builds/images/chained-build.png.cache
1515
bin
1616
commercial_package
1717
.vscode
18-
.vale
18+
.vale/styles/AsciiDoc
19+
.vale/styles/OpenShiftAsciiDoc
20+
.vale/styles/RedHat

.vale.ini

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,19 @@ MinAlertLevel = suggestion
44

55
Packages = RedHat, https://github.com/redhat-documentation/vale-at-red-hat/releases/latest/download/AsciiDoc.zip, https://github.com/redhat-documentation/vale-at-red-hat/releases/latest/download/OpenShiftAsciiDoc.zip
66

7-
#ignore files in dirs starting with `.` to avoid raising errors for `.vale/fixtures/*/testinvalid.adoc` files
7+
Vocab = OpenShiftDocs
8+
9+
# Ignore files in dirs starting with `.` to avoid raising errors for `.vale/fixtures/*/testinvalid.adoc` files
810
[[!.]*.adoc]
911
BasedOnStyles = RedHat, AsciiDoc
1012

11-
#optional: pass doc attributes to asciidoctor before linting
13+
# Optional: pass doc attributes to asciidoctor before linting
1214
#[asciidoctor]
1315
#openshift-enterprise = YES
1416

1517
# Disabling rules (NO)
1618
RedHat.ReleaseNotes = NO
19+
20+
# Use local OpenShiftDocs Vocab terms
21+
Vale.Terms = YES
22+
Vale.Avoid = YES
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Regex terms added to accept.txt are ignored by the Vale linter and override RedHat Vale rules.
2+
# Add terms that have a corresponding incorrectly capitalized form to reject.txt.
3+
4+
[Pp]assthrough
5+
Assisted Installer
6+
custom resource
7+
custom resources
8+
MetalLB
9+
Operator
10+
Operators
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Regex terms added to reject.txt are highlighted as errors by the Vale linter and override RedHat Vale rules.
2+
# Add terms that have a corresponding correctly capitalized form to accept.txt.
3+
4+
[Dd]eployment [Cc]onfigs?
5+
[Dd]eployment [Cc]onfigurations?
6+
[Oo]peratorize
7+
[Ss]ingle [Nn]ode OpenShift
8+
[Tt]hree [Nn]ode OpenShift
9+
AI
10+
configuration maps?
11+
minions?
12+
operators?
13+
SNO

modules/.vale.ini

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,11 @@ StylesPath = ../.vale/styles
22

33
MinAlertLevel = suggestion
44

5+
Vocab = OpenShiftDocs
6+
57
[[!.]*.adoc]
68
BasedOnStyles = OpenShiftAsciiDoc, AsciiDoc, RedHat
9+
10+
# Use local OpenShiftDocs Vocab terms
11+
Vale.Terms = YES
12+
Vale.Avoid = YES

0 commit comments

Comments
 (0)