Skip to content

Commit

Permalink
Merge pull request #720 from aireilly/tighten-errors
Browse files Browse the repository at this point in the history
Tightens what we fail as errors in RH Vale Styles
  • Loading branch information
aireilly authored Feb 27, 2024
2 parents 03c0bfc + 2df1724 commit 99fd6f2
Show file tree
Hide file tree
Showing 11 changed files with 11 additions and 11 deletions.
2 changes: 1 addition & 1 deletion .vale/styles/AsciiDoc/SequentialNumberedCallouts.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
extends: script
message: "Numbered callout does not follow sequentially."
level: suggestion
level: warning
link: https://docs.asciidoctor.org/asciidoc/latest/verbatim/callouts/
scope: raw
script: |
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
extends: existence
scope: raw
level: error
level: suggestion
link: https://redhat-documentation.github.io/supplementary-style-guide/#commands-with-root-privileges
message: "Terminal code block missing a command prompt at the beginning of the line. For example output, prepend the code block with '.Example output'."
raw:
Expand Down
2 changes: 1 addition & 1 deletion .vale/styles/OpenShiftAsciiDoc/HardWrappedLines.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
extends: script
message: "Avoid hard-wrapped lines."
level: error
level: warning
scope: raw
script: |
text := import("text")
Expand Down
2 changes: 1 addition & 1 deletion .vale/styles/OpenShiftAsciiDoc/IdHasContextVariable.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
extends: existence
scope: raw
level: error
level: warning
link: https://github.com/openshift/openshift-docs/blob/main/contributing_to_docs/doc_guidelines.adoc#anchoring-in-module-files
message: "ID is missing the '_{context}' variable at the end of the ID."
raw:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
extends: occurrence
scope: raw
level: error
level: warning
link: https://github.com/openshift/openshift-docs/blob/main/contributing_to_docs/doc_guidelines.adoc#module-file-metadata
message: "Module is missing the '_mod-docs-content-type' variable."
min: 1
Expand Down
2 changes: 1 addition & 1 deletion .vale/styles/RedHat/CaseSensitiveTerms.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ 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'.
message: "Use '%s' rather than '%s'."
# source: "https://redhat-documentation.github.io/supplementary-style-guide/#glossary-terms-conventions"
action:
name: replace
Expand Down
2 changes: 1 addition & 1 deletion .vale/styles/RedHat/ConsciousLanguage.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ 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'.
message: "Use %s rather than '%s'."
action:
name: replace
swap:
Expand Down
2 changes: 1 addition & 1 deletion .vale/styles/RedHat/Hyphens.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ extends: substitution
ignorecase: true
level: warning
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/hyphens/
message: Use %s rather than '%s'.
message: "Use %s rather than '%s'."
action:
name: replace
# swap maps tokens in the form "bad: good"
Expand Down
2 changes: 1 addition & 1 deletion .vale/styles/RedHat/ProductCentricWriting.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@ extends: existence
ignorecase: true
level: suggestion
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/productcentricwriting/
message: Do not use transitive verb constructions like "%s" to grant abilities to inanimate objects. Whenever possible, use direct, user-focused sentences where the subject of the sentence performs the action.
message: "Do not use transitive verb constructions like '%s' to grant abilities to inanimate objects. Whenever possible, use direct, user-focused sentences where the subject of the sentence performs the action."
tokens:
- '(allows?|enables?|lets?|permits?)\s(you|customers|the customer|the user|users)'
2 changes: 1 addition & 1 deletion .vale/styles/RedHat/ReadabilityGrade.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ 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."
message: "Grade level ('%s') too high."
metrics:
- Automated Readability
- Coleman-Liau
Expand Down
2 changes: 1 addition & 1 deletion .vale/styles/RedHat/UserReplacedValues.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
extends: substitution
message: '%s, rather than %s'
message: "%s."
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/userreplacedvalues/
level: suggestion
scope: raw
Expand Down

0 comments on commit 99fd6f2

Please sign in to comment.