From 2957750d1add4073ef79fa00f23b0720de5f205b Mon Sep 17 00:00:00 2001 From: wmat Date: Fri, 15 Nov 2024 11:26:49 -0500 Subject: [PATCH 01/13] Continue Vale GH action setup. --- .github/.vale.ini | 8 + .../styles/AsciiDoc/ClosedAttributeBlocks.yml | 7 + .github/styles/AsciiDoc/ClosedIdQuotes.yml | 7 + .../styles/AsciiDoc/ImageContainsAltText.yml | 8 + .../styles/AsciiDoc/LinkContainsLinkText.yml | 10 + .../styles/AsciiDoc/MatchingDotCallouts.yml | 47 ++ .../AsciiDoc/MatchingNumberedCallouts.yml | 62 +++ .../AsciiDoc/SequentialNumberedCallouts.yml | 59 ++ .github/styles/AsciiDoc/UnsetAttributes.yml | 49 ++ .../styles/AsciiDoc/ValidAdmonitionBlocks.yml | 30 + .github/styles/AsciiDoc/ValidCodeBlocks.yml | 30 + .github/styles/AsciiDoc/ValidConditions.yml | 37 ++ .github/styles/AsciiDoc/ValidTableBlocks.yml | 30 + .github/styles/RedHat/Abbreviations.yml | 9 + .github/styles/RedHat/CaseSensitiveTerms.yml | 327 +++++++++++ .github/styles/RedHat/Conjunctions.yml | 14 + .github/styles/RedHat/ConsciousLanguage.yml | 13 + .github/styles/RedHat/Contractions.yml | 44 ++ .github/styles/RedHat/Definitions.yml | 191 +++++++ .github/styles/RedHat/DoNotUseTerms.yml | 27 + .github/styles/RedHat/Ellipses.yml | 12 + .github/styles/RedHat/EmDash.yml | 11 + .github/styles/RedHat/GitLinks.yml | 12 + .github/styles/RedHat/HeadingPunctuation.yml | 11 + .github/styles/RedHat/Headings.yml | 261 +++++++++ .github/styles/RedHat/Hyphens.yml | 234 ++++++++ .../styles/RedHat/MergeConflictMarkers.yml | 13 + .github/styles/RedHat/ObviousTerms.yml | 16 + .github/styles/RedHat/OxfordComma.yml | 9 + .github/styles/RedHat/PascalCamelCase.yml | 190 +++++++ .github/styles/RedHat/PassiveVoice.yml | 193 +++++++ .../styles/RedHat/ProductCentricWriting.yml | 8 + .github/styles/RedHat/README-IBM.adoc | 9 + .github/styles/RedHat/README-proselint.md | 13 + .github/styles/RedHat/README-write-good.md | 28 + .github/styles/RedHat/ReadabilityGrade.yml | 9 + .github/styles/RedHat/ReleaseNotes.yml | 11 + .github/styles/RedHat/RepeatedWords.yml | 16 + .github/styles/RedHat/SelfReferentialText.yml | 14 + .github/styles/RedHat/SentenceLength.yml | 9 + .github/styles/RedHat/SimpleWords.yml | 120 ++++ .github/styles/RedHat/Slash.yml | 27 + .github/styles/RedHat/SmartQuotes.yml | 11 + .github/styles/RedHat/Spacing.yml | 10 + .github/styles/RedHat/Spelling.yml | 522 ++++++++++++++++++ .github/styles/RedHat/Symbols.yml | 9 + .github/styles/RedHat/TermsErrors.yml | 471 ++++++++++++++++ .github/styles/RedHat/TermsSuggestions.yml | 54 ++ .github/styles/RedHat/TermsWarnings.yml | 74 +++ .github/styles/RedHat/UserReplacedValues.yml | 16 + .github/styles/RedHat/Using.yml | 14 + .github/styles/RedHat/collate-output.tmpl | 66 +++ .github/styles/RedHat/meta.json | 4 + .github/styles/vocab.txt | 1 + .github/workflows/vale.yml | 17 + 55 files changed, 3504 insertions(+) create mode 100644 .github/.vale.ini create mode 100644 .github/styles/AsciiDoc/ClosedAttributeBlocks.yml create mode 100644 .github/styles/AsciiDoc/ClosedIdQuotes.yml create mode 100644 .github/styles/AsciiDoc/ImageContainsAltText.yml create mode 100644 .github/styles/AsciiDoc/LinkContainsLinkText.yml create mode 100644 .github/styles/AsciiDoc/MatchingDotCallouts.yml create mode 100644 .github/styles/AsciiDoc/MatchingNumberedCallouts.yml create mode 100644 .github/styles/AsciiDoc/SequentialNumberedCallouts.yml create mode 100644 .github/styles/AsciiDoc/UnsetAttributes.yml create mode 100644 .github/styles/AsciiDoc/ValidAdmonitionBlocks.yml create mode 100644 .github/styles/AsciiDoc/ValidCodeBlocks.yml create mode 100644 .github/styles/AsciiDoc/ValidConditions.yml create mode 100644 .github/styles/AsciiDoc/ValidTableBlocks.yml create mode 100644 .github/styles/RedHat/Abbreviations.yml create mode 100644 .github/styles/RedHat/CaseSensitiveTerms.yml create mode 100644 .github/styles/RedHat/Conjunctions.yml create mode 100644 .github/styles/RedHat/ConsciousLanguage.yml create mode 100644 .github/styles/RedHat/Contractions.yml create mode 100644 .github/styles/RedHat/Definitions.yml create mode 100644 .github/styles/RedHat/DoNotUseTerms.yml create mode 100644 .github/styles/RedHat/Ellipses.yml create mode 100644 .github/styles/RedHat/EmDash.yml create mode 100644 .github/styles/RedHat/GitLinks.yml create mode 100644 .github/styles/RedHat/HeadingPunctuation.yml create mode 100644 .github/styles/RedHat/Headings.yml create mode 100644 .github/styles/RedHat/Hyphens.yml create mode 100644 .github/styles/RedHat/MergeConflictMarkers.yml create mode 100644 .github/styles/RedHat/ObviousTerms.yml create mode 100644 .github/styles/RedHat/OxfordComma.yml create mode 100644 .github/styles/RedHat/PascalCamelCase.yml create mode 100644 .github/styles/RedHat/PassiveVoice.yml create mode 100644 .github/styles/RedHat/ProductCentricWriting.yml create mode 100644 .github/styles/RedHat/README-IBM.adoc create mode 100644 .github/styles/RedHat/README-proselint.md create mode 100644 .github/styles/RedHat/README-write-good.md create mode 100644 .github/styles/RedHat/ReadabilityGrade.yml create mode 100644 .github/styles/RedHat/ReleaseNotes.yml create mode 100644 .github/styles/RedHat/RepeatedWords.yml create mode 100644 .github/styles/RedHat/SelfReferentialText.yml create mode 100644 .github/styles/RedHat/SentenceLength.yml create mode 100644 .github/styles/RedHat/SimpleWords.yml create mode 100644 .github/styles/RedHat/Slash.yml create mode 100644 .github/styles/RedHat/SmartQuotes.yml create mode 100644 .github/styles/RedHat/Spacing.yml create mode 100644 .github/styles/RedHat/Spelling.yml create mode 100644 .github/styles/RedHat/Symbols.yml create mode 100644 .github/styles/RedHat/TermsErrors.yml create mode 100644 .github/styles/RedHat/TermsSuggestions.yml create mode 100644 .github/styles/RedHat/TermsWarnings.yml create mode 100644 .github/styles/RedHat/UserReplacedValues.yml create mode 100644 .github/styles/RedHat/Using.yml create mode 100644 .github/styles/RedHat/collate-output.tmpl create mode 100644 .github/styles/RedHat/meta.json create mode 100644 .github/styles/vocab.txt create mode 100644 .github/workflows/vale.yml diff --git a/.github/.vale.ini b/.github/.vale.ini new file mode 100644 index 0000000..0e01e99 --- /dev/null +++ b/.github/.vale.ini @@ -0,0 +1,8 @@ +StylesPath = .github/styles +MinAlertLevel = suggestion + +Packages = RedHat, AsciiDoc + +# Ignore files in dirs starting with `.` to avoid raising errors for `.vale/fixtures/*/testinvalid.adoc` files +[[!.]*.adoc] +BasedOnStyles = RedHat, AsciiDoc \ No newline at end of file diff --git a/.github/styles/AsciiDoc/ClosedAttributeBlocks.yml b/.github/styles/AsciiDoc/ClosedAttributeBlocks.yml new file mode 100644 index 0000000..b3e65fc --- /dev/null +++ b/.github/styles/AsciiDoc/ClosedAttributeBlocks.yml @@ -0,0 +1,7 @@ +--- +extends: existence +scope: raw +level: error +message: "Attribute block is not closed." +raw: + - '(?" + callout_regex := "^<(\\.)>" + + for line in text.split(scope, "\n") { + // trim trailing whitespace + line = text.trim_space(line) + if text.re_match(codeblock_callout_regex, line) { + //restart for new listingblock + num_callouts = 0 + //account for lines with multiple callouts + num_callouts_in_line := text.count(line, "<.>") + if num_callouts_in_line > 1 { + num_codeblock_callouts = num_codeblock_callouts + num_callouts_in_line + } else { + num_codeblock_callouts++ + } + } + + if text.re_match(callout_regex, line) { + num_callouts++ + if num_callouts > num_codeblock_callouts { + start := text.index(scope, line) + matches = append(matches, {begin: start, end: start + len(line)}) + } + if num_callouts == num_codeblock_callouts { + num_callouts = 0 + num_codeblock_callouts = 0 + } + } + } diff --git a/.github/styles/AsciiDoc/MatchingNumberedCallouts.yml b/.github/styles/AsciiDoc/MatchingNumberedCallouts.yml new file mode 100644 index 0000000..7e2c6f1 --- /dev/null +++ b/.github/styles/AsciiDoc/MatchingNumberedCallouts.yml @@ -0,0 +1,62 @@ +--- +extends: script +message: "Corresponding callout not found." +level: warning +link: https://docs.asciidoctor.org/asciidoc/latest/verbatim/callouts/ +scope: raw +script: | + text := import("text") + matches := [] + + // clean out multi-line comments + scope = text.re_replace("(?s) *(\n////.*?////\n)", scope, "") + //add a newline, it might be missing + scope += "\n" + + codeblock_callout_regex := ".+(<\\d+>)+" + callout_regex := "^<(\\d+)>" + codeblock_callouts := [] + inside := false + found := false + num_callouts := 0 + + num_lines := len(text.split(scope, "\n")) + + for line in text.split(scope, "\n") { + // trim trailing whitespace + line = text.trim_space(line) + if text.re_match(codeblock_callout_regex, line) { + inside = true + //account for lines with multiple callouts + for i := 1; i < num_lines; i++ { + //text.contains must be str, not regex + str := "<" + i + ">" + if text.contains(line, str) { + codeblock_callouts = append(codeblock_callouts, i) + } + } + } else if text.re_match(callout_regex, line) { + inside = false + found = false + num_callouts = 1 + for i in codeblock_callouts { + //cast int > string + j := text.itoa(i) + str := "<" + j + ">" + if text.contains(line, str) { + //setting found allows us to loop through the list of possible matches + found = true + } + num_callouts++ + } + if !found { + start := text.index(scope, line) + matches = append(matches, {begin: start, end: start + len(line)}) + } + } else if codeblock_callouts && inside == false { + //cycled through num_callouts, reset for next codeblock + if num_callouts == len(codeblock_callouts) { + codeblock_callouts = [] + } + } + } \ No newline at end of file diff --git a/.github/styles/AsciiDoc/SequentialNumberedCallouts.yml b/.github/styles/AsciiDoc/SequentialNumberedCallouts.yml new file mode 100644 index 0000000..0a195f5 --- /dev/null +++ b/.github/styles/AsciiDoc/SequentialNumberedCallouts.yml @@ -0,0 +1,59 @@ +--- +extends: script +message: "Numbered callout does not follow sequentially." +level: warning +link: https://docs.asciidoctor.org/asciidoc/latest/verbatim/callouts/ +scope: raw +script: | + text := import("text") + matches := [] + + // clean out multi-line comments + scope = text.re_replace("(?s) *(\n////.*?////\n)", scope, "") + //add a newline, it might be missing + scope += "\n" + + prev_num := 0 + callout_regex := "^<(\\d+)>" + listingblock_delim_regex := "^-{4,}$" + if_regex := "^ifdef::|ifndef::" + endif_regex := "^endif::\\[\\]" + inside_if := false + + for line in text.split(scope, "\n") { + // trim trailing whitespace + line = text.trim_space(line) + + // check if we're entering a conditional block + if text.re_match(if_regex, line) { + inside_if = true + } else if text.re_match(endif_regex, line) { + inside_if = false + } + + //reset count if we hit a listing block delimiter + if text.re_match(listingblock_delim_regex, line) { + prev_num = 0 + } + + //only count callouts where there are no ifdefs + if !inside_if { + if text.re_match(callout_regex, line) { + callout := text.re_find("<(\\d+)>", line) + for key, value in callout { + //trim angle brackets from string + trimmed := callout[key][0]["text"] + trimmed = text.trim_prefix(trimmed, "<") + trimmed = text.trim_suffix(trimmed, ">") + //cast string > int + num := text.atoi(trimmed) + //start counting + if num != prev_num+1 { + start := text.index(scope, line) + matches = append(matches, {begin: start, end: start + len(line)}) + } + prev_num = num + } + } + } + } diff --git a/.github/styles/AsciiDoc/UnsetAttributes.yml b/.github/styles/AsciiDoc/UnsetAttributes.yml new file mode 100644 index 0000000..7229e2a --- /dev/null +++ b/.github/styles/AsciiDoc/UnsetAttributes.yml @@ -0,0 +1,49 @@ +--- +extends: script +level: warning +message: "Set attribute directive does not have a corresponding unset attribute directive." +link: https://docs.asciidoctor.org/asciidoc/latest/attributes/unset-attributes/#unset-a-document-attribute-in-the-body +scope: raw +script: | + text := import("text") + matches := [] + + // trim extra whitespace + scope = text.trim_space(scope) + // add a newline, it might be missing + scope += "\n" + // clean out multi-line comments + scope = text.re_replace("(?s) *(\n////.*?////\n)", scope, "") + + attr_regex := "^:[\\w-_]+:.*$" + context_mod_docs_regex := "^:context|_content-type|_mod-docs-content-type:.*$" + attr_name_regex := ":[\\w-_]+:" + attr_name := "" + unset_attr_pref := "" + unset_attr_suff := "" + + for line in text.split(scope, "\n") { + if text.re_match(attr_regex, line) { + if !text.re_match(context_mod_docs_regex, line) { + start := text.index(scope, line) + matches = append(matches, {begin: start, end: start + len(line)}) + // re_find returns an array holding all matches + attr_name = ((text.re_find(attr_name_regex, line))[0][0])["text"] + unset_attr_pref = `^:!` + text.trim_prefix(attr_name, `:`) + unset_attr_suff = `^` + text.trim_suffix(attr_name, `:`) + `!:` + // loop through lines for every attr found + for line in text.split(scope, "\n") { + if text.re_match(unset_attr_pref, line) { + if len(matches) > 0 { + // remove the most recently added match + matches = matches[:len(matches)-1] + } else if text.re_match(unset_attr_suff, line) { + if len(matches) > 0 { + matches = matches[:len(matches)-1] + } + } + } + } + } + } + } diff --git a/.github/styles/AsciiDoc/ValidAdmonitionBlocks.yml b/.github/styles/AsciiDoc/ValidAdmonitionBlocks.yml new file mode 100644 index 0000000..1ebe018 --- /dev/null +++ b/.github/styles/AsciiDoc/ValidAdmonitionBlocks.yml @@ -0,0 +1,30 @@ +--- +extends: script +level: error +message: "Unterminated admonition block found in file." +link: https://docs.asciidoctor.org/asciidoc/latest/blocks/admonitions/ +scope: raw +script: | + text := import("text") + matches := [] + + // clean out multi-line comments + scope = text.re_replace("(?s) *(\n////.*?////\n)", scope, "") + //add a newline, it might be missing + scope += "\n" + + admon_delim_regex := "^={4}$" + count := 0 + + for line in text.split(scope, "\n") { + // trim trailing whitespace + line = text.trim_space(line) + if text.re_match(admon_delim_regex, line) { + count += 1 + start := text.index(scope, line) + matches = append(matches, {begin: start, end: start + len(line)}) + } else if count > 1 { + count = 0 // admonition block is closed, reset the count + matches = [] + } + } diff --git a/.github/styles/AsciiDoc/ValidCodeBlocks.yml b/.github/styles/AsciiDoc/ValidCodeBlocks.yml new file mode 100644 index 0000000..f7af5c1 --- /dev/null +++ b/.github/styles/AsciiDoc/ValidCodeBlocks.yml @@ -0,0 +1,30 @@ +--- +extends: script +level: error +message: "Unterminated listing block found in file." +link: https://docs.asciidoctor.org/asciidoc/latest/verbatim/listing-blocks/ +scope: raw +script: | + text := import("text") + matches := [] + + // clean out multi-line comments + scope = text.re_replace("(?s) *(\n////.*?////\n)", scope, "") + //add a newline, it might be missing + scope += "\n" + + listingblock_delim_regex := "^-{4}$" + count := 0 + + for line in text.split(scope, "\n") { + // trim trailing whitespace + line = text.trim_space(line) + if text.re_match(listingblock_delim_regex, line) { + count += 1 + start := text.index(scope, line) + matches = append(matches, {begin: start, end: start + len(line)}) + } else if count > 1 { + count = 0 // listing block is closed, reset the count + matches = [] + } + } diff --git a/.github/styles/AsciiDoc/ValidConditions.yml b/.github/styles/AsciiDoc/ValidConditions.yml new file mode 100644 index 0000000..1bc20cf --- /dev/null +++ b/.github/styles/AsciiDoc/ValidConditions.yml @@ -0,0 +1,37 @@ +--- +extends: script +level: error +message: "File contains unbalanced if statements. Review the file to ensure it contains matching opening and closing if statements." +link: https://docs.asciidoctor.org/asciidoc/latest/directives/ifdef-ifndef/ +scope: raw +script: | + text := import("text") + matches := [] + + // clean out multi-line comments + scope = text.re_replace("(?s) *(\n////.*?////\n)", scope, "") + //add a newline, it might be missing + scope += "\n" + + if_regex := "^ifdef::.+\\[\\]" + ifn_regex := "^ifndef::.+\\[\\]" + ifeval_regex := "ifeval::\\[.+\\]" + endif_regex := "^endif::.*\\[\\]" + + for line in text.split(scope, "\n") { + // trim trailing whitespace + line = text.trim_space(line) + if text.re_match(if_regex, line) || text.re_match(ifn_regex, line) || text.re_match(ifeval_regex, line) { + start := text.index(scope, line) + matches = append(matches, {begin: start, end: start + len(line)}) + } else if text.re_match(endif_regex, line) { + if len(matches) > 0 { + //remove the most recently added open ifdef match + matches = matches[:len(matches)-1] + } else if len(matches) == 0 { + //add orphan endif::[] statements + start := text.index(scope, line) + matches = append(matches, {begin: start, end: start + len(line)}) + } + } + } diff --git a/.github/styles/AsciiDoc/ValidTableBlocks.yml b/.github/styles/AsciiDoc/ValidTableBlocks.yml new file mode 100644 index 0000000..ecc74ff --- /dev/null +++ b/.github/styles/AsciiDoc/ValidTableBlocks.yml @@ -0,0 +1,30 @@ +--- +extends: script +level: error +message: "Unterminated table block found in file." +link: https://docs.asciidoctor.org/asciidoc/latest/tables/build-a-basic-table/ +scope: raw +script: | + text := import("text") + matches := [] + + // clean out multi-line comments + scope = text.re_replace("(?s) *(\n////.*?////\n)", scope, "") + //add a newline, it might be missing + scope += "\n" + + tbl_delim_regex := "^\\|={3,}$" + count := 0 + + for line in text.split(scope, "\n") { + // trim trailing whitespace + line = text.trim_space(line) + if text.re_match(tbl_delim_regex, line) { + count += 1 + start := text.index(scope, line) + matches = append(matches, {begin: start, end: start + len(line)}) + } else if count > 1 { + count = 0 //code block is closed, reset the count + matches = [] + } + } diff --git a/.github/styles/RedHat/Abbreviations.yml b/.github/styles/RedHat/Abbreviations.yml new file mode 100644 index 0000000..102fee4 --- /dev/null +++ b/.github/styles/RedHat/Abbreviations.yml @@ -0,0 +1,9 @@ +--- +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}' diff --git a/.github/styles/RedHat/CaseSensitiveTerms.yml b/.github/styles/RedHat/CaseSensitiveTerms.yml new file mode 100644 index 0000000..3e451ff --- /dev/null +++ b/.github/styles/RedHat/CaseSensitiveTerms.yml @@ -0,0 +1,327 @@ +--- +extends: substitution +ignorecase: false +level: error +link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/casesensitiveterms/ +message: "Use '%s' rather than '%s'." +action: + name: replace +swap: + "(?{7}\s.*$' diff --git a/.github/styles/RedHat/ObviousTerms.yml b/.github/styles/RedHat/ObviousTerms.yml new file mode 100644 index 0000000..fd3f2a3 --- /dev/null +++ b/.github/styles/RedHat/ObviousTerms.yml @@ -0,0 +1,16 @@ +--- +extends: existence +level: suggestion +# link: +message: "Consider not documenting %s because it is self-explanatory." +scope: sentence +# source: +action: + name: remove +tokens: + - 'User field' + - 'Username field' + - 'Password field' + - 'Mail field' + - 'Description field' + - 'Name field' diff --git a/.github/styles/RedHat/OxfordComma.yml b/.github/styles/RedHat/OxfordComma.yml new file mode 100644 index 0000000..2f9d108 --- /dev/null +++ b/.github/styles/RedHat/OxfordComma.yml @@ -0,0 +1,9 @@ +--- +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'." +scope: sentence +nonword: true +tokens: + - '(?:[^\s,]+,){1,} \w+ (?:and|or) \w+[.?!]' diff --git a/.github/styles/RedHat/PascalCamelCase.yml b/.github/styles/RedHat/PascalCamelCase.yml new file mode 100644 index 0000000..a2f3ea1 --- /dev/null +++ b/.github/styles/RedHat/PascalCamelCase.yml @@ -0,0 +1,190 @@ +--- +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 + - GBps + - 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 + - kBps + - KiB + - LangTags + - LGPLv + - libOSMesa + - LibreOffice + - libXNVCtrl + - LightPulse + - LinuxONE + - LiquidIO + - ManageIQ + - MariaDB + - MBps + - MegaRAID + - MiB + - MicroProfile + - MongoDB + - MoreUtils + - MySQL + - NetBIOS + - NetcoredebugOutput + - NetWeaver + - NetworkManager + - NetXen + - NetXtreme + - NFSv + - NMState + - NuGet + - NVidia + - NVMe + - OAuth + - objectClass + - OmniSharp + - OneConnect + - OpenEXR + - OpenID + - OpenIPMI + - OpenJDK + - OpenRAN + - OpenRewrite + - OpenSCAP + - OpenShift + - OpenSSH + - OpenSSL + - OpenStack + - OpenTelemetry + - OpenTracing + - OperatorHub + - OpEx + - OSBuild + - OTel + - 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 + - TBps + - TiB + - TuneD + - TypeScript + - UltraSPARC + - USBGuard + - vCenter + - vDisk + - vHost + - VMware + - vSphere + - vSwitch + - WebAuthn + - WebSocket + - WireGuard + - XEmacs + - xPaaS + - XString + - XWayland + - YouTube + - ZCentral diff --git a/.github/styles/RedHat/PassiveVoice.yml b/.github/styles/RedHat/PassiveVoice.yml new file mode 100644 index 0000000..67b16af --- /dev/null +++ b/.github/styles/RedHat/PassiveVoice.yml @@ -0,0 +1,193 @@ +--- +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 +exceptions: + - deprecated + - displayed + - imported + - supported + - tested + - trusted diff --git a/.github/styles/RedHat/ProductCentricWriting.yml b/.github/styles/RedHat/ProductCentricWriting.yml new file mode 100644 index 0000000..3721699 --- /dev/null +++ b/.github/styles/RedHat/ProductCentricWriting.yml @@ -0,0 +1,8 @@ +--- +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." +tokens: + - '(allows?|enables?|lets?|permits?)\s(you|customers|the customer|the user|users)' diff --git a/.github/styles/RedHat/README-IBM.adoc b/.github/styles/RedHat/README-IBM.adoc new file mode 100644 index 0000000..7e27b01 --- /dev/null +++ b/.github/styles/RedHat/README-IBM.adoc @@ -0,0 +1,9 @@ += 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] diff --git a/.github/styles/RedHat/README-proselint.md b/.github/styles/RedHat/README-proselint.md new file mode 100644 index 0000000..b08cef9 --- /dev/null +++ b/.github/styles/RedHat/README-proselint.md @@ -0,0 +1,13 @@ + +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. diff --git a/.github/styles/RedHat/README-write-good.md b/.github/styles/RedHat/README-write-good.md new file mode 100644 index 0000000..ba919b6 --- /dev/null +++ b/.github/styles/RedHat/README-write-good.md @@ -0,0 +1,28 @@ + +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. +``` diff --git a/.github/styles/RedHat/ReadabilityGrade.yml b/.github/styles/RedHat/ReadabilityGrade.yml new file mode 100644 index 0000000..a401a67 --- /dev/null +++ b/.github/styles/RedHat/ReadabilityGrade.yml @@ -0,0 +1,9 @@ +--- +extends: readability +grade: 9 +message: "Simplify your language. The calculated Flesch–Kincaid grade level of %s is above the recommended reading grade level of 9." +link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/readabilitygrade/ +level: suggestion +metrics: + - Flesch-Kincaid + diff --git a/.github/styles/RedHat/ReleaseNotes.yml b/.github/styles/RedHat/ReleaseNotes.yml new file mode 100644 index 0000000..10ee9c9 --- /dev/null +++ b/.github/styles/RedHat/ReleaseNotes.yml @@ -0,0 +1,11 @@ +--- +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 diff --git a/.github/styles/RedHat/RepeatedWords.yml b/.github/styles/RedHat/RepeatedWords.yml new file mode 100644 index 0000000..3893d9b --- /dev/null +++ b/.github/styles/RedHat/RepeatedWords.yml @@ -0,0 +1,16 @@ +--- +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 +action: + name: edit + params: + - regex + - '(\w+)(\s\w+)' # pattern + - "$1" # replace +tokens: + - '[^\s\.]+' + - '[^\s]+' diff --git a/.github/styles/RedHat/SelfReferentialText.yml b/.github/styles/RedHat/SelfReferentialText.yml new file mode 100644 index 0000000..36adbf4 --- /dev/null +++ b/.github/styles/RedHat/SelfReferentialText.yml @@ -0,0 +1,14 @@ +--- +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 diff --git a/.github/styles/RedHat/SentenceLength.yml b/.github/styles/RedHat/SentenceLength.yml new file mode 100644 index 0000000..c21f0bc --- /dev/null +++ b/.github/styles/RedHat/SentenceLength.yml @@ -0,0 +1,9 @@ +--- +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 diff --git a/.github/styles/RedHat/SimpleWords.yml b/.github/styles/RedHat/SimpleWords.yml new file mode 100644 index 0000000..452e7e4 --- /dev/null +++ b/.github/styles/RedHat/SimpleWords.yml @@ -0,0 +1,120 @@ +--- +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'." +action: + name: replace +swap: + "(?__' + - '<[a-z_]+-[a-z_-]+>' \ No newline at end of file diff --git a/.github/styles/RedHat/Using.yml b/.github/styles/RedHat/Using.yml new file mode 100644 index 0000000..869cdc9 --- /dev/null +++ b/.github/styles/RedHat/Using.yml @@ -0,0 +1,14 @@ +--- +extends: sequence +message: "Use 'by using' instead of 'using' when it follows a noun for clarity and grammatical correctness." +link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/using/ +level: warning +action: + name: edit + params: + - regex + - '(\w+)( using)' # pattern + - "$1 by using" # replace +tokens: + - tag: NN|NNP|NNPS|NNS + - pattern: using diff --git a/.github/styles/RedHat/collate-output.tmpl b/.github/styles/RedHat/collate-output.tmpl new file mode 100644 index 0000000..449aa42 --- /dev/null +++ b/.github/styles/RedHat/collate-output.tmpl @@ -0,0 +1,66 @@ +{{- /* See https://github.com/errata-ai/vale/issues/614 */ -}} +{{- /* See https://vale.sh/manual/output/ */ -}} + +{{- /* Keep track of our various counts */ -}} + +{{- $e := 0 -}} +{{- $w := 0 -}} +{{- $s := 0 -}} +{{- $f := 0 -}} + +{{- /* Range over the linted files */ -}} + +{{- range .Files}} +{{$table := newTable true}} + +{{- $f = add1 $f -}} +{{- .Path | underline | indent 1 -}} +{{- "\n" -}} + +{{- $msgToLoc := dict -}} +{{- $msgToLvl := dict -}} +{{- $msgToChk := dict -}} + +{{- /* Range over the file's alerts */ -}} + +{{- range .Alerts -}} + +{{- $error := "" -}} +{{- if eq .Severity "error" -}} + {{- $error = .Severity | red -}} + {{- $e = add1 $e -}} +{{- else if eq .Severity "warning" -}} + {{- $error = .Severity | yellow -}} + {{- $w = add1 $w -}} +{{- else -}} + {{- $error = .Severity | blue -}} + {{- $s = add1 $s -}} +{{- end}} + +{{- $loc := printf "%d:%d" .Line (index .Span 0) -}} + +{{- $locations := get $msgToLoc .Message -}} + +{{- $_ := set $msgToLoc .Message (cat $locations $loc) -}} +{{- $_ := set $msgToLvl .Message $error -}} +{{- $_ := set $msgToChk .Message .Check -}} + +{{end -}} + +{{- range keys $msgToLoc -}} + +{{- $msg := . -}} +{{- $loc := trimPrefix "," ((splitList " " (get $msgToLoc $msg)) | join ",") -}} +{{- $lvl := get $msgToLvl $msg -}} +{{- $chk := get $msgToChk $msg -}} + +{{- $row := list $loc $lvl $msg $chk | toStrings -}} +{{- $table = addRow $table $row -}} + +{{end -}} + +{{- $table = renderTable $table -}} + +{{end}} + +{{- $e}} {{"errors" | red}}, {{$w}} {{"warnings" | yellow}} and {{$s}} {{"suggestions" | blue}} in {{$f}} {{$f | int | plural "file" "files"}}. diff --git a/.github/styles/RedHat/meta.json b/.github/styles/RedHat/meta.json new file mode 100644 index 0000000..6099c80 --- /dev/null +++ b/.github/styles/RedHat/meta.json @@ -0,0 +1,4 @@ +{ + "feed": "https://github.com/redhat-documentation/vale-at-red-hat/releases.atom", + "vale_version": ">=2.20.0" +} diff --git a/.github/styles/vocab.txt b/.github/styles/vocab.txt new file mode 100644 index 0000000..2e018e0 --- /dev/null +++ b/.github/styles/vocab.txt @@ -0,0 +1 @@ +# Place holder for RISC-V style vacabulary. \ No newline at end of file diff --git a/.github/workflows/vale.yml b/.github/workflows/vale.yml new file mode 100644 index 0000000..eb86c4b --- /dev/null +++ b/.github/workflows/vale.yml @@ -0,0 +1,17 @@ +name: reviewdog +on: [pull_request] + +jobs: + vale: + name: runner / vale + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: errata-ai/vale-action@v2.1.1 + with: + version: 2.17.0 + files: /src/*.adoc + reporter: github-pr-check + fail_on_error: true + filter_mode: nofilter + token: ${{secrets.VALE_GITHUB_TOKEN}} \ No newline at end of file From 1a5cd04c81b927805aa097a069766a39784d33e2 Mon Sep 17 00:00:00 2001 From: wmat Date: Fri, 15 Nov 2024 12:20:25 -0500 Subject: [PATCH 02/13] Changing styles directory --- .github/.vale.ini | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/.vale.ini b/.github/.vale.ini index 0e01e99..dff4da0 100644 --- a/.github/.vale.ini +++ b/.github/.vale.ini @@ -1,4 +1,4 @@ -StylesPath = .github/styles +StylesPath = styles MinAlertLevel = suggestion Packages = RedHat, AsciiDoc From 8e5abba3b270bd720d195389783951312044be9e Mon Sep 17 00:00:00 2001 From: wmat Date: Fri, 15 Nov 2024 12:37:40 -0500 Subject: [PATCH 03/13] Tweaking Gh action setup for Vale. --- .github/.vale.ini | 8 -------- .github/workflows/vale.yml | 32 +++++++++++++++++++++--------- .vale.ini | 40 ++++++++++++++++++++++++++++++++++++++ 3 files changed, 63 insertions(+), 17 deletions(-) delete mode 100644 .github/.vale.ini create mode 100644 .vale.ini diff --git a/.github/.vale.ini b/.github/.vale.ini deleted file mode 100644 index dff4da0..0000000 --- a/.github/.vale.ini +++ /dev/null @@ -1,8 +0,0 @@ -StylesPath = styles -MinAlertLevel = suggestion - -Packages = RedHat, AsciiDoc - -# Ignore files in dirs starting with `.` to avoid raising errors for `.vale/fixtures/*/testinvalid.adoc` files -[[!.]*.adoc] -BasedOnStyles = RedHat, AsciiDoc \ No newline at end of file diff --git a/.github/workflows/vale.yml b/.github/workflows/vale.yml index eb86c4b..48d7cc4 100644 --- a/.github/workflows/vale.yml +++ b/.github/workflows/vale.yml @@ -1,17 +1,31 @@ -name: reviewdog +--- +# +# Copyright (c) 2021 Red Hat, Inc. +# This program and the accompanying materials are made +# available under the terms of the Eclipse Public License 2.0 +# which is available at https://www.eclipse.org/legal/epl-2.0/ +# +# SPDX-License-Identifier: EPL-2.0 +# +name: Linting with Vale on pull request on: [pull_request] jobs: vale: - name: runner / vale - runs-on: ubuntu-latest + name: Linting with Vale + runs-on: ubuntu-22.04 steps: - uses: actions/checkout@v4 - - uses: errata-ai/vale-action@v2.1.1 + - name: Install Asciidoctor + run: sudo apt-get install -y asciidoctor + - uses: errata-ai/vale-action@reviewdog with: - version: 2.17.0 - files: /src/*.adoc - reporter: github-pr-check + filter_mode: diff_context + vale_flags: "--no-exit --minAlertLevel=error --glob=*.adoc" + reporter: github-pr-review fail_on_error: true - filter_mode: nofilter - token: ${{secrets.VALE_GITHUB_TOKEN}} \ No newline at end of file + env: + # Required, set by GitHub actions automatically: + # https://docs.github.com/en/actions/security-guides/automatic-token-authentication#about-the-github_token-secret + GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} + REVIEWDOG_GITHUB_API_TOKEN: ${{secrets.GITHUB_TOKEN}} \ No newline at end of file diff --git a/.vale.ini b/.vale.ini new file mode 100644 index 0000000..36a9d4e --- /dev/null +++ b/.vale.ini @@ -0,0 +1,40 @@ +StylesPath = .vale/styles + +MinAlertLevel = suggestion + +IgnoredScopes = code, tt, img, url, a, body.id + +SkippedScopes = script, style, pre, figure, code, tt, blockquote, listingblock, literalblock + +Packages = RedHat + +# Match AsciiDoc files. See: https://vale.sh/docs/topics/scoping/ +# Ignore files in a directory starting by `.` +# to avoid raising errors for `.vale/fixtures/*/testinvalid.adoc` files +[[!.]*.adoc] + +BasedOnStyles = RedHat + +[*.md] + +BasedOnStyles = RedHat + +# Ignore code surrounded by backticks or plus sign, parameters defaults, URLs. +TokenIgnores = (\x60[^\n\x60]+\x60), ([^\n]+=[^\n]*), (\+[^\n]+\+), (http[^\n]+\[) + +# Match INI files. See: https://vale.sh/docs/topics/scoping/ +[*.ini] + +BasedOnStyles = RedHat + +# Ignore code surrounded by backticks or plus sign, parameters defaults, URLs. +TokenIgnores = (\x60[^\n\x60]+\x60), ([^\n]+=[^\n]*), (\+[^\n]+\+), (http[^\n]+\[) + +# Disabling rules (NO) +RedHat.CaseSensitiveTerms = NO +RedHat.ConfigMap = NO +RedHat.Definitions = NO +RedHat.Slash = NO +RedHat.Spacing = NO +RedHat.Spelling = NO +RedHat.TermsSuggestions = NO \ No newline at end of file From 57866512fa0817c732a181fed31d8fc53b282bd2 Mon Sep 17 00:00:00 2001 From: wmat Date: Fri, 15 Nov 2024 12:50:53 -0500 Subject: [PATCH 04/13] Removing quotes around message text in yaml files. --- .github/styles/AsciiDoc/ClosedAttributeBlocks.yml | 2 +- .github/styles/AsciiDoc/ClosedIdQuotes.yml | 2 +- .github/styles/AsciiDoc/ImageContainsAltText.yml | 2 +- .github/styles/AsciiDoc/LinkContainsLinkText.yml | 2 +- .github/styles/AsciiDoc/MatchingDotCallouts.yml | 2 +- .github/styles/AsciiDoc/MatchingNumberedCallouts.yml | 2 +- .github/styles/AsciiDoc/SequentialNumberedCallouts.yml | 2 +- .github/styles/AsciiDoc/UnsetAttributes.yml | 2 +- .github/styles/AsciiDoc/ValidAdmonitionBlocks.yml | 2 +- .github/styles/AsciiDoc/ValidCodeBlocks.yml | 2 +- .github/styles/AsciiDoc/ValidConditions.yml | 2 +- .github/styles/AsciiDoc/ValidTableBlocks.yml | 2 +- 12 files changed, 12 insertions(+), 12 deletions(-) diff --git a/.github/styles/AsciiDoc/ClosedAttributeBlocks.yml b/.github/styles/AsciiDoc/ClosedAttributeBlocks.yml index b3e65fc..ecdf7cc 100644 --- a/.github/styles/AsciiDoc/ClosedAttributeBlocks.yml +++ b/.github/styles/AsciiDoc/ClosedAttributeBlocks.yml @@ -2,6 +2,6 @@ extends: existence scope: raw level: error -message: "Attribute block is not closed." +message: Attribute block is not closed. raw: - '(? Date: Fri, 15 Nov 2024 13:09:27 -0500 Subject: [PATCH 05/13] Update reporter to github-pr-check --- .github/workflows/vale.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/vale.yml b/.github/workflows/vale.yml index 48d7cc4..c06af17 100644 --- a/.github/workflows/vale.yml +++ b/.github/workflows/vale.yml @@ -22,7 +22,7 @@ jobs: with: filter_mode: diff_context vale_flags: "--no-exit --minAlertLevel=error --glob=*.adoc" - reporter: github-pr-review + reporter: github-pr-check fail_on_error: true env: # Required, set by GitHub actions automatically: From 905386ee1fb9efe0854a3cd10c694a373d46223b Mon Sep 17 00:00:00 2001 From: wmat Date: Fri, 15 Nov 2024 13:18:06 -0500 Subject: [PATCH 06/13] Setting location of styles --- .vale.ini | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.vale.ini b/.vale.ini index 36a9d4e..2314187 100644 --- a/.vale.ini +++ b/.vale.ini @@ -1,4 +1,4 @@ -StylesPath = .vale/styles +StylesPath = .github/styles MinAlertLevel = suggestion From ad6057cf507606d7c8a087cedd4bd660373d295b Mon Sep 17 00:00:00 2001 From: wmat Date: Fri, 15 Nov 2024 13:27:54 -0500 Subject: [PATCH 07/13] Testing change to adoc file --- src/a_few_basics.adoc | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/a_few_basics.adoc b/src/a_few_basics.adoc index d4ce7fd..4d2c2c5 100644 --- a/src/a_few_basics.adoc +++ b/src/a_few_basics.adoc @@ -1,6 +1,8 @@ [[a_few_basics]] == AsciiDoc basics +asciidoc should be caught by linter. + AsciiDoc is fully documented, and its documentation is actively maintained. This document contains some information on AsciiDoc markup to get you started. For details and additional options, see: From e94b2042d626b3955056502a3056e5a28608ce77 Mon Sep 17 00:00:00 2001 From: wmat Date: Mon, 10 Feb 2025 11:12:23 -0500 Subject: [PATCH 08/13] Removing local vale setup and switching to Vale app. Removing the local vale configuration in lieu of the GH Vale App. --- .../styles/AsciiDoc/ClosedAttributeBlocks.yml | 7 - .github/styles/AsciiDoc/ClosedIdQuotes.yml | 7 - .../styles/AsciiDoc/ImageContainsAltText.yml | 8 - .../styles/AsciiDoc/LinkContainsLinkText.yml | 10 - .../styles/AsciiDoc/MatchingDotCallouts.yml | 47 -- .../AsciiDoc/MatchingNumberedCallouts.yml | 62 --- .../AsciiDoc/SequentialNumberedCallouts.yml | 59 -- .github/styles/AsciiDoc/UnsetAttributes.yml | 49 -- .../styles/AsciiDoc/ValidAdmonitionBlocks.yml | 30 - .github/styles/AsciiDoc/ValidCodeBlocks.yml | 30 - .github/styles/AsciiDoc/ValidConditions.yml | 37 -- .github/styles/AsciiDoc/ValidTableBlocks.yml | 30 - .github/styles/RedHat/Abbreviations.yml | 9 - .github/styles/RedHat/CaseSensitiveTerms.yml | 327 ----------- .github/styles/RedHat/Conjunctions.yml | 14 - .github/styles/RedHat/ConsciousLanguage.yml | 13 - .github/styles/RedHat/Contractions.yml | 44 -- .github/styles/RedHat/Definitions.yml | 191 ------- .github/styles/RedHat/DoNotUseTerms.yml | 27 - .github/styles/RedHat/Ellipses.yml | 12 - .github/styles/RedHat/EmDash.yml | 11 - .github/styles/RedHat/GitLinks.yml | 12 - .github/styles/RedHat/HeadingPunctuation.yml | 11 - .github/styles/RedHat/Headings.yml | 261 --------- .github/styles/RedHat/Hyphens.yml | 234 -------- .../styles/RedHat/MergeConflictMarkers.yml | 13 - .github/styles/RedHat/ObviousTerms.yml | 16 - .github/styles/RedHat/OxfordComma.yml | 9 - .github/styles/RedHat/PascalCamelCase.yml | 190 ------- .github/styles/RedHat/PassiveVoice.yml | 193 ------- .../styles/RedHat/ProductCentricWriting.yml | 8 - .github/styles/RedHat/README-IBM.adoc | 9 - .github/styles/RedHat/README-proselint.md | 13 - .github/styles/RedHat/README-write-good.md | 28 - .github/styles/RedHat/ReadabilityGrade.yml | 9 - .github/styles/RedHat/ReleaseNotes.yml | 11 - .github/styles/RedHat/RepeatedWords.yml | 16 - .github/styles/RedHat/SelfReferentialText.yml | 14 - .github/styles/RedHat/SentenceLength.yml | 9 - .github/styles/RedHat/SimpleWords.yml | 120 ---- .github/styles/RedHat/Slash.yml | 27 - .github/styles/RedHat/SmartQuotes.yml | 11 - .github/styles/RedHat/Spacing.yml | 10 - .github/styles/RedHat/Spelling.yml | 522 ------------------ .github/styles/RedHat/Symbols.yml | 9 - .github/styles/RedHat/TermsErrors.yml | 471 ---------------- .github/styles/RedHat/TermsSuggestions.yml | 54 -- .github/styles/RedHat/TermsWarnings.yml | 74 --- .github/styles/RedHat/UserReplacedValues.yml | 16 - .github/styles/RedHat/Using.yml | 14 - .github/styles/RedHat/collate-output.tmpl | 66 --- .github/styles/RedHat/meta.json | 4 - .github/styles/vocab.txt | 1 - .github/workflows/vale.yml | 31 -- .vale.ini | 40 -- docs-resources | 2 +- 56 files changed, 1 insertion(+), 3551 deletions(-) delete mode 100644 .github/styles/AsciiDoc/ClosedAttributeBlocks.yml delete mode 100644 .github/styles/AsciiDoc/ClosedIdQuotes.yml delete mode 100644 .github/styles/AsciiDoc/ImageContainsAltText.yml delete mode 100644 .github/styles/AsciiDoc/LinkContainsLinkText.yml delete mode 100644 .github/styles/AsciiDoc/MatchingDotCallouts.yml delete mode 100644 .github/styles/AsciiDoc/MatchingNumberedCallouts.yml delete mode 100644 .github/styles/AsciiDoc/SequentialNumberedCallouts.yml delete mode 100644 .github/styles/AsciiDoc/UnsetAttributes.yml delete mode 100644 .github/styles/AsciiDoc/ValidAdmonitionBlocks.yml delete mode 100644 .github/styles/AsciiDoc/ValidCodeBlocks.yml delete mode 100644 .github/styles/AsciiDoc/ValidConditions.yml delete mode 100644 .github/styles/AsciiDoc/ValidTableBlocks.yml delete mode 100644 .github/styles/RedHat/Abbreviations.yml delete mode 100644 .github/styles/RedHat/CaseSensitiveTerms.yml delete mode 100644 .github/styles/RedHat/Conjunctions.yml delete mode 100644 .github/styles/RedHat/ConsciousLanguage.yml delete mode 100644 .github/styles/RedHat/Contractions.yml delete mode 100644 .github/styles/RedHat/Definitions.yml delete mode 100644 .github/styles/RedHat/DoNotUseTerms.yml delete mode 100644 .github/styles/RedHat/Ellipses.yml delete mode 100644 .github/styles/RedHat/EmDash.yml delete mode 100644 .github/styles/RedHat/GitLinks.yml delete mode 100644 .github/styles/RedHat/HeadingPunctuation.yml delete mode 100644 .github/styles/RedHat/Headings.yml delete mode 100644 .github/styles/RedHat/Hyphens.yml delete mode 100644 .github/styles/RedHat/MergeConflictMarkers.yml delete mode 100644 .github/styles/RedHat/ObviousTerms.yml delete mode 100644 .github/styles/RedHat/OxfordComma.yml delete mode 100644 .github/styles/RedHat/PascalCamelCase.yml delete mode 100644 .github/styles/RedHat/PassiveVoice.yml delete mode 100644 .github/styles/RedHat/ProductCentricWriting.yml delete mode 100644 .github/styles/RedHat/README-IBM.adoc delete mode 100644 .github/styles/RedHat/README-proselint.md delete mode 100644 .github/styles/RedHat/README-write-good.md delete mode 100644 .github/styles/RedHat/ReadabilityGrade.yml delete mode 100644 .github/styles/RedHat/ReleaseNotes.yml delete mode 100644 .github/styles/RedHat/RepeatedWords.yml delete mode 100644 .github/styles/RedHat/SelfReferentialText.yml delete mode 100644 .github/styles/RedHat/SentenceLength.yml delete mode 100644 .github/styles/RedHat/SimpleWords.yml delete mode 100644 .github/styles/RedHat/Slash.yml delete mode 100644 .github/styles/RedHat/SmartQuotes.yml delete mode 100644 .github/styles/RedHat/Spacing.yml delete mode 100644 .github/styles/RedHat/Spelling.yml delete mode 100644 .github/styles/RedHat/Symbols.yml delete mode 100644 .github/styles/RedHat/TermsErrors.yml delete mode 100644 .github/styles/RedHat/TermsSuggestions.yml delete mode 100644 .github/styles/RedHat/TermsWarnings.yml delete mode 100644 .github/styles/RedHat/UserReplacedValues.yml delete mode 100644 .github/styles/RedHat/Using.yml delete mode 100644 .github/styles/RedHat/collate-output.tmpl delete mode 100644 .github/styles/RedHat/meta.json delete mode 100644 .github/styles/vocab.txt delete mode 100644 .github/workflows/vale.yml delete mode 100644 .vale.ini diff --git a/.github/styles/AsciiDoc/ClosedAttributeBlocks.yml b/.github/styles/AsciiDoc/ClosedAttributeBlocks.yml deleted file mode 100644 index ecdf7cc..0000000 --- a/.github/styles/AsciiDoc/ClosedAttributeBlocks.yml +++ /dev/null @@ -1,7 +0,0 @@ ---- -extends: existence -scope: raw -level: error -message: Attribute block is not closed. -raw: - - '(?" - callout_regex := "^<(\\.)>" - - for line in text.split(scope, "\n") { - // trim trailing whitespace - line = text.trim_space(line) - if text.re_match(codeblock_callout_regex, line) { - //restart for new listingblock - num_callouts = 0 - //account for lines with multiple callouts - num_callouts_in_line := text.count(line, "<.>") - if num_callouts_in_line > 1 { - num_codeblock_callouts = num_codeblock_callouts + num_callouts_in_line - } else { - num_codeblock_callouts++ - } - } - - if text.re_match(callout_regex, line) { - num_callouts++ - if num_callouts > num_codeblock_callouts { - start := text.index(scope, line) - matches = append(matches, {begin: start, end: start + len(line)}) - } - if num_callouts == num_codeblock_callouts { - num_callouts = 0 - num_codeblock_callouts = 0 - } - } - } diff --git a/.github/styles/AsciiDoc/MatchingNumberedCallouts.yml b/.github/styles/AsciiDoc/MatchingNumberedCallouts.yml deleted file mode 100644 index 6d0a745..0000000 --- a/.github/styles/AsciiDoc/MatchingNumberedCallouts.yml +++ /dev/null @@ -1,62 +0,0 @@ ---- -extends: script -message: Corresponding callout not found. -level: warning -link: https://docs.asciidoctor.org/asciidoc/latest/verbatim/callouts/ -scope: raw -script: | - text := import("text") - matches := [] - - // clean out multi-line comments - scope = text.re_replace("(?s) *(\n////.*?////\n)", scope, "") - //add a newline, it might be missing - scope += "\n" - - codeblock_callout_regex := ".+(<\\d+>)+" - callout_regex := "^<(\\d+)>" - codeblock_callouts := [] - inside := false - found := false - num_callouts := 0 - - num_lines := len(text.split(scope, "\n")) - - for line in text.split(scope, "\n") { - // trim trailing whitespace - line = text.trim_space(line) - if text.re_match(codeblock_callout_regex, line) { - inside = true - //account for lines with multiple callouts - for i := 1; i < num_lines; i++ { - //text.contains must be str, not regex - str := "<" + i + ">" - if text.contains(line, str) { - codeblock_callouts = append(codeblock_callouts, i) - } - } - } else if text.re_match(callout_regex, line) { - inside = false - found = false - num_callouts = 1 - for i in codeblock_callouts { - //cast int > string - j := text.itoa(i) - str := "<" + j + ">" - if text.contains(line, str) { - //setting found allows us to loop through the list of possible matches - found = true - } - num_callouts++ - } - if !found { - start := text.index(scope, line) - matches = append(matches, {begin: start, end: start + len(line)}) - } - } else if codeblock_callouts && inside == false { - //cycled through num_callouts, reset for next codeblock - if num_callouts == len(codeblock_callouts) { - codeblock_callouts = [] - } - } - } \ No newline at end of file diff --git a/.github/styles/AsciiDoc/SequentialNumberedCallouts.yml b/.github/styles/AsciiDoc/SequentialNumberedCallouts.yml deleted file mode 100644 index 760d50d..0000000 --- a/.github/styles/AsciiDoc/SequentialNumberedCallouts.yml +++ /dev/null @@ -1,59 +0,0 @@ ---- -extends: script -message: Numbered callout does not follow sequentially. -level: warning -link: https://docs.asciidoctor.org/asciidoc/latest/verbatim/callouts/ -scope: raw -script: | - text := import("text") - matches := [] - - // clean out multi-line comments - scope = text.re_replace("(?s) *(\n////.*?////\n)", scope, "") - //add a newline, it might be missing - scope += "\n" - - prev_num := 0 - callout_regex := "^<(\\d+)>" - listingblock_delim_regex := "^-{4,}$" - if_regex := "^ifdef::|ifndef::" - endif_regex := "^endif::\\[\\]" - inside_if := false - - for line in text.split(scope, "\n") { - // trim trailing whitespace - line = text.trim_space(line) - - // check if we're entering a conditional block - if text.re_match(if_regex, line) { - inside_if = true - } else if text.re_match(endif_regex, line) { - inside_if = false - } - - //reset count if we hit a listing block delimiter - if text.re_match(listingblock_delim_regex, line) { - prev_num = 0 - } - - //only count callouts where there are no ifdefs - if !inside_if { - if text.re_match(callout_regex, line) { - callout := text.re_find("<(\\d+)>", line) - for key, value in callout { - //trim angle brackets from string - trimmed := callout[key][0]["text"] - trimmed = text.trim_prefix(trimmed, "<") - trimmed = text.trim_suffix(trimmed, ">") - //cast string > int - num := text.atoi(trimmed) - //start counting - if num != prev_num+1 { - start := text.index(scope, line) - matches = append(matches, {begin: start, end: start + len(line)}) - } - prev_num = num - } - } - } - } diff --git a/.github/styles/AsciiDoc/UnsetAttributes.yml b/.github/styles/AsciiDoc/UnsetAttributes.yml deleted file mode 100644 index 7eb4b96..0000000 --- a/.github/styles/AsciiDoc/UnsetAttributes.yml +++ /dev/null @@ -1,49 +0,0 @@ ---- -extends: script -level: warning -message: Set attribute directive does not have a corresponding unset attribute directive. -link: https://docs.asciidoctor.org/asciidoc/latest/attributes/unset-attributes/#unset-a-document-attribute-in-the-body -scope: raw -script: | - text := import("text") - matches := [] - - // trim extra whitespace - scope = text.trim_space(scope) - // add a newline, it might be missing - scope += "\n" - // clean out multi-line comments - scope = text.re_replace("(?s) *(\n////.*?////\n)", scope, "") - - attr_regex := "^:[\\w-_]+:.*$" - context_mod_docs_regex := "^:context|_content-type|_mod-docs-content-type:.*$" - attr_name_regex := ":[\\w-_]+:" - attr_name := "" - unset_attr_pref := "" - unset_attr_suff := "" - - for line in text.split(scope, "\n") { - if text.re_match(attr_regex, line) { - if !text.re_match(context_mod_docs_regex, line) { - start := text.index(scope, line) - matches = append(matches, {begin: start, end: start + len(line)}) - // re_find returns an array holding all matches - attr_name = ((text.re_find(attr_name_regex, line))[0][0])["text"] - unset_attr_pref = `^:!` + text.trim_prefix(attr_name, `:`) - unset_attr_suff = `^` + text.trim_suffix(attr_name, `:`) + `!:` - // loop through lines for every attr found - for line in text.split(scope, "\n") { - if text.re_match(unset_attr_pref, line) { - if len(matches) > 0 { - // remove the most recently added match - matches = matches[:len(matches)-1] - } else if text.re_match(unset_attr_suff, line) { - if len(matches) > 0 { - matches = matches[:len(matches)-1] - } - } - } - } - } - } - } diff --git a/.github/styles/AsciiDoc/ValidAdmonitionBlocks.yml b/.github/styles/AsciiDoc/ValidAdmonitionBlocks.yml deleted file mode 100644 index 5d8cada..0000000 --- a/.github/styles/AsciiDoc/ValidAdmonitionBlocks.yml +++ /dev/null @@ -1,30 +0,0 @@ ---- -extends: script -level: error -message: Unterminated admonition block found in file. -link: https://docs.asciidoctor.org/asciidoc/latest/blocks/admonitions/ -scope: raw -script: | - text := import("text") - matches := [] - - // clean out multi-line comments - scope = text.re_replace("(?s) *(\n////.*?////\n)", scope, "") - //add a newline, it might be missing - scope += "\n" - - admon_delim_regex := "^={4}$" - count := 0 - - for line in text.split(scope, "\n") { - // trim trailing whitespace - line = text.trim_space(line) - if text.re_match(admon_delim_regex, line) { - count += 1 - start := text.index(scope, line) - matches = append(matches, {begin: start, end: start + len(line)}) - } else if count > 1 { - count = 0 // admonition block is closed, reset the count - matches = [] - } - } diff --git a/.github/styles/AsciiDoc/ValidCodeBlocks.yml b/.github/styles/AsciiDoc/ValidCodeBlocks.yml deleted file mode 100644 index 9e5a024..0000000 --- a/.github/styles/AsciiDoc/ValidCodeBlocks.yml +++ /dev/null @@ -1,30 +0,0 @@ ---- -extends: script -level: error -message: Unterminated listing block found in file. -link: https://docs.asciidoctor.org/asciidoc/latest/verbatim/listing-blocks/ -scope: raw -script: | - text := import("text") - matches := [] - - // clean out multi-line comments - scope = text.re_replace("(?s) *(\n////.*?////\n)", scope, "") - //add a newline, it might be missing - scope += "\n" - - listingblock_delim_regex := "^-{4}$" - count := 0 - - for line in text.split(scope, "\n") { - // trim trailing whitespace - line = text.trim_space(line) - if text.re_match(listingblock_delim_regex, line) { - count += 1 - start := text.index(scope, line) - matches = append(matches, {begin: start, end: start + len(line)}) - } else if count > 1 { - count = 0 // listing block is closed, reset the count - matches = [] - } - } diff --git a/.github/styles/AsciiDoc/ValidConditions.yml b/.github/styles/AsciiDoc/ValidConditions.yml deleted file mode 100644 index 37932f7..0000000 --- a/.github/styles/AsciiDoc/ValidConditions.yml +++ /dev/null @@ -1,37 +0,0 @@ ---- -extends: script -level: error -message: File contains unbalanced if statements. Review the file to ensure it contains matching opening and closing if statements. -link: https://docs.asciidoctor.org/asciidoc/latest/directives/ifdef-ifndef/ -scope: raw -script: | - text := import("text") - matches := [] - - // clean out multi-line comments - scope = text.re_replace("(?s) *(\n////.*?////\n)", scope, "") - //add a newline, it might be missing - scope += "\n" - - if_regex := "^ifdef::.+\\[\\]" - ifn_regex := "^ifndef::.+\\[\\]" - ifeval_regex := "ifeval::\\[.+\\]" - endif_regex := "^endif::.*\\[\\]" - - for line in text.split(scope, "\n") { - // trim trailing whitespace - line = text.trim_space(line) - if text.re_match(if_regex, line) || text.re_match(ifn_regex, line) || text.re_match(ifeval_regex, line) { - start := text.index(scope, line) - matches = append(matches, {begin: start, end: start + len(line)}) - } else if text.re_match(endif_regex, line) { - if len(matches) > 0 { - //remove the most recently added open ifdef match - matches = matches[:len(matches)-1] - } else if len(matches) == 0 { - //add orphan endif::[] statements - start := text.index(scope, line) - matches = append(matches, {begin: start, end: start + len(line)}) - } - } - } diff --git a/.github/styles/AsciiDoc/ValidTableBlocks.yml b/.github/styles/AsciiDoc/ValidTableBlocks.yml deleted file mode 100644 index 20f6ad5..0000000 --- a/.github/styles/AsciiDoc/ValidTableBlocks.yml +++ /dev/null @@ -1,30 +0,0 @@ ---- -extends: script -level: error -message: Unterminated table block found in file. -link: https://docs.asciidoctor.org/asciidoc/latest/tables/build-a-basic-table/ -scope: raw -script: | - text := import("text") - matches := [] - - // clean out multi-line comments - scope = text.re_replace("(?s) *(\n////.*?////\n)", scope, "") - //add a newline, it might be missing - scope += "\n" - - tbl_delim_regex := "^\\|={3,}$" - count := 0 - - for line in text.split(scope, "\n") { - // trim trailing whitespace - line = text.trim_space(line) - if text.re_match(tbl_delim_regex, line) { - count += 1 - start := text.index(scope, line) - matches = append(matches, {begin: start, end: start + len(line)}) - } else if count > 1 { - count = 0 //code block is closed, reset the count - matches = [] - } - } diff --git a/.github/styles/RedHat/Abbreviations.yml b/.github/styles/RedHat/Abbreviations.yml deleted file mode 100644 index 102fee4..0000000 --- a/.github/styles/RedHat/Abbreviations.yml +++ /dev/null @@ -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}' diff --git a/.github/styles/RedHat/CaseSensitiveTerms.yml b/.github/styles/RedHat/CaseSensitiveTerms.yml deleted file mode 100644 index 3e451ff..0000000 --- a/.github/styles/RedHat/CaseSensitiveTerms.yml +++ /dev/null @@ -1,327 +0,0 @@ ---- -extends: substitution -ignorecase: false -level: error -link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/casesensitiveterms/ -message: "Use '%s' rather than '%s'." -action: - name: replace -swap: - "(?{7}\s.*$' diff --git a/.github/styles/RedHat/ObviousTerms.yml b/.github/styles/RedHat/ObviousTerms.yml deleted file mode 100644 index fd3f2a3..0000000 --- a/.github/styles/RedHat/ObviousTerms.yml +++ /dev/null @@ -1,16 +0,0 @@ ---- -extends: existence -level: suggestion -# link: -message: "Consider not documenting %s because it is self-explanatory." -scope: sentence -# source: -action: - name: remove -tokens: - - 'User field' - - 'Username field' - - 'Password field' - - 'Mail field' - - 'Description field' - - 'Name field' diff --git a/.github/styles/RedHat/OxfordComma.yml b/.github/styles/RedHat/OxfordComma.yml deleted file mode 100644 index 2f9d108..0000000 --- a/.github/styles/RedHat/OxfordComma.yml +++ /dev/null @@ -1,9 +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'." -scope: sentence -nonword: true -tokens: - - '(?:[^\s,]+,){1,} \w+ (?:and|or) \w+[.?!]' diff --git a/.github/styles/RedHat/PascalCamelCase.yml b/.github/styles/RedHat/PascalCamelCase.yml deleted file mode 100644 index a2f3ea1..0000000 --- a/.github/styles/RedHat/PascalCamelCase.yml +++ /dev/null @@ -1,190 +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 - - GBps - - 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 - - kBps - - KiB - - LangTags - - LGPLv - - libOSMesa - - LibreOffice - - libXNVCtrl - - LightPulse - - LinuxONE - - LiquidIO - - ManageIQ - - MariaDB - - MBps - - MegaRAID - - MiB - - MicroProfile - - MongoDB - - MoreUtils - - MySQL - - NetBIOS - - NetcoredebugOutput - - NetWeaver - - NetworkManager - - NetXen - - NetXtreme - - NFSv - - NMState - - NuGet - - NVidia - - NVMe - - OAuth - - objectClass - - OmniSharp - - OneConnect - - OpenEXR - - OpenID - - OpenIPMI - - OpenJDK - - OpenRAN - - OpenRewrite - - OpenSCAP - - OpenShift - - OpenSSH - - OpenSSL - - OpenStack - - OpenTelemetry - - OpenTracing - - OperatorHub - - OpEx - - OSBuild - - OTel - - 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 - - TBps - - TiB - - TuneD - - TypeScript - - UltraSPARC - - USBGuard - - vCenter - - vDisk - - vHost - - VMware - - vSphere - - vSwitch - - WebAuthn - - WebSocket - - WireGuard - - XEmacs - - xPaaS - - XString - - XWayland - - YouTube - - ZCentral diff --git a/.github/styles/RedHat/PassiveVoice.yml b/.github/styles/RedHat/PassiveVoice.yml deleted file mode 100644 index 67b16af..0000000 --- a/.github/styles/RedHat/PassiveVoice.yml +++ /dev/null @@ -1,193 +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 -exceptions: - - deprecated - - displayed - - imported - - supported - - tested - - trusted diff --git a/.github/styles/RedHat/ProductCentricWriting.yml b/.github/styles/RedHat/ProductCentricWriting.yml deleted file mode 100644 index 3721699..0000000 --- a/.github/styles/RedHat/ProductCentricWriting.yml +++ /dev/null @@ -1,8 +0,0 @@ ---- -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." -tokens: - - '(allows?|enables?|lets?|permits?)\s(you|customers|the customer|the user|users)' diff --git a/.github/styles/RedHat/README-IBM.adoc b/.github/styles/RedHat/README-IBM.adoc deleted file mode 100644 index 7e27b01..0000000 --- a/.github/styles/RedHat/README-IBM.adoc +++ /dev/null @@ -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] diff --git a/.github/styles/RedHat/README-proselint.md b/.github/styles/RedHat/README-proselint.md deleted file mode 100644 index b08cef9..0000000 --- a/.github/styles/RedHat/README-proselint.md +++ /dev/null @@ -1,13 +0,0 @@ - -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. diff --git a/.github/styles/RedHat/README-write-good.md b/.github/styles/RedHat/README-write-good.md deleted file mode 100644 index ba919b6..0000000 --- a/.github/styles/RedHat/README-write-good.md +++ /dev/null @@ -1,28 +0,0 @@ - -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. -``` diff --git a/.github/styles/RedHat/ReadabilityGrade.yml b/.github/styles/RedHat/ReadabilityGrade.yml deleted file mode 100644 index a401a67..0000000 --- a/.github/styles/RedHat/ReadabilityGrade.yml +++ /dev/null @@ -1,9 +0,0 @@ ---- -extends: readability -grade: 9 -message: "Simplify your language. The calculated Flesch–Kincaid grade level of %s is above the recommended reading grade level of 9." -link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/readabilitygrade/ -level: suggestion -metrics: - - Flesch-Kincaid - diff --git a/.github/styles/RedHat/ReleaseNotes.yml b/.github/styles/RedHat/ReleaseNotes.yml deleted file mode 100644 index 10ee9c9..0000000 --- a/.github/styles/RedHat/ReleaseNotes.yml +++ /dev/null @@ -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 diff --git a/.github/styles/RedHat/RepeatedWords.yml b/.github/styles/RedHat/RepeatedWords.yml deleted file mode 100644 index 3893d9b..0000000 --- a/.github/styles/RedHat/RepeatedWords.yml +++ /dev/null @@ -1,16 +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 -action: - name: edit - params: - - regex - - '(\w+)(\s\w+)' # pattern - - "$1" # replace -tokens: - - '[^\s\.]+' - - '[^\s]+' diff --git a/.github/styles/RedHat/SelfReferentialText.yml b/.github/styles/RedHat/SelfReferentialText.yml deleted file mode 100644 index 36adbf4..0000000 --- a/.github/styles/RedHat/SelfReferentialText.yml +++ /dev/null @@ -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 diff --git a/.github/styles/RedHat/SentenceLength.yml b/.github/styles/RedHat/SentenceLength.yml deleted file mode 100644 index c21f0bc..0000000 --- a/.github/styles/RedHat/SentenceLength.yml +++ /dev/null @@ -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 diff --git a/.github/styles/RedHat/SimpleWords.yml b/.github/styles/RedHat/SimpleWords.yml deleted file mode 100644 index 452e7e4..0000000 --- a/.github/styles/RedHat/SimpleWords.yml +++ /dev/null @@ -1,120 +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'." -action: - name: replace -swap: - "(?__' - - '<[a-z_]+-[a-z_-]+>' \ No newline at end of file diff --git a/.github/styles/RedHat/Using.yml b/.github/styles/RedHat/Using.yml deleted file mode 100644 index 869cdc9..0000000 --- a/.github/styles/RedHat/Using.yml +++ /dev/null @@ -1,14 +0,0 @@ ---- -extends: sequence -message: "Use 'by using' instead of 'using' when it follows a noun for clarity and grammatical correctness." -link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/using/ -level: warning -action: - name: edit - params: - - regex - - '(\w+)( using)' # pattern - - "$1 by using" # replace -tokens: - - tag: NN|NNP|NNPS|NNS - - pattern: using diff --git a/.github/styles/RedHat/collate-output.tmpl b/.github/styles/RedHat/collate-output.tmpl deleted file mode 100644 index 449aa42..0000000 --- a/.github/styles/RedHat/collate-output.tmpl +++ /dev/null @@ -1,66 +0,0 @@ -{{- /* See https://github.com/errata-ai/vale/issues/614 */ -}} -{{- /* See https://vale.sh/manual/output/ */ -}} - -{{- /* Keep track of our various counts */ -}} - -{{- $e := 0 -}} -{{- $w := 0 -}} -{{- $s := 0 -}} -{{- $f := 0 -}} - -{{- /* Range over the linted files */ -}} - -{{- range .Files}} -{{$table := newTable true}} - -{{- $f = add1 $f -}} -{{- .Path | underline | indent 1 -}} -{{- "\n" -}} - -{{- $msgToLoc := dict -}} -{{- $msgToLvl := dict -}} -{{- $msgToChk := dict -}} - -{{- /* Range over the file's alerts */ -}} - -{{- range .Alerts -}} - -{{- $error := "" -}} -{{- if eq .Severity "error" -}} - {{- $error = .Severity | red -}} - {{- $e = add1 $e -}} -{{- else if eq .Severity "warning" -}} - {{- $error = .Severity | yellow -}} - {{- $w = add1 $w -}} -{{- else -}} - {{- $error = .Severity | blue -}} - {{- $s = add1 $s -}} -{{- end}} - -{{- $loc := printf "%d:%d" .Line (index .Span 0) -}} - -{{- $locations := get $msgToLoc .Message -}} - -{{- $_ := set $msgToLoc .Message (cat $locations $loc) -}} -{{- $_ := set $msgToLvl .Message $error -}} -{{- $_ := set $msgToChk .Message .Check -}} - -{{end -}} - -{{- range keys $msgToLoc -}} - -{{- $msg := . -}} -{{- $loc := trimPrefix "," ((splitList " " (get $msgToLoc $msg)) | join ",") -}} -{{- $lvl := get $msgToLvl $msg -}} -{{- $chk := get $msgToChk $msg -}} - -{{- $row := list $loc $lvl $msg $chk | toStrings -}} -{{- $table = addRow $table $row -}} - -{{end -}} - -{{- $table = renderTable $table -}} - -{{end}} - -{{- $e}} {{"errors" | red}}, {{$w}} {{"warnings" | yellow}} and {{$s}} {{"suggestions" | blue}} in {{$f}} {{$f | int | plural "file" "files"}}. diff --git a/.github/styles/RedHat/meta.json b/.github/styles/RedHat/meta.json deleted file mode 100644 index 6099c80..0000000 --- a/.github/styles/RedHat/meta.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "feed": "https://github.com/redhat-documentation/vale-at-red-hat/releases.atom", - "vale_version": ">=2.20.0" -} diff --git a/.github/styles/vocab.txt b/.github/styles/vocab.txt deleted file mode 100644 index 2e018e0..0000000 --- a/.github/styles/vocab.txt +++ /dev/null @@ -1 +0,0 @@ -# Place holder for RISC-V style vacabulary. \ No newline at end of file diff --git a/.github/workflows/vale.yml b/.github/workflows/vale.yml deleted file mode 100644 index c06af17..0000000 --- a/.github/workflows/vale.yml +++ /dev/null @@ -1,31 +0,0 @@ ---- -# -# Copyright (c) 2021 Red Hat, Inc. -# This program and the accompanying materials are made -# available under the terms of the Eclipse Public License 2.0 -# which is available at https://www.eclipse.org/legal/epl-2.0/ -# -# SPDX-License-Identifier: EPL-2.0 -# -name: Linting with Vale on pull request -on: [pull_request] - -jobs: - vale: - name: Linting with Vale - runs-on: ubuntu-22.04 - steps: - - uses: actions/checkout@v4 - - name: Install Asciidoctor - run: sudo apt-get install -y asciidoctor - - uses: errata-ai/vale-action@reviewdog - with: - filter_mode: diff_context - vale_flags: "--no-exit --minAlertLevel=error --glob=*.adoc" - reporter: github-pr-check - fail_on_error: true - env: - # Required, set by GitHub actions automatically: - # https://docs.github.com/en/actions/security-guides/automatic-token-authentication#about-the-github_token-secret - GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} - REVIEWDOG_GITHUB_API_TOKEN: ${{secrets.GITHUB_TOKEN}} \ No newline at end of file diff --git a/.vale.ini b/.vale.ini deleted file mode 100644 index 2314187..0000000 --- a/.vale.ini +++ /dev/null @@ -1,40 +0,0 @@ -StylesPath = .github/styles - -MinAlertLevel = suggestion - -IgnoredScopes = code, tt, img, url, a, body.id - -SkippedScopes = script, style, pre, figure, code, tt, blockquote, listingblock, literalblock - -Packages = RedHat - -# Match AsciiDoc files. See: https://vale.sh/docs/topics/scoping/ -# Ignore files in a directory starting by `.` -# to avoid raising errors for `.vale/fixtures/*/testinvalid.adoc` files -[[!.]*.adoc] - -BasedOnStyles = RedHat - -[*.md] - -BasedOnStyles = RedHat - -# Ignore code surrounded by backticks or plus sign, parameters defaults, URLs. -TokenIgnores = (\x60[^\n\x60]+\x60), ([^\n]+=[^\n]*), (\+[^\n]+\+), (http[^\n]+\[) - -# Match INI files. See: https://vale.sh/docs/topics/scoping/ -[*.ini] - -BasedOnStyles = RedHat - -# Ignore code surrounded by backticks or plus sign, parameters defaults, URLs. -TokenIgnores = (\x60[^\n\x60]+\x60), ([^\n]+=[^\n]*), (\+[^\n]+\+), (http[^\n]+\[) - -# Disabling rules (NO) -RedHat.CaseSensitiveTerms = NO -RedHat.ConfigMap = NO -RedHat.Definitions = NO -RedHat.Slash = NO -RedHat.Spacing = NO -RedHat.Spelling = NO -RedHat.TermsSuggestions = NO \ No newline at end of file diff --git a/docs-resources b/docs-resources index 07b9904..36fc023 160000 --- a/docs-resources +++ b/docs-resources @@ -1 +1 @@ -Subproject commit 07b9904bd4de7aca03257200a0f88cb2683d9790 +Subproject commit 36fc02378d2d2426f3870cc3c330a1db0bee7554 From 8d3e87dc56128a6abcaf82721ec664c40b5f2989 Mon Sep 17 00:00:00 2001 From: wmat Date: Mon, 10 Feb 2025 11:35:17 -0500 Subject: [PATCH 09/13] Testing Vale App. Testing Vale App. --- src/writing.adoc | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/writing.adoc b/src/writing.adoc index bd26232..9e3fdaf 100644 --- a/src/writing.adoc +++ b/src/writing.adoc @@ -3,6 +3,9 @@ This section contains suggested best practices for clear, concise, and consistent content. +Csr +CSR + === Use present tense [cols="1,1"] From 5af93efd11a852c460cd5bf8843526bf7599ce39 Mon Sep 17 00:00:00 2001 From: wmat Date: Mon, 10 Feb 2025 11:44:57 -0500 Subject: [PATCH 10/13] Testing Vale again --- src/writing.adoc | 1 + 1 file changed, 1 insertion(+) diff --git a/src/writing.adoc b/src/writing.adoc index 9e3fdaf..c268665 100644 --- a/src/writing.adoc +++ b/src/writing.adoc @@ -4,6 +4,7 @@ This section contains suggested best practices for clear, concise, and consistent content. Csr + CSR === Use present tense From 72c87018dce15774449a5b32e0c37cdd17871029 Mon Sep 17 00:00:00 2001 From: wmat Date: Mon, 10 Feb 2025 12:00:47 -0500 Subject: [PATCH 11/13] Testing Vale again Testing Vale again --- src/writing.adoc | 1 + 1 file changed, 1 insertion(+) diff --git a/src/writing.adoc b/src/writing.adoc index c268665..4b1fca6 100644 --- a/src/writing.adoc +++ b/src/writing.adoc @@ -6,6 +6,7 @@ This section contains suggested best practices for clear, concise, and consisten Csr CSR +CsR === Use present tense From 441f10b4a1f040c2982e82426d06ba06a3e61479 Mon Sep 17 00:00:00 2001 From: Bill Traynor Date: Mon, 17 Feb 2025 15:14:35 -0500 Subject: [PATCH 12/13] Adding empty vale.ini Adding empty .vale.ini. --- .vale.ini | 0 docs-resources | 2 +- 2 files changed, 1 insertion(+), 1 deletion(-) create mode 100644 .vale.ini diff --git a/.vale.ini b/.vale.ini new file mode 100644 index 0000000..e69de29 diff --git a/docs-resources b/docs-resources index 36fc023..66f972d 160000 --- a/docs-resources +++ b/docs-resources @@ -1 +1 @@ -Subproject commit 36fc02378d2d2426f3870cc3c330a1db0bee7554 +Subproject commit 66f972d7dc961551a7815d2fceb82fbea7ce2c44 From fe5cd70737ea8f44983985eeece2a8bcca50539e Mon Sep 17 00:00:00 2001 From: wmat Date: Mon, 10 Mar 2025 12:48:55 -0400 Subject: [PATCH 13/13] Updating PR to trigger Vale. --- docs-resources | 2 +- src/a_few_basics.adoc | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/docs-resources b/docs-resources index 66f972d..62576cd 160000 --- a/docs-resources +++ b/docs-resources @@ -1 +1 @@ -Subproject commit 66f972d7dc961551a7815d2fceb82fbea7ce2c44 +Subproject commit 62576cdd285615473c279eb9acecade9e0fe0e1f diff --git a/src/a_few_basics.adoc b/src/a_few_basics.adoc index 4d2c2c5..c88a0c7 100644 --- a/src/a_few_basics.adoc +++ b/src/a_few_basics.adoc @@ -2,6 +2,8 @@ == AsciiDoc basics asciidoc should be caught by linter. +pseudoinstruction +pseudo-instruction AsciiDoc is fully documented, and its documentation is actively maintained. This document contains some information on AsciiDoc markup to get you started.