From b166c514f2ea9435e451f549d2433f7ea7119794 Mon Sep 17 00:00:00 2001 From: Sandro Bonazzola Date: Mon, 24 Mar 2025 10:51:18 +0100 Subject: [PATCH 1/2] Fix vale errors Red Hat documentation is usually linted using vale. Fixing error level reported issues. Ignored for now warnings and suggestions, can be handled in follow up patches. See also: https://github.com/redhat-documentation/vale-at-red-hat Signed-off-by: Sandro Bonazzola --- .markdownlintignore | 1 + .vale.ini | 40 + .../AsciiDoc/ClosedAttributeBlocks/.vale.ini | 5 + .../ClosedAttributeBlocks/testinvalid.adoc | 9 + .../ClosedAttributeBlocks/testvalid.adoc | 33 + .../AsciiDoc/ClosedIdQuotes/.vale.ini | 5 + .../AsciiDoc/ClosedIdQuotes/testinvalid.adoc | 23 + .../AsciiDoc/ClosedIdQuotes/testvalid.adoc | 9 + .../AsciiDoc/ImageContainsAltText/.vale.ini | 5 + .../ImageContainsAltText/testinvalid.adoc | 3 + .../ImageContainsAltText/testvalid.adoc | 3 + .../AsciiDoc/LinkContainsLinkText/.vale.ini | 5 + .../LinkContainsLinkText/testinvalid.adoc | 20 + .../LinkContainsLinkText/testvalid.adoc | 2 + .../AsciiDoc/MatchingDotCallouts/.vale.ini | 5 + .../MatchingDotCallouts/testinvalid.adoc | 25 + .../MatchingDotCallouts/testvalid.adoc | 12 + .../MatchingNumberedCallouts/.vale.ini | 5 + .../MatchingNumberedCallouts/testinvalid.adoc | 32 + .../MatchingNumberedCallouts/testvalid.adoc | 26 + .../SequentialNumberedCallouts/.vale.ini | 5 + .../testinvalid.adoc | 31 + .../SequentialNumberedCallouts/testvalid.adoc | 25 + .../AsciiDoc/ValidAdmonitionBlocks/.vale.ini | 5 + .../ValidAdmonitionBlocks/testinvalid.adoc | 18 + .../ValidAdmonitionBlocks/testvalid.adoc | 12 + .../AsciiDoc/ValidCodeBlocks/.vale.ini | 5 + .../AsciiDoc/ValidCodeBlocks/testinvalid.adoc | 33 + .../AsciiDoc/ValidCodeBlocks/testvalid.adoc | 37 + .../AsciiDoc/ValidConditions/.vale.ini | 5 + .../AsciiDoc/ValidConditions/testinvalid.adoc | 33 + .../AsciiDoc/ValidConditions/testvalid.adoc | 42 ++ .../AsciiDoc/ValidTableBlocks/.vale.ini | 5 + .../ValidTableBlocks/testinvalid.adoc | 37 + .../AsciiDoc/ValidTableBlocks/testvalid.adoc | 58 ++ .../.vale.ini | 5 + .../testinvalid.adoc | 8 + .../testvalid.adoc | 8 + .../.vale.ini | 5 + .../testinvalid.adoc | 11 + .../testvalid.adoc | 93 +++ .../HardWrappedLines/.vale.ini | 5 + .../HardWrappedLines/testinvalid.adoc | 2 + .../HardWrappedLines/testvalid.adoc | 107 +++ .../IdHasContextVariable/.vale.ini | 5 + .../IdHasContextVariable/testinvalid.adoc | 5 + .../IdHasContextVariable/testvalid.adoc | 3 + .../ModuleContainsContentType/.vale.ini | 5 + .../testinvalid.adoc | 5 + .../ModuleContainsContentType/testvalid.adoc | 15 + .../.vale.ini | 5 + .../testinvalid.adoc | 5 + .../testvalid.adoc | 3 + .../OpenShiftAsciiDoc/NoLineRanges/.vale.ini | 5 + .../NoLineRanges/testinvalid.adoc | 11 + .../NoLineRanges/testvalid.adoc | 15 + .../NoNestingInModules/.vale.ini | 5 + .../NoNestingInModules/testinvalid.adoc | 5 + .../NoNestingInModules/testvalid.adoc | 15 + .../NoTocInModules/.vale.ini | 5 + .../NoTocInModules/testinvalid.adoc | 6 + .../NoTocInModules/testvalid.adoc | 4 + .../NoXrefInModules/.vale.ini | 5 + .../NoXrefInModules/testinvalid.adoc | 2 + .../NoXrefInModules/testvalid.adoc | 1 + .../SuggestAttribute/.vale.ini | 5 + .../SuggestAttribute/testinvalid.adoc | 180 +++++ .../SuggestAttribute/testvalid.adoc | 96 +++ .../XrefContainsAnchorID/.vale.ini | 5 + .../XrefContainsAnchorID/testinvalid.adoc | 8 + .../XrefContainsAnchorID/testvalid.adoc | 3 + .../XrefContainsHTML/.vale.ini | 5 + .../XrefContainsHTML/testinvalid.adoc | 5 + .../XrefContainsHTML/testvalid.adoc | 3 + .../XrefMustNotHaveNakedLabel/.vale.ini | 5 + .../testinvalid.adoc | 2 + .../XrefMustNotHaveNakedLabel/testvalid.adoc | 3 + .vale/fixtures/RedHat/Abbreviations/.vale.ini | 5 + .../RedHat/Abbreviations/testinvalid.adoc | 0 .../RedHat/Abbreviations/testvalid.adoc | 0 .../RedHat/CaseSensitiveTerms/.vale.ini | 5 + .../CaseSensitiveTerms/testinvalid.adoc | 561 ++++++++++++++ .../RedHat/CaseSensitiveTerms/testvalid.adoc | 338 +++++++++ .vale/fixtures/RedHat/Conjunctions/.vale.ini | 5 + .../RedHat/Conjunctions/testinvalid.adoc | 0 .../RedHat/Conjunctions/testvalid.adoc | 0 .../RedHat/ConsciousLanguage/.vale.ini | 5 + .../RedHat/ConsciousLanguage/testinvalid.adoc | 4 + .../RedHat/ConsciousLanguage/testvalid.adoc | 17 + .vale/fixtures/RedHat/Contractions/.vale.ini | 5 + .../fixtures/RedHat/Contractions/source.adoc | 34 + .../RedHat/Contractions/testinvalid.adoc | 34 + .../RedHat/Contractions/testvalid.adoc | 34 + .vale/fixtures/RedHat/Definitions/.vale.ini | 5 + .../RedHat/Definitions/testinvalid.adoc | 1 + .../RedHat/Definitions/testvalid.adoc | 191 +++++ .vale/fixtures/RedHat/DoNotUseTerms/.vale.ini | 5 + .../RedHat/DoNotUseTerms/testinvalid.adoc | 23 + .../RedHat/DoNotUseTerms/testvalid.adoc | 6 + .vale/fixtures/RedHat/Ellipses/.vale.ini | 5 + .../fixtures/RedHat/Ellipses/testinvalid.adoc | 1 + .vale/fixtures/RedHat/Ellipses/testvalid.adoc | 0 .vale/fixtures/RedHat/EmDash/.vale.ini | 5 + .vale/fixtures/RedHat/EmDash/testinvalid.adoc | 2 + .vale/fixtures/RedHat/EmDash/testvalid.adoc | 1 + .../RedHat/HeadingPunctuation/.vale.ini | 5 + .../HeadingPunctuation/testinvalid.adoc | 1 + .../RedHat/HeadingPunctuation/testvalid.adoc | 1 + .vale/fixtures/RedHat/Headings/.vale.ini | 5 + .../fixtures/RedHat/Headings/testinvalid.adoc | 1 + .vale/fixtures/RedHat/Headings/testvalid.adoc | 51 ++ .vale/fixtures/RedHat/Hyphens/.vale.ini | 5 + .../fixtures/RedHat/Hyphens/testinvalid.adoc | 226 ++++++ .vale/fixtures/RedHat/Hyphens/testvalid.adoc | 152 ++++ .../RedHat/MergeConflictMarkers/.vale.ini | 5 + .../MergeConflictMarkers/testinvalid.adoc | 3 + .../MergeConflictMarkers/testvalid.adoc | 3 + .vale/fixtures/RedHat/OxfordComma/.vale.ini | 5 + .../RedHat/OxfordComma/testinvalid.adoc | 2 + .../RedHat/OxfordComma/testvalid.adoc | 2 + .../fixtures/RedHat/PascalCamelCase/.vale.ini | 5 + .../RedHat/PascalCamelCase/testinvalid.adoc | 126 ++++ .../RedHat/PascalCamelCase/testvalid.adoc | 198 +++++ .vale/fixtures/RedHat/PassiveVoice/.vale.ini | 5 + .../RedHat/PassiveVoice/testinvalid.adoc | 176 +++++ .../RedHat/PassiveVoice/testvalid.adoc | 181 +++++ .../RedHat/ProductCentricWriting/.vale.ini | 5 + .../ProductCentricWriting/testinvalid.adoc | 5 + .../ProductCentricWriting/testvalid.adoc | 0 .../RedHat/ReadabilityGrade/.vale.ini | 5 + .../RedHat/ReadabilityGrade/testinvalid.adoc | 0 .../RedHat/ReadabilityGrade/testvalid.adoc | 0 .vale/fixtures/RedHat/ReleaseNotes/.vale.ini | 5 + .../RedHat/ReleaseNotes/testinvalid.adoc | 2 + .../RedHat/ReleaseNotes/testvalid.adoc | 2 + .vale/fixtures/RedHat/RepeatedWords/.vale.ini | 5 + .../RedHat/RepeatedWords/testinvalid.adoc | 2 + .../RedHat/RepeatedWords/testvalid.adoc | 6 + .../RedHat/SelfReferentialText/.vale.ini | 5 + .../SelfReferentialText/testinvalid.adoc | 11 + .../RedHat/SelfReferentialText/testvalid.adoc | 0 .../fixtures/RedHat/SentenceLength/.vale.ini | 5 + .../RedHat/SentenceLength/testinvalid.adoc | 0 .../RedHat/SentenceLength/testvalid.adoc | 0 .vale/fixtures/RedHat/SimpleWords/.vale.ini | 5 + .../RedHat/SimpleWords/testinvalid.adoc | 111 +++ .../RedHat/SimpleWords/testvalid.adoc | 122 +++ .vale/fixtures/RedHat/Slash/.vale.ini | 5 + .vale/fixtures/RedHat/Slash/testinvalid.adoc | 3 + .vale/fixtures/RedHat/Slash/testvalid.adoc | 17 + .vale/fixtures/RedHat/SmartQuotes/.vale.ini | 5 + .../RedHat/SmartQuotes/testinvalid.adoc | 4 + .../RedHat/SmartQuotes/testvalid.adoc | 5 + .vale/fixtures/RedHat/Spacing/.vale.ini | 5 + .../fixtures/RedHat/Spacing/testinvalid.adoc | 2 + .vale/fixtures/RedHat/Spacing/testvalid.adoc | 4 + .vale/fixtures/RedHat/Spelling/.vale.ini | 5 + .../fixtures/RedHat/Spelling/testinvalid.adoc | 59 ++ .vale/fixtures/RedHat/Spelling/testvalid.adoc | 649 ++++++++++++++++ .vale/fixtures/RedHat/Symbols/.vale.ini | 5 + .../fixtures/RedHat/Symbols/testinvalid.adoc | 2 + .vale/fixtures/RedHat/Symbols/testvalid.adoc | 15 + .vale/fixtures/RedHat/TermsErrors/.vale.ini | 5 + .../RedHat/TermsErrors/testinvalid.adoc | 473 ++++++++++++ .../RedHat/TermsErrors/testvalid.adoc | 698 ++++++++++++++++++ .../RedHat/TermsSuggestions/.vale.ini | 5 + .../RedHat/TermsSuggestions/testinvalid.adoc | 64 ++ .../RedHat/TermsSuggestions/testvalid.adoc | 57 ++ .vale/fixtures/RedHat/TermsWarnings/.vale.ini | 5 + .../RedHat/TermsWarnings/testinvalid.adoc | 68 ++ .../RedHat/TermsWarnings/testvalid.adoc | 69 ++ .../RedHat/UserReplacedValues/.vale.ini | 5 + .../UserReplacedValues/testinvalid.adoc | 5 + .../RedHat/UserReplacedValues/testvalid.adoc | 3 + .../styles/AsciiDoc/ClosedAttributeBlocks.yml | 7 + .vale/styles/AsciiDoc/ClosedIdQuotes.yml | 7 + .../styles/AsciiDoc/ImageContainsAltText.yml | 9 + .../styles/AsciiDoc/LinkContainsLinkText.yml | 10 + .vale/styles/AsciiDoc/MatchingDotCallouts.yml | 47 ++ .../AsciiDoc/MatchingNumberedCallouts.yml | 62 ++ .../AsciiDoc/SequentialNumberedCallouts.yml | 45 ++ .../styles/AsciiDoc/ValidAdmonitionBlocks.yml | 30 + .vale/styles/AsciiDoc/ValidCodeBlocks.yml | 30 + .vale/styles/AsciiDoc/ValidConditions.yml | 35 + .vale/styles/AsciiDoc/ValidTableBlocks.yml | 30 + .../AdditionalResourcesHeadingHasRoleID.yml | 10 + .../CheckDollarSymbolInTerminalBlock.yml | 8 + .../OpenShiftAsciiDoc/HardWrappedLines.yml | 51 ++ .../IdHasContextVariable.yml | 8 + .../ModuleContainsContentType.yml | 8 + .../ModuleContainsParentAssemblyComment.yml | 8 + .../styles/OpenShiftAsciiDoc/NoLineRanges.yml | 8 + .../OpenShiftAsciiDoc/NoNestingInModules.yml | 8 + .../OpenShiftAsciiDoc/NoTocInModules.yml | 9 + .../OpenShiftAsciiDoc/NoXrefInModules.yml | 8 + .../OpenShiftAsciiDoc/SuggestAttribute.yml | 100 +++ .../XrefContainsAnchorID.yml | 8 + .../OpenShiftAsciiDoc/XrefContainsHTML.yml | 8 + .../XrefMustNotHaveNakedLabel.yml | 8 + .vale/styles/RedHat/Abbreviations.yml | 9 + .vale/styles/RedHat/CaseSensitiveTerms.yml | 327 ++++++++ .vale/styles/RedHat/Conjunctions.yml | 14 + .vale/styles/RedHat/ConsciousLanguage.yml | 13 + .vale/styles/RedHat/Contractions.yml | 44 ++ .vale/styles/RedHat/Definitions.yml | 191 +++++ .vale/styles/RedHat/DoNotUseTerms.yml | 27 + .vale/styles/RedHat/Ellipses.yml | 12 + .vale/styles/RedHat/EmDash.yml | 11 + .vale/styles/RedHat/GitLinks.yml | 13 + .vale/styles/RedHat/HeadingPunctuation.yml | 11 + .vale/styles/RedHat/Headings.yml | 261 +++++++ .vale/styles/RedHat/Hyphens.yml | 236 ++++++ .vale/styles/RedHat/MergeConflictMarkers.yml | 13 + .vale/styles/RedHat/ObviousTerms.yml | 16 + .vale/styles/RedHat/OxfordComma.yml | 9 + .vale/styles/RedHat/PascalCamelCase.yml | 190 +++++ .vale/styles/RedHat/PassiveVoice.yml | 193 +++++ .vale/styles/RedHat/ProductCentricWriting.yml | 8 + .vale/styles/RedHat/README-IBM.adoc | 9 + .vale/styles/RedHat/README-proselint.md | 13 + .vale/styles/RedHat/README-write-good.md | 28 + .vale/styles/RedHat/ReadabilityGrade.yml | 8 + .vale/styles/RedHat/ReleaseNotes.yml | 11 + .vale/styles/RedHat/RepeatedWords.yml | 16 + .vale/styles/RedHat/SelfReferentialText.yml | 14 + .vale/styles/RedHat/SentenceLength.yml | 9 + .vale/styles/RedHat/SimpleWords.yml | 119 +++ .vale/styles/RedHat/Slash.yml | 27 + .vale/styles/RedHat/SmartQuotes.yml | 11 + .vale/styles/RedHat/Spacing.yml | 10 + .vale/styles/RedHat/Spelling.yml | 522 +++++++++++++ .vale/styles/RedHat/Symbols.yml | 9 + .vale/styles/RedHat/TermsErrors.yml | 472 ++++++++++++ .vale/styles/RedHat/TermsSuggestions.yml | 54 ++ .vale/styles/RedHat/TermsWarnings.yml | 76 ++ .vale/styles/RedHat/UserReplacedValues.yml | 16 + .vale/styles/RedHat/Using.yml | 14 + .vale/styles/RedHat/collate-output.tmpl | 66 ++ .vale/styles/RedHat/meta.json | 4 + README.md | 2 +- modules/ROOT/pages/eln-branch.adoc | 4 +- modules/ROOT/pages/eln-macros.adoc | 2 +- modules/ROOT/pages/extras.adoc | 12 +- modules/ROOT/pages/faq.adoc | 6 +- modules/ROOT/pages/index.adoc | 2 +- 245 files changed, 9983 insertions(+), 14 deletions(-) create mode 100644 .markdownlintignore create mode 100644 .vale.ini create mode 100644 .vale/fixtures/AsciiDoc/ClosedAttributeBlocks/.vale.ini create mode 100644 .vale/fixtures/AsciiDoc/ClosedAttributeBlocks/testinvalid.adoc create mode 100644 .vale/fixtures/AsciiDoc/ClosedAttributeBlocks/testvalid.adoc create mode 100644 .vale/fixtures/AsciiDoc/ClosedIdQuotes/.vale.ini create mode 100644 .vale/fixtures/AsciiDoc/ClosedIdQuotes/testinvalid.adoc create mode 100644 .vale/fixtures/AsciiDoc/ClosedIdQuotes/testvalid.adoc create mode 100644 .vale/fixtures/AsciiDoc/ImageContainsAltText/.vale.ini create mode 100644 .vale/fixtures/AsciiDoc/ImageContainsAltText/testinvalid.adoc create mode 100644 .vale/fixtures/AsciiDoc/ImageContainsAltText/testvalid.adoc create mode 100644 .vale/fixtures/AsciiDoc/LinkContainsLinkText/.vale.ini create mode 100644 .vale/fixtures/AsciiDoc/LinkContainsLinkText/testinvalid.adoc create mode 100644 .vale/fixtures/AsciiDoc/LinkContainsLinkText/testvalid.adoc create mode 100644 .vale/fixtures/AsciiDoc/MatchingDotCallouts/.vale.ini create mode 100644 .vale/fixtures/AsciiDoc/MatchingDotCallouts/testinvalid.adoc create mode 100644 .vale/fixtures/AsciiDoc/MatchingDotCallouts/testvalid.adoc create mode 100644 .vale/fixtures/AsciiDoc/MatchingNumberedCallouts/.vale.ini create mode 100644 .vale/fixtures/AsciiDoc/MatchingNumberedCallouts/testinvalid.adoc create mode 100644 .vale/fixtures/AsciiDoc/MatchingNumberedCallouts/testvalid.adoc create mode 100644 .vale/fixtures/AsciiDoc/SequentialNumberedCallouts/.vale.ini create mode 100644 .vale/fixtures/AsciiDoc/SequentialNumberedCallouts/testinvalid.adoc create mode 100644 .vale/fixtures/AsciiDoc/SequentialNumberedCallouts/testvalid.adoc create mode 100644 .vale/fixtures/AsciiDoc/ValidAdmonitionBlocks/.vale.ini create mode 100644 .vale/fixtures/AsciiDoc/ValidAdmonitionBlocks/testinvalid.adoc create mode 100644 .vale/fixtures/AsciiDoc/ValidAdmonitionBlocks/testvalid.adoc create mode 100644 .vale/fixtures/AsciiDoc/ValidCodeBlocks/.vale.ini create mode 100644 .vale/fixtures/AsciiDoc/ValidCodeBlocks/testinvalid.adoc create mode 100644 .vale/fixtures/AsciiDoc/ValidCodeBlocks/testvalid.adoc create mode 100644 .vale/fixtures/AsciiDoc/ValidConditions/.vale.ini create mode 100644 .vale/fixtures/AsciiDoc/ValidConditions/testinvalid.adoc create mode 100644 .vale/fixtures/AsciiDoc/ValidConditions/testvalid.adoc create mode 100644 .vale/fixtures/AsciiDoc/ValidTableBlocks/.vale.ini create mode 100644 .vale/fixtures/AsciiDoc/ValidTableBlocks/testinvalid.adoc create mode 100644 .vale/fixtures/AsciiDoc/ValidTableBlocks/testvalid.adoc create mode 100644 .vale/fixtures/OpenShiftAsciiDoc/AdditionalResourcesHeadingHasRoleID/.vale.ini create mode 100644 .vale/fixtures/OpenShiftAsciiDoc/AdditionalResourcesHeadingHasRoleID/testinvalid.adoc create mode 100644 .vale/fixtures/OpenShiftAsciiDoc/AdditionalResourcesHeadingHasRoleID/testvalid.adoc create mode 100644 .vale/fixtures/OpenShiftAsciiDoc/CheckDollarSymbolInTerminalBlock/.vale.ini create mode 100644 .vale/fixtures/OpenShiftAsciiDoc/CheckDollarSymbolInTerminalBlock/testinvalid.adoc create mode 100644 .vale/fixtures/OpenShiftAsciiDoc/CheckDollarSymbolInTerminalBlock/testvalid.adoc create mode 100644 .vale/fixtures/OpenShiftAsciiDoc/HardWrappedLines/.vale.ini create mode 100644 .vale/fixtures/OpenShiftAsciiDoc/HardWrappedLines/testinvalid.adoc create mode 100644 .vale/fixtures/OpenShiftAsciiDoc/HardWrappedLines/testvalid.adoc create mode 100644 .vale/fixtures/OpenShiftAsciiDoc/IdHasContextVariable/.vale.ini create mode 100644 .vale/fixtures/OpenShiftAsciiDoc/IdHasContextVariable/testinvalid.adoc create mode 100644 .vale/fixtures/OpenShiftAsciiDoc/IdHasContextVariable/testvalid.adoc create mode 100644 .vale/fixtures/OpenShiftAsciiDoc/ModuleContainsContentType/.vale.ini create mode 100644 .vale/fixtures/OpenShiftAsciiDoc/ModuleContainsContentType/testinvalid.adoc create mode 100644 .vale/fixtures/OpenShiftAsciiDoc/ModuleContainsContentType/testvalid.adoc create mode 100644 .vale/fixtures/OpenShiftAsciiDoc/ModuleContainsParentAssemblyComment/.vale.ini create mode 100644 .vale/fixtures/OpenShiftAsciiDoc/ModuleContainsParentAssemblyComment/testinvalid.adoc create mode 100644 .vale/fixtures/OpenShiftAsciiDoc/ModuleContainsParentAssemblyComment/testvalid.adoc create mode 100644 .vale/fixtures/OpenShiftAsciiDoc/NoLineRanges/.vale.ini create mode 100644 .vale/fixtures/OpenShiftAsciiDoc/NoLineRanges/testinvalid.adoc create mode 100644 .vale/fixtures/OpenShiftAsciiDoc/NoLineRanges/testvalid.adoc create mode 100644 .vale/fixtures/OpenShiftAsciiDoc/NoNestingInModules/.vale.ini create mode 100644 .vale/fixtures/OpenShiftAsciiDoc/NoNestingInModules/testinvalid.adoc create mode 100644 .vale/fixtures/OpenShiftAsciiDoc/NoNestingInModules/testvalid.adoc create mode 100644 .vale/fixtures/OpenShiftAsciiDoc/NoTocInModules/.vale.ini create mode 100644 .vale/fixtures/OpenShiftAsciiDoc/NoTocInModules/testinvalid.adoc create mode 100644 .vale/fixtures/OpenShiftAsciiDoc/NoTocInModules/testvalid.adoc create mode 100644 .vale/fixtures/OpenShiftAsciiDoc/NoXrefInModules/.vale.ini create mode 100644 .vale/fixtures/OpenShiftAsciiDoc/NoXrefInModules/testinvalid.adoc create mode 100644 .vale/fixtures/OpenShiftAsciiDoc/NoXrefInModules/testvalid.adoc create mode 100644 .vale/fixtures/OpenShiftAsciiDoc/SuggestAttribute/.vale.ini create mode 100644 .vale/fixtures/OpenShiftAsciiDoc/SuggestAttribute/testinvalid.adoc create mode 100644 .vale/fixtures/OpenShiftAsciiDoc/SuggestAttribute/testvalid.adoc create mode 100644 .vale/fixtures/OpenShiftAsciiDoc/XrefContainsAnchorID/.vale.ini create mode 100644 .vale/fixtures/OpenShiftAsciiDoc/XrefContainsAnchorID/testinvalid.adoc create mode 100644 .vale/fixtures/OpenShiftAsciiDoc/XrefContainsAnchorID/testvalid.adoc create mode 100644 .vale/fixtures/OpenShiftAsciiDoc/XrefContainsHTML/.vale.ini create mode 100644 .vale/fixtures/OpenShiftAsciiDoc/XrefContainsHTML/testinvalid.adoc create mode 100644 .vale/fixtures/OpenShiftAsciiDoc/XrefContainsHTML/testvalid.adoc create mode 100644 .vale/fixtures/OpenShiftAsciiDoc/XrefMustNotHaveNakedLabel/.vale.ini create mode 100644 .vale/fixtures/OpenShiftAsciiDoc/XrefMustNotHaveNakedLabel/testinvalid.adoc create mode 100644 .vale/fixtures/OpenShiftAsciiDoc/XrefMustNotHaveNakedLabel/testvalid.adoc create mode 100644 .vale/fixtures/RedHat/Abbreviations/.vale.ini create mode 100644 .vale/fixtures/RedHat/Abbreviations/testinvalid.adoc create mode 100644 .vale/fixtures/RedHat/Abbreviations/testvalid.adoc create mode 100644 .vale/fixtures/RedHat/CaseSensitiveTerms/.vale.ini create mode 100644 .vale/fixtures/RedHat/CaseSensitiveTerms/testinvalid.adoc create mode 100644 .vale/fixtures/RedHat/CaseSensitiveTerms/testvalid.adoc create mode 100644 .vale/fixtures/RedHat/Conjunctions/.vale.ini create mode 100644 .vale/fixtures/RedHat/Conjunctions/testinvalid.adoc create mode 100644 .vale/fixtures/RedHat/Conjunctions/testvalid.adoc create mode 100644 .vale/fixtures/RedHat/ConsciousLanguage/.vale.ini create mode 100644 .vale/fixtures/RedHat/ConsciousLanguage/testinvalid.adoc create mode 100644 .vale/fixtures/RedHat/ConsciousLanguage/testvalid.adoc create mode 100644 .vale/fixtures/RedHat/Contractions/.vale.ini create mode 100644 .vale/fixtures/RedHat/Contractions/source.adoc create mode 100644 .vale/fixtures/RedHat/Contractions/testinvalid.adoc create mode 100644 .vale/fixtures/RedHat/Contractions/testvalid.adoc create mode 100644 .vale/fixtures/RedHat/Definitions/.vale.ini create mode 100644 .vale/fixtures/RedHat/Definitions/testinvalid.adoc create mode 100644 .vale/fixtures/RedHat/Definitions/testvalid.adoc create mode 100644 .vale/fixtures/RedHat/DoNotUseTerms/.vale.ini create mode 100644 .vale/fixtures/RedHat/DoNotUseTerms/testinvalid.adoc create mode 100644 .vale/fixtures/RedHat/DoNotUseTerms/testvalid.adoc create mode 100644 .vale/fixtures/RedHat/Ellipses/.vale.ini create mode 100644 .vale/fixtures/RedHat/Ellipses/testinvalid.adoc create mode 100644 .vale/fixtures/RedHat/Ellipses/testvalid.adoc create mode 100644 .vale/fixtures/RedHat/EmDash/.vale.ini create mode 100644 .vale/fixtures/RedHat/EmDash/testinvalid.adoc create mode 100644 .vale/fixtures/RedHat/EmDash/testvalid.adoc create mode 100644 .vale/fixtures/RedHat/HeadingPunctuation/.vale.ini create mode 100644 .vale/fixtures/RedHat/HeadingPunctuation/testinvalid.adoc create mode 100644 .vale/fixtures/RedHat/HeadingPunctuation/testvalid.adoc create mode 100644 .vale/fixtures/RedHat/Headings/.vale.ini create mode 100644 .vale/fixtures/RedHat/Headings/testinvalid.adoc create mode 100644 .vale/fixtures/RedHat/Headings/testvalid.adoc create mode 100644 .vale/fixtures/RedHat/Hyphens/.vale.ini create mode 100644 .vale/fixtures/RedHat/Hyphens/testinvalid.adoc create mode 100644 .vale/fixtures/RedHat/Hyphens/testvalid.adoc create mode 100644 .vale/fixtures/RedHat/MergeConflictMarkers/.vale.ini create mode 100644 .vale/fixtures/RedHat/MergeConflictMarkers/testinvalid.adoc create mode 100644 .vale/fixtures/RedHat/MergeConflictMarkers/testvalid.adoc create mode 100644 .vale/fixtures/RedHat/OxfordComma/.vale.ini create mode 100644 .vale/fixtures/RedHat/OxfordComma/testinvalid.adoc create mode 100644 .vale/fixtures/RedHat/OxfordComma/testvalid.adoc create mode 100644 .vale/fixtures/RedHat/PascalCamelCase/.vale.ini create mode 100644 .vale/fixtures/RedHat/PascalCamelCase/testinvalid.adoc create mode 100644 .vale/fixtures/RedHat/PascalCamelCase/testvalid.adoc create mode 100644 .vale/fixtures/RedHat/PassiveVoice/.vale.ini create mode 100644 .vale/fixtures/RedHat/PassiveVoice/testinvalid.adoc create mode 100644 .vale/fixtures/RedHat/PassiveVoice/testvalid.adoc create mode 100644 .vale/fixtures/RedHat/ProductCentricWriting/.vale.ini create mode 100644 .vale/fixtures/RedHat/ProductCentricWriting/testinvalid.adoc create mode 100644 .vale/fixtures/RedHat/ProductCentricWriting/testvalid.adoc create mode 100644 .vale/fixtures/RedHat/ReadabilityGrade/.vale.ini create mode 100644 .vale/fixtures/RedHat/ReadabilityGrade/testinvalid.adoc create mode 100644 .vale/fixtures/RedHat/ReadabilityGrade/testvalid.adoc create mode 100644 .vale/fixtures/RedHat/ReleaseNotes/.vale.ini create mode 100644 .vale/fixtures/RedHat/ReleaseNotes/testinvalid.adoc create mode 100644 .vale/fixtures/RedHat/ReleaseNotes/testvalid.adoc create mode 100644 .vale/fixtures/RedHat/RepeatedWords/.vale.ini create mode 100644 .vale/fixtures/RedHat/RepeatedWords/testinvalid.adoc create mode 100644 .vale/fixtures/RedHat/RepeatedWords/testvalid.adoc create mode 100644 .vale/fixtures/RedHat/SelfReferentialText/.vale.ini create mode 100644 .vale/fixtures/RedHat/SelfReferentialText/testinvalid.adoc create mode 100644 .vale/fixtures/RedHat/SelfReferentialText/testvalid.adoc create mode 100644 .vale/fixtures/RedHat/SentenceLength/.vale.ini create mode 100644 .vale/fixtures/RedHat/SentenceLength/testinvalid.adoc create mode 100644 .vale/fixtures/RedHat/SentenceLength/testvalid.adoc create mode 100644 .vale/fixtures/RedHat/SimpleWords/.vale.ini create mode 100644 .vale/fixtures/RedHat/SimpleWords/testinvalid.adoc create mode 100644 .vale/fixtures/RedHat/SimpleWords/testvalid.adoc create mode 100644 .vale/fixtures/RedHat/Slash/.vale.ini create mode 100644 .vale/fixtures/RedHat/Slash/testinvalid.adoc create mode 100644 .vale/fixtures/RedHat/Slash/testvalid.adoc create mode 100644 .vale/fixtures/RedHat/SmartQuotes/.vale.ini create mode 100644 .vale/fixtures/RedHat/SmartQuotes/testinvalid.adoc create mode 100644 .vale/fixtures/RedHat/SmartQuotes/testvalid.adoc create mode 100644 .vale/fixtures/RedHat/Spacing/.vale.ini create mode 100644 .vale/fixtures/RedHat/Spacing/testinvalid.adoc create mode 100644 .vale/fixtures/RedHat/Spacing/testvalid.adoc create mode 100644 .vale/fixtures/RedHat/Spelling/.vale.ini create mode 100644 .vale/fixtures/RedHat/Spelling/testinvalid.adoc create mode 100644 .vale/fixtures/RedHat/Spelling/testvalid.adoc create mode 100644 .vale/fixtures/RedHat/Symbols/.vale.ini create mode 100644 .vale/fixtures/RedHat/Symbols/testinvalid.adoc create mode 100644 .vale/fixtures/RedHat/Symbols/testvalid.adoc create mode 100644 .vale/fixtures/RedHat/TermsErrors/.vale.ini create mode 100644 .vale/fixtures/RedHat/TermsErrors/testinvalid.adoc create mode 100644 .vale/fixtures/RedHat/TermsErrors/testvalid.adoc create mode 100644 .vale/fixtures/RedHat/TermsSuggestions/.vale.ini create mode 100644 .vale/fixtures/RedHat/TermsSuggestions/testinvalid.adoc create mode 100644 .vale/fixtures/RedHat/TermsSuggestions/testvalid.adoc create mode 100644 .vale/fixtures/RedHat/TermsWarnings/.vale.ini create mode 100644 .vale/fixtures/RedHat/TermsWarnings/testinvalid.adoc create mode 100644 .vale/fixtures/RedHat/TermsWarnings/testvalid.adoc create mode 100644 .vale/fixtures/RedHat/UserReplacedValues/.vale.ini create mode 100644 .vale/fixtures/RedHat/UserReplacedValues/testinvalid.adoc create mode 100644 .vale/fixtures/RedHat/UserReplacedValues/testvalid.adoc create mode 100644 .vale/styles/AsciiDoc/ClosedAttributeBlocks.yml create mode 100644 .vale/styles/AsciiDoc/ClosedIdQuotes.yml create mode 100644 .vale/styles/AsciiDoc/ImageContainsAltText.yml create mode 100644 .vale/styles/AsciiDoc/LinkContainsLinkText.yml create mode 100644 .vale/styles/AsciiDoc/MatchingDotCallouts.yml create mode 100644 .vale/styles/AsciiDoc/MatchingNumberedCallouts.yml create mode 100644 .vale/styles/AsciiDoc/SequentialNumberedCallouts.yml create mode 100644 .vale/styles/AsciiDoc/ValidAdmonitionBlocks.yml create mode 100644 .vale/styles/AsciiDoc/ValidCodeBlocks.yml create mode 100644 .vale/styles/AsciiDoc/ValidConditions.yml create mode 100644 .vale/styles/AsciiDoc/ValidTableBlocks.yml create mode 100644 .vale/styles/OpenShiftAsciiDoc/AdditionalResourcesHeadingHasRoleID.yml create mode 100644 .vale/styles/OpenShiftAsciiDoc/CheckDollarSymbolInTerminalBlock.yml create mode 100644 .vale/styles/OpenShiftAsciiDoc/HardWrappedLines.yml create mode 100644 .vale/styles/OpenShiftAsciiDoc/IdHasContextVariable.yml create mode 100644 .vale/styles/OpenShiftAsciiDoc/ModuleContainsContentType.yml create mode 100644 .vale/styles/OpenShiftAsciiDoc/ModuleContainsParentAssemblyComment.yml create mode 100644 .vale/styles/OpenShiftAsciiDoc/NoLineRanges.yml create mode 100644 .vale/styles/OpenShiftAsciiDoc/NoNestingInModules.yml create mode 100644 .vale/styles/OpenShiftAsciiDoc/NoTocInModules.yml create mode 100644 .vale/styles/OpenShiftAsciiDoc/NoXrefInModules.yml create mode 100644 .vale/styles/OpenShiftAsciiDoc/SuggestAttribute.yml create mode 100644 .vale/styles/OpenShiftAsciiDoc/XrefContainsAnchorID.yml create mode 100644 .vale/styles/OpenShiftAsciiDoc/XrefContainsHTML.yml create mode 100644 .vale/styles/OpenShiftAsciiDoc/XrefMustNotHaveNakedLabel.yml create mode 100644 .vale/styles/RedHat/Abbreviations.yml create mode 100644 .vale/styles/RedHat/CaseSensitiveTerms.yml create mode 100644 .vale/styles/RedHat/Conjunctions.yml create mode 100644 .vale/styles/RedHat/ConsciousLanguage.yml create mode 100644 .vale/styles/RedHat/Contractions.yml create mode 100644 .vale/styles/RedHat/Definitions.yml create mode 100644 .vale/styles/RedHat/DoNotUseTerms.yml create mode 100644 .vale/styles/RedHat/Ellipses.yml create mode 100644 .vale/styles/RedHat/EmDash.yml create mode 100644 .vale/styles/RedHat/GitLinks.yml create mode 100644 .vale/styles/RedHat/HeadingPunctuation.yml create mode 100644 .vale/styles/RedHat/Headings.yml create mode 100644 .vale/styles/RedHat/Hyphens.yml create mode 100644 .vale/styles/RedHat/MergeConflictMarkers.yml create mode 100644 .vale/styles/RedHat/ObviousTerms.yml create mode 100644 .vale/styles/RedHat/OxfordComma.yml create mode 100644 .vale/styles/RedHat/PascalCamelCase.yml create mode 100644 .vale/styles/RedHat/PassiveVoice.yml create mode 100644 .vale/styles/RedHat/ProductCentricWriting.yml create mode 100644 .vale/styles/RedHat/README-IBM.adoc create mode 100644 .vale/styles/RedHat/README-proselint.md create mode 100644 .vale/styles/RedHat/README-write-good.md create mode 100644 .vale/styles/RedHat/ReadabilityGrade.yml create mode 100644 .vale/styles/RedHat/ReleaseNotes.yml create mode 100644 .vale/styles/RedHat/RepeatedWords.yml create mode 100644 .vale/styles/RedHat/SelfReferentialText.yml create mode 100644 .vale/styles/RedHat/SentenceLength.yml create mode 100644 .vale/styles/RedHat/SimpleWords.yml create mode 100644 .vale/styles/RedHat/Slash.yml create mode 100644 .vale/styles/RedHat/SmartQuotes.yml create mode 100644 .vale/styles/RedHat/Spacing.yml create mode 100644 .vale/styles/RedHat/Spelling.yml create mode 100644 .vale/styles/RedHat/Symbols.yml create mode 100644 .vale/styles/RedHat/TermsErrors.yml create mode 100644 .vale/styles/RedHat/TermsSuggestions.yml create mode 100644 .vale/styles/RedHat/TermsWarnings.yml create mode 100644 .vale/styles/RedHat/UserReplacedValues.yml create mode 100644 .vale/styles/RedHat/Using.yml create mode 100644 .vale/styles/RedHat/collate-output.tmpl create mode 100644 .vale/styles/RedHat/meta.json diff --git a/.markdownlintignore b/.markdownlintignore new file mode 100644 index 0000000..08744a0 --- /dev/null +++ b/.markdownlintignore @@ -0,0 +1 @@ +.vale diff --git a/.vale.ini b/.vale.ini new file mode 100644 index 0000000..b59d4da --- /dev/null +++ b/.vale.ini @@ -0,0 +1,40 @@ +StylesPath = .vale/styles + +MinAlertLevel = error + +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 diff --git a/.vale/fixtures/AsciiDoc/ClosedAttributeBlocks/.vale.ini b/.vale/fixtures/AsciiDoc/ClosedAttributeBlocks/.vale.ini new file mode 100644 index 0000000..5822dc7 --- /dev/null +++ b/.vale/fixtures/AsciiDoc/ClosedAttributeBlocks/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `ClosedAttributeBlocks` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +AsciiDoc.ClosedAttributeBlocks = YES diff --git a/.vale/fixtures/AsciiDoc/ClosedAttributeBlocks/testinvalid.adoc b/.vale/fixtures/AsciiDoc/ClosedAttributeBlocks/testinvalid.adoc new file mode 100644 index 0000000..20ba60a --- /dev/null +++ b/.vale/fixtures/AsciiDoc/ClosedAttributeBlocks/testinvalid.adoc @@ -0,0 +1,9 @@ +//vale-fixture +:_mod-docs-content-type: ASSEMBLY +[id="rosa-getting-started += Comprehensive guide to getting started with {product-title} + +//vale-fixture +:_mod-docs-content-type: ASSEMBLY +[id="rosa-getting-started_{context} += Another guide to getting started diff --git a/.vale/fixtures/AsciiDoc/ClosedAttributeBlocks/testvalid.adoc b/.vale/fixtures/AsciiDoc/ClosedAttributeBlocks/testvalid.adoc new file mode 100644 index 0000000..d33413c --- /dev/null +++ b/.vale/fixtures/AsciiDoc/ClosedAttributeBlocks/testvalid.adoc @@ -0,0 +1,33 @@ +//vale-fixture +:_mod-docs-content-type: ASSEMBLY +[id="rosa-getting-started_{context}"] += Comprehensive guide to getting started with {product-title} + +//vale-fixture +.Example output +[source,terminal] +---- +{"status":"success","data":{"resultType":"vector","result":[{"metric":{"__name__":"up","endpoint":"web","instance":"10.129.0.46:8080","job":"prometheus-example-app","namespace":"ns1","pod":"prometheus-example-app-68d47c4fb6-jztp2","service":"prometheus-example-app"},"value":[1591881154.748,"1"]}]}} +---- + +//vale-fixture +[source,terminal] +---- +$ oc adm must-gather +[must-gather ] OUT Using must-gather plugin-in image: quay.io/openshift-release-dev/ocp-v4.0-art-dev@sha256:125f183d13601537ff15b3239df95d47f0a604da2847b561151fedd699f5e3a5 +[must-gather ] OUT namespace/openshift-must-gather-xm4wq created +[must-gather ] OUT clusterrolebinding.rbac.authorization.k8s.io/must-gather-2bd8x created +[must-gather ] OUT pod for plug-in image quay.io/openshift-release-dev/ocp-v4.0-art-dev@sha256:125f183d13601537ff15b3239df95d47f0a604da2847b561151fedd699f5e3a5 created +---- + +//vale-fixture +.Example API response +[source,json] +---- +[{ + "id": "ca11ab76-86f9-428c-8d3a-666c24e34d32", + "endpointUri": "http://localhost:9089/api/ocloudNotifications/v1/dummy", + "uriLocation": "http://localhost:8089/api/ocloudNotifications/v1/subscriptions/ca11ab76-86f9-428c-8d3a-666c24e34d32", + "resource": "/cluster/node/openshift-worker-0.openshift.example.com/redfish/event" +}] +---- diff --git a/.vale/fixtures/AsciiDoc/ClosedIdQuotes/.vale.ini b/.vale/fixtures/AsciiDoc/ClosedIdQuotes/.vale.ini new file mode 100644 index 0000000..8d4d742 --- /dev/null +++ b/.vale/fixtures/AsciiDoc/ClosedIdQuotes/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `ClosedIdQuotes` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +AsciiDoc.ClosedIdQuotes = YES diff --git a/.vale/fixtures/AsciiDoc/ClosedIdQuotes/testinvalid.adoc b/.vale/fixtures/AsciiDoc/ClosedIdQuotes/testinvalid.adoc new file mode 100644 index 0000000..e60121e --- /dev/null +++ b/.vale/fixtures/AsciiDoc/ClosedIdQuotes/testinvalid.adoc @@ -0,0 +1,23 @@ +//vale-fixture +[id="rosa-getting-started_{context}] += Comprehensive guide to getting started with {product-title} + +//vale-fixture +[id="rosa-getting-started] += Another guide to getting started + +//vale-fixture +[id='rosa-getting-started_{context}] += Comprehensive guide to getting started with {product-title} + +//vale-fixture +[id='rosa-getting-started] += Another guide to getting started + +//vale-fixture +[id="rosa-getting-started'] += Another guide to getting started + +//vale-fixture +[id='rosa-getting-started"] += Another guide to getting started diff --git a/.vale/fixtures/AsciiDoc/ClosedIdQuotes/testvalid.adoc b/.vale/fixtures/AsciiDoc/ClosedIdQuotes/testvalid.adoc new file mode 100644 index 0000000..c37f91a --- /dev/null +++ b/.vale/fixtures/AsciiDoc/ClosedIdQuotes/testvalid.adoc @@ -0,0 +1,9 @@ +//vale-fixture +:_mod-docs-content-type: ASSEMBLY +[id="rosa-getting-started_{context}"] += Comprehensive guide to getting started with {product-title} + +//vale-fixture +:_mod-docs-content-type: ASSEMBLY +[id='rosa-getting-started_{context}'] += Comprehensive guide to getting started with {product-title} diff --git a/.vale/fixtures/AsciiDoc/ImageContainsAltText/.vale.ini b/.vale/fixtures/AsciiDoc/ImageContainsAltText/.vale.ini new file mode 100644 index 0000000..c5541dc --- /dev/null +++ b/.vale/fixtures/AsciiDoc/ImageContainsAltText/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `ImageContainsAltText` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +AsciiDoc.ImageContainsAltText = YES diff --git a/.vale/fixtures/AsciiDoc/ImageContainsAltText/testinvalid.adoc b/.vale/fixtures/AsciiDoc/ImageContainsAltText/testinvalid.adoc new file mode 100644 index 0000000..4477e3f --- /dev/null +++ b/.vale/fixtures/AsciiDoc/ImageContainsAltText/testinvalid.adoc @@ -0,0 +1,3 @@ +//vale-fixture +image::my-image-name.png[] +image:my-image-name.png[] diff --git a/.vale/fixtures/AsciiDoc/ImageContainsAltText/testvalid.adoc b/.vale/fixtures/AsciiDoc/ImageContainsAltText/testvalid.adoc new file mode 100644 index 0000000..db45ec9 --- /dev/null +++ b/.vale/fixtures/AsciiDoc/ImageContainsAltText/testvalid.adoc @@ -0,0 +1,3 @@ +//Correct usage of alt text in image tags +image::my-image-name.png[my-image-alt-text] +image:my-image-name.png[my-image-alt-text] diff --git a/.vale/fixtures/AsciiDoc/LinkContainsLinkText/.vale.ini b/.vale/fixtures/AsciiDoc/LinkContainsLinkText/.vale.ini new file mode 100644 index 0000000..d6a199a --- /dev/null +++ b/.vale/fixtures/AsciiDoc/LinkContainsLinkText/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `LinkContainsLinkText` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +AsciiDoc.LinkContainsLinkText = YES diff --git a/.vale/fixtures/AsciiDoc/LinkContainsLinkText/testinvalid.adoc b/.vale/fixtures/AsciiDoc/LinkContainsLinkText/testinvalid.adoc new file mode 100644 index 0000000..29ff659 --- /dev/null +++ b/.vale/fixtures/AsciiDoc/LinkContainsLinkText/testinvalid.adoc @@ -0,0 +1,20 @@ +//vale-fixture +link:https://docs.aws.amazon.com/[] + +//vale-fixture +link:https://docs.aws.amazon.com/[Click here] + +//vale-fixture +link:https://docs.aws.amazon.com/[click here] + +//vale-fixture +link:https://docs.aws.amazon.com/[here] + +//vale-fixture +link:https://docs.aws.amazon.com/[Here] + +//vale-fixture +link:https://docs.aws.amazon.com/[this] + +//vale-fixture +link:https://docs.aws.amazon.com/[This] diff --git a/.vale/fixtures/AsciiDoc/LinkContainsLinkText/testvalid.adoc b/.vale/fixtures/AsciiDoc/LinkContainsLinkText/testvalid.adoc new file mode 100644 index 0000000..20c9f41 --- /dev/null +++ b/.vale/fixtures/AsciiDoc/LinkContainsLinkText/testvalid.adoc @@ -0,0 +1,2 @@ +//Correct usage of link text in links +link:https://docs.aws.amazon.com/[AWS documentation] diff --git a/.vale/fixtures/AsciiDoc/MatchingDotCallouts/.vale.ini b/.vale/fixtures/AsciiDoc/MatchingDotCallouts/.vale.ini new file mode 100644 index 0000000..5fc7ffd --- /dev/null +++ b/.vale/fixtures/AsciiDoc/MatchingDotCallouts/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `SequentialNumberedCallouts` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +AsciiDoc.MatchingDotCallouts = YES diff --git a/.vale/fixtures/AsciiDoc/MatchingDotCallouts/testinvalid.adoc b/.vale/fixtures/AsciiDoc/MatchingDotCallouts/testinvalid.adoc new file mode 100644 index 0000000..4efd682 --- /dev/null +++ b/.vale/fixtures/AsciiDoc/MatchingDotCallouts/testinvalid.adoc @@ -0,0 +1,25 @@ +//vale-fixture +[source,ruby] +---- +get '/hi' do <.> +get '/hi' do <.> +get '/hi' do<.> <.> <.> +---- +<.> first callout +<.> second callout +<.> third callout +<.> fourth callout +<.> fifth callout +<.> sixth callout + +//vale-fixture +[source,ruby] +---- +get '/hi' do <.> +get '/hi' do <.> +get '/hi' do <.> +---- +<.> first callout, second block +<.> second callout, second block +<.> third callout, second block +<.> fourth callout, second block diff --git a/.vale/fixtures/AsciiDoc/MatchingDotCallouts/testvalid.adoc b/.vale/fixtures/AsciiDoc/MatchingDotCallouts/testvalid.adoc new file mode 100644 index 0000000..8d4493c --- /dev/null +++ b/.vale/fixtures/AsciiDoc/MatchingDotCallouts/testvalid.adoc @@ -0,0 +1,12 @@ +//vale-fixture +[source,ruby] +---- +require 'sinatra' <.> + +get '/hi' do <.> + "Hello World!" <.> +end +---- +<.> Library import +<.> URL mapping +<.> Response block diff --git a/.vale/fixtures/AsciiDoc/MatchingNumberedCallouts/.vale.ini b/.vale/fixtures/AsciiDoc/MatchingNumberedCallouts/.vale.ini new file mode 100644 index 0000000..99a9f13 --- /dev/null +++ b/.vale/fixtures/AsciiDoc/MatchingNumberedCallouts/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `SequentialNumberedCallouts` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +AsciiDoc.MatchingNumberedCallouts = YES diff --git a/.vale/fixtures/AsciiDoc/MatchingNumberedCallouts/testinvalid.adoc b/.vale/fixtures/AsciiDoc/MatchingNumberedCallouts/testinvalid.adoc new file mode 100644 index 0000000..28df0ef --- /dev/null +++ b/.vale/fixtures/AsciiDoc/MatchingNumberedCallouts/testinvalid.adoc @@ -0,0 +1,32 @@ +//vale-fixture +[source,ruby] +---- +require 'frank' <1> +get '/hihi'<2><3> +---- +<1> text +<2> More text +<3> More text again +<4> Again, more text + +//vale-fixture +[source,ruby] +---- +require 'frankie' <1> +get '/hihihi' <2> +---- +<1> text! +<2> More text! +More text...! +<10> and again and again! + +//vale-fixture +[source,ruby] +---- +require 'judy' <2> +get '/hihihi' <1> +---- +<2> test +<1> text! +More text...! +<13> and again and again and again! diff --git a/.vale/fixtures/AsciiDoc/MatchingNumberedCallouts/testvalid.adoc b/.vale/fixtures/AsciiDoc/MatchingNumberedCallouts/testvalid.adoc new file mode 100644 index 0000000..28e386d --- /dev/null +++ b/.vale/fixtures/AsciiDoc/MatchingNumberedCallouts/testvalid.adoc @@ -0,0 +1,26 @@ +//vale-fixture +[source,ruby] +---- +require 'sinatra' <1> + +get '/hi' do <2> <3> + "Hello World!" +end +---- +<1> Library import +<2> URL mapping +<3> Response block + +//vale-fixture +[source,ruby] +---- +require 'sinatra' \\//<1> + +get '/hi' do <2><3> + "Hello World!"<4> +end +---- +<1> Library import +<2> URL mapping +<3> Response block +<4> Hi diff --git a/.vale/fixtures/AsciiDoc/SequentialNumberedCallouts/.vale.ini b/.vale/fixtures/AsciiDoc/SequentialNumberedCallouts/.vale.ini new file mode 100644 index 0000000..59cf66b --- /dev/null +++ b/.vale/fixtures/AsciiDoc/SequentialNumberedCallouts/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `SequentialNumberedCallouts` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +AsciiDoc.SequentialNumberedCallouts = YES diff --git a/.vale/fixtures/AsciiDoc/SequentialNumberedCallouts/testinvalid.adoc b/.vale/fixtures/AsciiDoc/SequentialNumberedCallouts/testinvalid.adoc new file mode 100644 index 0000000..2229014 --- /dev/null +++ b/.vale/fixtures/AsciiDoc/SequentialNumberedCallouts/testinvalid.adoc @@ -0,0 +1,31 @@ +//vale-fixture +[source,ruby] +---- +require 'sinatra' <1> +get '/hi' do <2> +require 'sinatra' <3> +get '/hi' do <4> +hi there <5> +goop <6> +require 'sinatra' + +get '/hi' do <7> <8> + "Hello World!" +---- +<1> text +<2> More text +<3> More text again +<5> Some text +<6> Again, some text +<7> Moar text +<8> Again, some more text + +//vale-fixture +[source,ruby] +---- +require 'sinatra' <1> +get '/hi' do <3> +get '/hi' do <4> +---- +<1> Test +<3> Test diff --git a/.vale/fixtures/AsciiDoc/SequentialNumberedCallouts/testvalid.adoc b/.vale/fixtures/AsciiDoc/SequentialNumberedCallouts/testvalid.adoc new file mode 100644 index 0000000..abb0837 --- /dev/null +++ b/.vale/fixtures/AsciiDoc/SequentialNumberedCallouts/testvalid.adoc @@ -0,0 +1,25 @@ +//vale-fixture +[source,ruby] +---- +require 'sinatra' <1> + +get '/hi' do <2> <3> + "Hello World!" +end +---- +<1> Library import +<2> URL mapping +<3> Response block + +//vale-fixture +[source,ruby] +---- +require 'sinatra' <1> + +get '/hi' do <1> + "Hello World!" +end +key: value <2> +---- +<1> Library import +<2> URL mapping diff --git a/.vale/fixtures/AsciiDoc/ValidAdmonitionBlocks/.vale.ini b/.vale/fixtures/AsciiDoc/ValidAdmonitionBlocks/.vale.ini new file mode 100644 index 0000000..1d27dec --- /dev/null +++ b/.vale/fixtures/AsciiDoc/ValidAdmonitionBlocks/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `ValidAdmonitionBlocks` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +AsciiDoc.ValidAdmonitionBlocks = YES diff --git a/.vale/fixtures/AsciiDoc/ValidAdmonitionBlocks/testinvalid.adoc b/.vale/fixtures/AsciiDoc/ValidAdmonitionBlocks/testinvalid.adoc new file mode 100644 index 0000000..a1bedcd --- /dev/null +++ b/.vale/fixtures/AsciiDoc/ValidAdmonitionBlocks/testinvalid.adoc @@ -0,0 +1,18 @@ +//vale-fixture +Here is a Admonition block: + +[IMPORTANT] +.Feeding the Werewolves +==== +While werewolves are hardy community members, keep in mind the following dietary concerns: + +. They are allergic to cinnamon. +. More than two glasses of orange juice in 24 hours makes them howl in harmony with alarms and sirens. +. Celery makes them sad. + +More text + +[NOTE] +==== +Hello +==== diff --git a/.vale/fixtures/AsciiDoc/ValidAdmonitionBlocks/testvalid.adoc b/.vale/fixtures/AsciiDoc/ValidAdmonitionBlocks/testvalid.adoc new file mode 100644 index 0000000..024577a --- /dev/null +++ b/.vale/fixtures/AsciiDoc/ValidAdmonitionBlocks/testvalid.adoc @@ -0,0 +1,12 @@ +//vale-fixture +Here is a Admonition block: + +[IMPORTANT] +.Feeding the Werewolves +==== +While werewolves are hardy community members, keep in mind the following dietary concerns: + +. They are allergic to cinnamon. +. More than two glasses of orange juice in 24 hours makes them howl in harmony with alarms and sirens. +. Celery makes them sad. +==== diff --git a/.vale/fixtures/AsciiDoc/ValidCodeBlocks/.vale.ini b/.vale/fixtures/AsciiDoc/ValidCodeBlocks/.vale.ini new file mode 100644 index 0000000..c244f78 --- /dev/null +++ b/.vale/fixtures/AsciiDoc/ValidCodeBlocks/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `ValidConditions` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +AsciiDoc.ValidCodeBlocks = YES diff --git a/.vale/fixtures/AsciiDoc/ValidCodeBlocks/testinvalid.adoc b/.vale/fixtures/AsciiDoc/ValidCodeBlocks/testinvalid.adoc new file mode 100644 index 0000000..d3827f8 --- /dev/null +++ b/.vale/fixtures/AsciiDoc/ValidCodeBlocks/testinvalid.adoc @@ -0,0 +1,33 @@ +//vale-fixture +Here is a code block: + +[source,terminal] +---- +$ pwd +---- + +Here is a another code block: + +[source,terminal] +---- +$ pwd +---- + +Here is a code block: + +[source,yaml] +---- +--- +apiVersion: 4.11 + +Some text. + +Here is a code block: + +[subs="+quotes",options="nowrap",role="white-space-pre"] +---- +--- +apiVersion: 4.11 +---- + +Some text. diff --git a/.vale/fixtures/AsciiDoc/ValidCodeBlocks/testvalid.adoc b/.vale/fixtures/AsciiDoc/ValidCodeBlocks/testvalid.adoc new file mode 100644 index 0000000..513732a --- /dev/null +++ b/.vale/fixtures/AsciiDoc/ValidCodeBlocks/testvalid.adoc @@ -0,0 +1,37 @@ +//vale-fixture +Here is a code block: + +[source,terminal] +---- +$ pwd +---- + +Here is a another code block: + +[source,java] +---- +$ pwd +---- + +Here is yet another code block: + +[source,python] +---- +$ pwd +---- + +[source,yaml] +----- +$ pwd +----- + + +Some text. + +//vale-fixture +Here is a final code block: + +[source,terminal] +---- +$ pwd +---- diff --git a/.vale/fixtures/AsciiDoc/ValidConditions/.vale.ini b/.vale/fixtures/AsciiDoc/ValidConditions/.vale.ini new file mode 100644 index 0000000..e29e99a --- /dev/null +++ b/.vale/fixtures/AsciiDoc/ValidConditions/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `ValidConditions` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +AsciiDoc.ValidConditions = YES diff --git a/.vale/fixtures/AsciiDoc/ValidConditions/testinvalid.adoc b/.vale/fixtures/AsciiDoc/ValidConditions/testinvalid.adoc new file mode 100644 index 0000000..a10434c --- /dev/null +++ b/.vale/fixtures/AsciiDoc/ValidConditions/testinvalid.adoc @@ -0,0 +1,33 @@ +//vale-fixture +ifdef::env-github[] +This content is for GitHub only. + +//vale-fixture +ifndef::env-github[] +This content is for GitHub only. + +So much content in this section, I'd get confused reading the source without the closing `ifdef` directive. + +//vale-fixture +ifdef::revnumber[] +This document has a version number of {revnumber}. + +//vale-fixture +ifeval::[2 > 1] +Some text! + +//vale-fixture +ifeval::["{docname}{outfilesuffix}" == "main.html"] +Some text! + +//vale-fixture +ifeval::["{docname}{outfilesuffix}" == "main.html"] +Some text! + +//vale-fixture +ifeval::["{docname}{outfilesuffix}" == "main.html"] +Some text! + +//vale-fixture +ifeval::[derp] +Some text! diff --git a/.vale/fixtures/AsciiDoc/ValidConditions/testvalid.adoc b/.vale/fixtures/AsciiDoc/ValidConditions/testvalid.adoc new file mode 100644 index 0000000..3bf5d6b --- /dev/null +++ b/.vale/fixtures/AsciiDoc/ValidConditions/testvalid.adoc @@ -0,0 +1,42 @@ +//vale-fixture +ifdef::env-github[] +This content is for GitHub only. +endif::env-github[] + +//vale-fixture +ifndef::env-github[] +This content is for GitHub only. + +So much content in this section, I'd get confused. +endif::[] + +//vale-fixture +ifdef::revnumber[] +This document has a version number of {revnumber}. +endif::[] + +//vale-fixture - doesn't work +//ifndef::profile-production,env-site[Not shown if profile-production or env-site is set.] + +//vale-fixture +ifndef::profile-staging+env-site[Not shown if profile-staging and env-site are set.] + +//vale-fixture +ifeval::[2 > 1] +Some text! +endif::[] + +//vale-fixture +ifeval::["{backend}" == "html5"] +Some text! +endif::[] + +//vale-fixture +ifeval::[{sectnumlevels} == 3] +Some text! +endif::[] + +//vale-fixture +ifeval::["{docname}{outfilesuffix}" == "main.html"] +Some text! +endif::[] diff --git a/.vale/fixtures/AsciiDoc/ValidTableBlocks/.vale.ini b/.vale/fixtures/AsciiDoc/ValidTableBlocks/.vale.ini new file mode 100644 index 0000000..1a65552 --- /dev/null +++ b/.vale/fixtures/AsciiDoc/ValidTableBlocks/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `ValidConditions` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +AsciiDoc.ValidTableBlocks = YES diff --git a/.vale/fixtures/AsciiDoc/ValidTableBlocks/testinvalid.adoc b/.vale/fixtures/AsciiDoc/ValidTableBlocks/testinvalid.adoc new file mode 100644 index 0000000..3b1479e --- /dev/null +++ b/.vale/fixtures/AsciiDoc/ValidTableBlocks/testinvalid.adoc @@ -0,0 +1,37 @@ +//vale-fixture +.Table one +[cols=3*,stripes=even] +|=== +|Header column 1 |Header column 2 |Header column 3 +|Cell 1, row 1 +|Cell 2, row 1 +|Cell 3, row 1 +Some text. +|=== + +.Table two +[options="header"] +|==== +|Column Title|Column Title +|content|content +|==== +This content goes on and on. + +Some text. + +.Table three +[options="header"] +|==== +|Column Title|Column Title|Column Title +|content|content|content +|==== + +Some text. + +.Table four +[options="header"] +|==== +|Column Title|Column Title|Column Title +|content|content|content + +Some text. diff --git a/.vale/fixtures/AsciiDoc/ValidTableBlocks/testvalid.adoc b/.vale/fixtures/AsciiDoc/ValidTableBlocks/testvalid.adoc new file mode 100644 index 0000000..e9e5724 --- /dev/null +++ b/.vale/fixtures/AsciiDoc/ValidTableBlocks/testvalid.adoc @@ -0,0 +1,58 @@ +//vale-fixture +.Table one +[options="header"] +|=== +|Header column 1 |Header column 2 |Header column 3 + +|Cell 1, row 1 +|Cell 2, row 1 +|Cell 3, row 1 +|=== + +Some text. + +//vale-fixture +.Table two +[options="header"] +|==== +|Column Title|Column Title +|content|content +This content goes on and on. +|==== + +Some text. + +//vale-fixture +[caption="test"] +.Table three +|======= +|A |B |C +|a |b |c +|1 |2 |3 +|======= + +Some text. + +//vale-fixture +.Table four +[options="header"] +|==== +|Column Title|Column Title|Column Title +|content|content|content +|==== + +Some text. + +//vale-fixture +.Table five +[cols=2*, width="40%", options="header"] +|==== +|Firefox +|Web Browser + +|Ruby +|Programming Language + +|TorqueBox +|Application Server +|==== diff --git a/.vale/fixtures/OpenShiftAsciiDoc/AdditionalResourcesHeadingHasRoleID/.vale.ini b/.vale/fixtures/OpenShiftAsciiDoc/AdditionalResourcesHeadingHasRoleID/.vale.ini new file mode 100644 index 0000000..4a215da --- /dev/null +++ b/.vale/fixtures/OpenShiftAsciiDoc/AdditionalResourcesHeadingHasRoleID/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `AdditionalResourcesHeadingHasRoleID` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +OpenShiftAsciiDoc.AdditionalResourcesHeadingHasRoleID = YES diff --git a/.vale/fixtures/OpenShiftAsciiDoc/AdditionalResourcesHeadingHasRoleID/testinvalid.adoc b/.vale/fixtures/OpenShiftAsciiDoc/AdditionalResourcesHeadingHasRoleID/testinvalid.adoc new file mode 100644 index 0000000..56438d2 --- /dev/null +++ b/.vale/fixtures/OpenShiftAsciiDoc/AdditionalResourcesHeadingHasRoleID/testinvalid.adoc @@ -0,0 +1,8 @@ +//vale-fixture +.Additional resources + +//vale-fixture +== Additional resources + +//vale-fixture +=== Additional resources diff --git a/.vale/fixtures/OpenShiftAsciiDoc/AdditionalResourcesHeadingHasRoleID/testvalid.adoc b/.vale/fixtures/OpenShiftAsciiDoc/AdditionalResourcesHeadingHasRoleID/testvalid.adoc new file mode 100644 index 0000000..76a90bd --- /dev/null +++ b/.vale/fixtures/OpenShiftAsciiDoc/AdditionalResourcesHeadingHasRoleID/testvalid.adoc @@ -0,0 +1,8 @@ +[role="_additional-resources"] +.Additional resources + +[role="_additional-resources"] +== Additional resources + +[role="_additional-resources"] +=== Additional resources diff --git a/.vale/fixtures/OpenShiftAsciiDoc/CheckDollarSymbolInTerminalBlock/.vale.ini b/.vale/fixtures/OpenShiftAsciiDoc/CheckDollarSymbolInTerminalBlock/.vale.ini new file mode 100644 index 0000000..f3a6da7 --- /dev/null +++ b/.vale/fixtures/OpenShiftAsciiDoc/CheckDollarSymbolInTerminalBlock/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `CheckDollarSymbolInTerminalBlock` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +OpenShiftAsciiDoc.CheckDollarSymbolInTerminalBlock = YES diff --git a/.vale/fixtures/OpenShiftAsciiDoc/CheckDollarSymbolInTerminalBlock/testinvalid.adoc b/.vale/fixtures/OpenShiftAsciiDoc/CheckDollarSymbolInTerminalBlock/testinvalid.adoc new file mode 100644 index 0000000..043fb86 --- /dev/null +++ b/.vale/fixtures/OpenShiftAsciiDoc/CheckDollarSymbolInTerminalBlock/testinvalid.adoc @@ -0,0 +1,11 @@ +//vale-fixture +[source,bash] +---- + oc get my lunch +---- + +//vale-fixture +[source,terminal] +---- +oc get my lunch +---- diff --git a/.vale/fixtures/OpenShiftAsciiDoc/CheckDollarSymbolInTerminalBlock/testvalid.adoc b/.vale/fixtures/OpenShiftAsciiDoc/CheckDollarSymbolInTerminalBlock/testvalid.adoc new file mode 100644 index 0000000..f5edaf7 --- /dev/null +++ b/.vale/fixtures/OpenShiftAsciiDoc/CheckDollarSymbolInTerminalBlock/testvalid.adoc @@ -0,0 +1,93 @@ +[source,bash] +---- +$ oc get my lunch +---- + +[source,yaml] +---- +oc get my lunch +---- + +[source,terminal] +---- +$ oc get my lunch +---- + +[source,terminal] +---- +# oc get my lunch +---- + +.Example output +[source,terminal] +---- +Computer says no +---- + +.Sample output +[source,bash] +---- +Computer says no +---- + +.Example +[source,terminal] +---- +spec: + settings: + ProcTurboMode: Disabled<1> +---- + +[source,terminal] +---- +C:\> net user +---- + +. Change your root directory to the host: ++ +[source,terminal] +---- +sh-4.2# chroot /host +---- + +[source,terminal] +---- +. +├── CODEOWNERS +├── README.md +└── scripts + └── validate-vale-rules.sh +---- + +[source,terminal] +---- +├── CODEOWNERS +├── README.md +└── scripts + └── validate-vale-rules.sh +---- + +[source,terminal] +---- +[ansible@control-node]$ +---- + +[source,terminal] +---- +(undercloud)$ cd go/to/path +---- + +[source,terminal] +---- +(undercloud) [stack@director ~]$ cd go/to/path +---- + +[source,terminal] +---- +sh-4.2# chroot /host +---- + +[source,yaml] +---- +include::yaml/boundary-clock-ptp-config.yaml[] +---- diff --git a/.vale/fixtures/OpenShiftAsciiDoc/HardWrappedLines/.vale.ini b/.vale/fixtures/OpenShiftAsciiDoc/HardWrappedLines/.vale.ini new file mode 100644 index 0000000..e4c4729 --- /dev/null +++ b/.vale/fixtures/OpenShiftAsciiDoc/HardWrappedLines/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `HardWrappedLines` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +OpenShiftAsciiDoc.HardWrappedLines = YES diff --git a/.vale/fixtures/OpenShiftAsciiDoc/HardWrappedLines/testinvalid.adoc b/.vale/fixtures/OpenShiftAsciiDoc/HardWrappedLines/testinvalid.adoc new file mode 100644 index 0000000..58f2573 --- /dev/null +++ b/.vale/fixtures/OpenShiftAsciiDoc/HardWrappedLines/testinvalid.adoc @@ -0,0 +1,2 @@ +//vale-fixture +Est eh ex, a rhoncus magna condimentum a. Aenean ut sem blandit, consectetur nisi diff --git a/.vale/fixtures/OpenShiftAsciiDoc/HardWrappedLines/testvalid.adoc b/.vale/fixtures/OpenShiftAsciiDoc/HardWrappedLines/testvalid.adoc new file mode 100644 index 0000000..dc2dd3a --- /dev/null +++ b/.vale/fixtures/OpenShiftAsciiDoc/HardWrappedLines/testvalid.adoc @@ -0,0 +1,107 @@ +//vale-fixture +:_mod-docs-content-type: ASSEMBLY +:url-home: https://asciidoctor.org +:link-docs: https://asciidoctor.org/docs[documentation] +[id="rosa-getting-started-on-really-very-long-id-with-extra-text"] += Comprehensive guide to getting started with {product-title} + +.REPLACE_WITH_TABLE_TITLE +[cols=2*, width="40%", options="header"] +|==== +|Firefox +|Web Browser + +|Ruby +|Programming Language + +|TorqueBox +|Application Server <1> +|==== +<1> Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse cursus urna +<2> Lorem ipsum dolor sit amet, consectetur adipiscing elit. + +[cols=2*, width="90%", options="header"] +|==== +|Requirement +|Description + +|SSD hard disks +a|* 1 SSD split into 15 200GB thin-provisioned logical volumes provisioned as `PV` CRs +* 1 SSD serving as an extra large `PV` resource +|==== + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse cursus urna, nulla. +Sed imperdiet nec nunc a dignissim srdfh amet dolor mollissrdfh fgtf. + +[source,yaml] +---- +# This CR verifies the installation/upgrade of the Cluster Logging Operator +apiVersion: operators.coreos.com/v1 +kind: Operator +metadata: + name: cluster-logging.openshift-logging + annotations: + ran.openshift.io/ztp-deploy-wave: "2" +status: + components: + refs: + - kind: Subscription + namespace: openshift-logging + conditions: + - type: CatalogSourcesUnhealthy + status: "False" + - kind: InstallPlan + namespace: openshift-logging + conditions: + - type: Installed + status: "True" + - kind: ClusterServiceVersion + namespace: openshift-logging + conditions: + - type: Succeeded + status: "True" + reason: InstallSucceeded +---- + +Bullet lists are OK. + +* Lorem ipsum dolor sit amet consectetur adipiscing elit furp +** Lorem ipsum dolor sit amet consectetur adipiscing elit furp +* three + +. Lists are ok Lorem ipsum dolor sit amet consectetur adipiscing elit furp +.. Lists are ok Lorem ipsum dolor sit amet consectetur adipiscing elit furp + +- Lists are ok Lorem ipsum dolor sit amet consectetur adipiscing elit furp +-- Lists are ok Lorem ipsum dolor sit amet consectetur adipiscing elit furp + +ifdef::openshift-origin,openshift-enterprise,openshift-webscale[] +* Hybrid cloud deployments. You can deploy {product-title} clusters to a variety of public cloud platforms or in your data center. +endif::[] + +==== +Here's a sample AsciiDoc document: + +---- += Title of Document +Doc Writer +:toc: + +This guide provides... +---- + +The document header is useful, but not required. +==== + +> I hold it that a little rebellion now and then is a good thing, and as necessary +> in the political world as storms in the physical. +> -- Thomas Jefferson, Papers of Thomas Jefferson: Volume 11 + +.High level {product-title} overview +image::product-workflow-overview.png[High-level {product-title} flow] + +include::modules/a-rather-very-very-long-very-log-very-long-indeed-so-long-file.adoc[] + +Hard drive:: Permanent storage for operating system and/or user files that are used on a daily basis + +`GET api/ocloudNotifications/v1/cluster/node//sync/ptp-status/lock-state/CurrentState` diff --git a/.vale/fixtures/OpenShiftAsciiDoc/IdHasContextVariable/.vale.ini b/.vale/fixtures/OpenShiftAsciiDoc/IdHasContextVariable/.vale.ini new file mode 100644 index 0000000..7926aff --- /dev/null +++ b/.vale/fixtures/OpenShiftAsciiDoc/IdHasContextVariable/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `IdHasContextVariable` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +OpenShiftAsciiDoc.IdHasContextVariable = YES diff --git a/.vale/fixtures/OpenShiftAsciiDoc/IdHasContextVariable/testinvalid.adoc b/.vale/fixtures/OpenShiftAsciiDoc/IdHasContextVariable/testinvalid.adoc new file mode 100644 index 0000000..10652a7 --- /dev/null +++ b/.vale/fixtures/OpenShiftAsciiDoc/IdHasContextVariable/testinvalid.adoc @@ -0,0 +1,5 @@ +//vale-fixture +[id="cli-basic-commands_"] + +//vale-fixture +[id="another-id-in-the-same-module-also-gets-flagged"] diff --git a/.vale/fixtures/OpenShiftAsciiDoc/IdHasContextVariable/testvalid.adoc b/.vale/fixtures/OpenShiftAsciiDoc/IdHasContextVariable/testvalid.adoc new file mode 100644 index 0000000..b1bae9c --- /dev/null +++ b/.vale/fixtures/OpenShiftAsciiDoc/IdHasContextVariable/testvalid.adoc @@ -0,0 +1,3 @@ +:_mod-docs-content-type: REFERENCE +[id="cli-basic-commands_{context}"] += Basic CLI commands diff --git a/.vale/fixtures/OpenShiftAsciiDoc/ModuleContainsContentType/.vale.ini b/.vale/fixtures/OpenShiftAsciiDoc/ModuleContainsContentType/.vale.ini new file mode 100644 index 0000000..7f26363 --- /dev/null +++ b/.vale/fixtures/OpenShiftAsciiDoc/ModuleContainsContentType/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `ModuleContainsContentType` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +OpenShiftAsciiDoc.ModuleContainsContentType = YES diff --git a/.vale/fixtures/OpenShiftAsciiDoc/ModuleContainsContentType/testinvalid.adoc b/.vale/fixtures/OpenShiftAsciiDoc/ModuleContainsContentType/testinvalid.adoc new file mode 100644 index 0000000..b1260e5 --- /dev/null +++ b/.vale/fixtures/OpenShiftAsciiDoc/ModuleContainsContentType/testinvalid.adoc @@ -0,0 +1,5 @@ +//vale-fixture +// Error only flagged from cmd line. If the content-type has the wrong test, or is missing entirely, the rule is triggered. +:_mod-docs-content-type: WRONG_TEXT +[id="cli-basic-commands_{context}"] += Basic CLI commands diff --git a/.vale/fixtures/OpenShiftAsciiDoc/ModuleContainsContentType/testvalid.adoc b/.vale/fixtures/OpenShiftAsciiDoc/ModuleContainsContentType/testvalid.adoc new file mode 100644 index 0000000..f2b905e --- /dev/null +++ b/.vale/fixtures/OpenShiftAsciiDoc/ModuleContainsContentType/testvalid.adoc @@ -0,0 +1,15 @@ +:_mod-docs-content-type: REFERENCE +[id="cli-basic-commands_{context}"] += Basic CLI commands + +:_mod-docs-content-type: PROCEDURE +[id="cli-basic-commands_{context}"] + +:_mod-docs-content-type: CONCEPT +[id="cli-basic-commands_{context}"] + +:_mod-docs-content-type: ASSEMBLY +[id="cli-basic-commands_{context}"] + +:_mod-docs-content-type: SNIPPET +[id="cli-basic-commands_{context}"] diff --git a/.vale/fixtures/OpenShiftAsciiDoc/ModuleContainsParentAssemblyComment/.vale.ini b/.vale/fixtures/OpenShiftAsciiDoc/ModuleContainsParentAssemblyComment/.vale.ini new file mode 100644 index 0000000..dded176 --- /dev/null +++ b/.vale/fixtures/OpenShiftAsciiDoc/ModuleContainsParentAssemblyComment/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `ModuleContainsParentAssemblyComment` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +OpenShiftAsciiDoc.ModuleContainsParentAssemblyComment = YES diff --git a/.vale/fixtures/OpenShiftAsciiDoc/ModuleContainsParentAssemblyComment/testinvalid.adoc b/.vale/fixtures/OpenShiftAsciiDoc/ModuleContainsParentAssemblyComment/testinvalid.adoc new file mode 100644 index 0000000..7e1cbe0 --- /dev/null +++ b/.vale/fixtures/OpenShiftAsciiDoc/ModuleContainsParentAssemblyComment/testinvalid.adoc @@ -0,0 +1,5 @@ +//vale-fixture +Here's some text. I have no commented lines in this file indicating the parent assembly. + + +This rule is only flagged when you run vale on this file from the cmd line. diff --git a/.vale/fixtures/OpenShiftAsciiDoc/ModuleContainsParentAssemblyComment/testvalid.adoc b/.vale/fixtures/OpenShiftAsciiDoc/ModuleContainsParentAssemblyComment/testvalid.adoc new file mode 100644 index 0000000..6c5defb --- /dev/null +++ b/.vale/fixtures/OpenShiftAsciiDoc/ModuleContainsParentAssemblyComment/testvalid.adoc @@ -0,0 +1,3 @@ +//Module is included in... + +//This module is included... diff --git a/.vale/fixtures/OpenShiftAsciiDoc/NoLineRanges/.vale.ini b/.vale/fixtures/OpenShiftAsciiDoc/NoLineRanges/.vale.ini new file mode 100644 index 0000000..ace796a --- /dev/null +++ b/.vale/fixtures/OpenShiftAsciiDoc/NoLineRanges/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `NoLineRanges` rule +StylesPath = ../../../styles +MinAlertLevel = error +[*.adoc] +OpenShiftAsciiDoc.NoLineRanges = YES diff --git a/.vale/fixtures/OpenShiftAsciiDoc/NoLineRanges/testinvalid.adoc b/.vale/fixtures/OpenShiftAsciiDoc/NoLineRanges/testinvalid.adoc new file mode 100644 index 0000000..0167e8c --- /dev/null +++ b/.vale/fixtures/OpenShiftAsciiDoc/NoLineRanges/testinvalid.adoc @@ -0,0 +1,11 @@ +//vale-fixture +include::filename.txt[lines=5..10] + +//vale-fixture +include::filename.txt[lines="1..10,15..20"] + +//vale-fixture +include::filename.txt[lines=7;14..25;28..43] + +//vale-fixture +include::filename.txt[lines=12..-1] diff --git a/.vale/fixtures/OpenShiftAsciiDoc/NoLineRanges/testvalid.adoc b/.vale/fixtures/OpenShiftAsciiDoc/NoLineRanges/testvalid.adoc new file mode 100644 index 0000000..78d2f5d --- /dev/null +++ b/.vale/fixtures/OpenShiftAsciiDoc/NoLineRanges/testvalid.adoc @@ -0,0 +1,15 @@ +include::snippets/technology-preview.adoc[leveloffset=+0] + +include::https://raw.githubusercontent.com/openshift/managed-cluster-validating-webhooks/master/docs/webhooks.json[] + +include::yaml/ordinary-clock.yaml[leveloffset=+0] + +include::yaml/ordinary-clock.yml[leveloffset=+0] + +include::ordinary-clock.json[leveloffset=+0] + +include::ordinary-clock.txt[leveloffset=+0] + +include::ordinary-clock.md[leveloffset=+0] + +include::xml/path/ordinary-clock.xml[] diff --git a/.vale/fixtures/OpenShiftAsciiDoc/NoNestingInModules/.vale.ini b/.vale/fixtures/OpenShiftAsciiDoc/NoNestingInModules/.vale.ini new file mode 100644 index 0000000..cb7dcd1 --- /dev/null +++ b/.vale/fixtures/OpenShiftAsciiDoc/NoNestingInModules/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `NoNestingInModules` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +OpenShiftAsciiDoc.NoNestingInModules = YES diff --git a/.vale/fixtures/OpenShiftAsciiDoc/NoNestingInModules/testinvalid.adoc b/.vale/fixtures/OpenShiftAsciiDoc/NoNestingInModules/testinvalid.adoc new file mode 100644 index 0000000..9df5c86 --- /dev/null +++ b/.vale/fixtures/OpenShiftAsciiDoc/NoNestingInModules/testinvalid.adoc @@ -0,0 +1,5 @@ +//vale-fixture +include::modules/rosa-getting-started-deleting-a-cluster.adoc[leveloffset=+1] + +//vale-fixture +include::rosa-getting-started-deleting-a-cluster.adoc[leveloffset=+1] diff --git a/.vale/fixtures/OpenShiftAsciiDoc/NoNestingInModules/testvalid.adoc b/.vale/fixtures/OpenShiftAsciiDoc/NoNestingInModules/testvalid.adoc new file mode 100644 index 0000000..78d2f5d --- /dev/null +++ b/.vale/fixtures/OpenShiftAsciiDoc/NoNestingInModules/testvalid.adoc @@ -0,0 +1,15 @@ +include::snippets/technology-preview.adoc[leveloffset=+0] + +include::https://raw.githubusercontent.com/openshift/managed-cluster-validating-webhooks/master/docs/webhooks.json[] + +include::yaml/ordinary-clock.yaml[leveloffset=+0] + +include::yaml/ordinary-clock.yml[leveloffset=+0] + +include::ordinary-clock.json[leveloffset=+0] + +include::ordinary-clock.txt[leveloffset=+0] + +include::ordinary-clock.md[leveloffset=+0] + +include::xml/path/ordinary-clock.xml[] diff --git a/.vale/fixtures/OpenShiftAsciiDoc/NoTocInModules/.vale.ini b/.vale/fixtures/OpenShiftAsciiDoc/NoTocInModules/.vale.ini new file mode 100644 index 0000000..6a4a126 --- /dev/null +++ b/.vale/fixtures/OpenShiftAsciiDoc/NoTocInModules/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `NoTocInModules` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +OpenShiftAsciiDoc.NoTocInModules = YES diff --git a/.vale/fixtures/OpenShiftAsciiDoc/NoTocInModules/testinvalid.adoc b/.vale/fixtures/OpenShiftAsciiDoc/NoTocInModules/testinvalid.adoc new file mode 100644 index 0000000..2a3c747 --- /dev/null +++ b/.vale/fixtures/OpenShiftAsciiDoc/NoTocInModules/testinvalid.adoc @@ -0,0 +1,6 @@ +//vale-fixture +:_mod-docs-content-type: REFERENCE +[id="cli-basic-commands_{context}"] += Basic CLI commands + +toc::[] diff --git a/.vale/fixtures/OpenShiftAsciiDoc/NoTocInModules/testvalid.adoc b/.vale/fixtures/OpenShiftAsciiDoc/NoTocInModules/testvalid.adoc new file mode 100644 index 0000000..6f2bcb9 --- /dev/null +++ b/.vale/fixtures/OpenShiftAsciiDoc/NoTocInModules/testvalid.adoc @@ -0,0 +1,4 @@ +//vale-fixture +:_mod-docs-content-type: REFERENCE +[id="cli-basic-commands_{context}"] += Basic CLI commands diff --git a/.vale/fixtures/OpenShiftAsciiDoc/NoXrefInModules/.vale.ini b/.vale/fixtures/OpenShiftAsciiDoc/NoXrefInModules/.vale.ini new file mode 100644 index 0000000..e51b482 --- /dev/null +++ b/.vale/fixtures/OpenShiftAsciiDoc/NoXrefInModules/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `NoXrefInModules` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +OpenShiftAsciiDoc.NoXrefInModules = YES diff --git a/.vale/fixtures/OpenShiftAsciiDoc/NoXrefInModules/testinvalid.adoc b/.vale/fixtures/OpenShiftAsciiDoc/NoXrefInModules/testinvalid.adoc new file mode 100644 index 0000000..885b8fc --- /dev/null +++ b/.vale/fixtures/OpenShiftAsciiDoc/NoXrefInModules/testinvalid.adoc @@ -0,0 +1,2 @@ +//vale-fixture +xref:../rosa_getting_started/rosa-getting-started.adoc#rosa-getting-started[Getting started with {product-title}] diff --git a/.vale/fixtures/OpenShiftAsciiDoc/NoXrefInModules/testvalid.adoc b/.vale/fixtures/OpenShiftAsciiDoc/NoXrefInModules/testvalid.adoc new file mode 100644 index 0000000..2a4fb8c --- /dev/null +++ b/.vale/fixtures/OpenShiftAsciiDoc/NoXrefInModules/testvalid.adoc @@ -0,0 +1 @@ +No xrefs here! diff --git a/.vale/fixtures/OpenShiftAsciiDoc/SuggestAttribute/.vale.ini b/.vale/fixtures/OpenShiftAsciiDoc/SuggestAttribute/.vale.ini new file mode 100644 index 0000000..6b43d1a --- /dev/null +++ b/.vale/fixtures/OpenShiftAsciiDoc/SuggestAttribute/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `SuggestAttribute` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +OpenShiftAsciiDoc.SuggestAttribute = YES diff --git a/.vale/fixtures/OpenShiftAsciiDoc/SuggestAttribute/testinvalid.adoc b/.vale/fixtures/OpenShiftAsciiDoc/SuggestAttribute/testinvalid.adoc new file mode 100644 index 0000000..ed118a0 --- /dev/null +++ b/.vale/fixtures/OpenShiftAsciiDoc/SuggestAttribute/testinvalid.adoc @@ -0,0 +1,180 @@ +//vale-fixture +OpenShift Container Platform +//vale-fixture +Alibaba Cloud +//vale-fixture +Bare Metal Event Relay +//vale-fixture +cert-manager Operator for Red Hat OpenShift +//vale-fixture +distributed tracing data collection +//vale-fixture +distributed tracing platform +//vale-fixture +distributed tracing +//vale-fixture +Factory-precaching-cli tool +//vale-fixture +factory-precaching-cli tool +//vale-fixture +GitOps ZTP +//vale-fixture +Hybrid Cloud Console +//vale-fixture +IBM Cloud +//vale-fixture +IBM Cloud Bare Metal +//vale-fixture +IBM LinuxONE +//vale-fixture +IBM Power +//vale-fixture +IBM Power Virtual Server +//vale-fixture +IBM Z +//vale-fixture +Logging subsystem for Red Hat OpenShift +//vale-fixture +logging subsystem for Red Hat OpenShift +//vale-fixture +LVM Storage +//vale-fixture +Migration Toolkit for Containers +//vale-fixture +MTC +//vale-fixture +odo +//vale-fixture +OpenShift Cluster Manager +//vale-fixture +OpenShift Data Foundation +//vale-fixture +OpenShift image registry +//vale-fixture +OpenShift Kubernetes Engine +//vale-fixture +OpenShift Pipelines +//vale-fixture +OpenShift Platform Plus +//vale-fixture +OpenShift sandboxed containers +//vale-fixture +OpenShift Serverless Functions +//vale-fixture +OpenShift Serverless Operator +//vale-fixture +Pipelines as Code +//vale-fixture +Red Hat Hybrid Cloud Console +//vale-fixture +Red Hat OpenShift Cluster Manager +//vale-fixture +Red Hat OpenShift Data Foundation +//vale-fixture +Red Hat OpenShift Dedicated +//vale-fixture +Red Hat OpenShift Dev Spaces +//vale-fixture +Red Hat OpenShift distributed tracing data collection +//vale-fixture +Red Hat OpenShift distributed tracing platform +//vale-fixture +Red Hat OpenShift GitOps +//vale-fixture +Red Hat OpenShift Local +//vale-fixture +Red Hat OpenShift Pipelines +//vale-fixture +Red Hat OpenShift Service Mesh +//vale-fixture +Red Hat OpenShift support for Windows Containers +//vale-fixture +Red Hat Quay Container Security Operator +//vale-fixture +RHACM +//vale-fixture +Run Once Duration Override Operator +//vale-fixture +Secondary Scheduler Operator +//vale-fixture +Single-node OpenShift +//vale-fixture +single-node OpenShift +//vale-fixture +TALM +//vale-fixture +Tekton Chains +//vale-fixture +Tekton Hub +//vale-fixture +Template Service Broker +//vale-fixture +Tempo Operator +//vale-fixture +Tempo +//vale-fixture +Three-node OpenShift +//vale-fixture +three-node OpenShift +//vale-fixture +Topology Aware Lifecycle Manager +//vale-fixture +velero.io +//vale-fixture +Web Terminal Operator +//vale-fixture +Cluster CAPI Operator +//vale-fixture +Cluster API Provider AWS +//vale-fixture +Cluster API Provider GCP +//vale-fixture +Cluster API Provider IBM Cloud +//vale-fixture +Cluster API Provider Kubevirt +//vale-fixture +Cluster API Provider OpenStack +//vale-fixture +Cluster API Provider OCI +//vale-fixture +Cluster API Provider vSphere +//vale-fixture +Cluster API Provider Nutanix +//vale-fixture +Cluster API Provider Azure +//vale-fixture +Cluster API Provider for AWS +//vale-fixture +Cluster API Provider for GCP +//vale-fixture +Cluster API Provider for IBM Cloud +//vale-fixture +Cluster API Provider for Kubevirt +//vale-fixture +Cluster API Provider for OpenStack +//vale-fixture +Cluster API Provider for OCI +//vale-fixture +Cluster API Provider for vSphere +//vale-fixture +Cluster API Provider for Nutanix +//vale-fixture +Cluster API Provider for Azure +//vale-fixture +CAPA +//vale-fixture +CAPG +//vale-fixture +CAPIBM +//vale-fixture +CAPK +//vale-fixture +CAPO +//vale-fixture +CAPOCI +//vale-fixture +CAPV +//vale-fixture +CAPX +//vale-fixture +CAPZ diff --git a/.vale/fixtures/OpenShiftAsciiDoc/SuggestAttribute/testvalid.adoc b/.vale/fixtures/OpenShiftAsciiDoc/SuggestAttribute/testvalid.adoc new file mode 100644 index 0000000..1410f07 --- /dev/null +++ b/.vale/fixtures/OpenShiftAsciiDoc/SuggestAttribute/testvalid.adoc @@ -0,0 +1,96 @@ +{product-title} +{product-title} +{alibaba} +{redfish-operator} +{cert-manager-operator} +{OTELShortName} +{JaegerShortName} +{DTShortName} +{factory-prestaging-tool-caps} +{factory-prestaging-tool} +{ztp-first} +{ztp} +{gitops-shortname} +{hybrid-console-second} +{ibm-title} +{ibm-cloud-title} +{ibm-cloud-bm-title} +{ibm-power-title} +{ibm-power-server-title} +{ibm-z-title} +{ibm-linuxone-title} +{logging-title-uc} +{logging-title} +{logging-uc} +{logging} +{lvms-first} +{lvms} +{mtc-full} +{mtc-short} +{odo-title} +{cluster-manager} +{rh-storage} +{product-registry} +{oke} +{pipelines-shortname} +{opp} +{sandboxed-containers-operator} +{sandboxed-containers-first} +{FunctionsProductName} +{ServerlessOperatorName} +{ServerlessProductName} +{pac} +{rh-rhacm-first} +{hybrid-console} +{cluster-manager-first} +{rh-storage-first} +{product-dedicated} +{openshift-dev-spaces-productname} +{OTELName} +{JaegerName} +{DTProductName} +{gitops-title} +{openshift-local-productname} +{pipelines-title} +{SMProductName} +{productwinc} +{rhq-cso} +{rh-rhacm} +{run-once-operator} +{secondary-scheduler-operator-full} +{secondary-scheduler-operator} +{ServerlessProductShortName} +{SMProductShortName} +{sno-caps} +{sno} +{cgu-operator} +{tekton-chains} +{tekton-hub} +{tsb-name} +{TempoName} +{TempoShortName} +{3no-caps} +{3no} +{cgu-operator-first} +{cgu-operator-full} +{velero-domain} +{web-terminal-op} +{cluster-capi-operator} +{capa-first} +{capa-short} +{capg-first} +{capg-short} +{capibm-first} +{capibm-short} +{capk-first} +{capk-short} +{capo-first} +{capo-short} +{capoci-first} +{capoci-short} +{capv-first} +{capv-short} +{capx-first} +{capx-short} +{capz-first} +{capz-short} diff --git a/.vale/fixtures/OpenShiftAsciiDoc/XrefContainsAnchorID/.vale.ini b/.vale/fixtures/OpenShiftAsciiDoc/XrefContainsAnchorID/.vale.ini new file mode 100644 index 0000000..621bd27 --- /dev/null +++ b/.vale/fixtures/OpenShiftAsciiDoc/XrefContainsAnchorID/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `XrefContainsAnchorID` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +OpenShiftAsciiDoc.XrefContainsAnchorID = YES diff --git a/.vale/fixtures/OpenShiftAsciiDoc/XrefContainsAnchorID/testinvalid.adoc b/.vale/fixtures/OpenShiftAsciiDoc/XrefContainsAnchorID/testinvalid.adoc new file mode 100644 index 0000000..5faba19 --- /dev/null +++ b/.vale/fixtures/OpenShiftAsciiDoc/XrefContainsAnchorID/testinvalid.adoc @@ -0,0 +1,8 @@ +//vale-fixture +xref:../rosa_getting_started/rosa-getting-started.adoc[Getting started with {product-title}] + +//vale-fixture +xref:../../rosa_getting_started/rosa-getting-started.adoc + +//vale-fixture +xref:../rosa_getting_started/rosa-getting-started.adoc[] diff --git a/.vale/fixtures/OpenShiftAsciiDoc/XrefContainsAnchorID/testvalid.adoc b/.vale/fixtures/OpenShiftAsciiDoc/XrefContainsAnchorID/testvalid.adoc new file mode 100644 index 0000000..b128ebb --- /dev/null +++ b/.vale/fixtures/OpenShiftAsciiDoc/XrefContainsAnchorID/testvalid.adoc @@ -0,0 +1,3 @@ +xref:../rosa_getting_started/rosa-getting-started.adoc#getting-started[Getting started with {product-title}] + +xref:../rosa_getting_started/rosa-getting-started.adoc#getting-started diff --git a/.vale/fixtures/OpenShiftAsciiDoc/XrefContainsHTML/.vale.ini b/.vale/fixtures/OpenShiftAsciiDoc/XrefContainsHTML/.vale.ini new file mode 100644 index 0000000..33a9e53 --- /dev/null +++ b/.vale/fixtures/OpenShiftAsciiDoc/XrefContainsHTML/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `XrefContainsHTML` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +OpenShiftAsciiDoc.XrefContainsHTML = YES diff --git a/.vale/fixtures/OpenShiftAsciiDoc/XrefContainsHTML/testinvalid.adoc b/.vale/fixtures/OpenShiftAsciiDoc/XrefContainsHTML/testinvalid.adoc new file mode 100644 index 0000000..dbc6841 --- /dev/null +++ b/.vale/fixtures/OpenShiftAsciiDoc/XrefContainsHTML/testinvalid.adoc @@ -0,0 +1,5 @@ +//vale-fixture +xref:../rosa_getting_started/rosa-getting-started.html#getting-started[Getting started with {product-title}] + +//vale-fixture +xref:../rosa_getting_started/rosa-getting-started.html#getting-started diff --git a/.vale/fixtures/OpenShiftAsciiDoc/XrefContainsHTML/testvalid.adoc b/.vale/fixtures/OpenShiftAsciiDoc/XrefContainsHTML/testvalid.adoc new file mode 100644 index 0000000..b128ebb --- /dev/null +++ b/.vale/fixtures/OpenShiftAsciiDoc/XrefContainsHTML/testvalid.adoc @@ -0,0 +1,3 @@ +xref:../rosa_getting_started/rosa-getting-started.adoc#getting-started[Getting started with {product-title}] + +xref:../rosa_getting_started/rosa-getting-started.adoc#getting-started diff --git a/.vale/fixtures/OpenShiftAsciiDoc/XrefMustNotHaveNakedLabel/.vale.ini b/.vale/fixtures/OpenShiftAsciiDoc/XrefMustNotHaveNakedLabel/.vale.ini new file mode 100644 index 0000000..7f88295 --- /dev/null +++ b/.vale/fixtures/OpenShiftAsciiDoc/XrefMustNotHaveNakedLabel/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `XrefMustNotHaveNakedLabel` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +OpenShiftAsciiDoc.XrefMustNotHaveNakedLabel = YES diff --git a/.vale/fixtures/OpenShiftAsciiDoc/XrefMustNotHaveNakedLabel/testinvalid.adoc b/.vale/fixtures/OpenShiftAsciiDoc/XrefMustNotHaveNakedLabel/testinvalid.adoc new file mode 100644 index 0000000..272e8f3 --- /dev/null +++ b/.vale/fixtures/OpenShiftAsciiDoc/XrefMustNotHaveNakedLabel/testinvalid.adoc @@ -0,0 +1,2 @@ +//vale-fixture +xref:../rosa_getting_started/rosa-getting-started.adoc#getting-started[] diff --git a/.vale/fixtures/OpenShiftAsciiDoc/XrefMustNotHaveNakedLabel/testvalid.adoc b/.vale/fixtures/OpenShiftAsciiDoc/XrefMustNotHaveNakedLabel/testvalid.adoc new file mode 100644 index 0000000..fc0458b --- /dev/null +++ b/.vale/fixtures/OpenShiftAsciiDoc/XrefMustNotHaveNakedLabel/testvalid.adoc @@ -0,0 +1,3 @@ +xref:../rosa_getting_started/rosa-getting-started.adoc#getting-started[Getting started with {product-title}] + +xref:../rosa_getting_started/rosa-getting-started.adoc#getting-started[Getting started] diff --git a/.vale/fixtures/RedHat/Abbreviations/.vale.ini b/.vale/fixtures/RedHat/Abbreviations/.vale.ini new file mode 100644 index 0000000..feda26d --- /dev/null +++ b/.vale/fixtures/RedHat/Abbreviations/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `Abbreviations` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +RedHat.Abbreviations = YES diff --git a/.vale/fixtures/RedHat/Abbreviations/testinvalid.adoc b/.vale/fixtures/RedHat/Abbreviations/testinvalid.adoc new file mode 100644 index 0000000..e69de29 diff --git a/.vale/fixtures/RedHat/Abbreviations/testvalid.adoc b/.vale/fixtures/RedHat/Abbreviations/testvalid.adoc new file mode 100644 index 0000000..e69de29 diff --git a/.vale/fixtures/RedHat/CaseSensitiveTerms/.vale.ini b/.vale/fixtures/RedHat/CaseSensitiveTerms/.vale.ini new file mode 100644 index 0000000..af30e7d --- /dev/null +++ b/.vale/fixtures/RedHat/CaseSensitiveTerms/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `CaseSensitiveTerms` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +RedHat.CaseSensitiveTerms = YES diff --git a/.vale/fixtures/RedHat/CaseSensitiveTerms/testinvalid.adoc b/.vale/fixtures/RedHat/CaseSensitiveTerms/testinvalid.adoc new file mode 100644 index 0000000..42ad2d0 --- /dev/null +++ b/.vale/fixtures/RedHat/CaseSensitiveTerms/testinvalid.adoc @@ -0,0 +1,561 @@ +A-MQ +A-MQ Broker +A-MQ Clients +A-MQ Console +A-MQ Interconnect +ack +ACK +ack packet +ActiveMQ +ActiveMQ Artemis +Admin Portal +Administration portal +Administrator Portal +Analysis +Ansible playbook +Ansible rulebook +Appliance Console +Application stream +application stream +Applix +ApplixWare +Appstream +appstream +Asciidoc +asciidoc +AsciiDoctor +asciidoctor +assertj +Assertj +auto-link +AutoLink +AWS opt in Region +basic auth +Basic auth +Basic Auth +basic authentication +Basic Authentication +BC +Bean +Bios +blue print +Blue Store +BluePrint +bluestore +BPM +BPMS +BRM +BRMS +BRMS engine +btrfs +burner +Business Central editor +c group +capex +capEx +Capex +Capsule server +CD 1 +Cds +CDS +Ceph Ansible +Ceph block device +Ceph block devices +Ceph file system +Ceph filesystem +Ceph monitor +Ceph object gateway +Ceph object gateways +ceph-osd +cephfs +CFME +CGroup +cidr +classic mode +Classless Inter-domain Routing +Classless Interdomain Routing +CloudForms Management Engine +Cluster Manager +command prompt +Compared to yaml, JSON has way more curly braces. +Composite Content view +composite content view +Composite View +composite view +configmap +configuration map +Content view +content view +control key +CP +crush map +crushmap +csv +ctrl +customer portal +cygmon +CygMon +CYGMON +Data Grid console +data warehouse +Dataware House +day-0 +Day-0 +day-1 +Day-1 +day-2 +Day-2 +Decision Server +Denial of Service +Denial-of-Service +Dev Ops +dev preview +Dev-Ops +Developer preview +Development Preview +devops +Devops +directory manager +directory server +disk druid +Disk druid +diskdruid +DM +DNF automatic +dnf automatic +dns +dotNet +DVD burner +DWH +EAP +engine VM +ETCD +Etcd +Exec Shield +exif +EXIF +Extranet +F.A.Q +facter +faq +Faq +fault tolerant +fault-tolerance +fedora project +File Store +filestore +Firewalld +firewallD +FirewallD +Firewire +firewire +FlatHub +FlatPak +fortran +fqdn +Fqdn +Fuse Ignite +gb +Gb +gbps +GBPS +GDBTK +gid +Gid +gimp +Gimp +GIT +gnome +Gnome +gnu +Gnu +gpl +Gpl +Graalvm +graalVM +green boots +Greenboot +GRPC +Grub +Gtk +gtk +GUI editor +hot rod +HotRod +hotrod +HP Proliant +HTTP interface +hyper-threading +hyperthreading +Hyperviser +HyperVisor +i-fix +i-Fix +ia64 +IA64 +IBM z Systems +ifix +iFix +Ignite +ignition config +IM +Image Builder +Image builder +Infiniband +INSTALL_DIR +installDir +Intel Tolapai +Iops +IOPs +Ip +IPSec +ipv4 +IPV4 +Ipv4 +ipv6 +IPV6 +Ipv6 +iSeries +iso +Istio Service Mesh +Itanium2 +jar file +javadoc +jbang +Jbang +JBoss +JBoss AMQ +JBoss BPMS +JBoss BRMS +JBoss Broker +JBoss Clients +JBoss Console +JBoss Data Grid +JBoss Enterprise Application Platform +JBoss Interconnect +JBoss.org +JDG +jetbrains +Jetbrains +Junit +junit +jvm +Jvm +k8s +kbase +Kernel +kernel-based virtual machine +kernelspace +key store +kickstart +Kie +kie API +Kie Server +kjar +kJAR +knowledge API +knowledge base +knowledge session +knowledgebase +ksession +Kubelet +kubernetes +kvm +lan +Lan +Librados +LIBRADOS +Librbd +LIBRBD +Lightweight Directory Access Protocol over Secure Socket Layer +linux +LINUX +live-backup group +Local Zone +local zone +Lun +lun +LZ +m-TLS +master CA +master server +micro-profile +Microprofile +MicroSoft +Microsoft Azure Portal +Microsoft Windows Server +MoM +Mom +mom +Mongo DB +Mongo-db +mongoDB +Mongodb +MS +ms-dos +Ms-Dos +msdos +MSDOS +MSFT +MTLS +mutual tls +Mutual tls +Mutual TLS +mySQL +MYSQL +native interface +network interface card +node.js +node.JS +Node.JS +nodejs +Nodejs +O.K.D. +Object Storage Device +objectclass +Objective-C +OCM +OCP +OD +ODF +ok +OK button +okay +okd +On-Demand Marketplace +OO +Open InfiniBand +Open Rewrite +openid connect +Openid Connect +openrewrite +Openrewrite +OpenShift Cluster Manager +OpenShift Kubernetes Distribution +Openshift online +OpenShift Origin +OpenStack Platform +Operating Environment +Operating System +Operator hub +Operator Hub +operatorhub +Operatorhub +opEx +Opex +OPEX +ORAN +Org Admin +org admin +Organization administrator +OS +OSD daemon +Overcloud +P-PC +Planner +Playbook +podman +Podman desktop +Pop-up +popup +posix +Posix +Postscript +Powershell +powershell +PPC64 +ppp +Ppp +prom +Prom +proof key for code exchange +proof of concepts +Properties editor +pSeries +puppet +puppet forge +q & a +Q & A +q&a +Q&A +qcow2 +Qcow2 +Qdmanage +QDMANAGE +Qdstat +QDSTAT +Qeth +QETH +ram +Ram +RAM-disk +ramdisk +RAMdisk +RAW +Red Boot +Red Hat Broker +Red Hat Console +Red Hat Interconnect +Red Hat JBoss Data Grid +Red Hat JBoss EAP +Red Hat Network Satellite server +Red Hat Proxy +Red Hat satellite +Red Hat Satellite Capsule server +Red Hat Satellite server +Red Hat Virtualization Hypervisor +Redboot +redis +Resource Planner +resteasy +Resteasy +RESTEASY +RH-OSP +RHCP +RHDS +RHEL host +RHEL-H +RHOS +RHV +RHV Host +RHV Manager +RHV-H +RHV-M +RHVM +Role Based Access Control +role based access control +Role-Based Access Control +rolling application stream +rolling application streams +rolling stream +rolling streams +rom +Rom +rpm +S-E Linux +s-record +s-Record +S-Record +samba +SAMBA +Satellite server +SE Linux +SE-Linux +self-hosted engine virtual machine +selinux +Shadow Man +Shadow passwords +Shadow utilities +ShadowMan +Smallrye +smart NIC +Smart State +smart state +Smart state +Smart-NIC +Smartstate +socks +SoftIRQ +software collection +Software collection +Source Navigator +source to image +Spec +Spice +spice +Spring boot +SR IOV +SREC +ssh +Ssh +SSL +SSL handshake +standard environment +standard Manager +Star Office +Staroffice +StartTLS +startTLS +StartX +STI +SU +sub version +Subscription manifest +Sys V +system d +system D +System V +SystemD +Technology preview +technology preview +The AMQ Broker +The Operator Lifecycle Manager +ttl +uid +UltraSparc +ULTRASPARC +unix +Unix +UNIX-like +uri +url +urn +Use the .NET Core framework +Use the .Net Core framework +Use the .Net framework +User Portal +var +VCPU +vcpu +VI +vim +VIM +Virtual Console +Virtual Desktop Server Management +Virtual Machine Portal +Virtual Network Interface Card +virtual-console +VisualStudio Code +VisualStudioCode +vlan +vLAN +VM portal +vm portal +vnic +VNIC +vnuma +VNUMA +vpn +VS Code +VSCode +VT +VT-i +wan +wca +web-UI +webadmin +webadmin portal +Webauthn +webAuthn +WebAuthN +Websocket +websocket +webUI +wi-fi +WiFi +Wifi +Window-Maker +WindowMaker +x-plat cli +X-PLAT CLI +x-plat-cli +X-PLAT-CLI +Xemacs +Xp +xp +xplat cli +XPLAT CLI +xplat-cli +XPLAT-CLI +Xterm +Yaml is not a markup language. diff --git a/.vale/fixtures/RedHat/CaseSensitiveTerms/testvalid.adoc b/.vale/fixtures/RedHat/CaseSensitiveTerms/testvalid.adoc new file mode 100644 index 0000000..ca8719e --- /dev/null +++ b/.vale/fixtures/RedHat/CaseSensitiveTerms/testvalid.adoc @@ -0,0 +1,338 @@ +.NET +// suppress inspection "IncorrectFormatting" for whole file +/var +ACK flag +Administration Portal +Amazon Web Services +AMQ +AMQ Broker +AMQ Clients +AMQ Console +AMQ Interconnect +Ansible Playbook +Apache Subversion +Appliance console +Application Stream +Applixware +AppStream repository +AsciiDoc +Asciidoctor +AssertJ +autolink +Azure Red Hat OpenShift +Basic authentication +Basic HTTP authentication +BIND +bind +BIOS +blueprint +BlueStore +Btrfs +built-in messaging +Business Central +Business Resource Planner +CapEx +capsule +Capsule Server +CD #1 +CDs +Central +Ceph Block Device +Ceph File System +Ceph Monitor +Ceph Object Gateway +ceph-ansible +CephFS +cgroup +CIDR +Command Prompt +Composite Content View +ConfigMap +Content View +CRUSH map +CSV +Ctrl +Customer Portal +Cygmon +Data Grid +Data Grid Console +Data Warehouse +Day 0 +Day 1 +Day 2 +Dedicated +denial of service +denial-of-service +Developer Preview +DevOps +Directory Manager +Directory Server +Disk Druid +DM Multipath +DM-Multipath +DNF Automatic +DNS +DVD writer +Editor +etcd +Exec-Shield +Exif +extranet +Facter +FAQ +fault tolerance +fault-tolerant +Fedora™ Project +File extension example.yaml must pass. +FileStore +firewalld +FireWire +Fortran +FQDN +Fuse Online +Fuse Online|Red Hat Fuse Online|Syndesis +FUSE_HOME +GB +Gbps +GID +GIMP +Git +GNOME +GNOME Classic +GNU +GPL +GraalVM +greenboot +gRPC +GRUB +GTK+ +GUI +guided editor +Hibernate ORM +Hot Rod +HP ProLiant +Hyper-Threading +hypervisor +IBM eServer System p +IBM S/390 +IBM Z +IdM CA renewal server +IdM server and replicas +Ignition config +image builder +inference engine +InfiniBand +Insight +Insights image builder +Intel Virtualization Technology +Intel(R) EP80579 Integrated Processor +Intelligent Process Server +IOPS +IP +IPsec +IPv4 +IPv6 +ISeries +ISO +ISO image +Istio service mesh +Itanium +Itanium 2 +JAR file +Javadoc +JBang +JBoss Community +JBoss EAP +JBoss EAP built-in messaging +JBoss EAP messaging +JetBrains +JUnit +JVM +kernel +kernel space +Kernel-based Virtual Machine +Kernel Module Management +keystore +Kickstart +KIE +KIE API +KIE base +KIE session +KJAR +Knowledgebase +kubelet +Kubelet Stats Receiver +Kubernetes +KVM +LAN +LDAPS +librados +librbd +Linux +Liquibase +LUN +management CLI +management console +Manager virtual machine +Mandrel +master-slave group +MicroProfile +Microsoft +Microsoft Azure Cross-Platform Command-Line Interface +Microsoft Azure On-Demand Marketplace +Microsoft Azure portal +Mockito +MOM +MongoDB +ms +MS-DOS +mTLS +mutual TLS +MySQL +network interface controller (NIC) +Node.js +O-RAN +object class +objectClass +Objective C +OK +OKD +OpenID Connect +OpenRewrite +OpenTelemetry +operating environment +operating system +Operator Lifecycle Manager +OperatorHub +OpEx +Organization Administrator +OSD +OTel +overcloud +Podman +pop-up +POSIX +PostScript +PowerPC +PowerShell +PPP +PROM +Proof Key for Code Exchange +proof of concept +Properties View +Puppet +Puppet Forge +Q and A +QCOW2 +qdmanage +qdstat +qeth +RAM +RAM disk +raw +Realtime Decision Server +Red Hat AMQ +Red Hat build of OpenJDK +Red Hat CloudForms +Red Hat CloudForms Appliance +Red Hat CloudForms|Red Hat CloudForms Appliance +Red Hat Customer Portal +Red Hat Data Grid +Red Hat Directory Server +Red Hat Enterprise Linux host +Red Hat Fuse Online +Red Hat JBoss BPM Suite +Red Hat JBoss BRMS +Red Hat JBoss Enterprise Application Platform +Red Hat Network Proxy Server +Red Hat Network Satellite Server +Red Hat OpenShift Cluster Manager +Red Hat OpenShift Container Platform +Red Hat OpenShift Data Foundation +Red Hat OpenShift Dedicated +Red Hat OpenShift Online +Red Hat OpenStack Platform +Red Hat Satellite +Red Hat Satellite Capsule Server +Red Hat Satellite Server +Red Hat Virtualization +Red Hat Virtualization Host +Red Hat Virtualization Manager +RedBoot +Redis +RESTEasy +role-based access control +Rolling Application Stream +Rolling Application Streams +Rolling Stream +Rolling Streams +ROM +RPM +S-record +Samba +Satellite Server +SELinux +shadow passwords +shadow utilities +Shadowman +SmartNIC +SmartState analysis +SOCKS +softirq +Software Collection +Source-Navigator^TM^ +Source-to-Image (S2I) +spec +SPICE +Spring Boot +SR-IOV +SSH +SSL/TLS +standalone Manager +StarOffice +STARTTLS +startx +su +Subscription Manifest +Syndesis +systemd +SysV +T-BC +Technology Preview +Temurin +The .NET framework +TLS handshake +TTL +UID +UltraSPARC +undercloud +UNIX +URI +URL +URN +VAR +vCPU +VDSM +vi +Vim +virtual console +Visual Studio Code +VLAN +VM Portal +vNIC +vNUMA node +VPN +VT-d +WAN +WCA +Web services +web UI +WebAuthn +WebSocket +Window Maker +Windows +Windows Server +XEmacs +XP +xterm +YAML diff --git a/.vale/fixtures/RedHat/Conjunctions/.vale.ini b/.vale/fixtures/RedHat/Conjunctions/.vale.ini new file mode 100644 index 0000000..ffb0ff9 --- /dev/null +++ b/.vale/fixtures/RedHat/Conjunctions/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `Conjunctions` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +RedHat.Conjunctions = YES diff --git a/.vale/fixtures/RedHat/Conjunctions/testinvalid.adoc b/.vale/fixtures/RedHat/Conjunctions/testinvalid.adoc new file mode 100644 index 0000000..e69de29 diff --git a/.vale/fixtures/RedHat/Conjunctions/testvalid.adoc b/.vale/fixtures/RedHat/Conjunctions/testvalid.adoc new file mode 100644 index 0000000..e69de29 diff --git a/.vale/fixtures/RedHat/ConsciousLanguage/.vale.ini b/.vale/fixtures/RedHat/ConsciousLanguage/.vale.ini new file mode 100644 index 0000000..69218b8 --- /dev/null +++ b/.vale/fixtures/RedHat/ConsciousLanguage/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `ConsciousLanguage` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +RedHat.ConsciousLanguage = YES diff --git a/.vale/fixtures/RedHat/ConsciousLanguage/testinvalid.adoc b/.vale/fixtures/RedHat/ConsciousLanguage/testinvalid.adoc new file mode 100644 index 0000000..0ba6b98 --- /dev/null +++ b/.vale/fixtures/RedHat/ConsciousLanguage/testinvalid.adoc @@ -0,0 +1,4 @@ +blacklist +master +slave +whitelist diff --git a/.vale/fixtures/RedHat/ConsciousLanguage/testvalid.adoc b/.vale/fixtures/RedHat/ConsciousLanguage/testvalid.adoc new file mode 100644 index 0000000..38bc8f7 --- /dev/null +++ b/.vale/fixtures/RedHat/ConsciousLanguage/testvalid.adoc @@ -0,0 +1,17 @@ +allowlist +blocklist +controller +device +director +host +initiator +master broker +performer +primary +proxy +replica +requester +responder +secondary +source +worker diff --git a/.vale/fixtures/RedHat/Contractions/.vale.ini b/.vale/fixtures/RedHat/Contractions/.vale.ini new file mode 100644 index 0000000..44c1a7c --- /dev/null +++ b/.vale/fixtures/RedHat/Contractions/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `Contractions` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +RedHat.Contractions = YES diff --git a/.vale/fixtures/RedHat/Contractions/source.adoc b/.vale/fixtures/RedHat/Contractions/source.adoc new file mode 100644 index 0000000..b01cb3c --- /dev/null +++ b/.vale/fixtures/RedHat/Contractions/source.adoc @@ -0,0 +1,34 @@ + "aren't": is not + "can't": cannot + "couldn't": could not + "didn't": did not + "doesn't": does not + "don't": do not + "hasn't": has not + "haven't": have not + "how'll": how will + "how's": how is + "isn't": is not + "it'll": it will + "it's": it is + "shouldn't": should not + "that'll": that will + "that's": that is + "they'll": they will + "they're": they are + "wasn't": was not + "we'll": we will + "we're": we are + "we've": we have + "weren't": were not + "what'll": what will + "what's": what is + "when'll": when will + "when's": when is + "where'll": where will + "where's": where is + "who'll": who will + "who's": who is + "why'll": why will + "why's": why is + "won't": will not diff --git a/.vale/fixtures/RedHat/Contractions/testinvalid.adoc b/.vale/fixtures/RedHat/Contractions/testinvalid.adoc new file mode 100644 index 0000000..aad9c40 --- /dev/null +++ b/.vale/fixtures/RedHat/Contractions/testinvalid.adoc @@ -0,0 +1,34 @@ +aren't +can't +couldn't +didn't +doesn't +don't +hasn't +haven't +how'll +how's +isn't +it'll +it's +shouldn't +that'll +that's +they'll +they're +wasn't +we'll +we're +we've +weren't +what'll +what's +when'll +when's +where'll +where's +who'll +who's +why'll +why's +won't diff --git a/.vale/fixtures/RedHat/Contractions/testvalid.adoc b/.vale/fixtures/RedHat/Contractions/testvalid.adoc new file mode 100644 index 0000000..0bdfdaf --- /dev/null +++ b/.vale/fixtures/RedHat/Contractions/testvalid.adoc @@ -0,0 +1,34 @@ +is not +cannot +could not +did not +does not +do not +has not +have not +how will +how is +is not +it will +it is +should not +that will +that is +they will +they are +was not +we will +we are +we have +were not +what will +what is +when will +when is +where will +where is +who will +who is +why will +why is +will not diff --git a/.vale/fixtures/RedHat/Definitions/.vale.ini b/.vale/fixtures/RedHat/Definitions/.vale.ini new file mode 100644 index 0000000..b953a7f --- /dev/null +++ b/.vale/fixtures/RedHat/Definitions/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `Definitions` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +RedHat.Definitions = YES diff --git a/.vale/fixtures/RedHat/Definitions/testinvalid.adoc b/.vale/fixtures/RedHat/Definitions/testinvalid.adoc new file mode 100644 index 0000000..4b0bd3f --- /dev/null +++ b/.vale/fixtures/RedHat/Definitions/testinvalid.adoc @@ -0,0 +1 @@ +OCS diff --git a/.vale/fixtures/RedHat/Definitions/testvalid.adoc b/.vale/fixtures/RedHat/Definitions/testvalid.adoc new file mode 100644 index 0000000..08df0ab --- /dev/null +++ b/.vale/fixtures/RedHat/Definitions/testvalid.adoc @@ -0,0 +1,191 @@ +// suppress inspection "IncorrectFormatting" for whole file +ACPI +AIX +API +APIs +ARM +ASCII +ASP +AWS +BIND +BIOS +DPDK +OVS +OVN +BMC +CD +CDs +CIDR +CLI +CNAME +CPU +CPUs +CSS +CSV +CUPS +CVE +CVE-2022-1234 +CVEs +DEBUG +DHCP +DNF +DNS +DOM +DOS +DPI +DRL +DSL +DVD +DVDs +EIP +ELB +ERROR +FAQ +FQDN +FTP +GAS +GCC +GCJ +GDB +GET +GID +GIDs +GIF +GIMP +GNOME +Global Navigation Satellite System (GNSS) +GNSS +GNU +GNUPro +GPL +GPU +GRUB +GTK+ +GUI +GUID +HP +HTML +HTTP +HTTPS +IAM +IBM +IDE +IOPS +IP +ISO +IT +JAR +JPEG +JSON +JSX +JVM +KB +KIE +KVM +LAN +LDAP +LESS +LLDB +LPAR +LUKS +LVM +MAC +MB +MBR +MDS +NAT +NET +NFS +NGINX +NIC +NOTE +NULL +NVDA +OEM +OSS +PATH +PC +PDF +PG +PHP +PID +PIDs +PIN +PNG +POSIX +POST +PPP +PROM +PTP +PXE +QCOW2 +QEMU +RADOS +RAID +RAM +RAN +RBAC +RBD +REPL +REST +RFC +RGW +RHEL +ROM +ROMs +RPM +RPMs +RSA +SAML +SAP +SCM +SCSI +SCSS +SDK +SFTP +SHA-1 +SHA-2 +SOCKS +SPEC +SQL +SR-IOV +SSD +SSH +SSL +SSSD +SVG +SVN +SWAT +TBD +TCP +TLS +TODO +TTL +UDP +UEFI +UID +UIDs +UNIX +URI +URIs +URL +URLs +USB +UTC +UTF +UUID +VAR +VDO +VDSM +VGA +VLAN +VNC +VPN +WCA +XFS +XML +XSS +YAML +YUM +ZIP +ZTP diff --git a/.vale/fixtures/RedHat/DoNotUseTerms/.vale.ini b/.vale/fixtures/RedHat/DoNotUseTerms/.vale.ini new file mode 100644 index 0000000..748a5e2 --- /dev/null +++ b/.vale/fixtures/RedHat/DoNotUseTerms/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `DoNotUseTerms` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +RedHat.DoNotUseTerms = YES diff --git a/.vale/fixtures/RedHat/DoNotUseTerms/testinvalid.adoc b/.vale/fixtures/RedHat/DoNotUseTerms/testinvalid.adoc new file mode 100644 index 0000000..2ef7d2a --- /dev/null +++ b/.vale/fixtures/RedHat/DoNotUseTerms/testinvalid.adoc @@ -0,0 +1,23 @@ +ACK +basically +congratulations +foo +fubar +future-proof +green +yellow +blue +kerberize +kerberized +native interface +out of the box +out-of-the-box +overhead +please +quiescent +resides +respective +respectively +time-tested +debuggable +and/or diff --git a/.vale/fixtures/RedHat/DoNotUseTerms/testvalid.adoc b/.vale/fixtures/RedHat/DoNotUseTerms/testvalid.adoc new file mode 100644 index 0000000..a2d7109 --- /dev/null +++ b/.vale/fixtures/RedHat/DoNotUseTerms/testvalid.adoc @@ -0,0 +1,6 @@ +hash sign +ACK flag +Red Hat +Red{nbsp}Hat +redhat +red-hat diff --git a/.vale/fixtures/RedHat/Ellipses/.vale.ini b/.vale/fixtures/RedHat/Ellipses/.vale.ini new file mode 100644 index 0000000..a7d7a5d --- /dev/null +++ b/.vale/fixtures/RedHat/Ellipses/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `Ellipses` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +RedHat.Ellipses = YES diff --git a/.vale/fixtures/RedHat/Ellipses/testinvalid.adoc b/.vale/fixtures/RedHat/Ellipses/testinvalid.adoc new file mode 100644 index 0000000..cb32106 --- /dev/null +++ b/.vale/fixtures/RedHat/Ellipses/testinvalid.adoc @@ -0,0 +1 @@ +this ... that diff --git a/.vale/fixtures/RedHat/Ellipses/testvalid.adoc b/.vale/fixtures/RedHat/Ellipses/testvalid.adoc new file mode 100644 index 0000000..e69de29 diff --git a/.vale/fixtures/RedHat/EmDash/.vale.ini b/.vale/fixtures/RedHat/EmDash/.vale.ini new file mode 100644 index 0000000..3746b20 --- /dev/null +++ b/.vale/fixtures/RedHat/EmDash/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `EmDash` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +RedHat.EmDash = YES diff --git a/.vale/fixtures/RedHat/EmDash/testinvalid.adoc b/.vale/fixtures/RedHat/EmDash/testinvalid.adoc new file mode 100644 index 0000000..3534f6b --- /dev/null +++ b/.vale/fixtures/RedHat/EmDash/testinvalid.adoc @@ -0,0 +1,2 @@ +If you make a mistake—for example, a typographical error—you can correct it easily. +Reliability, scalability, and availability—these are priorities for an enterprise system. diff --git a/.vale/fixtures/RedHat/EmDash/testvalid.adoc b/.vale/fixtures/RedHat/EmDash/testvalid.adoc new file mode 100644 index 0000000..d24df4f --- /dev/null +++ b/.vale/fixtures/RedHat/EmDash/testvalid.adoc @@ -0,0 +1 @@ +If you make a mistake (for example, a typographical error), you can correct it easily. diff --git a/.vale/fixtures/RedHat/HeadingPunctuation/.vale.ini b/.vale/fixtures/RedHat/HeadingPunctuation/.vale.ini new file mode 100644 index 0000000..b79ce07 --- /dev/null +++ b/.vale/fixtures/RedHat/HeadingPunctuation/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `HeadingPunctuation` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +RedHat.HeadingPunctuation = YES diff --git a/.vale/fixtures/RedHat/HeadingPunctuation/testinvalid.adoc b/.vale/fixtures/RedHat/HeadingPunctuation/testinvalid.adoc new file mode 100644 index 0000000..efa1eeb --- /dev/null +++ b/.vale/fixtures/RedHat/HeadingPunctuation/testinvalid.adoc @@ -0,0 +1 @@ += An invalid heading. diff --git a/.vale/fixtures/RedHat/HeadingPunctuation/testvalid.adoc b/.vale/fixtures/RedHat/HeadingPunctuation/testvalid.adoc new file mode 100644 index 0000000..242e677 --- /dev/null +++ b/.vale/fixtures/RedHat/HeadingPunctuation/testvalid.adoc @@ -0,0 +1 @@ += A valid heading diff --git a/.vale/fixtures/RedHat/Headings/.vale.ini b/.vale/fixtures/RedHat/Headings/.vale.ini new file mode 100644 index 0000000..c854fec --- /dev/null +++ b/.vale/fixtures/RedHat/Headings/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `Headings` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +RedHat.Headings = YES diff --git a/.vale/fixtures/RedHat/Headings/testinvalid.adoc b/.vale/fixtures/RedHat/Headings/testinvalid.adoc new file mode 100644 index 0000000..c849888 --- /dev/null +++ b/.vale/fixtures/RedHat/Headings/testinvalid.adoc @@ -0,0 +1 @@ += An Invalid Heading diff --git a/.vale/fixtures/RedHat/Headings/testvalid.adoc b/.vale/fixtures/RedHat/Headings/testvalid.adoc new file mode 100644 index 0000000..2b204cd --- /dev/null +++ b/.vale/fixtures/RedHat/Headings/testvalid.adoc @@ -0,0 +1,51 @@ += A valid heading +== Configuring Basic authentication +== Configuring Basic HTTP authentication +== GitLab Code Quality +== The Infinispan project +== Installing SmallRye to do xyz +== Installing RESTEasy with Quarkus +== A Jira instance +== Knative is a component used in Quarkus +== Eclipse Vert.x and Netty are upgraded in Quarkus +== IBM Cloud +== mTLS authentication +//== The mutual TLS authentication scheme +== Proof Key for Code Exchange +== Kogito updates +//== IBM Cloud is a valid product name +//== Spotify, GraphQL, and Quiltflower are proper nouns so uppercase in headings is OK. +== Redis is an in-memory data structure store that is used by several Red Hat products +== Repackage the JAR file +== Installing Podman Desktop +== Installing Flathub +== Installing Flatpak +== Flatpak Builder +== Software Development Kit +== Software Development Kits +== Application IDs +== AppData files +== The Electron base app +== The Node.js SDK extension +== Instructions for GTK +== Instructions for Qt +== Running Kind on Windows Subsystem for Linux (WSL) +== Technology Preview +== Using Podman Desktop +== Using a proxy requiring custom Certificate Authorities +== Using a proxy requiring custom Certificate Authorities (CA) +== JBang +== OpenRewrite something +== About Fluentd and Flyway +== About Graylog and Istio +== Installing JBoss Log Manager +== Troubleshooting with JBoss Logging +== Uninstalling Logstash +== About WebView +== Problems with gRPC and xDS +== Testing role-based access control in a heading +== Testing RBAC in a heading +== A Liquibase database +== Using Mockito +== Downloading the Eclipse Temurin distribution +== Configuring OpenTelemetry diff --git a/.vale/fixtures/RedHat/Hyphens/.vale.ini b/.vale/fixtures/RedHat/Hyphens/.vale.ini new file mode 100644 index 0000000..137a7d5 --- /dev/null +++ b/.vale/fixtures/RedHat/Hyphens/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `Hyphens` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +RedHat.Hyphens = YES diff --git a/.vale/fixtures/RedHat/Hyphens/testinvalid.adoc b/.vale/fixtures/RedHat/Hyphens/testinvalid.adoc new file mode 100644 index 0000000..48c8aa2 --- /dev/null +++ b/.vale/fixtures/RedHat/Hyphens/testinvalid.adoc @@ -0,0 +1,226 @@ +ad-hoc +addon +auto-configure +auto-generated +auto-install +auto-number +back-up +bi-annual +bi-directional +bi-monthly +bi-weekly +bilevel +broad cast +broad-cast +call out +call-out +check-out +checkin +client-server +cloud-bursting +cloud-washing +co-author +co-existence +co-locate +co-operate +co-ordinate +co-requisite +co-worker +comma delimited +comma separated +command driven +command-language +container based +counter-clockwise +counter-measures +cross platform +cross reference +cross site scripting +crossplatform +cyber-attack +cyber-crime +cyber-security +cyber-space +daisy-chain +daisychain +de-bias +de-bug +desk top +desk-top +disk-label +disklabel +domain-name +dotted-decimal +double-word +down-load +down-stream +e-book +e-mail +extra-linguistic +extra-partition +firm-ware +floating-point +fly-out +fore-ground +gray-scale +help-desk +hot-add +hot-line +hot-plug +hot-swap +hyper-active +hyper-converged +hyper-sensitive +in-line +infra-red +infra-structure +inter-active +inter-cept +inter-related +intra-node +intra-partition +intra-record +intra-system +load-balance +load-balancing +macro-instruction +macro-structure +meta data +meta-class +meta-data +meta-file +meta-table +micro-chip +micro-circuit +micro-code +mid-day +mid-term +mid-year +mini-computer +mini-course +mini-disk +mouse-button +mousebutton +multi site +multi-channel +multi-cloud +multi-factor +multi-media +multi-path +multi-plexer +multi-point +multi-processing +multi-processor +multi-schema +multi-site +multi-table +multi-tenant +multi-tier +multi-tiered +multi-vendor +multicore +multiinstance +new-line +non-compliant +non-contiguous +non-heap +non-interactive +non-linear +non-negotiable +non-paired +non-system +non-zero +nonnative +off-boarding +off-load +omni-channel +on-boarding +on-line +op-code +open-source +OpenSource +opensource +over ride +over-lay +over-ride +over-strike +plug in +plug ins +plug-in +plug-ins +post-editing +post-install +post-installation +post-mortem +post-operation +post-requisite +pre-apply +pre-assembled +pre-cache +pre-compile +pre-configure +pre-defined +pre-enrollment +pre-establish +pre-formatted +pre-install +pre-installation +pre-operational +pre-process +pre-processor +pre-runtime +pseudo-code +pseudo-random +pseudo-text +re-direct +re-edit +re-examine +re-synchronize +recreate +reenable +remote-access +run-time +semi-colon +semi-conductor +set-up +sound-card +stand-alone +straight-forward +sub-address +sub-area +sub-capacity +sub-class +sub-command +sub-directory +sub-menu +sub-net +sub-network +sub-package +sub-tab +super user +super-class +super-object +super-script +super-user +time-frame +time-out +timeframe +trade-off +un-available +un-committed +un-formatted +un-install +un-ordered +under-lying +under-run +under-used +up grade +up selling +up stream +up time +up-grade +up-sell +up-selling +up-stream +up-time +video-mode diff --git a/.vale/fixtures/RedHat/Hyphens/testvalid.adoc b/.vale/fixtures/RedHat/Hyphens/testvalid.adoc new file mode 100644 index 0000000..cd40125 --- /dev/null +++ b/.vale/fixtures/RedHat/Hyphens/testvalid.adoc @@ -0,0 +1,152 @@ +metadata +open source +override +plugins +plugin +superuser +time frame +upgrade +upselling +upstream +uptime +autoconfigure +autogenerate +autoinstall +autonumber +biannual +bidirectional +bimonthly +biweekly +bi-level +coauthor +coexistence +colocate +cooperate +coordinate +corequisite +coworker +counterclockwise +countermeasures +cyberattack +cybercrime +cybersecurity +cyberspace +extralinguistic +extrapartition +hyperactive +hypersensitive +infrared +infrastructure +interactive +intercept +interrelated +intranode +intrapartition +intrarecord +intrasystem +macroinstruction +macrostructure +metaclass +metafile +metatable +microchip +microcircuit +microcode +midday +midterm +midyear +minicomputer +minicourse +minidisk +mouse button +multisite +multichannel +multicloud +multifactor +multimedia +multipath +multiplexer +multipoint +multiprocessing +multiprocessor +multischema +multitable +multitenant +multitiered +multitiered +multivendor +multi-core +multi-instance +newline +noncompliant +noncontiguous +nonheap +noninteractive +nonlinear +nonnegotiable +nonpaired +nonsystem +nonzero +non-native +offboarding +offload +omnichannel +onboarding +online +opcode +overlay +override +overstrike +postediting +postinstallation +postmortem +postoperation +postrequisite +preapply +preassembled +precache +precompile +predefined +preenrollment +preestablish +preformatted +preinstallation +preoperational +preprocess +preprocessor +preruntime +pseudocode +pseudorandom +pseudotext +redirect +reedit +reexamine +resynchronize +re-create +re-enable +semicolon +semiconductor +subaddress +subarea +subcapacity +subclass +subcommand +subdirectory +submenu +subnet +subnetwork +subpackage +subtab +superclass +superobject +superscript +timeout +time out +unavailable +uncommitted +unformatted +unordered +underlying +underrun +underused +upsell diff --git a/.vale/fixtures/RedHat/MergeConflictMarkers/.vale.ini b/.vale/fixtures/RedHat/MergeConflictMarkers/.vale.ini new file mode 100644 index 0000000..22a7a18 --- /dev/null +++ b/.vale/fixtures/RedHat/MergeConflictMarkers/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `MergeConflictMarkers` rule +StylesPath = ../../../styles +MinAlertLevel = error +[*.adoc] +RedHat.MergeConflictMarkers = YES diff --git a/.vale/fixtures/RedHat/MergeConflictMarkers/testinvalid.adoc b/.vale/fixtures/RedHat/MergeConflictMarkers/testinvalid.adoc new file mode 100644 index 0000000..93cee8a --- /dev/null +++ b/.vale/fixtures/RedHat/MergeConflictMarkers/testinvalid.adoc @@ -0,0 +1,3 @@ +<<<<<<< HEAD +======= +>>>>>>> d14c1551c5 (test) diff --git a/.vale/fixtures/RedHat/MergeConflictMarkers/testvalid.adoc b/.vale/fixtures/RedHat/MergeConflictMarkers/testvalid.adoc new file mode 100644 index 0000000..ac5e323 --- /dev/null +++ b/.vale/fixtures/RedHat/MergeConflictMarkers/testvalid.adoc @@ -0,0 +1,3 @@ +|======= +====== +======== diff --git a/.vale/fixtures/RedHat/OxfordComma/.vale.ini b/.vale/fixtures/RedHat/OxfordComma/.vale.ini new file mode 100644 index 0000000..99e44d5 --- /dev/null +++ b/.vale/fixtures/RedHat/OxfordComma/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `OxfordComma` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +RedHat.OxfordComma = YES diff --git a/.vale/fixtures/RedHat/OxfordComma/testinvalid.adoc b/.vale/fixtures/RedHat/OxfordComma/testinvalid.adoc new file mode 100644 index 0000000..5c9eb8a --- /dev/null +++ b/.vale/fixtures/RedHat/OxfordComma/testinvalid.adoc @@ -0,0 +1,2 @@ +For lunch you can have cheese, carrots or peanuts. +This blanket is available in white, green and blue. diff --git a/.vale/fixtures/RedHat/OxfordComma/testvalid.adoc b/.vale/fixtures/RedHat/OxfordComma/testvalid.adoc new file mode 100644 index 0000000..7661bfb --- /dev/null +++ b/.vale/fixtures/RedHat/OxfordComma/testvalid.adoc @@ -0,0 +1,2 @@ +For lunch you can have cheese, carrots, or peanuts. +This blanket is available in white, green, and blue. diff --git a/.vale/fixtures/RedHat/PascalCamelCase/.vale.ini b/.vale/fixtures/RedHat/PascalCamelCase/.vale.ini new file mode 100644 index 0000000..1a5cea6 --- /dev/null +++ b/.vale/fixtures/RedHat/PascalCamelCase/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `PascalCamelCase` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +RedHat.PascalCamelCase = YES diff --git a/.vale/fixtures/RedHat/PascalCamelCase/testinvalid.adoc b/.vale/fixtures/RedHat/PascalCamelCase/testinvalid.adoc new file mode 100644 index 0000000..37cbcf6 --- /dev/null +++ b/.vale/fixtures/RedHat/PascalCamelCase/testinvalid.adoc @@ -0,0 +1,126 @@ +APIService +BareMetalHost +BrokerTemplateInstance +BuildConfig +CatalogSource +CertificateSigningRequest +CloudCredential +ClusterAutoscaler +ClusterCSIDriver +ClusterNetwork +ClusterOperator +ClusterResourceQuota +ClusterRole +ClusterRoleBinding +ClusterServiceVersion +ClusterTask +ClusterVersion +ComponentStatus +ConsoleCLIDownload +ConsoleExternalLogLink +ConsoleLink +ConsoleNotification +ConsoleYAMLSample +ContainerRuntimeConfig +ControllerConfig +ControllerRevision +CredentialsRequest +CronJob +CSIDriver +CSINode +CSISnapshotController +CustomResourceDefinition +DeploymentConfig +DNSRecord +EgressNetworkPolicy +EndpointSlice +FeatureGate +FlowSchema +HelmChartRepository +HorizontalPodAutoscaler +HostSubnet +ImageContentSourcePolicy +ImagePruner +ImageSignature +ImageStream +ImageStreamImage +ImageStreamImport +ImageStreamMapping +ImageStreamTag +ImageTag +IngressClass +IngressController +innerStopPod +InstallPlan +IPPool +KubeAPIServer +KubeControllerManager +KubeletConfig +KubeScheduler +KubeStorageVersionMigrator +LimitRange +LocalResourceAccessReview +LocalSubjectAccessReview +MachineAutoscaler +MachineConfig +MachineConfigPool +MachineHealthCheck +MachineSet +MutatingWebhookConfiguration +NetNamespace +NetworkAttachmentDefinition +NetworkPolicy +newCustomerId +OAuthAccessToken +OAuthAuthorizeToken +OAuthClient +OAuthClientAuthorization +OpenShiftAPIServer +OpenShiftControllerManager +OperatorGroup +OperatorPKI +PackageManifest +PersistentVolume is an API object. +PodDisruptionBudget +PodMonitor +PodSecurityPolicyReview +PodSecurityPolicySelfSubjectReview +PodSecurityPolicySubjectReview +PodTemplate +PriorityClass +PriorityLevelConfiguration +ProjectRequest +PrometheusRule +RangeAllocation +ReillyAidan +ReplicaSet +ReplicationController +ResourceAccessReview +ResourceQuota +RoleBinding +RoleBindingRestriction +RuntimeClass +SecurityContextConstraints +SelfSubjectAccessReview +SelfSubjectRulesReview +ServiceAccount +ServiceCA +ServiceMonitor +StatefulSet +StorageClass +StorageState +StorageVersionMigration +SubjectAccessReview +SubjectRulesReview +TemplateInstance +ThanosRuler +TokenReview +UserIdentityMapping +UserThing +ValidatingWebhookConfiguration +VolumeAttachment +VolumeSnapshot +VolumeSnapshotClass +VolumeSnapshotContent +xmlHttpRequest is a camel case term. +. youTubeImporter is a camel case term in a list. diff --git a/.vale/fixtures/RedHat/PascalCamelCase/testvalid.adoc b/.vale/fixtures/RedHat/PascalCamelCase/testvalid.adoc new file mode 100644 index 0000000..41e85f1 --- /dev/null +++ b/.vale/fixtures/RedHat/PascalCamelCase/testvalid.adoc @@ -0,0 +1,198 @@ +// suppress inspection "IncorrectFormatting" for whole file +== camelCase term should not be flagged in headings +3scale +AGPLv +AMQ +API +APIs +AppStream +AsciiDoc +AssertJ +BaseOS +BitBucket +BlueStore +CaaS +CapEx +CentOS +CephFS +CheckTree +ClassLoader +CloudForms +CodeReady +ConfigMap +ConfigMaps +ConnectX +Convert2RHEL +CoreOS +CPUs +DaemonSet +DDoS +DevOps +DevWorkspace +DNSSec +eServer +etcd +eXpress +eXtenSion +FaaS +FCoE +FDs +FileStore +FireWire +FreeRADIUS +GbE +GBps +GiB +GitHub +GitLab +GitOps +GlusterFS +GNUPro +GnuTLS +GraalVM +GraphQL +GTID +GTIDs +HashBase +HdrHistogram +Helm +HyperShift +IaaS +IBoE +IconBurst +Identity +IdM +IDs +IKEv +InfiniBand +Infrastructure +InnoDB +IntelliJ +IntelliSense +IPoIB +IPsec +IPv +ISeries +ISVs +JavaScript +JBoss +JetBrains +JUnit +kBps +KiB +LangTags +LGPLv +libOSMesa +LibreOffice +libXNVCtrl +LightPulse +LinuxONE +LiquidIO +Log4Shell +ManageIQ +MariaDB +MBps +MegaRAID +MiB +MicroProfile +MongoDB +MoreUtils +MySQL +NetBIOS +NetcoredebugOutput +NetWeaver +NetworkManager +NetXen +NetXtreme +NFSv +NMState +Node.js +NuGet +NVidia +NVMe +OAuth +objectClass +OmniSharp +OneConnect +OpenEXR +OpenID +OpenIPMI +OpenJDK +OpenRAN +OpenRewrite +OpenSCAP +OpenShift +OpenSSH +OpenSSL +OpenStack +OpenTelemetry +OpenTracing +OperatorHub +OpEx +OSBuild +OSs +OTel +PaaS +PackageKit +PathTools +PCIe +PDFs +PipeWire +PostgreSQL +PostScript +PowerPC +PowerShell +ProLiant +PulseAudio +PyPA +PyPI +QLogic +ReaR +RedBoot +relaxngDatatype +RESTEasy +RHEL +RoCE +RPMs +SaaS +SeaBIOS +SELinux +SLAs +SmallRye +SmartNIC +SmartState +SQLite +StarOffice +STMicroelectronics +Subscription +SuperLU +SysV +TBps +TiB +TuneD +TypeScript +UltraSPARC +USBGuard +UUIDs +vCPUs +vCenter +vDisk +vHost +VMs +VMware +vSphere +vSwitch +WebAuthn +WebSocket +WireGuard +Words at the start of a sentence should not trigger the rule. +XEmacs +xPaaS +XString +XWayland +YouTube +ZCentral +[source,terminal] +---- +PersistentVolumeClaim term should not be triggered in a code block +---- diff --git a/.vale/fixtures/RedHat/PassiveVoice/.vale.ini b/.vale/fixtures/RedHat/PassiveVoice/.vale.ini new file mode 100644 index 0000000..b49cb42 --- /dev/null +++ b/.vale/fixtures/RedHat/PassiveVoice/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `PassiveVoice` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +RedHat.PassiveVoice = YES diff --git a/.vale/fixtures/RedHat/PassiveVoice/testinvalid.adoc b/.vale/fixtures/RedHat/PassiveVoice/testinvalid.adoc new file mode 100644 index 0000000..bc545d3 --- /dev/null +++ b/.vale/fixtures/RedHat/PassiveVoice/testinvalid.adoc @@ -0,0 +1,176 @@ +It was decided +It was awoken +It was beat +It was become +It was been +It was begun +It was bent +It was beset +It was bet +It was bid +It was bidden +It was bitten +It was bled +It was blown +It was born +It was bought +It was bound +It was bred +It was broadcast +It was broken +It was brought +It was built +It was burnt +It was burst +It was cast +It was caught +It was chosen +It was clung +It was come +It was cost +It was crept +It was cut +It was dealt +It was dived +It was done +It was drawn +It was dreamt +It was driven +It was drunk +It was dug +It was eaten +It was fallen +It was fed +It was felt +It was fit +It was fled +It was flown +It was flung +It was forbidden +It was foregone +It was forgiven +It was forgotten +It was forsaken +It was fought +It was found +It was frozen +It was given +It was gone +It was gotten +It was ground +It was grown +It was heard +It was held +It was hidden +It was hit +It was hung +It was hurt +It was kept +It was knelt +It was knit +It was known +It was laid +It was lain +It was leapt +It was learnt +It was led +It was left +It was lent +It was let +It was lighted +It was lost +It was made +It was meant +It was met +It was misspelt +It was mistaken +It was mown +It was overcome +It was overdone +It was overtaken +It was overthrown +It was paid +It was pled +It was proven +It was put +It was quit +It was read +It was rid +It was ridden +It was risen +It was run +It was rung +It was said +It was sat +It was sawn +It was seen +It was sent +It was set +It was sewn +It was shaken +It was shaven +It was shed +It was shod +It was shone +It was shorn +It was shot +It was shown +It was shrunk +It was shut +It was slain +It was slept +It was slid +It was slit +It was slung +It was smitten +It was sold +It was sought +It was sown +It was sped +It was spent +It was spilt +It was spit +It was split +It was spoken +It was spread +It was sprung +It was spun +It was stolen +It was stood +It was stridden +It was striven +It was struck +It was strung +It was stuck +It was stung +It was stunk +It was sung +It was sunk +It was swept +It was swollen +It was sworn +It was swum +It was swung +It was taken +It was taught +It was thought +It was thrived +It was thrown +It was thrust +It was told +It was torn +It was trodden +It was understood +It was upheld +It was upset +It was wed +It was wept +It was withheld +It was withstood +It was woken +It was won +It was worn +It was wound +It was woven +It was written +It was wrung diff --git a/.vale/fixtures/RedHat/PassiveVoice/testvalid.adoc b/.vale/fixtures/RedHat/PassiveVoice/testvalid.adoc new file mode 100644 index 0000000..a3ffc70 --- /dev/null +++ b/.vale/fixtures/RedHat/PassiveVoice/testvalid.adoc @@ -0,0 +1,181 @@ +It awoken +It beat +It become +It been +It begun +It bent +It beset +It bet +It bid +It bidden +It bitten +It bled +It blown +It born +It bought +It bound +It bred +It broadcast +It broken +It brought +It built +It burnt +It burst +It cast +It caught +It chosen +It clung +It come +It cost +It crept +It cut +It dealt +It decided +It dived +It done +It drawn +It dreamt +It driven +It drunk +It dug +It eaten +It fallen +It fed +It felt +It fit +It fled +It flown +It flung +It forbidden +It foregone +It forgiven +It forgotten +It forsaken +It fought +It found +It frozen +It given +It gone +It gotten +It ground +It grown +It heard +It held +It hidden +It hit +It hung +It hurt +It is deprecated +It is imported +It is supported +It is tested +It is trusted +It kept +It knelt +It knit +It known +It laid +It lain +It leapt +It learnt +It led +It left +It lent +It let +It lighted +It lost +It made +It meant +It met +It misspelt +It mistaken +It mown +It overcome +It overdone +It overtaken +It overthrown +It paid +It pled +It proven +It put +It quit +It read +It rid +It ridden +It risen +It run +It rung +It said +It sat +It sawn +It seen +It sent +It set +It sewn +It shaken +It shaven +It shed +It shod +It shone +It shorn +It shot +It shown +It shrunk +It shut +It slain +It slept +It slid +It slit +It slung +It smitten +It sold +It sought +It sown +It sped +It spent +It spilt +It spit +It split +It spoken +It spread +It sprung +It spun +It stolen +It stood +It stridden +It striven +It struck +It strung +It stuck +It stung +It stunk +It sung +It sunk +It swept +It swollen +It sworn +It swum +It swung +It taken +It taught +It thought +It thrived +It thrown +It thrust +It told +It torn +It trodden +It understood +It upheld +It upset +It wed +It wept +It withheld +It withstood +It woken +It won +It worn +It wound +It woven +It written +It wrung diff --git a/.vale/fixtures/RedHat/ProductCentricWriting/.vale.ini b/.vale/fixtures/RedHat/ProductCentricWriting/.vale.ini new file mode 100644 index 0000000..7d393ea --- /dev/null +++ b/.vale/fixtures/RedHat/ProductCentricWriting/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `ProductCentricWriting` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +RedHat.ProductCentricWriting = YES diff --git a/.vale/fixtures/RedHat/ProductCentricWriting/testinvalid.adoc b/.vale/fixtures/RedHat/ProductCentricWriting/testinvalid.adoc new file mode 100644 index 0000000..8697697 --- /dev/null +++ b/.vale/fixtures/RedHat/ProductCentricWriting/testinvalid.adoc @@ -0,0 +1,5 @@ +The tools allow customers to use a Kubernetes Network Policy to create microsegmentation between deployed application services on the cluster. +The `monitoring-rules-edit` rule permits you to create and silence alerts in the *Developer* perspective in the web console. +The `must-gather` tool enables the user to collect diagnostic information about your cluster. +LoadBalancer lets users assign an external load balancer to an associated service API object in your {product-title} cluster. +LoadBalancer lets you assign an external load balancer to an associated service API object in your {product-title} cluster. diff --git a/.vale/fixtures/RedHat/ProductCentricWriting/testvalid.adoc b/.vale/fixtures/RedHat/ProductCentricWriting/testvalid.adoc new file mode 100644 index 0000000..e69de29 diff --git a/.vale/fixtures/RedHat/ReadabilityGrade/.vale.ini b/.vale/fixtures/RedHat/ReadabilityGrade/.vale.ini new file mode 100644 index 0000000..9a25382 --- /dev/null +++ b/.vale/fixtures/RedHat/ReadabilityGrade/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `ReadabilityGrade` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +RedHat.ReadabilityGrade = YES diff --git a/.vale/fixtures/RedHat/ReadabilityGrade/testinvalid.adoc b/.vale/fixtures/RedHat/ReadabilityGrade/testinvalid.adoc new file mode 100644 index 0000000..e69de29 diff --git a/.vale/fixtures/RedHat/ReadabilityGrade/testvalid.adoc b/.vale/fixtures/RedHat/ReadabilityGrade/testvalid.adoc new file mode 100644 index 0000000..e69de29 diff --git a/.vale/fixtures/RedHat/ReleaseNotes/.vale.ini b/.vale/fixtures/RedHat/ReleaseNotes/.vale.ini new file mode 100644 index 0000000..54dd95f --- /dev/null +++ b/.vale/fixtures/RedHat/ReleaseNotes/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `ReleaseNotes` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +RedHat.ReleaseNotes = YES diff --git a/.vale/fixtures/RedHat/ReleaseNotes/testinvalid.adoc b/.vale/fixtures/RedHat/ReleaseNotes/testinvalid.adoc new file mode 100644 index 0000000..194cd76 --- /dev/null +++ b/.vale/fixtures/RedHat/ReleaseNotes/testinvalid.adoc @@ -0,0 +1,2 @@ +Now +Previously diff --git a/.vale/fixtures/RedHat/ReleaseNotes/testvalid.adoc b/.vale/fixtures/RedHat/ReleaseNotes/testvalid.adoc new file mode 100644 index 0000000..8beed02 --- /dev/null +++ b/.vale/fixtures/RedHat/ReleaseNotes/testvalid.adoc @@ -0,0 +1,2 @@ +With this update +Before this update diff --git a/.vale/fixtures/RedHat/RepeatedWords/.vale.ini b/.vale/fixtures/RedHat/RepeatedWords/.vale.ini new file mode 100644 index 0000000..78b328d --- /dev/null +++ b/.vale/fixtures/RedHat/RepeatedWords/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `SentenceLength` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +RedHat.RepeatedWords = YES diff --git a/.vale/fixtures/RedHat/RepeatedWords/testinvalid.adoc b/.vale/fixtures/RedHat/RepeatedWords/testinvalid.adoc new file mode 100644 index 0000000..8855b0f --- /dev/null +++ b/.vale/fixtures/RedHat/RepeatedWords/testinvalid.adoc @@ -0,0 +1,2 @@ +This is is a sentence with a repeated word. +This is a test test. diff --git a/.vale/fixtures/RedHat/RepeatedWords/testvalid.adoc b/.vale/fixtures/RedHat/RepeatedWords/testvalid.adoc new file mode 100644 index 0000000..0740ca8 --- /dev/null +++ b/.vale/fixtures/RedHat/RepeatedWords/testvalid.adoc @@ -0,0 +1,6 @@ +This is a sentence without a repeated word. +This is a sentence with two instances of a word. +Allow searches to be performed on type, contributor, contributor type, and others. +This is a Text. Text is nice. +This is a text. Text is nice. +Select the THE checkbox. diff --git a/.vale/fixtures/RedHat/SelfReferentialText/.vale.ini b/.vale/fixtures/RedHat/SelfReferentialText/.vale.ini new file mode 100644 index 0000000..1de9278 --- /dev/null +++ b/.vale/fixtures/RedHat/SelfReferentialText/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `SelfReferentialText` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +RedHat.SelfReferentialText = YES diff --git a/.vale/fixtures/RedHat/SelfReferentialText/testinvalid.adoc b/.vale/fixtures/RedHat/SelfReferentialText/testinvalid.adoc new file mode 100644 index 0000000..35ee939 --- /dev/null +++ b/.vale/fixtures/RedHat/SelfReferentialText/testinvalid.adoc @@ -0,0 +1,11 @@ +This topic describes something. +This module describes something. +Follow the steps in this module to configure something. +This assembly describes something. +Follow the steps in this assembly to configure something. +This chapter describes something. +Follow the steps in this chapter to configure something. +This section describes something. +Follow the steps in this section to configure something. +This subsection describes something. +Follow the steps in this subsection to configure something. diff --git a/.vale/fixtures/RedHat/SelfReferentialText/testvalid.adoc b/.vale/fixtures/RedHat/SelfReferentialText/testvalid.adoc new file mode 100644 index 0000000..e69de29 diff --git a/.vale/fixtures/RedHat/SentenceLength/.vale.ini b/.vale/fixtures/RedHat/SentenceLength/.vale.ini new file mode 100644 index 0000000..2d28897 --- /dev/null +++ b/.vale/fixtures/RedHat/SentenceLength/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `SentenceLength` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +RedHat.SentenceLength = YES diff --git a/.vale/fixtures/RedHat/SentenceLength/testinvalid.adoc b/.vale/fixtures/RedHat/SentenceLength/testinvalid.adoc new file mode 100644 index 0000000..e69de29 diff --git a/.vale/fixtures/RedHat/SentenceLength/testvalid.adoc b/.vale/fixtures/RedHat/SentenceLength/testvalid.adoc new file mode 100644 index 0000000..e69de29 diff --git a/.vale/fixtures/RedHat/SimpleWords/.vale.ini b/.vale/fixtures/RedHat/SimpleWords/.vale.ini new file mode 100644 index 0000000..10bbc0f --- /dev/null +++ b/.vale/fixtures/RedHat/SimpleWords/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `SimpleWords` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +RedHat.SimpleWords = YES diff --git a/.vale/fixtures/RedHat/SimpleWords/testinvalid.adoc b/.vale/fixtures/RedHat/SimpleWords/testinvalid.adoc new file mode 100644 index 0000000..9b63ea1 --- /dev/null +++ b/.vale/fixtures/RedHat/SimpleWords/testinvalid.adoc @@ -0,0 +1,111 @@ +absent +abundance +accentuate +accompany +accomplish +accorded +accordingly +accrue +accurate +acquiesce +acquire +address +addressees +adjacent to +adjustment +admissible +advantageous +advise +aggregate +aircraft +alleviate +allocate +alternatively +alternatives +ameliorate +amend +anticipate +apparent +approximate +ascertain +assistance +attain +attempt +authorize +belated +bestow +cease +collaborate +commence +compensate +component +comprise +concerning +confer +consequently +consolidate +constitutes +contains +convene +demonstrate +depart +designate +desire +determine +detrimental +disclose +discontinue +disseminate +eliminate +elucidate +employ +enclosed +encounter +endeavor +enumerate +equitable +equivalent +exclusively +expedite +facilitate +females +finalize +frequently +identical +incorrect +indication +initiate +itemized +jeopardize +liaise +maintain +methodology +modify +monitor +multiple +necessitate +notify +numerous +objective +obligate +optimum +permit +portion +possess +previous +previously +prioritize +procure +provide +purchase +relocate +solicit +state-of-the-art +subsequent +substantial +sufficient +terminate +transmit +utilization +utilize +utilizing diff --git a/.vale/fixtures/RedHat/SimpleWords/testvalid.adoc b/.vale/fixtures/RedHat/SimpleWords/testvalid.adoc new file mode 100644 index 0000000..9cd7d8f --- /dev/null +++ b/.vale/fixtures/RedHat/SimpleWords/testvalid.adoc @@ -0,0 +1,122 @@ +about +add +agree +aim +allow +allowed +an address +ask +assign +award +bad +before +begin +best +bind +buy +carry out +cause +change +check +choices +choose +clear +compel +complete +count +decide +discover +discuss +divide +do +earlier +ease +end +enough +equal +exact +expect +explain +fair +find +find out +finish +form +forms +get +give +given +go with +goal +harmful +has +help +helpful +hurry +improve +include +included +inside +IP address +IPv4 address +IPv6 address +keep +large +late +later +latest +leave +let +listed +MAC address +many +meet +merge +method +most +move +next +next to +none +not here +offer +often +only +options +or +own +part +partner with +pay +plain +plane +plenty +prove +rank +request +right +risk +same +send +share +show +sign +so +speed up +start +stop +stress +support +tell +the address +total +try +use +want +watch +wish +women +work together +work with +wrong +you diff --git a/.vale/fixtures/RedHat/Slash/.vale.ini b/.vale/fixtures/RedHat/Slash/.vale.ini new file mode 100644 index 0000000..2d31a05 --- /dev/null +++ b/.vale/fixtures/RedHat/Slash/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `Slash` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +RedHat.Slash = YES diff --git a/.vale/fixtures/RedHat/Slash/testinvalid.adoc b/.vale/fixtures/RedHat/Slash/testinvalid.adoc new file mode 100644 index 0000000..c0c86b1 --- /dev/null +++ b/.vale/fixtures/RedHat/Slash/testinvalid.adoc @@ -0,0 +1,3 @@ +more/less +this/that +first/second/third diff --git a/.vale/fixtures/RedHat/Slash/testvalid.adoc b/.vale/fixtures/RedHat/Slash/testvalid.adoc new file mode 100644 index 0000000..0c25780 --- /dev/null +++ b/.vale/fixtures/RedHat/Slash/testvalid.adoc @@ -0,0 +1,17 @@ +/mnt/sysimage +07/2023 +192.168.0.0/16 +2023/07/21 +23/7 +C/C++ +client/server +I/O +input/output +Input/Output +N/A +read/write +SSL/TLS +TCP/IP +upstream/downstream +z/OS +z/OSMF diff --git a/.vale/fixtures/RedHat/SmartQuotes/.vale.ini b/.vale/fixtures/RedHat/SmartQuotes/.vale.ini new file mode 100644 index 0000000..a2805ae --- /dev/null +++ b/.vale/fixtures/RedHat/SmartQuotes/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `SmartQuotes` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +RedHat.SmartQuotes = YES diff --git a/.vale/fixtures/RedHat/SmartQuotes/testinvalid.adoc b/.vale/fixtures/RedHat/SmartQuotes/testinvalid.adoc new file mode 100644 index 0000000..648df5a --- /dev/null +++ b/.vale/fixtures/RedHat/SmartQuotes/testinvalid.adoc @@ -0,0 +1,4 @@ +‘Wrong‘ +’Also incorrect’ +″Bad″ +‶bad‶ diff --git a/.vale/fixtures/RedHat/SmartQuotes/testvalid.adoc b/.vale/fixtures/RedHat/SmartQuotes/testvalid.adoc new file mode 100644 index 0000000..c2933d3 --- /dev/null +++ b/.vale/fixtures/RedHat/SmartQuotes/testvalid.adoc @@ -0,0 +1,5 @@ +"Looks good" +"this is fine" +Jim's hair is black +`fine()` +He's good to go. diff --git a/.vale/fixtures/RedHat/Spacing/.vale.ini b/.vale/fixtures/RedHat/Spacing/.vale.ini new file mode 100644 index 0000000..6e0f191 --- /dev/null +++ b/.vale/fixtures/RedHat/Spacing/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `Spacing` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +RedHat.Spacing = YES diff --git a/.vale/fixtures/RedHat/Spacing/testinvalid.adoc b/.vale/fixtures/RedHat/Spacing/testinvalid.adoc new file mode 100644 index 0000000..0762032 --- /dev/null +++ b/.vale/fixtures/RedHat/Spacing/testinvalid.adoc @@ -0,0 +1,2 @@ +this. That +this.That diff --git a/.vale/fixtures/RedHat/Spacing/testvalid.adoc b/.vale/fixtures/RedHat/Spacing/testvalid.adoc new file mode 100644 index 0000000..706ccd9 --- /dev/null +++ b/.vale/fixtures/RedHat/Spacing/testvalid.adoc @@ -0,0 +1,4 @@ +this. That +https://rover.redhat.com/apps/ +www.example.com +docs.microsoft.com diff --git a/.vale/fixtures/RedHat/Spelling/.vale.ini b/.vale/fixtures/RedHat/Spelling/.vale.ini new file mode 100644 index 0000000..ebe4e87 --- /dev/null +++ b/.vale/fixtures/RedHat/Spelling/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `Spelling` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +RedHat.Spelling = YES diff --git a/.vale/fixtures/RedHat/Spelling/testinvalid.adoc b/.vale/fixtures/RedHat/Spelling/testinvalid.adoc new file mode 100644 index 0000000..cd3c7aa --- /dev/null +++ b/.vale/fixtures/RedHat/Spelling/testinvalid.adoc @@ -0,0 +1,59 @@ +ansible +antora +api +bitbucket +btrfs +centos +Centos +ceph +Classloader +crd +ctrl +Daemonset +dns +dotnet +gluster +Graal VM +graal vm +gui +homebrew +Ide +infinispan +intelephense +Intellij +Intellij IDEA +Jvm +kibana +kubespray +lombok +mattermost +microsoft azure +minikube +mokito +mokitto +Mysql +mysql +Netcoredebugoutput +nginx +Nuget +Oauth +Omnisharp +Openshift +Opentracing +php +podman +postgres +Postgresql +quarkus +redis +restic +Sbt +scm +svg +symfony +uber +velero +VMWare +woopra +yaml +zowe diff --git a/.vale/fixtures/RedHat/Spelling/testvalid.adoc b/.vale/fixtures/RedHat/Spelling/testvalid.adoc new file mode 100644 index 0000000..17ed7a2 --- /dev/null +++ b/.vale/fixtures/RedHat/Spelling/testvalid.adoc @@ -0,0 +1,649 @@ +// suppress inspection "IncorrectFormatting" for whole file +a .NET application +accessor +ACLs +adoc +AGPLv +Agroal +Allowlist +allowlist +Annobin +Ansible +Antora +API +APIs +Applixware +Asciidoctor +AssertJ +autoconfigure +autogenerate +autoinstall +autolink +automount +Automount +autonumber +autostart +Autostart +aws +AWS +backfilling +Backfilling +backport +backported +backtrace +Backtrace +bcrypt +bi-level +biannual +bidirectional +Bierner +bimonthly +bindable +Bindable +Bitbucket +biweekly +BOM +Bonjour +boolean +Boolean +bootable +Bootable +Bouncy Castle +breakpoint +Breakpoint +breakpoints +Breakpoints +btn +Btrfs +Bugzilla +build config +Buildah +camelCase +CentOS +Ceph +CephFS +cgroup +che +Che +Che-Theia +chrony +Chrony +Ciphertext +Civetweb +ClassLoader +classloading +Classloading +classpath +Cloudbursting +Cloudwashing +coauthor +CodeReady +coexistence +colocate +Colocate +colocation +Colocation +config +Config +config map +config maps +ConfigMap +ConfigMaps +configure +containerd +Containerfile +Containerfiles +Cookiecutter +cooperate +coordinate +corequisite +counterclockwise +countermeasures +coworker +CPU +CPUs +CR +CRD +CRDs +CRs +CSVs +Ctrl +CVEs +cyberattack +cybercrime +cybersecurity +cyberspace +Cygmon +DaemonSet +Datadog +declaratively +decompiler +defragmentation +deserialization +deserialize +deserialized +desynchronize +desynchronized +Dev +devfile +Devfile +devfiles +Devfiles +devworkspace +DevWorkspace +Dex +DNS +Docker +Dockerfile +Dockerfiles +Dotnet +downstream +Downstream +downstreaming +Downstreaming +Dyninst +Endevor +Endian +endif +eServer +Esprima +etcd +Exif +exposal +Exposal +extralinguistic +extranet +extrapartition +Fabrice +Facter +factories +Factories +factory +Factory +failback +Failback +failover +Failover +Failsafe +FDs +Fernflower +firewalld +Flathub +Flatpak +Fluentd +Flyway +Fortran +Funqy +Galera +Gbps +GCC +GID +GIDs +Git +GitHub +GitLab +glock +Glock +glocks +Glocks +Gluster +GNUPro +GraalVM +Gradle +Grafana +GraphQL +Graylog +Grayscale +greenboot +gRPC +GTIDs +GUI +hardcoding +Hashicorp +Heatmap +Helgrind +Helm +Homebrew +hostname +Hostname +htmltest +http +HTTP +https +HTTPS +hyperactive +Hyperconverged +hypersensitive +I/O +IDE +IDEs +IKEv +Infinispan +infrared +infrastructure +Inode +Intelephense +IntelliJ +interactive +intercept +interrelated +intranode +intrapartition +intrarecord +intrasystem +invocable +IPsec +IPv +ISeries +Istio +ISVs +Itanium +Item +Jakarta +Jandex +Java +Jave +JBang +JBoss +JetBrains +Jira +Jolokia +Journald +Journaling +Joyent +JUnit +JVM +Kafka +kbd +kdump +Kdump +Kerberos +Keycloak +Keylime +Keyring +Keyrings +keyspace +keystore +keytab +Keytab +keytabs +Keytabs +Kibana +Knative +Knowledgebase +Kogito +Kompose +kubelet +Kubernetes +Kubespray +Kylin +Laravel +Let's Encrypt +LGPLv +libOSMesa +librados +librbd +Libreswan +libvirt +Libvirt +Licensor +Liquibase +Liveness +Logstash +Lombok +Loopback +macroinstruction +macrostructure +Makefile +Matrixes +Mattermost +Maven +Mebibytes +metaclass +metadata +metafile +metatable +microchip +microcircuit +microcode +MicroProfile +Microsoft +Microsoft Azure +midday +Middleware +middleware +midterm +midyear +Millicores +minicomputer +minicourse +minidisk +Minikube +Minishift +Mirantis +Mixin +Mixins +Mockito +Modularization +MongoDB +monospace +mouse button +multi-core +multi-instance +multichannel +multicloud +Multicluster +multifactor +Multihost +multimedia +Multinode +multipath +Multipath +multiplexer +multipoint +multiprocessing +multiprocessor +multischema +multisite +multitable +multitenancy +Multitenant +multitenant +multithread +Multithread +multitiered +Multiuser +multivendor +Multizone +MySQL +Nagios +Namespace +Namespaces +Narayana +Neoverse +NetcoredebugOutput +Netty +Newdoc +newline +NFSv +Nginx +Node.js +non-native +noncompliant +noncontiguous +nonheap +noninteractive +nonlinear +nonnegotiable +nonpaired +nonsystem +nonzero +npm +NuGet +Nutanix +NVidia +NVMe +OAuth +objectClass +ocp +offboarding +offload +omnichannel +OmniSharp +Onboarding +onboarding +online +opcode +open source +OpenID +OpenJDK +OpenRewrite +OpenShift +OpenTelemetry +OpenTracing +Operator +OSBuild +osd +OSs +OSTree +overlay +overridable +override +overstrike +PCIe +PDFs +Petitboot +PHP +PIDs +pluggable +plugin +plugins +Podman +postediting +PostgreSQL +postinstall +postinstallation +postmortem +postoperation +postrequisite +PowerShell +preapply +preassembled +precache +precompile +precompiled +precompiles +preconfigure +preconfigured +Preconfigured +predefined +preenrollment +preestablish +preformatted +pregenerated +preinstall +preinstallation +preoperational +prepend +prepended +preprocess +preprocessor +preruntime +productize +productized +Prometheus +proxied +pseudocode +pseudorandom +pseudotext +Pulldown +Pytorch +qdmanage +qdstat +qeth +QLogic +Quarkiverse +Quarkus +Quiltflower +Qute +re-create +re-enable +Readonly +Realtime +reauthenticate +Rebalance +Rebalances +Rebalancing +Rebase +Rebased +Recertification +Recertifications +redirect +Redis +Redistributions +reedit +reenabled +reentrant +reexamine +refreshable +reindex +reindexing +relaxngDatatype +Reshard +Resharding +Reshards +RESTEasy +Restic +resynchronize +Resyncing +Rolfe +Rollout +Rollouts +Rollup +ROMs +rootful +rootless +Roundtable +Roundtables +RPMs +Rulebook +rulebook +ruleset +Runlevel +Runlevels +Runtime +Runtimes +Sakila +sbt +SCM +Scrollbar +SELinux +Semeru +semicolon +semiconductor +serializable +serialization +Serializer +Serverless +servlet +Shadowman +Sharding +Skopeo +SLA +SLAs +SmallRye +Spotify +startx +STMicroelectronics +Stratis +su +subaddress +subarea +subcapacity +subclass +Subcommand +subcommand +Subcommands +subdirectory +Submenu +submenu +Submenus +subnet +Subnetwork +subnetwork +Subnetworks +Subpackage +subpackage +Subpackages +Subpath +Subpaths +Substep +Substeps +subtab +Subtest +Subtests +Subuser +Subusers +Subvolume +Subvolumes +Suchow +superclass +superobject +superscript +superuser +SVG +Symfony +sysctl +Sysctl +sysctls +Sysctls +Systemd +Tekton +Telekom +Templated +Temurin +Tensorflow +Texinfo +Theia +time frame +timeout|time out +Tolerations +Toolset +traceback +Traceback +Traefik +Truststore +Uber +UIDs +umask +Umask +unavailable +Uncomment +uncommitted +Undercloud +underlying +underrun +underused +unformatted +Uninstallation +Unmount +Unmounting +unordered +Unported +Unstaged +Untrusted +upgrade +Upsell +upsell +Upselling +upselling +upstream +uptime +URI +URIs +URL +URLs +USBGuard +Valgrind +validator +vDisk +Velero +Vert.x +vHost +VMs +VMware +vsix +vSphere +WebAuthn +Webpack +WebSocket +wifi +Wildfly +Woopra +Wordpress +XString +XWayland +Yana +Yeoman +ZCentral +Zowe diff --git a/.vale/fixtures/RedHat/Symbols/.vale.ini b/.vale/fixtures/RedHat/Symbols/.vale.ini new file mode 100644 index 0000000..c0e7dc2 --- /dev/null +++ b/.vale/fixtures/RedHat/Symbols/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `Symbols` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +RedHat.Symbols = YES diff --git a/.vale/fixtures/RedHat/Symbols/testinvalid.adoc b/.vale/fixtures/RedHat/Symbols/testinvalid.adoc new file mode 100644 index 0000000..ff84c29 --- /dev/null +++ b/.vale/fixtures/RedHat/Symbols/testinvalid.adoc @@ -0,0 +1,2 @@ +Don't use this & that. +* Don't use this! diff --git a/.vale/fixtures/RedHat/Symbols/testvalid.adoc b/.vale/fixtures/RedHat/Symbols/testvalid.adoc new file mode 100644 index 0000000..5929335 --- /dev/null +++ b/.vale/fixtures/RedHat/Symbols/testvalid.adoc @@ -0,0 +1,15 @@ +:!attribute: +:attribute!: + +Use the "!" symbol +Use the "&" symbol + +[source,terminal] +---- +$ if ! [[ -z $THING ]]; then echo "hihi"; fi +---- + +[source,terminal] +---- +echo "bye bye" && exit +---- diff --git a/.vale/fixtures/RedHat/TermsErrors/.vale.ini b/.vale/fixtures/RedHat/TermsErrors/.vale.ini new file mode 100644 index 0000000..0103e4c --- /dev/null +++ b/.vale/fixtures/RedHat/TermsErrors/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `TermsErrors` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +RedHat.TermsErrors = YES diff --git a/.vale/fixtures/RedHat/TermsErrors/testinvalid.adoc b/.vale/fixtures/RedHat/TermsErrors/testinvalid.adoc new file mode 100644 index 0000000..2297075 --- /dev/null +++ b/.vale/fixtures/RedHat/TermsErrors/testinvalid.adoc @@ -0,0 +1,473 @@ +10BASET +24/7 +a lot +a number of +abort +ac +accelerator key +acknowledgement +adapter card +adaptor +administrate +adviser +air wall +aka +all right +alphanumerical +alright +am +amongst +analogue +analyse +anticlockwise +appendices +application program interface +artefact +as long as +as per +autodetect +back slash +backside +backwards compatible +barcode +best of breed +Bidi +Big Blue +bit map +bitfield +bitness +bitrate +bitstring +black hat hacker +blink +blue screen of death +boot diskette +bootloader +bottle neck +breadcrumbing +break point +bring up +bufferpool +builtin +bunches of +burner +busmaster +busses +byte code +Camelcase +CamelCase +cancelation +cancelled +cancelling +canned +cardreader +case insensitive +catalogue +catastrophic error +CBE +CBTS +CD burner +centre +check box +check list +check mark +chipset +Christian name +chronologic +cipher text +clear text +cleartext +codepage +codepoint +codeset +cold backup +cold boot +cold start +colours +combo box +comes with +CommServer +comprised of +computer farm +computer ranch +connect with +containerised +context menu +contextual help +control point logical unit +controlling logical unit +convertor +copy book +cyber attack +cyber attacker +cyber crime +cyber defense +cyber hacker +cyber intelligence +cyber security +cyber space +cyber terror +cyber threat +cyberresilience +cypher text +data base +datacentre +datafile +dataflow +datamart +datamirroring +datapath +datapool +dataset +datasheet +datum +daylight savings time +dc +DDNAME +deconfigure +deinstall +deinstallation +demilitarized zone +demon +demount +deployment configuration +depress +deregister +descendent +details pane +diagnostic tests +different than +different to +dismiss +disrupter +domain mode +DOS environment +double quote +double word +down time +downwards compatible +drill up +dual boot +dualboot +dumpfile +eFix +Elastic Load Balancer +emphasise +end user +enum +env +EUI +evangelist +fatal +fill in +finalise +fire up +Firefox +first name +fixed disk drive +flavor +focussed +forename +forward compatible +freezes +G11N +g11n +gage +grayed out +grey +gzipped file +hard boot +hard copy +hard file +hardcode +hardcoded +health care +healthcheck +heart beat +hence +hostgroup +hotkey +HOWTO +imbed +in depth +in other words +in spite of +in the event +inactivate +incent +incentivize +inch pound +information technology +initial caps +Internet address +Intranet +invoke +io +IPI +irrecoverable +is shipped with +JavaBean +joblog +jobstream +judgement +keep in mind +kernelspace +kick off +L10N +l10n +labelled +labour +large page +last name +learnings +learnt +leave out +left most +left-arrow key +left-hand +left-justified +left-justify +left-most +line cord +link edit +link editing +live broker +live only +loadtime +log into +log off of +log onto +logfile +lots of +main directory +make file +man day +man hour +manipulation button +manpage +masterbrand +matrices +memory stick +menu driven +menubar +menudriven +microcomputer +motherboard +mountpoint +mouse button 1 +mouse button 2 +mouse over +multijobbing +MV +nameserver +network-centric computing +newsfeed +nextgen +non-secure +nonrecoverable +nonsecure +notion +NWSAA +offline storage +on demand +on ramp +on the fly +on the other hand +on-ramp +oops +OpenShit +ops +opt into +opting into +organise +organised +organising +orientate +pain point +parent task +parent/child +passive broker +pathname +PCOMM +perfcounter +perimeter network +phillips screw +phillips screwdriver +phone +PL/1 +plain-text +plaintext +planar board +Plug-and-Play +pm +Pod Cast +Podcast +pojo +pop-up list +pop-up menu +pop-up window +pops up +pow wow +poweron +practise +preventative +print friendly +prior to +program product +programmed operator +Programming Language/I +proof of concepts +pub/sub +publish-subscribe +quickstart +Quickstart +read-write +recognise +Red Hat Java +Red Hat Open Java Development Kit +Red Hat OpenJDK +regex +requestor +RHOJDK +right now +right-hand +right-justified +right-justify +right-most +round table +round-robin task dispatching +rule of thumb +S 390 +sanity check +schemata +screencap +screensaver +scroll bar +second name +secondary storage +segregate +segregation +selection button +send out +serial database +Sharename +ships with +short cut +shortcut key +shortcut menu +sign into +sign off of +signoff +signon +Simple Object Access Protocol +single quote +single signon +smartcard +smartpaper +SME routine +snapset +snapsets +so long as +sockets interface +socksified +soft boot +soft copy +specfile +spelt +spend +standalone mode +sunset +super page +swapspace +switch off +synch +sysprep function +system engineer +tablespace +TCP/IP network +teleprocessing line +testcase +the installer +There are many ways to write, for instance, using a pencil. +thin provisioned +third-party software vendor +thru +thumb drive +thumbstick +Thunderbird +tier 1 +tier-one +time box +time line +time stamp +timeslice +timezone +toggle off +tool bar +tool box +tool kit +tool tip +ToolTip +totalled +touch base +touchscreen +trouble shoot +trust store +try and +twisty +TY-RAP +typo +unallocate +uncheck +uncompilation +uncompile +uncompress +undeploy +underbar +unencrypt +unselect +untar +unzip +upgradable +UPI +upward compatible +USB thumb drive +useable +utilize +vanilla +versus +virtual diskette +virtual diskette +virtual diskette drive +virtual diskette drive +virtual DOS machine +virtual hard disk +virtual hard disk +w/ this +w/o +wait condition +war room +warm boot +warmstart +warning notice +web cast +web master +web site +webmistress +white hat hacker +whitepaper +wild card +wiring closet +wish +work flow +work group +work load +work space +work station +would like +XSA +xsite +zero out +zeroes +zonegroup +Zulu time diff --git a/.vale/fixtures/RedHat/TermsErrors/testvalid.adoc b/.vale/fixtures/RedHat/TermsErrors/testvalid.adoc new file mode 100644 index 0000000..72b02a0 --- /dev/null +++ b/.vale/fixtures/RedHat/TermsErrors/testvalid.adoc @@ -0,0 +1,698 @@ +/etc +/etc/ +10BASE-T +10BASE2 +12.00 AM +24x7 +a or b +a, b, or both +AC +access method +according to +acknowledgment +ad hoc +adapter +add a prefix to +add-on +administer +advisor +advocate +afterward +air gap +allowlist +alphanumeric +also known as +alternatively +although +AM +ambassador +AMD64 +analog +and so on +Apache Subversion +app +appendixes +Application Load Balancer +application programming interface +archive +artifact +as +as expected +as in +as needed +as well as per recipient +attacker +attention notice +auto-detect +auxiliary storage +back +backslash +backup +bar code +bean +benchmark +best in class +bidi +bimonthly +bit field +bit rate +bit string +bit value +bit version +bitmap +biweekly +blocklist +boot disk +boot loader +bottleneck +breadcrumb trail +breakpoint +broadcast +BTS +buffer pool +bug fix +built-in +bus master +buses +bytecode +cable tie +callout +camel case +cancel +canceled +canceling +cancellation +cannot +card +card reader +catalog +CD writer +cell phone +center of operations +challenge +change +check-in +checkbox +checklist +checkmark +checkout +child +chip set +chronological +CICS BTS +ciphertext +class-like +Classic Load Balancer +clear +click +client/server +close +cloudbursting +cloudwashing +code page +code point +code set +collect +colocate +colocation +combination box +comma-delimited +comma-separated values +command center +command language +Command Prompt +command-driven +Common Base Event +communicate +Communications Server +compared to +compatible with earlier versions +compatible with later versions +compilation +complete +component architecture +component model +component-based development +compress +compressed file +concept +concern +connect to +consist of +consumer +contact +container-based +containerized +context-sensitive help +control logical unit +control room +conversely +converter +Coordinated Universal Time +copybook +corporate brand +correct +counterclockwise +create +create retrieve update and delete +cross-platform +cross-reference +cross-site replication +cross-site scripting +cyber resilience +cyberattack +cyberattacker +cybercrime +cyberdefense +cyberhacker +cyberintelligence +cybersecurity +cyberspace +cyberterror +cyberthreat +daemon +daisy chain +data +data center +data enumeration +data file +data flow +data mart +data mirroring +data model +data path +data pool +data set +data sheet +database +Daylight Saving Time +DC +ddname +deactivate +deallocate +debias +debug +decompilation +decompile +decompress +decrypt +delete from the database +demo +demonstration +deployment +descendant +deselect +desktop +despite +details view +develop components +diagnostics +different from +difficulty +discontinue +disk label +diskette +diskette drive +dismount +disruptor +DMZ +domain name +DOS session +dotted decimal +double quotation mark +double right-click +double-byte +double-click +doubleword +download +downstream +downtime +drag +dual-boot +dump file +dynamically +earlier +ebook +Elastic Load Balancing +email +embed +emit +enable for the web +encourage +end +ensure +enter +environment +etc/ +evaluate +examine +executable files +executable program +executable routine +expenditure +expense +experiences +extended subarea addressing +extract +fail +fall back +fallback +firmware +fix +flash +floating point +flyout +for example +foreground +front end +front-end +Gateway Load Balancer +gauge +given name +globalization +graphical interface +graphical user interface +gray +grayscale +hard code +hard disk +hard disk drive +hard-coded +hardcopy +hardware restart +health check +healthcare +heartbeat +help +help desk +helper +host group +hot add +hot key +hot plug +hot swap +hotline +how-to +however +huge page +hyperconverged +I am +I/O +IBM +IBM S/390 +if +immediately +in case +in languages other than English +in real time +in-depth +inch-pound +include +included +includes +independent software vendor +influencer +information +initial capital letters +inline +insecure +installation program +installer-provisioned infrastructure +instant message +interface +interim fix +Internet email address +Internet Protocol network +intranet +IP address +IP network +issue +IT +Java +java-class-jar +java-package-add-on +JavaBeans +job log +job stream +judgment +kernel oops +kernel-space +keyboard shortcut +knowledge base +labeled +labor hour +laptop +left +Left Arrow key +left mouse button +left-align +left-aligned +leftmost +lessons +licensed program +link-edit +link-editing +list +live-only +load balance +load time +load-time +localization +lock up +log file +log in to +log off from +log on to +lower left +lower right +lower-left +lower-right +major vector +make the transition +makefile +man page +managed domain +many +master broker +matrixes +menu +menu bar +menu-driven +merge +metadata +method +migrate +mobile phone +motivate +mount point +Mouse +mouse button +move +move the mouse pointer over +Mozilla Firefox +Mozilla Thunderbird +ms +much +multichannel +multiprocessing +multisite +multitasking +multitenant +multitiered +name server +navigate +need +NetWare for SAA +network computing +Network Load Balancer +newline +news feed +next generation +no longer support +non-English-language +nonpageable +nonpartitioned database environment +not at the latest level +not case-sensitive +not displayed +notebook +now +offboarding +offensive security researcher +offline backup +offload +offsite +OK +omit +omnichannel +on-demand +onboarding +online +onsite +opcode +open +open source +OpenJDK +opens +OpenShift +operations +orient +outlay +override +pageable +parent process +parent-child +path name +PC +performance counter +person day +person hour +Personal Communications +Phillips screw +Phillips screwdriver +PL/I +plain text +plug-and-play +plugin +PM +podcast +point to +power cable +power cord +power-off +power-on +practice +preconfigured +predefined +preinstall +preinstalled +preplanned +press +press Ctrl and click +press Shift and click +preventive +previous +printer friendly +program operator +proofs of concept +provided that +pseudo-ops +pseudocode +publish/subscribe +pull-down +quick start +rather than +re-create +read/write +rear +recur +Red Hat build of OpenJDK +regardless of +regular expression +remember +remote access +remote access server +remove +replica +requester +required +restart +restart the system +retry +right +right mouse button +right-align +right-aligned +rightmost +roll back +rollback +root directory +round-robin scheduling +roundtable +rule +run time +runlevel +runtime +schemas +screen capture +screen saver +scrollbar +secondary +segmentation +self-hosted engine +self-hosted engine node +self-signed certificate +separate +separation +server cluster +server farm +server side +server-side +session management exit routine +setup +several +share name +shared components +shell prompt +shell script +shortcut +sign in to +sign off from +sign on to +sign-off +single quotation mark +single sign-on +slave broker +smart card +smart paper +snapshot set +SOAP +socket interface +SOCKS-enabled +softcopy +software to block pop-up ad windows +sort +sound card +spec file +specific +specify +spelled +standalone +standalone server +start +stop +stop error +stop responding +straightforward +sub-version +subcommand +subdirectory +submenu +subpackage +superuser +supplier +surname +swap space +sync +sync point +synchronize +sysprep +system board +systems engineer +table space +tap +telecommunication line +telecommunications closet +telephone +test +test case +text mode +text-based +that is +The .tar file +The .zip file +therefore +thin-provisioned +this clause that is restrictive +this clause, which is nonrestrictive +though +throughput +tier-1 +time frame +time out +time slice +time zone +timebox +timeline +timeout +timestamp +to +toggle +toolbar +toolbox +tooling +toolkit +tools +tooltip +topic-based information +totaled +touch-sensitive screen +tradeoff +training events +transmission line +troubleshoot +trusted certificate authority +truststore +try again +try to +turn off +turn on +twistie +type +typing error +typographical error +vCenter datacenter +un-customized +unavailable +unconfigure +uncustomized +underscore +uninstall +uninstallation +unmount +unrecoverable +unrecoverable error +unregister +upgrade +upgradeable +upper left +upper right +upper-left +upper-right +uppercase +upsell +upselling +upstream +uptime +URL +usable +USB flash drive +use +user +user-provisioned infrastructure +verify +version +video mode +virtual +virtual floppy disk +virtual floppy drive +virtual hard drive +wait state +want +warm start +web address +web seminar +web-based event +webcast +webinar +webmaster +website +when +white paper +Wi-Fi +wildcard +window +Windows 32-bit operating system +withdraw +withdraw from marketing +withdraw from service +worker +workflow +workgroup +workload +workspace +workstation +zero +zeros +zone group +Configuring the Compute Service for Instance Creation. Support for instance domain change-deltas, and for instances where. diff --git a/.vale/fixtures/RedHat/TermsSuggestions/.vale.ini b/.vale/fixtures/RedHat/TermsSuggestions/.vale.ini new file mode 100644 index 0000000..1a6c642 --- /dev/null +++ b/.vale/fixtures/RedHat/TermsSuggestions/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `TermsSuggestions` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +RedHat.TermsSuggestions = YES diff --git a/.vale/fixtures/RedHat/TermsSuggestions/testinvalid.adoc b/.vale/fixtures/RedHat/TermsSuggestions/testinvalid.adoc new file mode 100644 index 0000000..b712bd0 --- /dev/null +++ b/.vale/fixtures/RedHat/TermsSuggestions/testinvalid.adoc @@ -0,0 +1,64 @@ +above +afterwards +all caps +bare metal clusters +bare metal compute +bare metal configuration +bare metal control +bare metal environment +bare metal equipment +bare metal event +bare metal hardware +bare metal host +bare metal infrastructure +bare metal installation +bare metal installer +bare metal machine +bare metal media +bare metal node +bare metal provisioning +bare metal server +bare metal worker +below +bottom left +bottom right +bugfix +can not +choose +componentization +componentize +consumes +drag and drop +executable +frontend +gzip +higher +hit +in order to +information on +jar +launch +legacy +Navigate +once +operator +operators +refer to +segfault +shell +spawn +start up +Start using this. +tar +tar file +tarball +This clause which is nonrestrictive +This clause, that is restrictive +thus +translate +via +x64 +x86 +x86-64 +zip +zip file diff --git a/.vale/fixtures/RedHat/TermsSuggestions/testvalid.adoc b/.vale/fixtures/RedHat/TermsSuggestions/testvalid.adoc new file mode 100644 index 0000000..06f145c --- /dev/null +++ b/.vale/fixtures/RedHat/TermsSuggestions/testvalid.adoc @@ -0,0 +1,57 @@ +64-bit x86 +about using +after +are not using +are using +bare-metal clusters +bare-metal compute +bare-metal configuration +bare-metal control +bare-metal environment +bare-metal equipment +bare-metal event +bare-metal hardware +bare-metal host +bare-metal infrastructure +bare-metal installation +bare-metal installer +bare-metal machine +bare-metal media +bare-metal node +bare-metal provisioning +bare-metal server +bare-metal worker +before +By using +by using +earlier +following +from +information about +later +lower left +lower right +on +Operator +program operator +security-profiles-operator +see this section +segmentation fault +shell prompt +shell script +something against which something else +something at which something else +something for which something else +something from which something else +something in which something else +something of which something else +something on which something else +something to which something else +something with which something else +something without which something else +this clause, which is nonrestrictive +through +to using +when using +When using +x86_64 diff --git a/.vale/fixtures/RedHat/TermsWarnings/.vale.ini b/.vale/fixtures/RedHat/TermsWarnings/.vale.ini new file mode 100644 index 0000000..9c1af69 --- /dev/null +++ b/.vale/fixtures/RedHat/TermsWarnings/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `TermsWarnings` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +RedHat.TermsWarnings = YES diff --git a/.vale/fixtures/RedHat/TermsWarnings/testinvalid.adoc b/.vale/fixtures/RedHat/TermsWarnings/testinvalid.adoc new file mode 100644 index 0000000..5eddf18 --- /dev/null +++ b/.vale/fixtures/RedHat/TermsWarnings/testinvalid.adoc @@ -0,0 +1,68 @@ +all caps +architected +are updatable +as well as +BIOS +call up +carry on +carry out +click on +Ctrl-click +deselect +desired +destroy +destroyed +double click +double-click on +downgrade +entitlement +etc +execute +find out +hamburger +he +host name +I +illegal +in order to +ingests +insure +invokable +is updatable +kebab +kebab menu +kill +kilobytes +leverage +like +look at +may +non-English +on premise +on-prem +on-premises +opt into +opting into +preload +preloaded +print out +right double-click +sane +she +shift-click +spawn +start up +speed up +speeds up +switch on +tap on +tarball +terminate +tooling +transition +vs +Hybrid Cloud Console +Cloud Console +Red Hat Hybrid Cloud Console +the Cloud Console +The Cloud Console diff --git a/.vale/fixtures/RedHat/TermsWarnings/testvalid.adoc b/.vale/fixtures/RedHat/TermsWarnings/testvalid.adoc new file mode 100644 index 0000000..f57a5a0 --- /dev/null +++ b/.vale/fixtures/RedHat/TermsWarnings/testvalid.adoc @@ -0,0 +1,69 @@ +accurate +accelerate +after +and +and so on +camel case +can +change +clear +colocate +colocation +delete +deleted +designed +discover +end +end +ensure +enter +examine +fall back +fallback +firmware +hostname +import +in languages other than English +in-house +incorrect +invalid +invocable +issue +KB +kB +load +load balance +make the transition +might +migrate +move +non-English-language +not allowed +obtain +on-premise +on-site +open +plugin +preinstall +preinstalled +print +process +repository +roll back +rollback +run +start +start +stop +stop +subscription +such as +tool +tools +upgrade +use +valid +verified +when +you +you diff --git a/.vale/fixtures/RedHat/UserReplacedValues/.vale.ini b/.vale/fixtures/RedHat/UserReplacedValues/.vale.ini new file mode 100644 index 0000000..7b57a11 --- /dev/null +++ b/.vale/fixtures/RedHat/UserReplacedValues/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `PassiveVoice` rule +StylesPath = ../../../styles +MinAlertLevel = suggestion +[*.adoc] +RedHat.UserReplacedValues = YES diff --git a/.vale/fixtures/RedHat/UserReplacedValues/testinvalid.adoc b/.vale/fixtures/RedHat/UserReplacedValues/testinvalid.adoc new file mode 100644 index 0000000..f4020c2 --- /dev/null +++ b/.vale/fixtures/RedHat/UserReplacedValues/testinvalid.adoc @@ -0,0 +1,5 @@ +This is ____ with hyphens. +This is ____ with hyphens and underscores. +This is ____ with hyphens and undersores. +This is ____ with hyphens and underscores. +This is ____ with hyphens and monospaced. diff --git a/.vale/fixtures/RedHat/UserReplacedValues/testvalid.adoc b/.vale/fixtures/RedHat/UserReplacedValues/testvalid.adoc new file mode 100644 index 0000000..8409b0f --- /dev/null +++ b/.vale/fixtures/RedHat/UserReplacedValues/testvalid.adoc @@ -0,0 +1,3 @@ +This is ____. +This is __<{an-attribute-using-hyphens-in_a_user_replaced_value}>__. +This is an hyphen, not in a user-replaced value. diff --git a/.vale/styles/AsciiDoc/ClosedAttributeBlocks.yml b/.vale/styles/AsciiDoc/ClosedAttributeBlocks.yml new file mode 100644 index 0000000..b3e65fc --- /dev/null +++ b/.vale/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/.vale/styles/AsciiDoc/MatchingNumberedCallouts.yml b/.vale/styles/AsciiDoc/MatchingNumberedCallouts.yml new file mode 100644 index 0000000..3f61a60 --- /dev/null +++ b/.vale/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 = [] + } + } + } diff --git a/.vale/styles/AsciiDoc/SequentialNumberedCallouts.yml b/.vale/styles/AsciiDoc/SequentialNumberedCallouts.yml new file mode 100644 index 0000000..443c8f0 --- /dev/null +++ b/.vale/styles/AsciiDoc/SequentialNumberedCallouts.yml @@ -0,0 +1,45 @@ +--- +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,}$" + + for line in text.split(scope, "\n") { + // trim trailing whitespace + line = text.trim_space(line) + //reset count if we hit a listing block delimiter + if text.re_match(listingblock_delim_regex, line) { + prev_num = 0 + } + + 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/.vale/styles/AsciiDoc/ValidAdmonitionBlocks.yml b/.vale/styles/AsciiDoc/ValidAdmonitionBlocks.yml new file mode 100644 index 0000000..1ebe018 --- /dev/null +++ b/.vale/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/.vale/styles/AsciiDoc/ValidCodeBlocks.yml b/.vale/styles/AsciiDoc/ValidCodeBlocks.yml new file mode 100644 index 0000000..f7af5c1 --- /dev/null +++ b/.vale/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/.vale/styles/AsciiDoc/ValidConditions.yml b/.vale/styles/AsciiDoc/ValidConditions.yml new file mode 100644 index 0000000..62994e4 --- /dev/null +++ b/.vale/styles/AsciiDoc/ValidConditions.yml @@ -0,0 +1,35 @@ +--- +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::.+\\[\\]|ifndef::.+\\[\\]|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) { + 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/.vale/styles/AsciiDoc/ValidTableBlocks.yml b/.vale/styles/AsciiDoc/ValidTableBlocks.yml new file mode 100644 index 0000000..8096be3 --- /dev/null +++ b/.vale/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/.vale/styles/OpenShiftAsciiDoc/AdditionalResourcesHeadingHasRoleID.yml b/.vale/styles/OpenShiftAsciiDoc/AdditionalResourcesHeadingHasRoleID.yml new file mode 100644 index 0000000..a6ea2fc --- /dev/null +++ b/.vale/styles/OpenShiftAsciiDoc/AdditionalResourcesHeadingHasRoleID.yml @@ -0,0 +1,10 @@ +--- +extends: existence +scope: raw +level: suggestion +nonword: true +link: https://github.com/openshift/openshift-docs/blob/main/contributing_to_docs/doc_guidelines.adoc#additional-resources-sections +message: "Additional resources heading is missing the '_additional-resources' role attribute declaration" +tokens: + - '(?|sh|.*\n\├|\[.*\]|\(.*\))' diff --git a/.vale/styles/OpenShiftAsciiDoc/HardWrappedLines.yml b/.vale/styles/OpenShiftAsciiDoc/HardWrappedLines.yml new file mode 100644 index 0000000..5a84f86 --- /dev/null +++ b/.vale/styles/OpenShiftAsciiDoc/HardWrappedLines.yml @@ -0,0 +1,51 @@ +--- +extends: script +message: "Avoid hard-wrapped lines." +level: warning +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" + + sentence_regex := "^.*(\\.|\\?|\\!|:)$" + list_regex := "^(\\.|\\*|-).*$" + hard_wrap_80_regex := "^.{65,80}$" + hard_wrap_100_regex := "^.{75,100}$" + asciidoc_markup := "^(.*\\[.*\\]|\\/\\/.*|=+.*|<(\\.|\\d+)>.*|>|#+.*|\\..+|\\|.*|a\\|.*|:.+|.*::|`.*`|ifdef::|endif::|image::|include::|link::|video::).*$" + listingblock_delim_regex := "^-{4}$" + inside_listingblock := false + + for line in text.split(scope, "\n") { + // trim trailing whitespace + line = text.trim_space(line) + //ignore content in codeblocks + if text.re_match(listingblock_delim_regex, line) && inside_listingblock == false { + inside_listingblock = true + } else if text.re_match(listingblock_delim_regex, line) && inside_listingblock == true { + inside_listingblock = false + } + + //ignore sentences + if !text.re_match(sentence_regex, line) && inside_listingblock == false { + //ignore AsciiDoc elements + if !text.re_match(asciidoc_markup, line) { + //ignore lists + if !text.re_match(list_regex, line) { + //match hard wrapped lines at 80 + if text.re_match(hard_wrap_80_regex, line) && inside_listingblock == false { + start := text.index(scope, line) + matches = append(matches, {begin: start, end: start + len(line)}) + //match hard wrapped lines at 100 + } else if text.re_match(hard_wrap_100_regex, line) && inside_listingblock == false { + start := text.index(scope, line) + matches = append(matches, {begin: start, end: start + len(line)}) + } + } + } + } + } diff --git a/.vale/styles/OpenShiftAsciiDoc/IdHasContextVariable.yml b/.vale/styles/OpenShiftAsciiDoc/IdHasContextVariable.yml new file mode 100644 index 0000000..6642212 --- /dev/null +++ b/.vale/styles/OpenShiftAsciiDoc/IdHasContextVariable.yml @@ -0,0 +1,8 @@ +--- +extends: existence +scope: raw +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: + - '(?{7}\s.*$' diff --git a/.vale/styles/RedHat/ObviousTerms.yml b/.vale/styles/RedHat/ObviousTerms.yml new file mode 100644 index 0000000..fd3f2a3 --- /dev/null +++ b/.vale/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/.vale/styles/RedHat/OxfordComma.yml b/.vale/styles/RedHat/OxfordComma.yml new file mode 100644 index 0000000..2f9d108 --- /dev/null +++ b/.vale/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/.vale/styles/RedHat/PascalCamelCase.yml b/.vale/styles/RedHat/PascalCamelCase.yml new file mode 100644 index 0000000..a2f3ea1 --- /dev/null +++ b/.vale/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/.vale/styles/RedHat/PassiveVoice.yml b/.vale/styles/RedHat/PassiveVoice.yml new file mode 100644 index 0000000..67b16af --- /dev/null +++ b/.vale/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/.vale/styles/RedHat/ProductCentricWriting.yml b/.vale/styles/RedHat/ProductCentricWriting.yml new file mode 100644 index 0000000..3721699 --- /dev/null +++ b/.vale/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/.vale/styles/RedHat/README-IBM.adoc b/.vale/styles/RedHat/README-IBM.adoc new file mode 100644 index 0000000..7e27b01 --- /dev/null +++ b/.vale/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/.vale/styles/RedHat/README-proselint.md b/.vale/styles/RedHat/README-proselint.md new file mode 100644 index 0000000..b08cef9 --- /dev/null +++ b/.vale/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/.vale/styles/RedHat/README-write-good.md b/.vale/styles/RedHat/README-write-good.md new file mode 100644 index 0000000..ba919b6 --- /dev/null +++ b/.vale/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/.vale/styles/RedHat/ReadabilityGrade.yml b/.vale/styles/RedHat/ReadabilityGrade.yml new file mode 100644 index 0000000..ad1e171 --- /dev/null +++ b/.vale/styles/RedHat/ReadabilityGrade.yml @@ -0,0 +1,8 @@ +--- +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/.vale/styles/RedHat/ReleaseNotes.yml b/.vale/styles/RedHat/ReleaseNotes.yml new file mode 100644 index 0000000..10ee9c9 --- /dev/null +++ b/.vale/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/.vale/styles/RedHat/RepeatedWords.yml b/.vale/styles/RedHat/RepeatedWords.yml new file mode 100644 index 0000000..3893d9b --- /dev/null +++ b/.vale/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/.vale/styles/RedHat/SelfReferentialText.yml b/.vale/styles/RedHat/SelfReferentialText.yml new file mode 100644 index 0000000..36adbf4 --- /dev/null +++ b/.vale/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/.vale/styles/RedHat/SentenceLength.yml b/.vale/styles/RedHat/SentenceLength.yml new file mode 100644 index 0000000..c21f0bc --- /dev/null +++ b/.vale/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/.vale/styles/RedHat/SimpleWords.yml b/.vale/styles/RedHat/SimpleWords.yml new file mode 100644 index 0000000..dd8ed6e --- /dev/null +++ b/.vale/styles/RedHat/SimpleWords.yml @@ -0,0 +1,119 @@ +--- +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: + "approximate(?:ly)?": about + "objective(?! C?)": aim|goal + absent: none|not here + abundance: plenty + accentuate: stress + accompany: go with + accomplish: carry out|do + accorded: given + accordingly: so + accrue: add + accurate: right|exact + acquiesce: agree + acquire: get|buy + addressees: you + adjacent to: next to + adjustment: change + admissible: allowed + advantageous: helpful + advise: tell + aggregate: total + aircraft: plane + alleviate: ease + allocate: assign|divide + alternatively: or + alternatives: choices|options + ameliorate: improve + amend: change + anticipate: expect + apparent: clear|plain + ascertain: discover|find out + assistance: help + attain: meet + attempt: try + authorize: allow + belated: late + bestow: give + cease: stop|end + collaborate: work together + commence: begin + compensate: pay + component: part + comprise: form|include + concerning: about + confer: give|award + consequently: so + consolidate: merge + constitutes: forms + contains: has + convene: meet + demonstrate: show|prove + depart: leave + designate: choose + desire: want|wish + determine: decide|find + detrimental: bad|harmful + disclose: share|tell + discontinue: stop + disseminate: send|give + eliminate: end + elucidate: explain + employ: use + enclosed: inside|included + encounter: meet + endeavor: try + enumerate: count + equitable: fair + equivalent: equal + exclusively: only + expedite: hurry + facilitate: ease + females: women + finalize: complete|finish + frequently: often + identical: same + incorrect: wrong + indication: sign + initiate: start|begin + itemized: listed + jeopardize: risk + liaise: work with|partner with + maintain: keep|support + methodology: method + modify: change + monitor: check|watch + multiple: many + necessitate: cause + notify: tell + numerous: many + obligate: bind|compel + optimum: best|most + permit: let + portion: part + possess: own + previous: earlier + previously: before + prioritize: rank + procure: buy + provide: give|offer + purchase: buy + relocate: move + solicit: request + state-of-the-art: latest + subsequent: later|next + substantial: large + sufficient: enough + terminate: end + transmit: send + utilization: use + utilize: use + utilizing: using diff --git a/.vale/styles/RedHat/Slash.yml b/.vale/styles/RedHat/Slash.yml new file mode 100644 index 0000000..7584c39 --- /dev/null +++ b/.vale/styles/RedHat/Slash.yml @@ -0,0 +1,27 @@ +--- +extends: existence +ignorecase: true +level: warning +link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/slash/ +message: "Use either 'or' or 'and' in '%s'" +# source: "IBM - Slashes, p. 68" +scope: + - sentence + - heading +tokens: + - '(?__' + - '<[a-z_]+-[a-z_-]+>' diff --git a/.vale/styles/RedHat/Using.yml b/.vale/styles/RedHat/Using.yml new file mode 100644 index 0000000..869cdc9 --- /dev/null +++ b/.vale/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/.vale/styles/RedHat/collate-output.tmpl b/.vale/styles/RedHat/collate-output.tmpl new file mode 100644 index 0000000..449aa42 --- /dev/null +++ b/.vale/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/.vale/styles/RedHat/meta.json b/.vale/styles/RedHat/meta.json new file mode 100644 index 0000000..6099c80 --- /dev/null +++ b/.vale/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/README.md b/README.md index ab5fa21..61a9b86 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ It is published via Fedora Docs: 6. **Images** to be used on any page. 7. **Downloadable attachments** to be used on any page. 8. **Menu definition.** Also defines the hierarchy of all the pages. -9. **Pages with the actual content.** They can be also organised into subdirectories if desired. +9. **Pages with the actual content.** They can be also organized into subdirectories if desired. ## Local preview diff --git a/modules/ROOT/pages/eln-branch.adoc b/modules/ROOT/pages/eln-branch.adoc index c8af544..2309161 100644 --- a/modules/ROOT/pages/eln-branch.adoc +++ b/modules/ROOT/pages/eln-branch.adoc @@ -1,7 +1,7 @@ = ELN Branches Whenever possible, ELN work should be done in the Fedora rawhide branches. -But sometimes ELN work needs to be done in an Fedora eln branch. Here are +But sometimes ELN work needs to be done in an Fedora eln branch. Here are the steps for making that happen. == Step 1: Request Permission @@ -62,7 +62,7 @@ as a co-maintaine through https://src.fedoraproject.org/rpms//adduser == Step 3: Maintain Branch After your branch has been created, remember that the ELN branch is your -responsibility. Do not create the branch, build it once, and then never +responsibility. Do not create the branch, build it once, and then never touch the branch again. *If you decide that you no longer need the ELN branch Do not retire the branch. diff --git a/modules/ROOT/pages/eln-macros.adoc b/modules/ROOT/pages/eln-macros.adoc index 0af7215..58e446a 100644 --- a/modules/ROOT/pages/eln-macros.adoc +++ b/modules/ROOT/pages/eln-macros.adoc @@ -1,7 +1,7 @@ = ELN Macros The ELN buildroot defines the %\{rhel\} macro as the next major version of RHEL -(currently, 11), and does not define the %\{fedora\} macro. For almost all cases, +(currently, 11), and does not define the %\{fedora\} macro. For almost all cases, this is sufficient for differentiating build behavior between Fedora and ELN. == Request Permission diff --git a/modules/ROOT/pages/extras.adoc b/modules/ROOT/pages/extras.adoc index 00be3ac..9480061 100644 --- a/modules/ROOT/pages/extras.adoc +++ b/modules/ROOT/pages/extras.adoc @@ -10,7 +10,7 @@ and quicker to get a compose of EPEL N+1 out the door if the initial packages have already been built for ELN-Extras. NOTE: **You** are responsible when your package fails to build on ELN -Extras. Remember to check your packages on +Extras. Remember to check your packages on https://sgallagh.fedorapeople.org/dbs_status.html[the ELN Status Page]. ELN Extras packages get rebuilt much more frequently than in EPEL. @@ -44,7 +44,7 @@ https://github.com/minimization/content-resolver/blob/master/config_specs/worklo The create your initial workload yaml file, take that example yaml file, rename it, edit it, then submit it as a pull request. -The example workload yaml has an example for everything. But we don't need everything +The example workload yaml has an example for everything. But we don't need everything for ELN Extras. ==== Workload Required Sections @@ -105,7 +105,7 @@ Can I add any or all Fedora packages to ELN-Extras?:: You are attaching your name as the supporter of these packages. You will be submitting these workload packages as pull requests. The ELN SIG will review the pull requests and ask questions if - things look strange or incorrect. So, yes, if you are willing + things look strange or incorrect. So, yes, if you are willing to support a package, it can be any Fedora package not in ELN. And while we are not putting a firm limit on the number of packages you can add to ELN Extras, the SIG is reviewing them and will @@ -113,7 +113,7 @@ Can I add any or all Fedora packages to ELN-Extras?:: If someone has already added a package to their workload, can I have the same package in mine?:: -Yes. Content Resolver is setup to deal with a package in more than -one workload, or a dependency in more than one workload. It will show what -workloads list, or require what packages. It even takes a guess on who +Yes. Content Resolver is setup to deal with a package in more than +one workload, or a dependency in more than one workload. It will show what +workloads list, or require what packages. It even takes a guess on who should be the owner of the package. diff --git a/modules/ROOT/pages/faq.adoc b/modules/ROOT/pages/faq.adoc index a017b99..6bea75d 100644 --- a/modules/ROOT/pages/faq.adoc +++ b/modules/ROOT/pages/faq.adoc @@ -21,7 +21,7 @@ image::ROOT:fedora-eln-centos-stream-rhel.png[] What are the differences between Rawhide and ELN?:: For the majority of packages, there is little or no difference between Rawhide and - ELN packages. They are the same versions, usually built on the same libraries. But + ELN packages. They are the same versions, usually built on the same libraries. But there are some https://docs.fedoraproject.org/en-US/eln/buildroot/[buildroot differences] in https://docs.fedoraproject.org/en-US/eln/buildroot/#_compiler_flags_and_other_tweaks[compiler flags] and https://docs.fedoraproject.org/en-US/eln/buildroot/#_distribution_related_macro_definitions[global macros] @@ -49,10 +49,10 @@ What are the differences between the Rawhide and ELN kernel?:: a much larger range of hardware and features. A notable difference is that the ELN kernel does not support btrfs at all, making it difficult to install and use on systems that were installed as Fedora Workstation edition, or in Fedora 35 or newer Cloud images which use btrfs - by default. There are also differences in baseline supported hardware, meaning the ELN kernel + by default. There are also differences in baseline supported hardware, meaning the ELN kernel may not run on older systems where the Rawhide kernel runs just fine. When should I use the rpm macro %\{eln}?:: - Never. In nearly all cases, you actually want to use the %\{rhel} macro. + Never. In nearly all cases, you actually want to use the %\{rhel} macro. See xref:eln-macros.adoc[ELN Macros] for more information. diff --git a/modules/ROOT/pages/index.adoc b/modules/ROOT/pages/index.adoc index ccc8d49..ce4563e 100644 --- a/modules/ROOT/pages/index.adoc +++ b/modules/ROOT/pages/index.adoc @@ -78,7 +78,7 @@ This includes: Who benefits from the ELN project: * Fedora Infrastructure -** As we are going to try and test new infrastructure for composes. +** As we are going to try to test new infrastructure for composes. * Fedora Minimization ** As we are going to modify the compose content according to minimization goals. From 9e29da0e6196c6c60b10c60f38350de24e3024e1 Mon Sep 17 00:00:00 2001 From: Sandro Bonazzola Date: Thu, 8 May 2025 15:31:41 +0200 Subject: [PATCH 2/2] Drop local copy of RedHat vale package Red Hat package is available in the official [Package Explorer](https://vale.sh/explorer) and pre-commit hook can fetch it automatically. In order to fetch it manually, just call `vale sync`. Signed-off-by: Sandro Bonazzola --- .gitignore | 1 + .../AsciiDoc/ClosedAttributeBlocks/.vale.ini | 5 - .../ClosedAttributeBlocks/testinvalid.adoc | 9 - .../ClosedAttributeBlocks/testvalid.adoc | 33 - .../AsciiDoc/ClosedIdQuotes/.vale.ini | 5 - .../AsciiDoc/ClosedIdQuotes/testinvalid.adoc | 23 - .../AsciiDoc/ClosedIdQuotes/testvalid.adoc | 9 - .../AsciiDoc/ImageContainsAltText/.vale.ini | 5 - .../ImageContainsAltText/testinvalid.adoc | 3 - .../ImageContainsAltText/testvalid.adoc | 3 - .../AsciiDoc/LinkContainsLinkText/.vale.ini | 5 - .../LinkContainsLinkText/testinvalid.adoc | 20 - .../LinkContainsLinkText/testvalid.adoc | 2 - .../AsciiDoc/MatchingDotCallouts/.vale.ini | 5 - .../MatchingDotCallouts/testinvalid.adoc | 25 - .../MatchingDotCallouts/testvalid.adoc | 12 - .../MatchingNumberedCallouts/.vale.ini | 5 - .../MatchingNumberedCallouts/testinvalid.adoc | 32 - .../MatchingNumberedCallouts/testvalid.adoc | 26 - .../SequentialNumberedCallouts/.vale.ini | 5 - .../testinvalid.adoc | 31 - .../SequentialNumberedCallouts/testvalid.adoc | 25 - .../AsciiDoc/ValidAdmonitionBlocks/.vale.ini | 5 - .../ValidAdmonitionBlocks/testinvalid.adoc | 18 - .../ValidAdmonitionBlocks/testvalid.adoc | 12 - .../AsciiDoc/ValidCodeBlocks/.vale.ini | 5 - .../AsciiDoc/ValidCodeBlocks/testinvalid.adoc | 33 - .../AsciiDoc/ValidCodeBlocks/testvalid.adoc | 37 - .../AsciiDoc/ValidConditions/.vale.ini | 5 - .../AsciiDoc/ValidConditions/testinvalid.adoc | 33 - .../AsciiDoc/ValidConditions/testvalid.adoc | 42 -- .../AsciiDoc/ValidTableBlocks/.vale.ini | 5 - .../ValidTableBlocks/testinvalid.adoc | 37 - .../AsciiDoc/ValidTableBlocks/testvalid.adoc | 58 -- .../.vale.ini | 5 - .../testinvalid.adoc | 8 - .../testvalid.adoc | 8 - .../.vale.ini | 5 - .../testinvalid.adoc | 11 - .../testvalid.adoc | 93 --- .../HardWrappedLines/.vale.ini | 5 - .../HardWrappedLines/testinvalid.adoc | 2 - .../HardWrappedLines/testvalid.adoc | 107 --- .../IdHasContextVariable/.vale.ini | 5 - .../IdHasContextVariable/testinvalid.adoc | 5 - .../IdHasContextVariable/testvalid.adoc | 3 - .../ModuleContainsContentType/.vale.ini | 5 - .../testinvalid.adoc | 5 - .../ModuleContainsContentType/testvalid.adoc | 15 - .../.vale.ini | 5 - .../testinvalid.adoc | 5 - .../testvalid.adoc | 3 - .../OpenShiftAsciiDoc/NoLineRanges/.vale.ini | 5 - .../NoLineRanges/testinvalid.adoc | 11 - .../NoLineRanges/testvalid.adoc | 15 - .../NoNestingInModules/.vale.ini | 5 - .../NoNestingInModules/testinvalid.adoc | 5 - .../NoNestingInModules/testvalid.adoc | 15 - .../NoTocInModules/.vale.ini | 5 - .../NoTocInModules/testinvalid.adoc | 6 - .../NoTocInModules/testvalid.adoc | 4 - .../NoXrefInModules/.vale.ini | 5 - .../NoXrefInModules/testinvalid.adoc | 2 - .../NoXrefInModules/testvalid.adoc | 1 - .../SuggestAttribute/.vale.ini | 5 - .../SuggestAttribute/testinvalid.adoc | 180 ----- .../SuggestAttribute/testvalid.adoc | 96 --- .../XrefContainsAnchorID/.vale.ini | 5 - .../XrefContainsAnchorID/testinvalid.adoc | 8 - .../XrefContainsAnchorID/testvalid.adoc | 3 - .../XrefContainsHTML/.vale.ini | 5 - .../XrefContainsHTML/testinvalid.adoc | 5 - .../XrefContainsHTML/testvalid.adoc | 3 - .../XrefMustNotHaveNakedLabel/.vale.ini | 5 - .../testinvalid.adoc | 2 - .../XrefMustNotHaveNakedLabel/testvalid.adoc | 3 - .vale/fixtures/RedHat/Abbreviations/.vale.ini | 5 - .../RedHat/Abbreviations/testinvalid.adoc | 0 .../RedHat/Abbreviations/testvalid.adoc | 0 .../RedHat/CaseSensitiveTerms/.vale.ini | 5 - .../CaseSensitiveTerms/testinvalid.adoc | 561 -------------- .../RedHat/CaseSensitiveTerms/testvalid.adoc | 338 --------- .vale/fixtures/RedHat/Conjunctions/.vale.ini | 5 - .../RedHat/Conjunctions/testinvalid.adoc | 0 .../RedHat/Conjunctions/testvalid.adoc | 0 .../RedHat/ConsciousLanguage/.vale.ini | 5 - .../RedHat/ConsciousLanguage/testinvalid.adoc | 4 - .../RedHat/ConsciousLanguage/testvalid.adoc | 17 - .vale/fixtures/RedHat/Contractions/.vale.ini | 5 - .../fixtures/RedHat/Contractions/source.adoc | 34 - .../RedHat/Contractions/testinvalid.adoc | 34 - .../RedHat/Contractions/testvalid.adoc | 34 - .vale/fixtures/RedHat/Definitions/.vale.ini | 5 - .../RedHat/Definitions/testinvalid.adoc | 1 - .../RedHat/Definitions/testvalid.adoc | 191 ----- .vale/fixtures/RedHat/DoNotUseTerms/.vale.ini | 5 - .../RedHat/DoNotUseTerms/testinvalid.adoc | 23 - .../RedHat/DoNotUseTerms/testvalid.adoc | 6 - .vale/fixtures/RedHat/Ellipses/.vale.ini | 5 - .../fixtures/RedHat/Ellipses/testinvalid.adoc | 1 - .vale/fixtures/RedHat/Ellipses/testvalid.adoc | 0 .vale/fixtures/RedHat/EmDash/.vale.ini | 5 - .vale/fixtures/RedHat/EmDash/testinvalid.adoc | 2 - .vale/fixtures/RedHat/EmDash/testvalid.adoc | 1 - .../RedHat/HeadingPunctuation/.vale.ini | 5 - .../HeadingPunctuation/testinvalid.adoc | 1 - .../RedHat/HeadingPunctuation/testvalid.adoc | 1 - .vale/fixtures/RedHat/Headings/.vale.ini | 5 - .../fixtures/RedHat/Headings/testinvalid.adoc | 1 - .vale/fixtures/RedHat/Headings/testvalid.adoc | 51 -- .vale/fixtures/RedHat/Hyphens/.vale.ini | 5 - .../fixtures/RedHat/Hyphens/testinvalid.adoc | 226 ------ .vale/fixtures/RedHat/Hyphens/testvalid.adoc | 152 ---- .../RedHat/MergeConflictMarkers/.vale.ini | 5 - .../MergeConflictMarkers/testinvalid.adoc | 3 - .../MergeConflictMarkers/testvalid.adoc | 3 - .vale/fixtures/RedHat/OxfordComma/.vale.ini | 5 - .../RedHat/OxfordComma/testinvalid.adoc | 2 - .../RedHat/OxfordComma/testvalid.adoc | 2 - .../fixtures/RedHat/PascalCamelCase/.vale.ini | 5 - .../RedHat/PascalCamelCase/testinvalid.adoc | 126 ---- .../RedHat/PascalCamelCase/testvalid.adoc | 198 ----- .vale/fixtures/RedHat/PassiveVoice/.vale.ini | 5 - .../RedHat/PassiveVoice/testinvalid.adoc | 176 ----- .../RedHat/PassiveVoice/testvalid.adoc | 181 ----- .../RedHat/ProductCentricWriting/.vale.ini | 5 - .../ProductCentricWriting/testinvalid.adoc | 5 - .../ProductCentricWriting/testvalid.adoc | 0 .../RedHat/ReadabilityGrade/.vale.ini | 5 - .../RedHat/ReadabilityGrade/testinvalid.adoc | 0 .../RedHat/ReadabilityGrade/testvalid.adoc | 0 .vale/fixtures/RedHat/ReleaseNotes/.vale.ini | 5 - .../RedHat/ReleaseNotes/testinvalid.adoc | 2 - .../RedHat/ReleaseNotes/testvalid.adoc | 2 - .vale/fixtures/RedHat/RepeatedWords/.vale.ini | 5 - .../RedHat/RepeatedWords/testinvalid.adoc | 2 - .../RedHat/RepeatedWords/testvalid.adoc | 6 - .../RedHat/SelfReferentialText/.vale.ini | 5 - .../SelfReferentialText/testinvalid.adoc | 11 - .../RedHat/SelfReferentialText/testvalid.adoc | 0 .../fixtures/RedHat/SentenceLength/.vale.ini | 5 - .../RedHat/SentenceLength/testinvalid.adoc | 0 .../RedHat/SentenceLength/testvalid.adoc | 0 .vale/fixtures/RedHat/SimpleWords/.vale.ini | 5 - .../RedHat/SimpleWords/testinvalid.adoc | 111 --- .../RedHat/SimpleWords/testvalid.adoc | 122 --- .vale/fixtures/RedHat/Slash/.vale.ini | 5 - .vale/fixtures/RedHat/Slash/testinvalid.adoc | 3 - .vale/fixtures/RedHat/Slash/testvalid.adoc | 17 - .vale/fixtures/RedHat/SmartQuotes/.vale.ini | 5 - .../RedHat/SmartQuotes/testinvalid.adoc | 4 - .../RedHat/SmartQuotes/testvalid.adoc | 5 - .vale/fixtures/RedHat/Spacing/.vale.ini | 5 - .../fixtures/RedHat/Spacing/testinvalid.adoc | 2 - .vale/fixtures/RedHat/Spacing/testvalid.adoc | 4 - .vale/fixtures/RedHat/Spelling/.vale.ini | 5 - .../fixtures/RedHat/Spelling/testinvalid.adoc | 59 -- .vale/fixtures/RedHat/Spelling/testvalid.adoc | 649 ---------------- .vale/fixtures/RedHat/Symbols/.vale.ini | 5 - .../fixtures/RedHat/Symbols/testinvalid.adoc | 2 - .vale/fixtures/RedHat/Symbols/testvalid.adoc | 15 - .vale/fixtures/RedHat/TermsErrors/.vale.ini | 5 - .../RedHat/TermsErrors/testinvalid.adoc | 473 ------------ .../RedHat/TermsErrors/testvalid.adoc | 698 ------------------ .../RedHat/TermsSuggestions/.vale.ini | 5 - .../RedHat/TermsSuggestions/testinvalid.adoc | 64 -- .../RedHat/TermsSuggestions/testvalid.adoc | 57 -- .vale/fixtures/RedHat/TermsWarnings/.vale.ini | 5 - .../RedHat/TermsWarnings/testinvalid.adoc | 68 -- .../RedHat/TermsWarnings/testvalid.adoc | 69 -- .../RedHat/UserReplacedValues/.vale.ini | 5 - .../UserReplacedValues/testinvalid.adoc | 5 - .../RedHat/UserReplacedValues/testvalid.adoc | 3 - .../styles/AsciiDoc/ClosedAttributeBlocks.yml | 7 - .vale/styles/AsciiDoc/ClosedIdQuotes.yml | 7 - .../styles/AsciiDoc/ImageContainsAltText.yml | 9 - .../styles/AsciiDoc/LinkContainsLinkText.yml | 10 - .vale/styles/AsciiDoc/MatchingDotCallouts.yml | 47 -- .../AsciiDoc/MatchingNumberedCallouts.yml | 62 -- .../AsciiDoc/SequentialNumberedCallouts.yml | 45 -- .../styles/AsciiDoc/ValidAdmonitionBlocks.yml | 30 - .vale/styles/AsciiDoc/ValidCodeBlocks.yml | 30 - .vale/styles/AsciiDoc/ValidConditions.yml | 35 - .vale/styles/AsciiDoc/ValidTableBlocks.yml | 30 - .../AdditionalResourcesHeadingHasRoleID.yml | 10 - .../CheckDollarSymbolInTerminalBlock.yml | 8 - .../OpenShiftAsciiDoc/HardWrappedLines.yml | 51 -- .../IdHasContextVariable.yml | 8 - .../ModuleContainsContentType.yml | 8 - .../ModuleContainsParentAssemblyComment.yml | 8 - .../styles/OpenShiftAsciiDoc/NoLineRanges.yml | 8 - .../OpenShiftAsciiDoc/NoNestingInModules.yml | 8 - .../OpenShiftAsciiDoc/NoTocInModules.yml | 9 - .../OpenShiftAsciiDoc/NoXrefInModules.yml | 8 - .../OpenShiftAsciiDoc/SuggestAttribute.yml | 100 --- .../XrefContainsAnchorID.yml | 8 - .../OpenShiftAsciiDoc/XrefContainsHTML.yml | 8 - .../XrefMustNotHaveNakedLabel.yml | 8 - .vale/styles/RedHat/Abbreviations.yml | 9 - .vale/styles/RedHat/CaseSensitiveTerms.yml | 327 -------- .vale/styles/RedHat/Conjunctions.yml | 14 - .vale/styles/RedHat/ConsciousLanguage.yml | 13 - .vale/styles/RedHat/Contractions.yml | 44 -- .vale/styles/RedHat/Definitions.yml | 191 ----- .vale/styles/RedHat/DoNotUseTerms.yml | 27 - .vale/styles/RedHat/Ellipses.yml | 12 - .vale/styles/RedHat/EmDash.yml | 11 - .vale/styles/RedHat/GitLinks.yml | 13 - .vale/styles/RedHat/HeadingPunctuation.yml | 11 - .vale/styles/RedHat/Headings.yml | 261 ------- .vale/styles/RedHat/Hyphens.yml | 236 ------ .vale/styles/RedHat/MergeConflictMarkers.yml | 13 - .vale/styles/RedHat/ObviousTerms.yml | 16 - .vale/styles/RedHat/OxfordComma.yml | 9 - .vale/styles/RedHat/PascalCamelCase.yml | 190 ----- .vale/styles/RedHat/PassiveVoice.yml | 193 ----- .vale/styles/RedHat/ProductCentricWriting.yml | 8 - .vale/styles/RedHat/README-IBM.adoc | 9 - .vale/styles/RedHat/README-proselint.md | 13 - .vale/styles/RedHat/README-write-good.md | 28 - .vale/styles/RedHat/ReadabilityGrade.yml | 8 - .vale/styles/RedHat/ReleaseNotes.yml | 11 - .vale/styles/RedHat/RepeatedWords.yml | 16 - .vale/styles/RedHat/SelfReferentialText.yml | 14 - .vale/styles/RedHat/SentenceLength.yml | 9 - .vale/styles/RedHat/SimpleWords.yml | 119 --- .vale/styles/RedHat/Slash.yml | 27 - .vale/styles/RedHat/SmartQuotes.yml | 11 - .vale/styles/RedHat/Spacing.yml | 10 - .vale/styles/RedHat/Spelling.yml | 522 ------------- .vale/styles/RedHat/Symbols.yml | 9 - .vale/styles/RedHat/TermsErrors.yml | 472 ------------ .vale/styles/RedHat/TermsSuggestions.yml | 54 -- .vale/styles/RedHat/TermsWarnings.yml | 76 -- .vale/styles/RedHat/UserReplacedValues.yml | 16 - .vale/styles/RedHat/Using.yml | 14 - .vale/styles/RedHat/collate-output.tmpl | 66 -- .vale/styles/RedHat/meta.json | 4 - .../styles/config/vocabularies/ELN/accept.txt | 29 + 239 files changed, 30 insertions(+), 9928 deletions(-) delete mode 100644 .vale/fixtures/AsciiDoc/ClosedAttributeBlocks/.vale.ini delete mode 100644 .vale/fixtures/AsciiDoc/ClosedAttributeBlocks/testinvalid.adoc delete mode 100644 .vale/fixtures/AsciiDoc/ClosedAttributeBlocks/testvalid.adoc delete mode 100644 .vale/fixtures/AsciiDoc/ClosedIdQuotes/.vale.ini delete mode 100644 .vale/fixtures/AsciiDoc/ClosedIdQuotes/testinvalid.adoc delete mode 100644 .vale/fixtures/AsciiDoc/ClosedIdQuotes/testvalid.adoc delete mode 100644 .vale/fixtures/AsciiDoc/ImageContainsAltText/.vale.ini delete mode 100644 .vale/fixtures/AsciiDoc/ImageContainsAltText/testinvalid.adoc delete mode 100644 .vale/fixtures/AsciiDoc/ImageContainsAltText/testvalid.adoc delete mode 100644 .vale/fixtures/AsciiDoc/LinkContainsLinkText/.vale.ini delete mode 100644 .vale/fixtures/AsciiDoc/LinkContainsLinkText/testinvalid.adoc delete mode 100644 .vale/fixtures/AsciiDoc/LinkContainsLinkText/testvalid.adoc delete mode 100644 .vale/fixtures/AsciiDoc/MatchingDotCallouts/.vale.ini delete mode 100644 .vale/fixtures/AsciiDoc/MatchingDotCallouts/testinvalid.adoc delete mode 100644 .vale/fixtures/AsciiDoc/MatchingDotCallouts/testvalid.adoc delete mode 100644 .vale/fixtures/AsciiDoc/MatchingNumberedCallouts/.vale.ini delete mode 100644 .vale/fixtures/AsciiDoc/MatchingNumberedCallouts/testinvalid.adoc delete mode 100644 .vale/fixtures/AsciiDoc/MatchingNumberedCallouts/testvalid.adoc delete mode 100644 .vale/fixtures/AsciiDoc/SequentialNumberedCallouts/.vale.ini delete mode 100644 .vale/fixtures/AsciiDoc/SequentialNumberedCallouts/testinvalid.adoc delete mode 100644 .vale/fixtures/AsciiDoc/SequentialNumberedCallouts/testvalid.adoc delete mode 100644 .vale/fixtures/AsciiDoc/ValidAdmonitionBlocks/.vale.ini delete mode 100644 .vale/fixtures/AsciiDoc/ValidAdmonitionBlocks/testinvalid.adoc delete mode 100644 .vale/fixtures/AsciiDoc/ValidAdmonitionBlocks/testvalid.adoc delete mode 100644 .vale/fixtures/AsciiDoc/ValidCodeBlocks/.vale.ini delete mode 100644 .vale/fixtures/AsciiDoc/ValidCodeBlocks/testinvalid.adoc delete mode 100644 .vale/fixtures/AsciiDoc/ValidCodeBlocks/testvalid.adoc delete mode 100644 .vale/fixtures/AsciiDoc/ValidConditions/.vale.ini delete mode 100644 .vale/fixtures/AsciiDoc/ValidConditions/testinvalid.adoc delete mode 100644 .vale/fixtures/AsciiDoc/ValidConditions/testvalid.adoc delete mode 100644 .vale/fixtures/AsciiDoc/ValidTableBlocks/.vale.ini delete mode 100644 .vale/fixtures/AsciiDoc/ValidTableBlocks/testinvalid.adoc delete mode 100644 .vale/fixtures/AsciiDoc/ValidTableBlocks/testvalid.adoc delete mode 100644 .vale/fixtures/OpenShiftAsciiDoc/AdditionalResourcesHeadingHasRoleID/.vale.ini delete mode 100644 .vale/fixtures/OpenShiftAsciiDoc/AdditionalResourcesHeadingHasRoleID/testinvalid.adoc delete mode 100644 .vale/fixtures/OpenShiftAsciiDoc/AdditionalResourcesHeadingHasRoleID/testvalid.adoc delete mode 100644 .vale/fixtures/OpenShiftAsciiDoc/CheckDollarSymbolInTerminalBlock/.vale.ini delete mode 100644 .vale/fixtures/OpenShiftAsciiDoc/CheckDollarSymbolInTerminalBlock/testinvalid.adoc delete mode 100644 .vale/fixtures/OpenShiftAsciiDoc/CheckDollarSymbolInTerminalBlock/testvalid.adoc delete mode 100644 .vale/fixtures/OpenShiftAsciiDoc/HardWrappedLines/.vale.ini delete mode 100644 .vale/fixtures/OpenShiftAsciiDoc/HardWrappedLines/testinvalid.adoc delete mode 100644 .vale/fixtures/OpenShiftAsciiDoc/HardWrappedLines/testvalid.adoc delete mode 100644 .vale/fixtures/OpenShiftAsciiDoc/IdHasContextVariable/.vale.ini delete mode 100644 .vale/fixtures/OpenShiftAsciiDoc/IdHasContextVariable/testinvalid.adoc delete mode 100644 .vale/fixtures/OpenShiftAsciiDoc/IdHasContextVariable/testvalid.adoc delete mode 100644 .vale/fixtures/OpenShiftAsciiDoc/ModuleContainsContentType/.vale.ini delete mode 100644 .vale/fixtures/OpenShiftAsciiDoc/ModuleContainsContentType/testinvalid.adoc delete mode 100644 .vale/fixtures/OpenShiftAsciiDoc/ModuleContainsContentType/testvalid.adoc delete mode 100644 .vale/fixtures/OpenShiftAsciiDoc/ModuleContainsParentAssemblyComment/.vale.ini delete mode 100644 .vale/fixtures/OpenShiftAsciiDoc/ModuleContainsParentAssemblyComment/testinvalid.adoc delete mode 100644 .vale/fixtures/OpenShiftAsciiDoc/ModuleContainsParentAssemblyComment/testvalid.adoc delete mode 100644 .vale/fixtures/OpenShiftAsciiDoc/NoLineRanges/.vale.ini delete mode 100644 .vale/fixtures/OpenShiftAsciiDoc/NoLineRanges/testinvalid.adoc delete mode 100644 .vale/fixtures/OpenShiftAsciiDoc/NoLineRanges/testvalid.adoc delete mode 100644 .vale/fixtures/OpenShiftAsciiDoc/NoNestingInModules/.vale.ini delete mode 100644 .vale/fixtures/OpenShiftAsciiDoc/NoNestingInModules/testinvalid.adoc delete mode 100644 .vale/fixtures/OpenShiftAsciiDoc/NoNestingInModules/testvalid.adoc delete mode 100644 .vale/fixtures/OpenShiftAsciiDoc/NoTocInModules/.vale.ini delete mode 100644 .vale/fixtures/OpenShiftAsciiDoc/NoTocInModules/testinvalid.adoc delete mode 100644 .vale/fixtures/OpenShiftAsciiDoc/NoTocInModules/testvalid.adoc delete mode 100644 .vale/fixtures/OpenShiftAsciiDoc/NoXrefInModules/.vale.ini delete mode 100644 .vale/fixtures/OpenShiftAsciiDoc/NoXrefInModules/testinvalid.adoc delete mode 100644 .vale/fixtures/OpenShiftAsciiDoc/NoXrefInModules/testvalid.adoc delete mode 100644 .vale/fixtures/OpenShiftAsciiDoc/SuggestAttribute/.vale.ini delete mode 100644 .vale/fixtures/OpenShiftAsciiDoc/SuggestAttribute/testinvalid.adoc delete mode 100644 .vale/fixtures/OpenShiftAsciiDoc/SuggestAttribute/testvalid.adoc delete mode 100644 .vale/fixtures/OpenShiftAsciiDoc/XrefContainsAnchorID/.vale.ini delete mode 100644 .vale/fixtures/OpenShiftAsciiDoc/XrefContainsAnchorID/testinvalid.adoc delete mode 100644 .vale/fixtures/OpenShiftAsciiDoc/XrefContainsAnchorID/testvalid.adoc delete mode 100644 .vale/fixtures/OpenShiftAsciiDoc/XrefContainsHTML/.vale.ini delete mode 100644 .vale/fixtures/OpenShiftAsciiDoc/XrefContainsHTML/testinvalid.adoc delete mode 100644 .vale/fixtures/OpenShiftAsciiDoc/XrefContainsHTML/testvalid.adoc delete mode 100644 .vale/fixtures/OpenShiftAsciiDoc/XrefMustNotHaveNakedLabel/.vale.ini delete mode 100644 .vale/fixtures/OpenShiftAsciiDoc/XrefMustNotHaveNakedLabel/testinvalid.adoc delete mode 100644 .vale/fixtures/OpenShiftAsciiDoc/XrefMustNotHaveNakedLabel/testvalid.adoc delete mode 100644 .vale/fixtures/RedHat/Abbreviations/.vale.ini delete mode 100644 .vale/fixtures/RedHat/Abbreviations/testinvalid.adoc delete mode 100644 .vale/fixtures/RedHat/Abbreviations/testvalid.adoc delete mode 100644 .vale/fixtures/RedHat/CaseSensitiveTerms/.vale.ini delete mode 100644 .vale/fixtures/RedHat/CaseSensitiveTerms/testinvalid.adoc delete mode 100644 .vale/fixtures/RedHat/CaseSensitiveTerms/testvalid.adoc delete mode 100644 .vale/fixtures/RedHat/Conjunctions/.vale.ini delete mode 100644 .vale/fixtures/RedHat/Conjunctions/testinvalid.adoc delete mode 100644 .vale/fixtures/RedHat/Conjunctions/testvalid.adoc delete mode 100644 .vale/fixtures/RedHat/ConsciousLanguage/.vale.ini delete mode 100644 .vale/fixtures/RedHat/ConsciousLanguage/testinvalid.adoc delete mode 100644 .vale/fixtures/RedHat/ConsciousLanguage/testvalid.adoc delete mode 100644 .vale/fixtures/RedHat/Contractions/.vale.ini delete mode 100644 .vale/fixtures/RedHat/Contractions/source.adoc delete mode 100644 .vale/fixtures/RedHat/Contractions/testinvalid.adoc delete mode 100644 .vale/fixtures/RedHat/Contractions/testvalid.adoc delete mode 100644 .vale/fixtures/RedHat/Definitions/.vale.ini delete mode 100644 .vale/fixtures/RedHat/Definitions/testinvalid.adoc delete mode 100644 .vale/fixtures/RedHat/Definitions/testvalid.adoc delete mode 100644 .vale/fixtures/RedHat/DoNotUseTerms/.vale.ini delete mode 100644 .vale/fixtures/RedHat/DoNotUseTerms/testinvalid.adoc delete mode 100644 .vale/fixtures/RedHat/DoNotUseTerms/testvalid.adoc delete mode 100644 .vale/fixtures/RedHat/Ellipses/.vale.ini delete mode 100644 .vale/fixtures/RedHat/Ellipses/testinvalid.adoc delete mode 100644 .vale/fixtures/RedHat/Ellipses/testvalid.adoc delete mode 100644 .vale/fixtures/RedHat/EmDash/.vale.ini delete mode 100644 .vale/fixtures/RedHat/EmDash/testinvalid.adoc delete mode 100644 .vale/fixtures/RedHat/EmDash/testvalid.adoc delete mode 100644 .vale/fixtures/RedHat/HeadingPunctuation/.vale.ini delete mode 100644 .vale/fixtures/RedHat/HeadingPunctuation/testinvalid.adoc delete mode 100644 .vale/fixtures/RedHat/HeadingPunctuation/testvalid.adoc delete mode 100644 .vale/fixtures/RedHat/Headings/.vale.ini delete mode 100644 .vale/fixtures/RedHat/Headings/testinvalid.adoc delete mode 100644 .vale/fixtures/RedHat/Headings/testvalid.adoc delete mode 100644 .vale/fixtures/RedHat/Hyphens/.vale.ini delete mode 100644 .vale/fixtures/RedHat/Hyphens/testinvalid.adoc delete mode 100644 .vale/fixtures/RedHat/Hyphens/testvalid.adoc delete mode 100644 .vale/fixtures/RedHat/MergeConflictMarkers/.vale.ini delete mode 100644 .vale/fixtures/RedHat/MergeConflictMarkers/testinvalid.adoc delete mode 100644 .vale/fixtures/RedHat/MergeConflictMarkers/testvalid.adoc delete mode 100644 .vale/fixtures/RedHat/OxfordComma/.vale.ini delete mode 100644 .vale/fixtures/RedHat/OxfordComma/testinvalid.adoc delete mode 100644 .vale/fixtures/RedHat/OxfordComma/testvalid.adoc delete mode 100644 .vale/fixtures/RedHat/PascalCamelCase/.vale.ini delete mode 100644 .vale/fixtures/RedHat/PascalCamelCase/testinvalid.adoc delete mode 100644 .vale/fixtures/RedHat/PascalCamelCase/testvalid.adoc delete mode 100644 .vale/fixtures/RedHat/PassiveVoice/.vale.ini delete mode 100644 .vale/fixtures/RedHat/PassiveVoice/testinvalid.adoc delete mode 100644 .vale/fixtures/RedHat/PassiveVoice/testvalid.adoc delete mode 100644 .vale/fixtures/RedHat/ProductCentricWriting/.vale.ini delete mode 100644 .vale/fixtures/RedHat/ProductCentricWriting/testinvalid.adoc delete mode 100644 .vale/fixtures/RedHat/ProductCentricWriting/testvalid.adoc delete mode 100644 .vale/fixtures/RedHat/ReadabilityGrade/.vale.ini delete mode 100644 .vale/fixtures/RedHat/ReadabilityGrade/testinvalid.adoc delete mode 100644 .vale/fixtures/RedHat/ReadabilityGrade/testvalid.adoc delete mode 100644 .vale/fixtures/RedHat/ReleaseNotes/.vale.ini delete mode 100644 .vale/fixtures/RedHat/ReleaseNotes/testinvalid.adoc delete mode 100644 .vale/fixtures/RedHat/ReleaseNotes/testvalid.adoc delete mode 100644 .vale/fixtures/RedHat/RepeatedWords/.vale.ini delete mode 100644 .vale/fixtures/RedHat/RepeatedWords/testinvalid.adoc delete mode 100644 .vale/fixtures/RedHat/RepeatedWords/testvalid.adoc delete mode 100644 .vale/fixtures/RedHat/SelfReferentialText/.vale.ini delete mode 100644 .vale/fixtures/RedHat/SelfReferentialText/testinvalid.adoc delete mode 100644 .vale/fixtures/RedHat/SelfReferentialText/testvalid.adoc delete mode 100644 .vale/fixtures/RedHat/SentenceLength/.vale.ini delete mode 100644 .vale/fixtures/RedHat/SentenceLength/testinvalid.adoc delete mode 100644 .vale/fixtures/RedHat/SentenceLength/testvalid.adoc delete mode 100644 .vale/fixtures/RedHat/SimpleWords/.vale.ini delete mode 100644 .vale/fixtures/RedHat/SimpleWords/testinvalid.adoc delete mode 100644 .vale/fixtures/RedHat/SimpleWords/testvalid.adoc delete mode 100644 .vale/fixtures/RedHat/Slash/.vale.ini delete mode 100644 .vale/fixtures/RedHat/Slash/testinvalid.adoc delete mode 100644 .vale/fixtures/RedHat/Slash/testvalid.adoc delete mode 100644 .vale/fixtures/RedHat/SmartQuotes/.vale.ini delete mode 100644 .vale/fixtures/RedHat/SmartQuotes/testinvalid.adoc delete mode 100644 .vale/fixtures/RedHat/SmartQuotes/testvalid.adoc delete mode 100644 .vale/fixtures/RedHat/Spacing/.vale.ini delete mode 100644 .vale/fixtures/RedHat/Spacing/testinvalid.adoc delete mode 100644 .vale/fixtures/RedHat/Spacing/testvalid.adoc delete mode 100644 .vale/fixtures/RedHat/Spelling/.vale.ini delete mode 100644 .vale/fixtures/RedHat/Spelling/testinvalid.adoc delete mode 100644 .vale/fixtures/RedHat/Spelling/testvalid.adoc delete mode 100644 .vale/fixtures/RedHat/Symbols/.vale.ini delete mode 100644 .vale/fixtures/RedHat/Symbols/testinvalid.adoc delete mode 100644 .vale/fixtures/RedHat/Symbols/testvalid.adoc delete mode 100644 .vale/fixtures/RedHat/TermsErrors/.vale.ini delete mode 100644 .vale/fixtures/RedHat/TermsErrors/testinvalid.adoc delete mode 100644 .vale/fixtures/RedHat/TermsErrors/testvalid.adoc delete mode 100644 .vale/fixtures/RedHat/TermsSuggestions/.vale.ini delete mode 100644 .vale/fixtures/RedHat/TermsSuggestions/testinvalid.adoc delete mode 100644 .vale/fixtures/RedHat/TermsSuggestions/testvalid.adoc delete mode 100644 .vale/fixtures/RedHat/TermsWarnings/.vale.ini delete mode 100644 .vale/fixtures/RedHat/TermsWarnings/testinvalid.adoc delete mode 100644 .vale/fixtures/RedHat/TermsWarnings/testvalid.adoc delete mode 100644 .vale/fixtures/RedHat/UserReplacedValues/.vale.ini delete mode 100644 .vale/fixtures/RedHat/UserReplacedValues/testinvalid.adoc delete mode 100644 .vale/fixtures/RedHat/UserReplacedValues/testvalid.adoc delete mode 100644 .vale/styles/AsciiDoc/ClosedAttributeBlocks.yml delete mode 100644 .vale/styles/AsciiDoc/ClosedIdQuotes.yml delete mode 100644 .vale/styles/AsciiDoc/ImageContainsAltText.yml delete mode 100644 .vale/styles/AsciiDoc/LinkContainsLinkText.yml delete mode 100644 .vale/styles/AsciiDoc/MatchingDotCallouts.yml delete mode 100644 .vale/styles/AsciiDoc/MatchingNumberedCallouts.yml delete mode 100644 .vale/styles/AsciiDoc/SequentialNumberedCallouts.yml delete mode 100644 .vale/styles/AsciiDoc/ValidAdmonitionBlocks.yml delete mode 100644 .vale/styles/AsciiDoc/ValidCodeBlocks.yml delete mode 100644 .vale/styles/AsciiDoc/ValidConditions.yml delete mode 100644 .vale/styles/AsciiDoc/ValidTableBlocks.yml delete mode 100644 .vale/styles/OpenShiftAsciiDoc/AdditionalResourcesHeadingHasRoleID.yml delete mode 100644 .vale/styles/OpenShiftAsciiDoc/CheckDollarSymbolInTerminalBlock.yml delete mode 100644 .vale/styles/OpenShiftAsciiDoc/HardWrappedLines.yml delete mode 100644 .vale/styles/OpenShiftAsciiDoc/IdHasContextVariable.yml delete mode 100644 .vale/styles/OpenShiftAsciiDoc/ModuleContainsContentType.yml delete mode 100644 .vale/styles/OpenShiftAsciiDoc/ModuleContainsParentAssemblyComment.yml delete mode 100644 .vale/styles/OpenShiftAsciiDoc/NoLineRanges.yml delete mode 100644 .vale/styles/OpenShiftAsciiDoc/NoNestingInModules.yml delete mode 100644 .vale/styles/OpenShiftAsciiDoc/NoTocInModules.yml delete mode 100644 .vale/styles/OpenShiftAsciiDoc/NoXrefInModules.yml delete mode 100644 .vale/styles/OpenShiftAsciiDoc/SuggestAttribute.yml delete mode 100644 .vale/styles/OpenShiftAsciiDoc/XrefContainsAnchorID.yml delete mode 100644 .vale/styles/OpenShiftAsciiDoc/XrefContainsHTML.yml delete mode 100644 .vale/styles/OpenShiftAsciiDoc/XrefMustNotHaveNakedLabel.yml delete mode 100644 .vale/styles/RedHat/Abbreviations.yml delete mode 100644 .vale/styles/RedHat/CaseSensitiveTerms.yml delete mode 100644 .vale/styles/RedHat/Conjunctions.yml delete mode 100644 .vale/styles/RedHat/ConsciousLanguage.yml delete mode 100644 .vale/styles/RedHat/Contractions.yml delete mode 100644 .vale/styles/RedHat/Definitions.yml delete mode 100644 .vale/styles/RedHat/DoNotUseTerms.yml delete mode 100644 .vale/styles/RedHat/Ellipses.yml delete mode 100644 .vale/styles/RedHat/EmDash.yml delete mode 100644 .vale/styles/RedHat/GitLinks.yml delete mode 100644 .vale/styles/RedHat/HeadingPunctuation.yml delete mode 100644 .vale/styles/RedHat/Headings.yml delete mode 100644 .vale/styles/RedHat/Hyphens.yml delete mode 100644 .vale/styles/RedHat/MergeConflictMarkers.yml delete mode 100644 .vale/styles/RedHat/ObviousTerms.yml delete mode 100644 .vale/styles/RedHat/OxfordComma.yml delete mode 100644 .vale/styles/RedHat/PascalCamelCase.yml delete mode 100644 .vale/styles/RedHat/PassiveVoice.yml delete mode 100644 .vale/styles/RedHat/ProductCentricWriting.yml delete mode 100644 .vale/styles/RedHat/README-IBM.adoc delete mode 100644 .vale/styles/RedHat/README-proselint.md delete mode 100644 .vale/styles/RedHat/README-write-good.md delete mode 100644 .vale/styles/RedHat/ReadabilityGrade.yml delete mode 100644 .vale/styles/RedHat/ReleaseNotes.yml delete mode 100644 .vale/styles/RedHat/RepeatedWords.yml delete mode 100644 .vale/styles/RedHat/SelfReferentialText.yml delete mode 100644 .vale/styles/RedHat/SentenceLength.yml delete mode 100644 .vale/styles/RedHat/SimpleWords.yml delete mode 100644 .vale/styles/RedHat/Slash.yml delete mode 100644 .vale/styles/RedHat/SmartQuotes.yml delete mode 100644 .vale/styles/RedHat/Spacing.yml delete mode 100644 .vale/styles/RedHat/Spelling.yml delete mode 100644 .vale/styles/RedHat/Symbols.yml delete mode 100644 .vale/styles/RedHat/TermsErrors.yml delete mode 100644 .vale/styles/RedHat/TermsSuggestions.yml delete mode 100644 .vale/styles/RedHat/TermsWarnings.yml delete mode 100644 .vale/styles/RedHat/UserReplacedValues.yml delete mode 100644 .vale/styles/RedHat/Using.yml delete mode 100644 .vale/styles/RedHat/collate-output.tmpl delete mode 100644 .vale/styles/RedHat/meta.json create mode 100644 .vale/styles/config/vocabularies/ELN/accept.txt diff --git a/.gitignore b/.gitignore index e86e7e3..9e0334d 100644 --- a/.gitignore +++ b/.gitignore @@ -2,3 +2,4 @@ build cache public *~ +.vale/styles/RedHat/ diff --git a/.vale/fixtures/AsciiDoc/ClosedAttributeBlocks/.vale.ini b/.vale/fixtures/AsciiDoc/ClosedAttributeBlocks/.vale.ini deleted file mode 100644 index 5822dc7..0000000 --- a/.vale/fixtures/AsciiDoc/ClosedAttributeBlocks/.vale.ini +++ /dev/null @@ -1,5 +0,0 @@ -; Vale configuration file to test the `ClosedAttributeBlocks` rule -StylesPath = ../../../styles -MinAlertLevel = suggestion -[*.adoc] -AsciiDoc.ClosedAttributeBlocks = YES diff --git a/.vale/fixtures/AsciiDoc/ClosedAttributeBlocks/testinvalid.adoc b/.vale/fixtures/AsciiDoc/ClosedAttributeBlocks/testinvalid.adoc deleted file mode 100644 index 20ba60a..0000000 --- a/.vale/fixtures/AsciiDoc/ClosedAttributeBlocks/testinvalid.adoc +++ /dev/null @@ -1,9 +0,0 @@ -//vale-fixture -:_mod-docs-content-type: ASSEMBLY -[id="rosa-getting-started -= Comprehensive guide to getting started with {product-title} - -//vale-fixture -:_mod-docs-content-type: ASSEMBLY -[id="rosa-getting-started_{context} -= Another guide to getting started diff --git a/.vale/fixtures/AsciiDoc/ClosedAttributeBlocks/testvalid.adoc b/.vale/fixtures/AsciiDoc/ClosedAttributeBlocks/testvalid.adoc deleted file mode 100644 index d33413c..0000000 --- a/.vale/fixtures/AsciiDoc/ClosedAttributeBlocks/testvalid.adoc +++ /dev/null @@ -1,33 +0,0 @@ -//vale-fixture -:_mod-docs-content-type: ASSEMBLY -[id="rosa-getting-started_{context}"] -= Comprehensive guide to getting started with {product-title} - -//vale-fixture -.Example output -[source,terminal] ----- -{"status":"success","data":{"resultType":"vector","result":[{"metric":{"__name__":"up","endpoint":"web","instance":"10.129.0.46:8080","job":"prometheus-example-app","namespace":"ns1","pod":"prometheus-example-app-68d47c4fb6-jztp2","service":"prometheus-example-app"},"value":[1591881154.748,"1"]}]}} ----- - -//vale-fixture -[source,terminal] ----- -$ oc adm must-gather -[must-gather ] OUT Using must-gather plugin-in image: quay.io/openshift-release-dev/ocp-v4.0-art-dev@sha256:125f183d13601537ff15b3239df95d47f0a604da2847b561151fedd699f5e3a5 -[must-gather ] OUT namespace/openshift-must-gather-xm4wq created -[must-gather ] OUT clusterrolebinding.rbac.authorization.k8s.io/must-gather-2bd8x created -[must-gather ] OUT pod for plug-in image quay.io/openshift-release-dev/ocp-v4.0-art-dev@sha256:125f183d13601537ff15b3239df95d47f0a604da2847b561151fedd699f5e3a5 created ----- - -//vale-fixture -.Example API response -[source,json] ----- -[{ - "id": "ca11ab76-86f9-428c-8d3a-666c24e34d32", - "endpointUri": "http://localhost:9089/api/ocloudNotifications/v1/dummy", - "uriLocation": "http://localhost:8089/api/ocloudNotifications/v1/subscriptions/ca11ab76-86f9-428c-8d3a-666c24e34d32", - "resource": "/cluster/node/openshift-worker-0.openshift.example.com/redfish/event" -}] ----- diff --git a/.vale/fixtures/AsciiDoc/ClosedIdQuotes/.vale.ini b/.vale/fixtures/AsciiDoc/ClosedIdQuotes/.vale.ini deleted file mode 100644 index 8d4d742..0000000 --- a/.vale/fixtures/AsciiDoc/ClosedIdQuotes/.vale.ini +++ /dev/null @@ -1,5 +0,0 @@ -; Vale configuration file to test the `ClosedIdQuotes` rule -StylesPath = ../../../styles -MinAlertLevel = suggestion -[*.adoc] -AsciiDoc.ClosedIdQuotes = YES diff --git a/.vale/fixtures/AsciiDoc/ClosedIdQuotes/testinvalid.adoc b/.vale/fixtures/AsciiDoc/ClosedIdQuotes/testinvalid.adoc deleted file mode 100644 index e60121e..0000000 --- a/.vale/fixtures/AsciiDoc/ClosedIdQuotes/testinvalid.adoc +++ /dev/null @@ -1,23 +0,0 @@ -//vale-fixture -[id="rosa-getting-started_{context}] -= Comprehensive guide to getting started with {product-title} - -//vale-fixture -[id="rosa-getting-started] -= Another guide to getting started - -//vale-fixture -[id='rosa-getting-started_{context}] -= Comprehensive guide to getting started with {product-title} - -//vale-fixture -[id='rosa-getting-started] -= Another guide to getting started - -//vale-fixture -[id="rosa-getting-started'] -= Another guide to getting started - -//vale-fixture -[id='rosa-getting-started"] -= Another guide to getting started diff --git a/.vale/fixtures/AsciiDoc/ClosedIdQuotes/testvalid.adoc b/.vale/fixtures/AsciiDoc/ClosedIdQuotes/testvalid.adoc deleted file mode 100644 index c37f91a..0000000 --- a/.vale/fixtures/AsciiDoc/ClosedIdQuotes/testvalid.adoc +++ /dev/null @@ -1,9 +0,0 @@ -//vale-fixture -:_mod-docs-content-type: ASSEMBLY -[id="rosa-getting-started_{context}"] -= Comprehensive guide to getting started with {product-title} - -//vale-fixture -:_mod-docs-content-type: ASSEMBLY -[id='rosa-getting-started_{context}'] -= Comprehensive guide to getting started with {product-title} diff --git a/.vale/fixtures/AsciiDoc/ImageContainsAltText/.vale.ini b/.vale/fixtures/AsciiDoc/ImageContainsAltText/.vale.ini deleted file mode 100644 index c5541dc..0000000 --- a/.vale/fixtures/AsciiDoc/ImageContainsAltText/.vale.ini +++ /dev/null @@ -1,5 +0,0 @@ -; Vale configuration file to test the `ImageContainsAltText` rule -StylesPath = ../../../styles -MinAlertLevel = suggestion -[*.adoc] -AsciiDoc.ImageContainsAltText = YES diff --git a/.vale/fixtures/AsciiDoc/ImageContainsAltText/testinvalid.adoc b/.vale/fixtures/AsciiDoc/ImageContainsAltText/testinvalid.adoc deleted file mode 100644 index 4477e3f..0000000 --- a/.vale/fixtures/AsciiDoc/ImageContainsAltText/testinvalid.adoc +++ /dev/null @@ -1,3 +0,0 @@ -//vale-fixture -image::my-image-name.png[] -image:my-image-name.png[] diff --git a/.vale/fixtures/AsciiDoc/ImageContainsAltText/testvalid.adoc b/.vale/fixtures/AsciiDoc/ImageContainsAltText/testvalid.adoc deleted file mode 100644 index db45ec9..0000000 --- a/.vale/fixtures/AsciiDoc/ImageContainsAltText/testvalid.adoc +++ /dev/null @@ -1,3 +0,0 @@ -//Correct usage of alt text in image tags -image::my-image-name.png[my-image-alt-text] -image:my-image-name.png[my-image-alt-text] diff --git a/.vale/fixtures/AsciiDoc/LinkContainsLinkText/.vale.ini b/.vale/fixtures/AsciiDoc/LinkContainsLinkText/.vale.ini deleted file mode 100644 index d6a199a..0000000 --- a/.vale/fixtures/AsciiDoc/LinkContainsLinkText/.vale.ini +++ /dev/null @@ -1,5 +0,0 @@ -; Vale configuration file to test the `LinkContainsLinkText` rule -StylesPath = ../../../styles -MinAlertLevel = suggestion -[*.adoc] -AsciiDoc.LinkContainsLinkText = YES diff --git a/.vale/fixtures/AsciiDoc/LinkContainsLinkText/testinvalid.adoc b/.vale/fixtures/AsciiDoc/LinkContainsLinkText/testinvalid.adoc deleted file mode 100644 index 29ff659..0000000 --- a/.vale/fixtures/AsciiDoc/LinkContainsLinkText/testinvalid.adoc +++ /dev/null @@ -1,20 +0,0 @@ -//vale-fixture -link:https://docs.aws.amazon.com/[] - -//vale-fixture -link:https://docs.aws.amazon.com/[Click here] - -//vale-fixture -link:https://docs.aws.amazon.com/[click here] - -//vale-fixture -link:https://docs.aws.amazon.com/[here] - -//vale-fixture -link:https://docs.aws.amazon.com/[Here] - -//vale-fixture -link:https://docs.aws.amazon.com/[this] - -//vale-fixture -link:https://docs.aws.amazon.com/[This] diff --git a/.vale/fixtures/AsciiDoc/LinkContainsLinkText/testvalid.adoc b/.vale/fixtures/AsciiDoc/LinkContainsLinkText/testvalid.adoc deleted file mode 100644 index 20c9f41..0000000 --- a/.vale/fixtures/AsciiDoc/LinkContainsLinkText/testvalid.adoc +++ /dev/null @@ -1,2 +0,0 @@ -//Correct usage of link text in links -link:https://docs.aws.amazon.com/[AWS documentation] diff --git a/.vale/fixtures/AsciiDoc/MatchingDotCallouts/.vale.ini b/.vale/fixtures/AsciiDoc/MatchingDotCallouts/.vale.ini deleted file mode 100644 index 5fc7ffd..0000000 --- a/.vale/fixtures/AsciiDoc/MatchingDotCallouts/.vale.ini +++ /dev/null @@ -1,5 +0,0 @@ -; Vale configuration file to test the `SequentialNumberedCallouts` rule -StylesPath = ../../../styles -MinAlertLevel = suggestion -[*.adoc] -AsciiDoc.MatchingDotCallouts = YES diff --git a/.vale/fixtures/AsciiDoc/MatchingDotCallouts/testinvalid.adoc b/.vale/fixtures/AsciiDoc/MatchingDotCallouts/testinvalid.adoc deleted file mode 100644 index 4efd682..0000000 --- a/.vale/fixtures/AsciiDoc/MatchingDotCallouts/testinvalid.adoc +++ /dev/null @@ -1,25 +0,0 @@ -//vale-fixture -[source,ruby] ----- -get '/hi' do <.> -get '/hi' do <.> -get '/hi' do<.> <.> <.> ----- -<.> first callout -<.> second callout -<.> third callout -<.> fourth callout -<.> fifth callout -<.> sixth callout - -//vale-fixture -[source,ruby] ----- -get '/hi' do <.> -get '/hi' do <.> -get '/hi' do <.> ----- -<.> first callout, second block -<.> second callout, second block -<.> third callout, second block -<.> fourth callout, second block diff --git a/.vale/fixtures/AsciiDoc/MatchingDotCallouts/testvalid.adoc b/.vale/fixtures/AsciiDoc/MatchingDotCallouts/testvalid.adoc deleted file mode 100644 index 8d4493c..0000000 --- a/.vale/fixtures/AsciiDoc/MatchingDotCallouts/testvalid.adoc +++ /dev/null @@ -1,12 +0,0 @@ -//vale-fixture -[source,ruby] ----- -require 'sinatra' <.> - -get '/hi' do <.> - "Hello World!" <.> -end ----- -<.> Library import -<.> URL mapping -<.> Response block diff --git a/.vale/fixtures/AsciiDoc/MatchingNumberedCallouts/.vale.ini b/.vale/fixtures/AsciiDoc/MatchingNumberedCallouts/.vale.ini deleted file mode 100644 index 99a9f13..0000000 --- a/.vale/fixtures/AsciiDoc/MatchingNumberedCallouts/.vale.ini +++ /dev/null @@ -1,5 +0,0 @@ -; Vale configuration file to test the `SequentialNumberedCallouts` rule -StylesPath = ../../../styles -MinAlertLevel = suggestion -[*.adoc] -AsciiDoc.MatchingNumberedCallouts = YES diff --git a/.vale/fixtures/AsciiDoc/MatchingNumberedCallouts/testinvalid.adoc b/.vale/fixtures/AsciiDoc/MatchingNumberedCallouts/testinvalid.adoc deleted file mode 100644 index 28df0ef..0000000 --- a/.vale/fixtures/AsciiDoc/MatchingNumberedCallouts/testinvalid.adoc +++ /dev/null @@ -1,32 +0,0 @@ -//vale-fixture -[source,ruby] ----- -require 'frank' <1> -get '/hihi'<2><3> ----- -<1> text -<2> More text -<3> More text again -<4> Again, more text - -//vale-fixture -[source,ruby] ----- -require 'frankie' <1> -get '/hihihi' <2> ----- -<1> text! -<2> More text! -More text...! -<10> and again and again! - -//vale-fixture -[source,ruby] ----- -require 'judy' <2> -get '/hihihi' <1> ----- -<2> test -<1> text! -More text...! -<13> and again and again and again! diff --git a/.vale/fixtures/AsciiDoc/MatchingNumberedCallouts/testvalid.adoc b/.vale/fixtures/AsciiDoc/MatchingNumberedCallouts/testvalid.adoc deleted file mode 100644 index 28e386d..0000000 --- a/.vale/fixtures/AsciiDoc/MatchingNumberedCallouts/testvalid.adoc +++ /dev/null @@ -1,26 +0,0 @@ -//vale-fixture -[source,ruby] ----- -require 'sinatra' <1> - -get '/hi' do <2> <3> - "Hello World!" -end ----- -<1> Library import -<2> URL mapping -<3> Response block - -//vale-fixture -[source,ruby] ----- -require 'sinatra' \\//<1> - -get '/hi' do <2><3> - "Hello World!"<4> -end ----- -<1> Library import -<2> URL mapping -<3> Response block -<4> Hi diff --git a/.vale/fixtures/AsciiDoc/SequentialNumberedCallouts/.vale.ini b/.vale/fixtures/AsciiDoc/SequentialNumberedCallouts/.vale.ini deleted file mode 100644 index 59cf66b..0000000 --- a/.vale/fixtures/AsciiDoc/SequentialNumberedCallouts/.vale.ini +++ /dev/null @@ -1,5 +0,0 @@ -; Vale configuration file to test the `SequentialNumberedCallouts` rule -StylesPath = ../../../styles -MinAlertLevel = suggestion -[*.adoc] -AsciiDoc.SequentialNumberedCallouts = YES diff --git a/.vale/fixtures/AsciiDoc/SequentialNumberedCallouts/testinvalid.adoc b/.vale/fixtures/AsciiDoc/SequentialNumberedCallouts/testinvalid.adoc deleted file mode 100644 index 2229014..0000000 --- a/.vale/fixtures/AsciiDoc/SequentialNumberedCallouts/testinvalid.adoc +++ /dev/null @@ -1,31 +0,0 @@ -//vale-fixture -[source,ruby] ----- -require 'sinatra' <1> -get '/hi' do <2> -require 'sinatra' <3> -get '/hi' do <4> -hi there <5> -goop <6> -require 'sinatra' - -get '/hi' do <7> <8> - "Hello World!" ----- -<1> text -<2> More text -<3> More text again -<5> Some text -<6> Again, some text -<7> Moar text -<8> Again, some more text - -//vale-fixture -[source,ruby] ----- -require 'sinatra' <1> -get '/hi' do <3> -get '/hi' do <4> ----- -<1> Test -<3> Test diff --git a/.vale/fixtures/AsciiDoc/SequentialNumberedCallouts/testvalid.adoc b/.vale/fixtures/AsciiDoc/SequentialNumberedCallouts/testvalid.adoc deleted file mode 100644 index abb0837..0000000 --- a/.vale/fixtures/AsciiDoc/SequentialNumberedCallouts/testvalid.adoc +++ /dev/null @@ -1,25 +0,0 @@ -//vale-fixture -[source,ruby] ----- -require 'sinatra' <1> - -get '/hi' do <2> <3> - "Hello World!" -end ----- -<1> Library import -<2> URL mapping -<3> Response block - -//vale-fixture -[source,ruby] ----- -require 'sinatra' <1> - -get '/hi' do <1> - "Hello World!" -end -key: value <2> ----- -<1> Library import -<2> URL mapping diff --git a/.vale/fixtures/AsciiDoc/ValidAdmonitionBlocks/.vale.ini b/.vale/fixtures/AsciiDoc/ValidAdmonitionBlocks/.vale.ini deleted file mode 100644 index 1d27dec..0000000 --- a/.vale/fixtures/AsciiDoc/ValidAdmonitionBlocks/.vale.ini +++ /dev/null @@ -1,5 +0,0 @@ -; Vale configuration file to test the `ValidAdmonitionBlocks` rule -StylesPath = ../../../styles -MinAlertLevel = suggestion -[*.adoc] -AsciiDoc.ValidAdmonitionBlocks = YES diff --git a/.vale/fixtures/AsciiDoc/ValidAdmonitionBlocks/testinvalid.adoc b/.vale/fixtures/AsciiDoc/ValidAdmonitionBlocks/testinvalid.adoc deleted file mode 100644 index a1bedcd..0000000 --- a/.vale/fixtures/AsciiDoc/ValidAdmonitionBlocks/testinvalid.adoc +++ /dev/null @@ -1,18 +0,0 @@ -//vale-fixture -Here is a Admonition block: - -[IMPORTANT] -.Feeding the Werewolves -==== -While werewolves are hardy community members, keep in mind the following dietary concerns: - -. They are allergic to cinnamon. -. More than two glasses of orange juice in 24 hours makes them howl in harmony with alarms and sirens. -. Celery makes them sad. - -More text - -[NOTE] -==== -Hello -==== diff --git a/.vale/fixtures/AsciiDoc/ValidAdmonitionBlocks/testvalid.adoc b/.vale/fixtures/AsciiDoc/ValidAdmonitionBlocks/testvalid.adoc deleted file mode 100644 index 024577a..0000000 --- a/.vale/fixtures/AsciiDoc/ValidAdmonitionBlocks/testvalid.adoc +++ /dev/null @@ -1,12 +0,0 @@ -//vale-fixture -Here is a Admonition block: - -[IMPORTANT] -.Feeding the Werewolves -==== -While werewolves are hardy community members, keep in mind the following dietary concerns: - -. They are allergic to cinnamon. -. More than two glasses of orange juice in 24 hours makes them howl in harmony with alarms and sirens. -. Celery makes them sad. -==== diff --git a/.vale/fixtures/AsciiDoc/ValidCodeBlocks/.vale.ini b/.vale/fixtures/AsciiDoc/ValidCodeBlocks/.vale.ini deleted file mode 100644 index c244f78..0000000 --- a/.vale/fixtures/AsciiDoc/ValidCodeBlocks/.vale.ini +++ /dev/null @@ -1,5 +0,0 @@ -; Vale configuration file to test the `ValidConditions` rule -StylesPath = ../../../styles -MinAlertLevel = suggestion -[*.adoc] -AsciiDoc.ValidCodeBlocks = YES diff --git a/.vale/fixtures/AsciiDoc/ValidCodeBlocks/testinvalid.adoc b/.vale/fixtures/AsciiDoc/ValidCodeBlocks/testinvalid.adoc deleted file mode 100644 index d3827f8..0000000 --- a/.vale/fixtures/AsciiDoc/ValidCodeBlocks/testinvalid.adoc +++ /dev/null @@ -1,33 +0,0 @@ -//vale-fixture -Here is a code block: - -[source,terminal] ----- -$ pwd ----- - -Here is a another code block: - -[source,terminal] ----- -$ pwd ----- - -Here is a code block: - -[source,yaml] ----- ---- -apiVersion: 4.11 - -Some text. - -Here is a code block: - -[subs="+quotes",options="nowrap",role="white-space-pre"] ----- ---- -apiVersion: 4.11 ----- - -Some text. diff --git a/.vale/fixtures/AsciiDoc/ValidCodeBlocks/testvalid.adoc b/.vale/fixtures/AsciiDoc/ValidCodeBlocks/testvalid.adoc deleted file mode 100644 index 513732a..0000000 --- a/.vale/fixtures/AsciiDoc/ValidCodeBlocks/testvalid.adoc +++ /dev/null @@ -1,37 +0,0 @@ -//vale-fixture -Here is a code block: - -[source,terminal] ----- -$ pwd ----- - -Here is a another code block: - -[source,java] ----- -$ pwd ----- - -Here is yet another code block: - -[source,python] ----- -$ pwd ----- - -[source,yaml] ------ -$ pwd ------ - - -Some text. - -//vale-fixture -Here is a final code block: - -[source,terminal] ----- -$ pwd ----- diff --git a/.vale/fixtures/AsciiDoc/ValidConditions/.vale.ini b/.vale/fixtures/AsciiDoc/ValidConditions/.vale.ini deleted file mode 100644 index e29e99a..0000000 --- a/.vale/fixtures/AsciiDoc/ValidConditions/.vale.ini +++ /dev/null @@ -1,5 +0,0 @@ -; Vale configuration file to test the `ValidConditions` rule -StylesPath = ../../../styles -MinAlertLevel = suggestion -[*.adoc] -AsciiDoc.ValidConditions = YES diff --git a/.vale/fixtures/AsciiDoc/ValidConditions/testinvalid.adoc b/.vale/fixtures/AsciiDoc/ValidConditions/testinvalid.adoc deleted file mode 100644 index a10434c..0000000 --- a/.vale/fixtures/AsciiDoc/ValidConditions/testinvalid.adoc +++ /dev/null @@ -1,33 +0,0 @@ -//vale-fixture -ifdef::env-github[] -This content is for GitHub only. - -//vale-fixture -ifndef::env-github[] -This content is for GitHub only. - -So much content in this section, I'd get confused reading the source without the closing `ifdef` directive. - -//vale-fixture -ifdef::revnumber[] -This document has a version number of {revnumber}. - -//vale-fixture -ifeval::[2 > 1] -Some text! - -//vale-fixture -ifeval::["{docname}{outfilesuffix}" == "main.html"] -Some text! - -//vale-fixture -ifeval::["{docname}{outfilesuffix}" == "main.html"] -Some text! - -//vale-fixture -ifeval::["{docname}{outfilesuffix}" == "main.html"] -Some text! - -//vale-fixture -ifeval::[derp] -Some text! diff --git a/.vale/fixtures/AsciiDoc/ValidConditions/testvalid.adoc b/.vale/fixtures/AsciiDoc/ValidConditions/testvalid.adoc deleted file mode 100644 index 3bf5d6b..0000000 --- a/.vale/fixtures/AsciiDoc/ValidConditions/testvalid.adoc +++ /dev/null @@ -1,42 +0,0 @@ -//vale-fixture -ifdef::env-github[] -This content is for GitHub only. -endif::env-github[] - -//vale-fixture -ifndef::env-github[] -This content is for GitHub only. - -So much content in this section, I'd get confused. -endif::[] - -//vale-fixture -ifdef::revnumber[] -This document has a version number of {revnumber}. -endif::[] - -//vale-fixture - doesn't work -//ifndef::profile-production,env-site[Not shown if profile-production or env-site is set.] - -//vale-fixture -ifndef::profile-staging+env-site[Not shown if profile-staging and env-site are set.] - -//vale-fixture -ifeval::[2 > 1] -Some text! -endif::[] - -//vale-fixture -ifeval::["{backend}" == "html5"] -Some text! -endif::[] - -//vale-fixture -ifeval::[{sectnumlevels} == 3] -Some text! -endif::[] - -//vale-fixture -ifeval::["{docname}{outfilesuffix}" == "main.html"] -Some text! -endif::[] diff --git a/.vale/fixtures/AsciiDoc/ValidTableBlocks/.vale.ini b/.vale/fixtures/AsciiDoc/ValidTableBlocks/.vale.ini deleted file mode 100644 index 1a65552..0000000 --- a/.vale/fixtures/AsciiDoc/ValidTableBlocks/.vale.ini +++ /dev/null @@ -1,5 +0,0 @@ -; Vale configuration file to test the `ValidConditions` rule -StylesPath = ../../../styles -MinAlertLevel = suggestion -[*.adoc] -AsciiDoc.ValidTableBlocks = YES diff --git a/.vale/fixtures/AsciiDoc/ValidTableBlocks/testinvalid.adoc b/.vale/fixtures/AsciiDoc/ValidTableBlocks/testinvalid.adoc deleted file mode 100644 index 3b1479e..0000000 --- a/.vale/fixtures/AsciiDoc/ValidTableBlocks/testinvalid.adoc +++ /dev/null @@ -1,37 +0,0 @@ -//vale-fixture -.Table one -[cols=3*,stripes=even] -|=== -|Header column 1 |Header column 2 |Header column 3 -|Cell 1, row 1 -|Cell 2, row 1 -|Cell 3, row 1 -Some text. -|=== - -.Table two -[options="header"] -|==== -|Column Title|Column Title -|content|content -|==== -This content goes on and on. - -Some text. - -.Table three -[options="header"] -|==== -|Column Title|Column Title|Column Title -|content|content|content -|==== - -Some text. - -.Table four -[options="header"] -|==== -|Column Title|Column Title|Column Title -|content|content|content - -Some text. diff --git a/.vale/fixtures/AsciiDoc/ValidTableBlocks/testvalid.adoc b/.vale/fixtures/AsciiDoc/ValidTableBlocks/testvalid.adoc deleted file mode 100644 index e9e5724..0000000 --- a/.vale/fixtures/AsciiDoc/ValidTableBlocks/testvalid.adoc +++ /dev/null @@ -1,58 +0,0 @@ -//vale-fixture -.Table one -[options="header"] -|=== -|Header column 1 |Header column 2 |Header column 3 - -|Cell 1, row 1 -|Cell 2, row 1 -|Cell 3, row 1 -|=== - -Some text. - -//vale-fixture -.Table two -[options="header"] -|==== -|Column Title|Column Title -|content|content -This content goes on and on. -|==== - -Some text. - -//vale-fixture -[caption="test"] -.Table three -|======= -|A |B |C -|a |b |c -|1 |2 |3 -|======= - -Some text. - -//vale-fixture -.Table four -[options="header"] -|==== -|Column Title|Column Title|Column Title -|content|content|content -|==== - -Some text. - -//vale-fixture -.Table five -[cols=2*, width="40%", options="header"] -|==== -|Firefox -|Web Browser - -|Ruby -|Programming Language - -|TorqueBox -|Application Server -|==== diff --git a/.vale/fixtures/OpenShiftAsciiDoc/AdditionalResourcesHeadingHasRoleID/.vale.ini b/.vale/fixtures/OpenShiftAsciiDoc/AdditionalResourcesHeadingHasRoleID/.vale.ini deleted file mode 100644 index 4a215da..0000000 --- a/.vale/fixtures/OpenShiftAsciiDoc/AdditionalResourcesHeadingHasRoleID/.vale.ini +++ /dev/null @@ -1,5 +0,0 @@ -; Vale configuration file to test the `AdditionalResourcesHeadingHasRoleID` rule -StylesPath = ../../../styles -MinAlertLevel = suggestion -[*.adoc] -OpenShiftAsciiDoc.AdditionalResourcesHeadingHasRoleID = YES diff --git a/.vale/fixtures/OpenShiftAsciiDoc/AdditionalResourcesHeadingHasRoleID/testinvalid.adoc b/.vale/fixtures/OpenShiftAsciiDoc/AdditionalResourcesHeadingHasRoleID/testinvalid.adoc deleted file mode 100644 index 56438d2..0000000 --- a/.vale/fixtures/OpenShiftAsciiDoc/AdditionalResourcesHeadingHasRoleID/testinvalid.adoc +++ /dev/null @@ -1,8 +0,0 @@ -//vale-fixture -.Additional resources - -//vale-fixture -== Additional resources - -//vale-fixture -=== Additional resources diff --git a/.vale/fixtures/OpenShiftAsciiDoc/AdditionalResourcesHeadingHasRoleID/testvalid.adoc b/.vale/fixtures/OpenShiftAsciiDoc/AdditionalResourcesHeadingHasRoleID/testvalid.adoc deleted file mode 100644 index 76a90bd..0000000 --- a/.vale/fixtures/OpenShiftAsciiDoc/AdditionalResourcesHeadingHasRoleID/testvalid.adoc +++ /dev/null @@ -1,8 +0,0 @@ -[role="_additional-resources"] -.Additional resources - -[role="_additional-resources"] -== Additional resources - -[role="_additional-resources"] -=== Additional resources diff --git a/.vale/fixtures/OpenShiftAsciiDoc/CheckDollarSymbolInTerminalBlock/.vale.ini b/.vale/fixtures/OpenShiftAsciiDoc/CheckDollarSymbolInTerminalBlock/.vale.ini deleted file mode 100644 index f3a6da7..0000000 --- a/.vale/fixtures/OpenShiftAsciiDoc/CheckDollarSymbolInTerminalBlock/.vale.ini +++ /dev/null @@ -1,5 +0,0 @@ -; Vale configuration file to test the `CheckDollarSymbolInTerminalBlock` rule -StylesPath = ../../../styles -MinAlertLevel = suggestion -[*.adoc] -OpenShiftAsciiDoc.CheckDollarSymbolInTerminalBlock = YES diff --git a/.vale/fixtures/OpenShiftAsciiDoc/CheckDollarSymbolInTerminalBlock/testinvalid.adoc b/.vale/fixtures/OpenShiftAsciiDoc/CheckDollarSymbolInTerminalBlock/testinvalid.adoc deleted file mode 100644 index 043fb86..0000000 --- a/.vale/fixtures/OpenShiftAsciiDoc/CheckDollarSymbolInTerminalBlock/testinvalid.adoc +++ /dev/null @@ -1,11 +0,0 @@ -//vale-fixture -[source,bash] ----- - oc get my lunch ----- - -//vale-fixture -[source,terminal] ----- -oc get my lunch ----- diff --git a/.vale/fixtures/OpenShiftAsciiDoc/CheckDollarSymbolInTerminalBlock/testvalid.adoc b/.vale/fixtures/OpenShiftAsciiDoc/CheckDollarSymbolInTerminalBlock/testvalid.adoc deleted file mode 100644 index f5edaf7..0000000 --- a/.vale/fixtures/OpenShiftAsciiDoc/CheckDollarSymbolInTerminalBlock/testvalid.adoc +++ /dev/null @@ -1,93 +0,0 @@ -[source,bash] ----- -$ oc get my lunch ----- - -[source,yaml] ----- -oc get my lunch ----- - -[source,terminal] ----- -$ oc get my lunch ----- - -[source,terminal] ----- -# oc get my lunch ----- - -.Example output -[source,terminal] ----- -Computer says no ----- - -.Sample output -[source,bash] ----- -Computer says no ----- - -.Example -[source,terminal] ----- -spec: - settings: - ProcTurboMode: Disabled<1> ----- - -[source,terminal] ----- -C:\> net user ----- - -. Change your root directory to the host: -+ -[source,terminal] ----- -sh-4.2# chroot /host ----- - -[source,terminal] ----- -. -├── CODEOWNERS -├── README.md -└── scripts - └── validate-vale-rules.sh ----- - -[source,terminal] ----- -├── CODEOWNERS -├── README.md -└── scripts - └── validate-vale-rules.sh ----- - -[source,terminal] ----- -[ansible@control-node]$ ----- - -[source,terminal] ----- -(undercloud)$ cd go/to/path ----- - -[source,terminal] ----- -(undercloud) [stack@director ~]$ cd go/to/path ----- - -[source,terminal] ----- -sh-4.2# chroot /host ----- - -[source,yaml] ----- -include::yaml/boundary-clock-ptp-config.yaml[] ----- diff --git a/.vale/fixtures/OpenShiftAsciiDoc/HardWrappedLines/.vale.ini b/.vale/fixtures/OpenShiftAsciiDoc/HardWrappedLines/.vale.ini deleted file mode 100644 index e4c4729..0000000 --- a/.vale/fixtures/OpenShiftAsciiDoc/HardWrappedLines/.vale.ini +++ /dev/null @@ -1,5 +0,0 @@ -; Vale configuration file to test the `HardWrappedLines` rule -StylesPath = ../../../styles -MinAlertLevel = suggestion -[*.adoc] -OpenShiftAsciiDoc.HardWrappedLines = YES diff --git a/.vale/fixtures/OpenShiftAsciiDoc/HardWrappedLines/testinvalid.adoc b/.vale/fixtures/OpenShiftAsciiDoc/HardWrappedLines/testinvalid.adoc deleted file mode 100644 index 58f2573..0000000 --- a/.vale/fixtures/OpenShiftAsciiDoc/HardWrappedLines/testinvalid.adoc +++ /dev/null @@ -1,2 +0,0 @@ -//vale-fixture -Est eh ex, a rhoncus magna condimentum a. Aenean ut sem blandit, consectetur nisi diff --git a/.vale/fixtures/OpenShiftAsciiDoc/HardWrappedLines/testvalid.adoc b/.vale/fixtures/OpenShiftAsciiDoc/HardWrappedLines/testvalid.adoc deleted file mode 100644 index dc2dd3a..0000000 --- a/.vale/fixtures/OpenShiftAsciiDoc/HardWrappedLines/testvalid.adoc +++ /dev/null @@ -1,107 +0,0 @@ -//vale-fixture -:_mod-docs-content-type: ASSEMBLY -:url-home: https://asciidoctor.org -:link-docs: https://asciidoctor.org/docs[documentation] -[id="rosa-getting-started-on-really-very-long-id-with-extra-text"] -= Comprehensive guide to getting started with {product-title} - -.REPLACE_WITH_TABLE_TITLE -[cols=2*, width="40%", options="header"] -|==== -|Firefox -|Web Browser - -|Ruby -|Programming Language - -|TorqueBox -|Application Server <1> -|==== -<1> Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse cursus urna -<2> Lorem ipsum dolor sit amet, consectetur adipiscing elit. - -[cols=2*, width="90%", options="header"] -|==== -|Requirement -|Description - -|SSD hard disks -a|* 1 SSD split into 15 200GB thin-provisioned logical volumes provisioned as `PV` CRs -* 1 SSD serving as an extra large `PV` resource -|==== - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Suspendisse cursus urna, nulla. -Sed imperdiet nec nunc a dignissim srdfh amet dolor mollissrdfh fgtf. - -[source,yaml] ----- -# This CR verifies the installation/upgrade of the Cluster Logging Operator -apiVersion: operators.coreos.com/v1 -kind: Operator -metadata: - name: cluster-logging.openshift-logging - annotations: - ran.openshift.io/ztp-deploy-wave: "2" -status: - components: - refs: - - kind: Subscription - namespace: openshift-logging - conditions: - - type: CatalogSourcesUnhealthy - status: "False" - - kind: InstallPlan - namespace: openshift-logging - conditions: - - type: Installed - status: "True" - - kind: ClusterServiceVersion - namespace: openshift-logging - conditions: - - type: Succeeded - status: "True" - reason: InstallSucceeded ----- - -Bullet lists are OK. - -* Lorem ipsum dolor sit amet consectetur adipiscing elit furp -** Lorem ipsum dolor sit amet consectetur adipiscing elit furp -* three - -. Lists are ok Lorem ipsum dolor sit amet consectetur adipiscing elit furp -.. Lists are ok Lorem ipsum dolor sit amet consectetur adipiscing elit furp - -- Lists are ok Lorem ipsum dolor sit amet consectetur adipiscing elit furp --- Lists are ok Lorem ipsum dolor sit amet consectetur adipiscing elit furp - -ifdef::openshift-origin,openshift-enterprise,openshift-webscale[] -* Hybrid cloud deployments. You can deploy {product-title} clusters to a variety of public cloud platforms or in your data center. -endif::[] - -==== -Here's a sample AsciiDoc document: - ----- -= Title of Document -Doc Writer -:toc: - -This guide provides... ----- - -The document header is useful, but not required. -==== - -> I hold it that a little rebellion now and then is a good thing, and as necessary -> in the political world as storms in the physical. -> -- Thomas Jefferson, Papers of Thomas Jefferson: Volume 11 - -.High level {product-title} overview -image::product-workflow-overview.png[High-level {product-title} flow] - -include::modules/a-rather-very-very-long-very-log-very-long-indeed-so-long-file.adoc[] - -Hard drive:: Permanent storage for operating system and/or user files that are used on a daily basis - -`GET api/ocloudNotifications/v1/cluster/node//sync/ptp-status/lock-state/CurrentState` diff --git a/.vale/fixtures/OpenShiftAsciiDoc/IdHasContextVariable/.vale.ini b/.vale/fixtures/OpenShiftAsciiDoc/IdHasContextVariable/.vale.ini deleted file mode 100644 index 7926aff..0000000 --- a/.vale/fixtures/OpenShiftAsciiDoc/IdHasContextVariable/.vale.ini +++ /dev/null @@ -1,5 +0,0 @@ -; Vale configuration file to test the `IdHasContextVariable` rule -StylesPath = ../../../styles -MinAlertLevel = suggestion -[*.adoc] -OpenShiftAsciiDoc.IdHasContextVariable = YES diff --git a/.vale/fixtures/OpenShiftAsciiDoc/IdHasContextVariable/testinvalid.adoc b/.vale/fixtures/OpenShiftAsciiDoc/IdHasContextVariable/testinvalid.adoc deleted file mode 100644 index 10652a7..0000000 --- a/.vale/fixtures/OpenShiftAsciiDoc/IdHasContextVariable/testinvalid.adoc +++ /dev/null @@ -1,5 +0,0 @@ -//vale-fixture -[id="cli-basic-commands_"] - -//vale-fixture -[id="another-id-in-the-same-module-also-gets-flagged"] diff --git a/.vale/fixtures/OpenShiftAsciiDoc/IdHasContextVariable/testvalid.adoc b/.vale/fixtures/OpenShiftAsciiDoc/IdHasContextVariable/testvalid.adoc deleted file mode 100644 index b1bae9c..0000000 --- a/.vale/fixtures/OpenShiftAsciiDoc/IdHasContextVariable/testvalid.adoc +++ /dev/null @@ -1,3 +0,0 @@ -:_mod-docs-content-type: REFERENCE -[id="cli-basic-commands_{context}"] -= Basic CLI commands diff --git a/.vale/fixtures/OpenShiftAsciiDoc/ModuleContainsContentType/.vale.ini b/.vale/fixtures/OpenShiftAsciiDoc/ModuleContainsContentType/.vale.ini deleted file mode 100644 index 7f26363..0000000 --- a/.vale/fixtures/OpenShiftAsciiDoc/ModuleContainsContentType/.vale.ini +++ /dev/null @@ -1,5 +0,0 @@ -; Vale configuration file to test the `ModuleContainsContentType` rule -StylesPath = ../../../styles -MinAlertLevel = suggestion -[*.adoc] -OpenShiftAsciiDoc.ModuleContainsContentType = YES diff --git a/.vale/fixtures/OpenShiftAsciiDoc/ModuleContainsContentType/testinvalid.adoc b/.vale/fixtures/OpenShiftAsciiDoc/ModuleContainsContentType/testinvalid.adoc deleted file mode 100644 index b1260e5..0000000 --- a/.vale/fixtures/OpenShiftAsciiDoc/ModuleContainsContentType/testinvalid.adoc +++ /dev/null @@ -1,5 +0,0 @@ -//vale-fixture -// Error only flagged from cmd line. If the content-type has the wrong test, or is missing entirely, the rule is triggered. -:_mod-docs-content-type: WRONG_TEXT -[id="cli-basic-commands_{context}"] -= Basic CLI commands diff --git a/.vale/fixtures/OpenShiftAsciiDoc/ModuleContainsContentType/testvalid.adoc b/.vale/fixtures/OpenShiftAsciiDoc/ModuleContainsContentType/testvalid.adoc deleted file mode 100644 index f2b905e..0000000 --- a/.vale/fixtures/OpenShiftAsciiDoc/ModuleContainsContentType/testvalid.adoc +++ /dev/null @@ -1,15 +0,0 @@ -:_mod-docs-content-type: REFERENCE -[id="cli-basic-commands_{context}"] -= Basic CLI commands - -:_mod-docs-content-type: PROCEDURE -[id="cli-basic-commands_{context}"] - -:_mod-docs-content-type: CONCEPT -[id="cli-basic-commands_{context}"] - -:_mod-docs-content-type: ASSEMBLY -[id="cli-basic-commands_{context}"] - -:_mod-docs-content-type: SNIPPET -[id="cli-basic-commands_{context}"] diff --git a/.vale/fixtures/OpenShiftAsciiDoc/ModuleContainsParentAssemblyComment/.vale.ini b/.vale/fixtures/OpenShiftAsciiDoc/ModuleContainsParentAssemblyComment/.vale.ini deleted file mode 100644 index dded176..0000000 --- a/.vale/fixtures/OpenShiftAsciiDoc/ModuleContainsParentAssemblyComment/.vale.ini +++ /dev/null @@ -1,5 +0,0 @@ -; Vale configuration file to test the `ModuleContainsParentAssemblyComment` rule -StylesPath = ../../../styles -MinAlertLevel = suggestion -[*.adoc] -OpenShiftAsciiDoc.ModuleContainsParentAssemblyComment = YES diff --git a/.vale/fixtures/OpenShiftAsciiDoc/ModuleContainsParentAssemblyComment/testinvalid.adoc b/.vale/fixtures/OpenShiftAsciiDoc/ModuleContainsParentAssemblyComment/testinvalid.adoc deleted file mode 100644 index 7e1cbe0..0000000 --- a/.vale/fixtures/OpenShiftAsciiDoc/ModuleContainsParentAssemblyComment/testinvalid.adoc +++ /dev/null @@ -1,5 +0,0 @@ -//vale-fixture -Here's some text. I have no commented lines in this file indicating the parent assembly. - - -This rule is only flagged when you run vale on this file from the cmd line. diff --git a/.vale/fixtures/OpenShiftAsciiDoc/ModuleContainsParentAssemblyComment/testvalid.adoc b/.vale/fixtures/OpenShiftAsciiDoc/ModuleContainsParentAssemblyComment/testvalid.adoc deleted file mode 100644 index 6c5defb..0000000 --- a/.vale/fixtures/OpenShiftAsciiDoc/ModuleContainsParentAssemblyComment/testvalid.adoc +++ /dev/null @@ -1,3 +0,0 @@ -//Module is included in... - -//This module is included... diff --git a/.vale/fixtures/OpenShiftAsciiDoc/NoLineRanges/.vale.ini b/.vale/fixtures/OpenShiftAsciiDoc/NoLineRanges/.vale.ini deleted file mode 100644 index ace796a..0000000 --- a/.vale/fixtures/OpenShiftAsciiDoc/NoLineRanges/.vale.ini +++ /dev/null @@ -1,5 +0,0 @@ -; Vale configuration file to test the `NoLineRanges` rule -StylesPath = ../../../styles -MinAlertLevel = error -[*.adoc] -OpenShiftAsciiDoc.NoLineRanges = YES diff --git a/.vale/fixtures/OpenShiftAsciiDoc/NoLineRanges/testinvalid.adoc b/.vale/fixtures/OpenShiftAsciiDoc/NoLineRanges/testinvalid.adoc deleted file mode 100644 index 0167e8c..0000000 --- a/.vale/fixtures/OpenShiftAsciiDoc/NoLineRanges/testinvalid.adoc +++ /dev/null @@ -1,11 +0,0 @@ -//vale-fixture -include::filename.txt[lines=5..10] - -//vale-fixture -include::filename.txt[lines="1..10,15..20"] - -//vale-fixture -include::filename.txt[lines=7;14..25;28..43] - -//vale-fixture -include::filename.txt[lines=12..-1] diff --git a/.vale/fixtures/OpenShiftAsciiDoc/NoLineRanges/testvalid.adoc b/.vale/fixtures/OpenShiftAsciiDoc/NoLineRanges/testvalid.adoc deleted file mode 100644 index 78d2f5d..0000000 --- a/.vale/fixtures/OpenShiftAsciiDoc/NoLineRanges/testvalid.adoc +++ /dev/null @@ -1,15 +0,0 @@ -include::snippets/technology-preview.adoc[leveloffset=+0] - -include::https://raw.githubusercontent.com/openshift/managed-cluster-validating-webhooks/master/docs/webhooks.json[] - -include::yaml/ordinary-clock.yaml[leveloffset=+0] - -include::yaml/ordinary-clock.yml[leveloffset=+0] - -include::ordinary-clock.json[leveloffset=+0] - -include::ordinary-clock.txt[leveloffset=+0] - -include::ordinary-clock.md[leveloffset=+0] - -include::xml/path/ordinary-clock.xml[] diff --git a/.vale/fixtures/OpenShiftAsciiDoc/NoNestingInModules/.vale.ini b/.vale/fixtures/OpenShiftAsciiDoc/NoNestingInModules/.vale.ini deleted file mode 100644 index cb7dcd1..0000000 --- a/.vale/fixtures/OpenShiftAsciiDoc/NoNestingInModules/.vale.ini +++ /dev/null @@ -1,5 +0,0 @@ -; Vale configuration file to test the `NoNestingInModules` rule -StylesPath = ../../../styles -MinAlertLevel = suggestion -[*.adoc] -OpenShiftAsciiDoc.NoNestingInModules = YES diff --git a/.vale/fixtures/OpenShiftAsciiDoc/NoNestingInModules/testinvalid.adoc b/.vale/fixtures/OpenShiftAsciiDoc/NoNestingInModules/testinvalid.adoc deleted file mode 100644 index 9df5c86..0000000 --- a/.vale/fixtures/OpenShiftAsciiDoc/NoNestingInModules/testinvalid.adoc +++ /dev/null @@ -1,5 +0,0 @@ -//vale-fixture -include::modules/rosa-getting-started-deleting-a-cluster.adoc[leveloffset=+1] - -//vale-fixture -include::rosa-getting-started-deleting-a-cluster.adoc[leveloffset=+1] diff --git a/.vale/fixtures/OpenShiftAsciiDoc/NoNestingInModules/testvalid.adoc b/.vale/fixtures/OpenShiftAsciiDoc/NoNestingInModules/testvalid.adoc deleted file mode 100644 index 78d2f5d..0000000 --- a/.vale/fixtures/OpenShiftAsciiDoc/NoNestingInModules/testvalid.adoc +++ /dev/null @@ -1,15 +0,0 @@ -include::snippets/technology-preview.adoc[leveloffset=+0] - -include::https://raw.githubusercontent.com/openshift/managed-cluster-validating-webhooks/master/docs/webhooks.json[] - -include::yaml/ordinary-clock.yaml[leveloffset=+0] - -include::yaml/ordinary-clock.yml[leveloffset=+0] - -include::ordinary-clock.json[leveloffset=+0] - -include::ordinary-clock.txt[leveloffset=+0] - -include::ordinary-clock.md[leveloffset=+0] - -include::xml/path/ordinary-clock.xml[] diff --git a/.vale/fixtures/OpenShiftAsciiDoc/NoTocInModules/.vale.ini b/.vale/fixtures/OpenShiftAsciiDoc/NoTocInModules/.vale.ini deleted file mode 100644 index 6a4a126..0000000 --- a/.vale/fixtures/OpenShiftAsciiDoc/NoTocInModules/.vale.ini +++ /dev/null @@ -1,5 +0,0 @@ -; Vale configuration file to test the `NoTocInModules` rule -StylesPath = ../../../styles -MinAlertLevel = suggestion -[*.adoc] -OpenShiftAsciiDoc.NoTocInModules = YES diff --git a/.vale/fixtures/OpenShiftAsciiDoc/NoTocInModules/testinvalid.adoc b/.vale/fixtures/OpenShiftAsciiDoc/NoTocInModules/testinvalid.adoc deleted file mode 100644 index 2a3c747..0000000 --- a/.vale/fixtures/OpenShiftAsciiDoc/NoTocInModules/testinvalid.adoc +++ /dev/null @@ -1,6 +0,0 @@ -//vale-fixture -:_mod-docs-content-type: REFERENCE -[id="cli-basic-commands_{context}"] -= Basic CLI commands - -toc::[] diff --git a/.vale/fixtures/OpenShiftAsciiDoc/NoTocInModules/testvalid.adoc b/.vale/fixtures/OpenShiftAsciiDoc/NoTocInModules/testvalid.adoc deleted file mode 100644 index 6f2bcb9..0000000 --- a/.vale/fixtures/OpenShiftAsciiDoc/NoTocInModules/testvalid.adoc +++ /dev/null @@ -1,4 +0,0 @@ -//vale-fixture -:_mod-docs-content-type: REFERENCE -[id="cli-basic-commands_{context}"] -= Basic CLI commands diff --git a/.vale/fixtures/OpenShiftAsciiDoc/NoXrefInModules/.vale.ini b/.vale/fixtures/OpenShiftAsciiDoc/NoXrefInModules/.vale.ini deleted file mode 100644 index e51b482..0000000 --- a/.vale/fixtures/OpenShiftAsciiDoc/NoXrefInModules/.vale.ini +++ /dev/null @@ -1,5 +0,0 @@ -; Vale configuration file to test the `NoXrefInModules` rule -StylesPath = ../../../styles -MinAlertLevel = suggestion -[*.adoc] -OpenShiftAsciiDoc.NoXrefInModules = YES diff --git a/.vale/fixtures/OpenShiftAsciiDoc/NoXrefInModules/testinvalid.adoc b/.vale/fixtures/OpenShiftAsciiDoc/NoXrefInModules/testinvalid.adoc deleted file mode 100644 index 885b8fc..0000000 --- a/.vale/fixtures/OpenShiftAsciiDoc/NoXrefInModules/testinvalid.adoc +++ /dev/null @@ -1,2 +0,0 @@ -//vale-fixture -xref:../rosa_getting_started/rosa-getting-started.adoc#rosa-getting-started[Getting started with {product-title}] diff --git a/.vale/fixtures/OpenShiftAsciiDoc/NoXrefInModules/testvalid.adoc b/.vale/fixtures/OpenShiftAsciiDoc/NoXrefInModules/testvalid.adoc deleted file mode 100644 index 2a4fb8c..0000000 --- a/.vale/fixtures/OpenShiftAsciiDoc/NoXrefInModules/testvalid.adoc +++ /dev/null @@ -1 +0,0 @@ -No xrefs here! diff --git a/.vale/fixtures/OpenShiftAsciiDoc/SuggestAttribute/.vale.ini b/.vale/fixtures/OpenShiftAsciiDoc/SuggestAttribute/.vale.ini deleted file mode 100644 index 6b43d1a..0000000 --- a/.vale/fixtures/OpenShiftAsciiDoc/SuggestAttribute/.vale.ini +++ /dev/null @@ -1,5 +0,0 @@ -; Vale configuration file to test the `SuggestAttribute` rule -StylesPath = ../../../styles -MinAlertLevel = suggestion -[*.adoc] -OpenShiftAsciiDoc.SuggestAttribute = YES diff --git a/.vale/fixtures/OpenShiftAsciiDoc/SuggestAttribute/testinvalid.adoc b/.vale/fixtures/OpenShiftAsciiDoc/SuggestAttribute/testinvalid.adoc deleted file mode 100644 index ed118a0..0000000 --- a/.vale/fixtures/OpenShiftAsciiDoc/SuggestAttribute/testinvalid.adoc +++ /dev/null @@ -1,180 +0,0 @@ -//vale-fixture -OpenShift Container Platform -//vale-fixture -Alibaba Cloud -//vale-fixture -Bare Metal Event Relay -//vale-fixture -cert-manager Operator for Red Hat OpenShift -//vale-fixture -distributed tracing data collection -//vale-fixture -distributed tracing platform -//vale-fixture -distributed tracing -//vale-fixture -Factory-precaching-cli tool -//vale-fixture -factory-precaching-cli tool -//vale-fixture -GitOps ZTP -//vale-fixture -Hybrid Cloud Console -//vale-fixture -IBM Cloud -//vale-fixture -IBM Cloud Bare Metal -//vale-fixture -IBM LinuxONE -//vale-fixture -IBM Power -//vale-fixture -IBM Power Virtual Server -//vale-fixture -IBM Z -//vale-fixture -Logging subsystem for Red Hat OpenShift -//vale-fixture -logging subsystem for Red Hat OpenShift -//vale-fixture -LVM Storage -//vale-fixture -Migration Toolkit for Containers -//vale-fixture -MTC -//vale-fixture -odo -//vale-fixture -OpenShift Cluster Manager -//vale-fixture -OpenShift Data Foundation -//vale-fixture -OpenShift image registry -//vale-fixture -OpenShift Kubernetes Engine -//vale-fixture -OpenShift Pipelines -//vale-fixture -OpenShift Platform Plus -//vale-fixture -OpenShift sandboxed containers -//vale-fixture -OpenShift Serverless Functions -//vale-fixture -OpenShift Serverless Operator -//vale-fixture -Pipelines as Code -//vale-fixture -Red Hat Hybrid Cloud Console -//vale-fixture -Red Hat OpenShift Cluster Manager -//vale-fixture -Red Hat OpenShift Data Foundation -//vale-fixture -Red Hat OpenShift Dedicated -//vale-fixture -Red Hat OpenShift Dev Spaces -//vale-fixture -Red Hat OpenShift distributed tracing data collection -//vale-fixture -Red Hat OpenShift distributed tracing platform -//vale-fixture -Red Hat OpenShift GitOps -//vale-fixture -Red Hat OpenShift Local -//vale-fixture -Red Hat OpenShift Pipelines -//vale-fixture -Red Hat OpenShift Service Mesh -//vale-fixture -Red Hat OpenShift support for Windows Containers -//vale-fixture -Red Hat Quay Container Security Operator -//vale-fixture -RHACM -//vale-fixture -Run Once Duration Override Operator -//vale-fixture -Secondary Scheduler Operator -//vale-fixture -Single-node OpenShift -//vale-fixture -single-node OpenShift -//vale-fixture -TALM -//vale-fixture -Tekton Chains -//vale-fixture -Tekton Hub -//vale-fixture -Template Service Broker -//vale-fixture -Tempo Operator -//vale-fixture -Tempo -//vale-fixture -Three-node OpenShift -//vale-fixture -three-node OpenShift -//vale-fixture -Topology Aware Lifecycle Manager -//vale-fixture -velero.io -//vale-fixture -Web Terminal Operator -//vale-fixture -Cluster CAPI Operator -//vale-fixture -Cluster API Provider AWS -//vale-fixture -Cluster API Provider GCP -//vale-fixture -Cluster API Provider IBM Cloud -//vale-fixture -Cluster API Provider Kubevirt -//vale-fixture -Cluster API Provider OpenStack -//vale-fixture -Cluster API Provider OCI -//vale-fixture -Cluster API Provider vSphere -//vale-fixture -Cluster API Provider Nutanix -//vale-fixture -Cluster API Provider Azure -//vale-fixture -Cluster API Provider for AWS -//vale-fixture -Cluster API Provider for GCP -//vale-fixture -Cluster API Provider for IBM Cloud -//vale-fixture -Cluster API Provider for Kubevirt -//vale-fixture -Cluster API Provider for OpenStack -//vale-fixture -Cluster API Provider for OCI -//vale-fixture -Cluster API Provider for vSphere -//vale-fixture -Cluster API Provider for Nutanix -//vale-fixture -Cluster API Provider for Azure -//vale-fixture -CAPA -//vale-fixture -CAPG -//vale-fixture -CAPIBM -//vale-fixture -CAPK -//vale-fixture -CAPO -//vale-fixture -CAPOCI -//vale-fixture -CAPV -//vale-fixture -CAPX -//vale-fixture -CAPZ diff --git a/.vale/fixtures/OpenShiftAsciiDoc/SuggestAttribute/testvalid.adoc b/.vale/fixtures/OpenShiftAsciiDoc/SuggestAttribute/testvalid.adoc deleted file mode 100644 index 1410f07..0000000 --- a/.vale/fixtures/OpenShiftAsciiDoc/SuggestAttribute/testvalid.adoc +++ /dev/null @@ -1,96 +0,0 @@ -{product-title} -{product-title} -{alibaba} -{redfish-operator} -{cert-manager-operator} -{OTELShortName} -{JaegerShortName} -{DTShortName} -{factory-prestaging-tool-caps} -{factory-prestaging-tool} -{ztp-first} -{ztp} -{gitops-shortname} -{hybrid-console-second} -{ibm-title} -{ibm-cloud-title} -{ibm-cloud-bm-title} -{ibm-power-title} -{ibm-power-server-title} -{ibm-z-title} -{ibm-linuxone-title} -{logging-title-uc} -{logging-title} -{logging-uc} -{logging} -{lvms-first} -{lvms} -{mtc-full} -{mtc-short} -{odo-title} -{cluster-manager} -{rh-storage} -{product-registry} -{oke} -{pipelines-shortname} -{opp} -{sandboxed-containers-operator} -{sandboxed-containers-first} -{FunctionsProductName} -{ServerlessOperatorName} -{ServerlessProductName} -{pac} -{rh-rhacm-first} -{hybrid-console} -{cluster-manager-first} -{rh-storage-first} -{product-dedicated} -{openshift-dev-spaces-productname} -{OTELName} -{JaegerName} -{DTProductName} -{gitops-title} -{openshift-local-productname} -{pipelines-title} -{SMProductName} -{productwinc} -{rhq-cso} -{rh-rhacm} -{run-once-operator} -{secondary-scheduler-operator-full} -{secondary-scheduler-operator} -{ServerlessProductShortName} -{SMProductShortName} -{sno-caps} -{sno} -{cgu-operator} -{tekton-chains} -{tekton-hub} -{tsb-name} -{TempoName} -{TempoShortName} -{3no-caps} -{3no} -{cgu-operator-first} -{cgu-operator-full} -{velero-domain} -{web-terminal-op} -{cluster-capi-operator} -{capa-first} -{capa-short} -{capg-first} -{capg-short} -{capibm-first} -{capibm-short} -{capk-first} -{capk-short} -{capo-first} -{capo-short} -{capoci-first} -{capoci-short} -{capv-first} -{capv-short} -{capx-first} -{capx-short} -{capz-first} -{capz-short} diff --git a/.vale/fixtures/OpenShiftAsciiDoc/XrefContainsAnchorID/.vale.ini b/.vale/fixtures/OpenShiftAsciiDoc/XrefContainsAnchorID/.vale.ini deleted file mode 100644 index 621bd27..0000000 --- a/.vale/fixtures/OpenShiftAsciiDoc/XrefContainsAnchorID/.vale.ini +++ /dev/null @@ -1,5 +0,0 @@ -; Vale configuration file to test the `XrefContainsAnchorID` rule -StylesPath = ../../../styles -MinAlertLevel = suggestion -[*.adoc] -OpenShiftAsciiDoc.XrefContainsAnchorID = YES diff --git a/.vale/fixtures/OpenShiftAsciiDoc/XrefContainsAnchorID/testinvalid.adoc b/.vale/fixtures/OpenShiftAsciiDoc/XrefContainsAnchorID/testinvalid.adoc deleted file mode 100644 index 5faba19..0000000 --- a/.vale/fixtures/OpenShiftAsciiDoc/XrefContainsAnchorID/testinvalid.adoc +++ /dev/null @@ -1,8 +0,0 @@ -//vale-fixture -xref:../rosa_getting_started/rosa-getting-started.adoc[Getting started with {product-title}] - -//vale-fixture -xref:../../rosa_getting_started/rosa-getting-started.adoc - -//vale-fixture -xref:../rosa_getting_started/rosa-getting-started.adoc[] diff --git a/.vale/fixtures/OpenShiftAsciiDoc/XrefContainsAnchorID/testvalid.adoc b/.vale/fixtures/OpenShiftAsciiDoc/XrefContainsAnchorID/testvalid.adoc deleted file mode 100644 index b128ebb..0000000 --- a/.vale/fixtures/OpenShiftAsciiDoc/XrefContainsAnchorID/testvalid.adoc +++ /dev/null @@ -1,3 +0,0 @@ -xref:../rosa_getting_started/rosa-getting-started.adoc#getting-started[Getting started with {product-title}] - -xref:../rosa_getting_started/rosa-getting-started.adoc#getting-started diff --git a/.vale/fixtures/OpenShiftAsciiDoc/XrefContainsHTML/.vale.ini b/.vale/fixtures/OpenShiftAsciiDoc/XrefContainsHTML/.vale.ini deleted file mode 100644 index 33a9e53..0000000 --- a/.vale/fixtures/OpenShiftAsciiDoc/XrefContainsHTML/.vale.ini +++ /dev/null @@ -1,5 +0,0 @@ -; Vale configuration file to test the `XrefContainsHTML` rule -StylesPath = ../../../styles -MinAlertLevel = suggestion -[*.adoc] -OpenShiftAsciiDoc.XrefContainsHTML = YES diff --git a/.vale/fixtures/OpenShiftAsciiDoc/XrefContainsHTML/testinvalid.adoc b/.vale/fixtures/OpenShiftAsciiDoc/XrefContainsHTML/testinvalid.adoc deleted file mode 100644 index dbc6841..0000000 --- a/.vale/fixtures/OpenShiftAsciiDoc/XrefContainsHTML/testinvalid.adoc +++ /dev/null @@ -1,5 +0,0 @@ -//vale-fixture -xref:../rosa_getting_started/rosa-getting-started.html#getting-started[Getting started with {product-title}] - -//vale-fixture -xref:../rosa_getting_started/rosa-getting-started.html#getting-started diff --git a/.vale/fixtures/OpenShiftAsciiDoc/XrefContainsHTML/testvalid.adoc b/.vale/fixtures/OpenShiftAsciiDoc/XrefContainsHTML/testvalid.adoc deleted file mode 100644 index b128ebb..0000000 --- a/.vale/fixtures/OpenShiftAsciiDoc/XrefContainsHTML/testvalid.adoc +++ /dev/null @@ -1,3 +0,0 @@ -xref:../rosa_getting_started/rosa-getting-started.adoc#getting-started[Getting started with {product-title}] - -xref:../rosa_getting_started/rosa-getting-started.adoc#getting-started diff --git a/.vale/fixtures/OpenShiftAsciiDoc/XrefMustNotHaveNakedLabel/.vale.ini b/.vale/fixtures/OpenShiftAsciiDoc/XrefMustNotHaveNakedLabel/.vale.ini deleted file mode 100644 index 7f88295..0000000 --- a/.vale/fixtures/OpenShiftAsciiDoc/XrefMustNotHaveNakedLabel/.vale.ini +++ /dev/null @@ -1,5 +0,0 @@ -; Vale configuration file to test the `XrefMustNotHaveNakedLabel` rule -StylesPath = ../../../styles -MinAlertLevel = suggestion -[*.adoc] -OpenShiftAsciiDoc.XrefMustNotHaveNakedLabel = YES diff --git a/.vale/fixtures/OpenShiftAsciiDoc/XrefMustNotHaveNakedLabel/testinvalid.adoc b/.vale/fixtures/OpenShiftAsciiDoc/XrefMustNotHaveNakedLabel/testinvalid.adoc deleted file mode 100644 index 272e8f3..0000000 --- a/.vale/fixtures/OpenShiftAsciiDoc/XrefMustNotHaveNakedLabel/testinvalid.adoc +++ /dev/null @@ -1,2 +0,0 @@ -//vale-fixture -xref:../rosa_getting_started/rosa-getting-started.adoc#getting-started[] diff --git a/.vale/fixtures/OpenShiftAsciiDoc/XrefMustNotHaveNakedLabel/testvalid.adoc b/.vale/fixtures/OpenShiftAsciiDoc/XrefMustNotHaveNakedLabel/testvalid.adoc deleted file mode 100644 index fc0458b..0000000 --- a/.vale/fixtures/OpenShiftAsciiDoc/XrefMustNotHaveNakedLabel/testvalid.adoc +++ /dev/null @@ -1,3 +0,0 @@ -xref:../rosa_getting_started/rosa-getting-started.adoc#getting-started[Getting started with {product-title}] - -xref:../rosa_getting_started/rosa-getting-started.adoc#getting-started[Getting started] diff --git a/.vale/fixtures/RedHat/Abbreviations/.vale.ini b/.vale/fixtures/RedHat/Abbreviations/.vale.ini deleted file mode 100644 index feda26d..0000000 --- a/.vale/fixtures/RedHat/Abbreviations/.vale.ini +++ /dev/null @@ -1,5 +0,0 @@ -; Vale configuration file to test the `Abbreviations` rule -StylesPath = ../../../styles -MinAlertLevel = suggestion -[*.adoc] -RedHat.Abbreviations = YES diff --git a/.vale/fixtures/RedHat/Abbreviations/testinvalid.adoc b/.vale/fixtures/RedHat/Abbreviations/testinvalid.adoc deleted file mode 100644 index e69de29..0000000 diff --git a/.vale/fixtures/RedHat/Abbreviations/testvalid.adoc b/.vale/fixtures/RedHat/Abbreviations/testvalid.adoc deleted file mode 100644 index e69de29..0000000 diff --git a/.vale/fixtures/RedHat/CaseSensitiveTerms/.vale.ini b/.vale/fixtures/RedHat/CaseSensitiveTerms/.vale.ini deleted file mode 100644 index af30e7d..0000000 --- a/.vale/fixtures/RedHat/CaseSensitiveTerms/.vale.ini +++ /dev/null @@ -1,5 +0,0 @@ -; Vale configuration file to test the `CaseSensitiveTerms` rule -StylesPath = ../../../styles -MinAlertLevel = suggestion -[*.adoc] -RedHat.CaseSensitiveTerms = YES diff --git a/.vale/fixtures/RedHat/CaseSensitiveTerms/testinvalid.adoc b/.vale/fixtures/RedHat/CaseSensitiveTerms/testinvalid.adoc deleted file mode 100644 index 42ad2d0..0000000 --- a/.vale/fixtures/RedHat/CaseSensitiveTerms/testinvalid.adoc +++ /dev/null @@ -1,561 +0,0 @@ -A-MQ -A-MQ Broker -A-MQ Clients -A-MQ Console -A-MQ Interconnect -ack -ACK -ack packet -ActiveMQ -ActiveMQ Artemis -Admin Portal -Administration portal -Administrator Portal -Analysis -Ansible playbook -Ansible rulebook -Appliance Console -Application stream -application stream -Applix -ApplixWare -Appstream -appstream -Asciidoc -asciidoc -AsciiDoctor -asciidoctor -assertj -Assertj -auto-link -AutoLink -AWS opt in Region -basic auth -Basic auth -Basic Auth -basic authentication -Basic Authentication -BC -Bean -Bios -blue print -Blue Store -BluePrint -bluestore -BPM -BPMS -BRM -BRMS -BRMS engine -btrfs -burner -Business Central editor -c group -capex -capEx -Capex -Capsule server -CD 1 -Cds -CDS -Ceph Ansible -Ceph block device -Ceph block devices -Ceph file system -Ceph filesystem -Ceph monitor -Ceph object gateway -Ceph object gateways -ceph-osd -cephfs -CFME -CGroup -cidr -classic mode -Classless Inter-domain Routing -Classless Interdomain Routing -CloudForms Management Engine -Cluster Manager -command prompt -Compared to yaml, JSON has way more curly braces. -Composite Content view -composite content view -Composite View -composite view -configmap -configuration map -Content view -content view -control key -CP -crush map -crushmap -csv -ctrl -customer portal -cygmon -CygMon -CYGMON -Data Grid console -data warehouse -Dataware House -day-0 -Day-0 -day-1 -Day-1 -day-2 -Day-2 -Decision Server -Denial of Service -Denial-of-Service -Dev Ops -dev preview -Dev-Ops -Developer preview -Development Preview -devops -Devops -directory manager -directory server -disk druid -Disk druid -diskdruid -DM -DNF automatic -dnf automatic -dns -dotNet -DVD burner -DWH -EAP -engine VM -ETCD -Etcd -Exec Shield -exif -EXIF -Extranet -F.A.Q -facter -faq -Faq -fault tolerant -fault-tolerance -fedora project -File Store -filestore -Firewalld -firewallD -FirewallD -Firewire -firewire -FlatHub -FlatPak -fortran -fqdn -Fqdn -Fuse Ignite -gb -Gb -gbps -GBPS -GDBTK -gid -Gid -gimp -Gimp -GIT -gnome -Gnome -gnu -Gnu -gpl -Gpl -Graalvm -graalVM -green boots -Greenboot -GRPC -Grub -Gtk -gtk -GUI editor -hot rod -HotRod -hotrod -HP Proliant -HTTP interface -hyper-threading -hyperthreading -Hyperviser -HyperVisor -i-fix -i-Fix -ia64 -IA64 -IBM z Systems -ifix -iFix -Ignite -ignition config -IM -Image Builder -Image builder -Infiniband -INSTALL_DIR -installDir -Intel Tolapai -Iops -IOPs -Ip -IPSec -ipv4 -IPV4 -Ipv4 -ipv6 -IPV6 -Ipv6 -iSeries -iso -Istio Service Mesh -Itanium2 -jar file -javadoc -jbang -Jbang -JBoss -JBoss AMQ -JBoss BPMS -JBoss BRMS -JBoss Broker -JBoss Clients -JBoss Console -JBoss Data Grid -JBoss Enterprise Application Platform -JBoss Interconnect -JBoss.org -JDG -jetbrains -Jetbrains -Junit -junit -jvm -Jvm -k8s -kbase -Kernel -kernel-based virtual machine -kernelspace -key store -kickstart -Kie -kie API -Kie Server -kjar -kJAR -knowledge API -knowledge base -knowledge session -knowledgebase -ksession -Kubelet -kubernetes -kvm -lan -Lan -Librados -LIBRADOS -Librbd -LIBRBD -Lightweight Directory Access Protocol over Secure Socket Layer -linux -LINUX -live-backup group -Local Zone -local zone -Lun -lun -LZ -m-TLS -master CA -master server -micro-profile -Microprofile -MicroSoft -Microsoft Azure Portal -Microsoft Windows Server -MoM -Mom -mom -Mongo DB -Mongo-db -mongoDB -Mongodb -MS -ms-dos -Ms-Dos -msdos -MSDOS -MSFT -MTLS -mutual tls -Mutual tls -Mutual TLS -mySQL -MYSQL -native interface -network interface card -node.js -node.JS -Node.JS -nodejs -Nodejs -O.K.D. -Object Storage Device -objectclass -Objective-C -OCM -OCP -OD -ODF -ok -OK button -okay -okd -On-Demand Marketplace -OO -Open InfiniBand -Open Rewrite -openid connect -Openid Connect -openrewrite -Openrewrite -OpenShift Cluster Manager -OpenShift Kubernetes Distribution -Openshift online -OpenShift Origin -OpenStack Platform -Operating Environment -Operating System -Operator hub -Operator Hub -operatorhub -Operatorhub -opEx -Opex -OPEX -ORAN -Org Admin -org admin -Organization administrator -OS -OSD daemon -Overcloud -P-PC -Planner -Playbook -podman -Podman desktop -Pop-up -popup -posix -Posix -Postscript -Powershell -powershell -PPC64 -ppp -Ppp -prom -Prom -proof key for code exchange -proof of concepts -Properties editor -pSeries -puppet -puppet forge -q & a -Q & A -q&a -Q&A -qcow2 -Qcow2 -Qdmanage -QDMANAGE -Qdstat -QDSTAT -Qeth -QETH -ram -Ram -RAM-disk -ramdisk -RAMdisk -RAW -Red Boot -Red Hat Broker -Red Hat Console -Red Hat Interconnect -Red Hat JBoss Data Grid -Red Hat JBoss EAP -Red Hat Network Satellite server -Red Hat Proxy -Red Hat satellite -Red Hat Satellite Capsule server -Red Hat Satellite server -Red Hat Virtualization Hypervisor -Redboot -redis -Resource Planner -resteasy -Resteasy -RESTEASY -RH-OSP -RHCP -RHDS -RHEL host -RHEL-H -RHOS -RHV -RHV Host -RHV Manager -RHV-H -RHV-M -RHVM -Role Based Access Control -role based access control -Role-Based Access Control -rolling application stream -rolling application streams -rolling stream -rolling streams -rom -Rom -rpm -S-E Linux -s-record -s-Record -S-Record -samba -SAMBA -Satellite server -SE Linux -SE-Linux -self-hosted engine virtual machine -selinux -Shadow Man -Shadow passwords -Shadow utilities -ShadowMan -Smallrye -smart NIC -Smart State -smart state -Smart state -Smart-NIC -Smartstate -socks -SoftIRQ -software collection -Software collection -Source Navigator -source to image -Spec -Spice -spice -Spring boot -SR IOV -SREC -ssh -Ssh -SSL -SSL handshake -standard environment -standard Manager -Star Office -Staroffice -StartTLS -startTLS -StartX -STI -SU -sub version -Subscription manifest -Sys V -system d -system D -System V -SystemD -Technology preview -technology preview -The AMQ Broker -The Operator Lifecycle Manager -ttl -uid -UltraSparc -ULTRASPARC -unix -Unix -UNIX-like -uri -url -urn -Use the .NET Core framework -Use the .Net Core framework -Use the .Net framework -User Portal -var -VCPU -vcpu -VI -vim -VIM -Virtual Console -Virtual Desktop Server Management -Virtual Machine Portal -Virtual Network Interface Card -virtual-console -VisualStudio Code -VisualStudioCode -vlan -vLAN -VM portal -vm portal -vnic -VNIC -vnuma -VNUMA -vpn -VS Code -VSCode -VT -VT-i -wan -wca -web-UI -webadmin -webadmin portal -Webauthn -webAuthn -WebAuthN -Websocket -websocket -webUI -wi-fi -WiFi -Wifi -Window-Maker -WindowMaker -x-plat cli -X-PLAT CLI -x-plat-cli -X-PLAT-CLI -Xemacs -Xp -xp -xplat cli -XPLAT CLI -xplat-cli -XPLAT-CLI -Xterm -Yaml is not a markup language. diff --git a/.vale/fixtures/RedHat/CaseSensitiveTerms/testvalid.adoc b/.vale/fixtures/RedHat/CaseSensitiveTerms/testvalid.adoc deleted file mode 100644 index ca8719e..0000000 --- a/.vale/fixtures/RedHat/CaseSensitiveTerms/testvalid.adoc +++ /dev/null @@ -1,338 +0,0 @@ -.NET -// suppress inspection "IncorrectFormatting" for whole file -/var -ACK flag -Administration Portal -Amazon Web Services -AMQ -AMQ Broker -AMQ Clients -AMQ Console -AMQ Interconnect -Ansible Playbook -Apache Subversion -Appliance console -Application Stream -Applixware -AppStream repository -AsciiDoc -Asciidoctor -AssertJ -autolink -Azure Red Hat OpenShift -Basic authentication -Basic HTTP authentication -BIND -bind -BIOS -blueprint -BlueStore -Btrfs -built-in messaging -Business Central -Business Resource Planner -CapEx -capsule -Capsule Server -CD #1 -CDs -Central -Ceph Block Device -Ceph File System -Ceph Monitor -Ceph Object Gateway -ceph-ansible -CephFS -cgroup -CIDR -Command Prompt -Composite Content View -ConfigMap -Content View -CRUSH map -CSV -Ctrl -Customer Portal -Cygmon -Data Grid -Data Grid Console -Data Warehouse -Day 0 -Day 1 -Day 2 -Dedicated -denial of service -denial-of-service -Developer Preview -DevOps -Directory Manager -Directory Server -Disk Druid -DM Multipath -DM-Multipath -DNF Automatic -DNS -DVD writer -Editor -etcd -Exec-Shield -Exif -extranet -Facter -FAQ -fault tolerance -fault-tolerant -Fedora™ Project -File extension example.yaml must pass. -FileStore -firewalld -FireWire -Fortran -FQDN -Fuse Online -Fuse Online|Red Hat Fuse Online|Syndesis -FUSE_HOME -GB -Gbps -GID -GIMP -Git -GNOME -GNOME Classic -GNU -GPL -GraalVM -greenboot -gRPC -GRUB -GTK+ -GUI -guided editor -Hibernate ORM -Hot Rod -HP ProLiant -Hyper-Threading -hypervisor -IBM eServer System p -IBM S/390 -IBM Z -IdM CA renewal server -IdM server and replicas -Ignition config -image builder -inference engine -InfiniBand -Insight -Insights image builder -Intel Virtualization Technology -Intel(R) EP80579 Integrated Processor -Intelligent Process Server -IOPS -IP -IPsec -IPv4 -IPv6 -ISeries -ISO -ISO image -Istio service mesh -Itanium -Itanium 2 -JAR file -Javadoc -JBang -JBoss Community -JBoss EAP -JBoss EAP built-in messaging -JBoss EAP messaging -JetBrains -JUnit -JVM -kernel -kernel space -Kernel-based Virtual Machine -Kernel Module Management -keystore -Kickstart -KIE -KIE API -KIE base -KIE session -KJAR -Knowledgebase -kubelet -Kubelet Stats Receiver -Kubernetes -KVM -LAN -LDAPS -librados -librbd -Linux -Liquibase -LUN -management CLI -management console -Manager virtual machine -Mandrel -master-slave group -MicroProfile -Microsoft -Microsoft Azure Cross-Platform Command-Line Interface -Microsoft Azure On-Demand Marketplace -Microsoft Azure portal -Mockito -MOM -MongoDB -ms -MS-DOS -mTLS -mutual TLS -MySQL -network interface controller (NIC) -Node.js -O-RAN -object class -objectClass -Objective C -OK -OKD -OpenID Connect -OpenRewrite -OpenTelemetry -operating environment -operating system -Operator Lifecycle Manager -OperatorHub -OpEx -Organization Administrator -OSD -OTel -overcloud -Podman -pop-up -POSIX -PostScript -PowerPC -PowerShell -PPP -PROM -Proof Key for Code Exchange -proof of concept -Properties View -Puppet -Puppet Forge -Q and A -QCOW2 -qdmanage -qdstat -qeth -RAM -RAM disk -raw -Realtime Decision Server -Red Hat AMQ -Red Hat build of OpenJDK -Red Hat CloudForms -Red Hat CloudForms Appliance -Red Hat CloudForms|Red Hat CloudForms Appliance -Red Hat Customer Portal -Red Hat Data Grid -Red Hat Directory Server -Red Hat Enterprise Linux host -Red Hat Fuse Online -Red Hat JBoss BPM Suite -Red Hat JBoss BRMS -Red Hat JBoss Enterprise Application Platform -Red Hat Network Proxy Server -Red Hat Network Satellite Server -Red Hat OpenShift Cluster Manager -Red Hat OpenShift Container Platform -Red Hat OpenShift Data Foundation -Red Hat OpenShift Dedicated -Red Hat OpenShift Online -Red Hat OpenStack Platform -Red Hat Satellite -Red Hat Satellite Capsule Server -Red Hat Satellite Server -Red Hat Virtualization -Red Hat Virtualization Host -Red Hat Virtualization Manager -RedBoot -Redis -RESTEasy -role-based access control -Rolling Application Stream -Rolling Application Streams -Rolling Stream -Rolling Streams -ROM -RPM -S-record -Samba -Satellite Server -SELinux -shadow passwords -shadow utilities -Shadowman -SmartNIC -SmartState analysis -SOCKS -softirq -Software Collection -Source-Navigator^TM^ -Source-to-Image (S2I) -spec -SPICE -Spring Boot -SR-IOV -SSH -SSL/TLS -standalone Manager -StarOffice -STARTTLS -startx -su -Subscription Manifest -Syndesis -systemd -SysV -T-BC -Technology Preview -Temurin -The .NET framework -TLS handshake -TTL -UID -UltraSPARC -undercloud -UNIX -URI -URL -URN -VAR -vCPU -VDSM -vi -Vim -virtual console -Visual Studio Code -VLAN -VM Portal -vNIC -vNUMA node -VPN -VT-d -WAN -WCA -Web services -web UI -WebAuthn -WebSocket -Window Maker -Windows -Windows Server -XEmacs -XP -xterm -YAML diff --git a/.vale/fixtures/RedHat/Conjunctions/.vale.ini b/.vale/fixtures/RedHat/Conjunctions/.vale.ini deleted file mode 100644 index ffb0ff9..0000000 --- a/.vale/fixtures/RedHat/Conjunctions/.vale.ini +++ /dev/null @@ -1,5 +0,0 @@ -; Vale configuration file to test the `Conjunctions` rule -StylesPath = ../../../styles -MinAlertLevel = suggestion -[*.adoc] -RedHat.Conjunctions = YES diff --git a/.vale/fixtures/RedHat/Conjunctions/testinvalid.adoc b/.vale/fixtures/RedHat/Conjunctions/testinvalid.adoc deleted file mode 100644 index e69de29..0000000 diff --git a/.vale/fixtures/RedHat/Conjunctions/testvalid.adoc b/.vale/fixtures/RedHat/Conjunctions/testvalid.adoc deleted file mode 100644 index e69de29..0000000 diff --git a/.vale/fixtures/RedHat/ConsciousLanguage/.vale.ini b/.vale/fixtures/RedHat/ConsciousLanguage/.vale.ini deleted file mode 100644 index 69218b8..0000000 --- a/.vale/fixtures/RedHat/ConsciousLanguage/.vale.ini +++ /dev/null @@ -1,5 +0,0 @@ -; Vale configuration file to test the `ConsciousLanguage` rule -StylesPath = ../../../styles -MinAlertLevel = suggestion -[*.adoc] -RedHat.ConsciousLanguage = YES diff --git a/.vale/fixtures/RedHat/ConsciousLanguage/testinvalid.adoc b/.vale/fixtures/RedHat/ConsciousLanguage/testinvalid.adoc deleted file mode 100644 index 0ba6b98..0000000 --- a/.vale/fixtures/RedHat/ConsciousLanguage/testinvalid.adoc +++ /dev/null @@ -1,4 +0,0 @@ -blacklist -master -slave -whitelist diff --git a/.vale/fixtures/RedHat/ConsciousLanguage/testvalid.adoc b/.vale/fixtures/RedHat/ConsciousLanguage/testvalid.adoc deleted file mode 100644 index 38bc8f7..0000000 --- a/.vale/fixtures/RedHat/ConsciousLanguage/testvalid.adoc +++ /dev/null @@ -1,17 +0,0 @@ -allowlist -blocklist -controller -device -director -host -initiator -master broker -performer -primary -proxy -replica -requester -responder -secondary -source -worker diff --git a/.vale/fixtures/RedHat/Contractions/.vale.ini b/.vale/fixtures/RedHat/Contractions/.vale.ini deleted file mode 100644 index 44c1a7c..0000000 --- a/.vale/fixtures/RedHat/Contractions/.vale.ini +++ /dev/null @@ -1,5 +0,0 @@ -; Vale configuration file to test the `Contractions` rule -StylesPath = ../../../styles -MinAlertLevel = suggestion -[*.adoc] -RedHat.Contractions = YES diff --git a/.vale/fixtures/RedHat/Contractions/source.adoc b/.vale/fixtures/RedHat/Contractions/source.adoc deleted file mode 100644 index b01cb3c..0000000 --- a/.vale/fixtures/RedHat/Contractions/source.adoc +++ /dev/null @@ -1,34 +0,0 @@ - "aren't": is not - "can't": cannot - "couldn't": could not - "didn't": did not - "doesn't": does not - "don't": do not - "hasn't": has not - "haven't": have not - "how'll": how will - "how's": how is - "isn't": is not - "it'll": it will - "it's": it is - "shouldn't": should not - "that'll": that will - "that's": that is - "they'll": they will - "they're": they are - "wasn't": was not - "we'll": we will - "we're": we are - "we've": we have - "weren't": were not - "what'll": what will - "what's": what is - "when'll": when will - "when's": when is - "where'll": where will - "where's": where is - "who'll": who will - "who's": who is - "why'll": why will - "why's": why is - "won't": will not diff --git a/.vale/fixtures/RedHat/Contractions/testinvalid.adoc b/.vale/fixtures/RedHat/Contractions/testinvalid.adoc deleted file mode 100644 index aad9c40..0000000 --- a/.vale/fixtures/RedHat/Contractions/testinvalid.adoc +++ /dev/null @@ -1,34 +0,0 @@ -aren't -can't -couldn't -didn't -doesn't -don't -hasn't -haven't -how'll -how's -isn't -it'll -it's -shouldn't -that'll -that's -they'll -they're -wasn't -we'll -we're -we've -weren't -what'll -what's -when'll -when's -where'll -where's -who'll -who's -why'll -why's -won't diff --git a/.vale/fixtures/RedHat/Contractions/testvalid.adoc b/.vale/fixtures/RedHat/Contractions/testvalid.adoc deleted file mode 100644 index 0bdfdaf..0000000 --- a/.vale/fixtures/RedHat/Contractions/testvalid.adoc +++ /dev/null @@ -1,34 +0,0 @@ -is not -cannot -could not -did not -does not -do not -has not -have not -how will -how is -is not -it will -it is -should not -that will -that is -they will -they are -was not -we will -we are -we have -were not -what will -what is -when will -when is -where will -where is -who will -who is -why will -why is -will not diff --git a/.vale/fixtures/RedHat/Definitions/.vale.ini b/.vale/fixtures/RedHat/Definitions/.vale.ini deleted file mode 100644 index b953a7f..0000000 --- a/.vale/fixtures/RedHat/Definitions/.vale.ini +++ /dev/null @@ -1,5 +0,0 @@ -; Vale configuration file to test the `Definitions` rule -StylesPath = ../../../styles -MinAlertLevel = suggestion -[*.adoc] -RedHat.Definitions = YES diff --git a/.vale/fixtures/RedHat/Definitions/testinvalid.adoc b/.vale/fixtures/RedHat/Definitions/testinvalid.adoc deleted file mode 100644 index 4b0bd3f..0000000 --- a/.vale/fixtures/RedHat/Definitions/testinvalid.adoc +++ /dev/null @@ -1 +0,0 @@ -OCS diff --git a/.vale/fixtures/RedHat/Definitions/testvalid.adoc b/.vale/fixtures/RedHat/Definitions/testvalid.adoc deleted file mode 100644 index 08df0ab..0000000 --- a/.vale/fixtures/RedHat/Definitions/testvalid.adoc +++ /dev/null @@ -1,191 +0,0 @@ -// suppress inspection "IncorrectFormatting" for whole file -ACPI -AIX -API -APIs -ARM -ASCII -ASP -AWS -BIND -BIOS -DPDK -OVS -OVN -BMC -CD -CDs -CIDR -CLI -CNAME -CPU -CPUs -CSS -CSV -CUPS -CVE -CVE-2022-1234 -CVEs -DEBUG -DHCP -DNF -DNS -DOM -DOS -DPI -DRL -DSL -DVD -DVDs -EIP -ELB -ERROR -FAQ -FQDN -FTP -GAS -GCC -GCJ -GDB -GET -GID -GIDs -GIF -GIMP -GNOME -Global Navigation Satellite System (GNSS) -GNSS -GNU -GNUPro -GPL -GPU -GRUB -GTK+ -GUI -GUID -HP -HTML -HTTP -HTTPS -IAM -IBM -IDE -IOPS -IP -ISO -IT -JAR -JPEG -JSON -JSX -JVM -KB -KIE -KVM -LAN -LDAP -LESS -LLDB -LPAR -LUKS -LVM -MAC -MB -MBR -MDS -NAT -NET -NFS -NGINX -NIC -NOTE -NULL -NVDA -OEM -OSS -PATH -PC -PDF -PG -PHP -PID -PIDs -PIN -PNG -POSIX -POST -PPP -PROM -PTP -PXE -QCOW2 -QEMU -RADOS -RAID -RAM -RAN -RBAC -RBD -REPL -REST -RFC -RGW -RHEL -ROM -ROMs -RPM -RPMs -RSA -SAML -SAP -SCM -SCSI -SCSS -SDK -SFTP -SHA-1 -SHA-2 -SOCKS -SPEC -SQL -SR-IOV -SSD -SSH -SSL -SSSD -SVG -SVN -SWAT -TBD -TCP -TLS -TODO -TTL -UDP -UEFI -UID -UIDs -UNIX -URI -URIs -URL -URLs -USB -UTC -UTF -UUID -VAR -VDO -VDSM -VGA -VLAN -VNC -VPN -WCA -XFS -XML -XSS -YAML -YUM -ZIP -ZTP diff --git a/.vale/fixtures/RedHat/DoNotUseTerms/.vale.ini b/.vale/fixtures/RedHat/DoNotUseTerms/.vale.ini deleted file mode 100644 index 748a5e2..0000000 --- a/.vale/fixtures/RedHat/DoNotUseTerms/.vale.ini +++ /dev/null @@ -1,5 +0,0 @@ -; Vale configuration file to test the `DoNotUseTerms` rule -StylesPath = ../../../styles -MinAlertLevel = suggestion -[*.adoc] -RedHat.DoNotUseTerms = YES diff --git a/.vale/fixtures/RedHat/DoNotUseTerms/testinvalid.adoc b/.vale/fixtures/RedHat/DoNotUseTerms/testinvalid.adoc deleted file mode 100644 index 2ef7d2a..0000000 --- a/.vale/fixtures/RedHat/DoNotUseTerms/testinvalid.adoc +++ /dev/null @@ -1,23 +0,0 @@ -ACK -basically -congratulations -foo -fubar -future-proof -green -yellow -blue -kerberize -kerberized -native interface -out of the box -out-of-the-box -overhead -please -quiescent -resides -respective -respectively -time-tested -debuggable -and/or diff --git a/.vale/fixtures/RedHat/DoNotUseTerms/testvalid.adoc b/.vale/fixtures/RedHat/DoNotUseTerms/testvalid.adoc deleted file mode 100644 index a2d7109..0000000 --- a/.vale/fixtures/RedHat/DoNotUseTerms/testvalid.adoc +++ /dev/null @@ -1,6 +0,0 @@ -hash sign -ACK flag -Red Hat -Red{nbsp}Hat -redhat -red-hat diff --git a/.vale/fixtures/RedHat/Ellipses/.vale.ini b/.vale/fixtures/RedHat/Ellipses/.vale.ini deleted file mode 100644 index a7d7a5d..0000000 --- a/.vale/fixtures/RedHat/Ellipses/.vale.ini +++ /dev/null @@ -1,5 +0,0 @@ -; Vale configuration file to test the `Ellipses` rule -StylesPath = ../../../styles -MinAlertLevel = suggestion -[*.adoc] -RedHat.Ellipses = YES diff --git a/.vale/fixtures/RedHat/Ellipses/testinvalid.adoc b/.vale/fixtures/RedHat/Ellipses/testinvalid.adoc deleted file mode 100644 index cb32106..0000000 --- a/.vale/fixtures/RedHat/Ellipses/testinvalid.adoc +++ /dev/null @@ -1 +0,0 @@ -this ... that diff --git a/.vale/fixtures/RedHat/Ellipses/testvalid.adoc b/.vale/fixtures/RedHat/Ellipses/testvalid.adoc deleted file mode 100644 index e69de29..0000000 diff --git a/.vale/fixtures/RedHat/EmDash/.vale.ini b/.vale/fixtures/RedHat/EmDash/.vale.ini deleted file mode 100644 index 3746b20..0000000 --- a/.vale/fixtures/RedHat/EmDash/.vale.ini +++ /dev/null @@ -1,5 +0,0 @@ -; Vale configuration file to test the `EmDash` rule -StylesPath = ../../../styles -MinAlertLevel = suggestion -[*.adoc] -RedHat.EmDash = YES diff --git a/.vale/fixtures/RedHat/EmDash/testinvalid.adoc b/.vale/fixtures/RedHat/EmDash/testinvalid.adoc deleted file mode 100644 index 3534f6b..0000000 --- a/.vale/fixtures/RedHat/EmDash/testinvalid.adoc +++ /dev/null @@ -1,2 +0,0 @@ -If you make a mistake—for example, a typographical error—you can correct it easily. -Reliability, scalability, and availability—these are priorities for an enterprise system. diff --git a/.vale/fixtures/RedHat/EmDash/testvalid.adoc b/.vale/fixtures/RedHat/EmDash/testvalid.adoc deleted file mode 100644 index d24df4f..0000000 --- a/.vale/fixtures/RedHat/EmDash/testvalid.adoc +++ /dev/null @@ -1 +0,0 @@ -If you make a mistake (for example, a typographical error), you can correct it easily. diff --git a/.vale/fixtures/RedHat/HeadingPunctuation/.vale.ini b/.vale/fixtures/RedHat/HeadingPunctuation/.vale.ini deleted file mode 100644 index b79ce07..0000000 --- a/.vale/fixtures/RedHat/HeadingPunctuation/.vale.ini +++ /dev/null @@ -1,5 +0,0 @@ -; Vale configuration file to test the `HeadingPunctuation` rule -StylesPath = ../../../styles -MinAlertLevel = suggestion -[*.adoc] -RedHat.HeadingPunctuation = YES diff --git a/.vale/fixtures/RedHat/HeadingPunctuation/testinvalid.adoc b/.vale/fixtures/RedHat/HeadingPunctuation/testinvalid.adoc deleted file mode 100644 index efa1eeb..0000000 --- a/.vale/fixtures/RedHat/HeadingPunctuation/testinvalid.adoc +++ /dev/null @@ -1 +0,0 @@ -= An invalid heading. diff --git a/.vale/fixtures/RedHat/HeadingPunctuation/testvalid.adoc b/.vale/fixtures/RedHat/HeadingPunctuation/testvalid.adoc deleted file mode 100644 index 242e677..0000000 --- a/.vale/fixtures/RedHat/HeadingPunctuation/testvalid.adoc +++ /dev/null @@ -1 +0,0 @@ -= A valid heading diff --git a/.vale/fixtures/RedHat/Headings/.vale.ini b/.vale/fixtures/RedHat/Headings/.vale.ini deleted file mode 100644 index c854fec..0000000 --- a/.vale/fixtures/RedHat/Headings/.vale.ini +++ /dev/null @@ -1,5 +0,0 @@ -; Vale configuration file to test the `Headings` rule -StylesPath = ../../../styles -MinAlertLevel = suggestion -[*.adoc] -RedHat.Headings = YES diff --git a/.vale/fixtures/RedHat/Headings/testinvalid.adoc b/.vale/fixtures/RedHat/Headings/testinvalid.adoc deleted file mode 100644 index c849888..0000000 --- a/.vale/fixtures/RedHat/Headings/testinvalid.adoc +++ /dev/null @@ -1 +0,0 @@ -= An Invalid Heading diff --git a/.vale/fixtures/RedHat/Headings/testvalid.adoc b/.vale/fixtures/RedHat/Headings/testvalid.adoc deleted file mode 100644 index 2b204cd..0000000 --- a/.vale/fixtures/RedHat/Headings/testvalid.adoc +++ /dev/null @@ -1,51 +0,0 @@ -= A valid heading -== Configuring Basic authentication -== Configuring Basic HTTP authentication -== GitLab Code Quality -== The Infinispan project -== Installing SmallRye to do xyz -== Installing RESTEasy with Quarkus -== A Jira instance -== Knative is a component used in Quarkus -== Eclipse Vert.x and Netty are upgraded in Quarkus -== IBM Cloud -== mTLS authentication -//== The mutual TLS authentication scheme -== Proof Key for Code Exchange -== Kogito updates -//== IBM Cloud is a valid product name -//== Spotify, GraphQL, and Quiltflower are proper nouns so uppercase in headings is OK. -== Redis is an in-memory data structure store that is used by several Red Hat products -== Repackage the JAR file -== Installing Podman Desktop -== Installing Flathub -== Installing Flatpak -== Flatpak Builder -== Software Development Kit -== Software Development Kits -== Application IDs -== AppData files -== The Electron base app -== The Node.js SDK extension -== Instructions for GTK -== Instructions for Qt -== Running Kind on Windows Subsystem for Linux (WSL) -== Technology Preview -== Using Podman Desktop -== Using a proxy requiring custom Certificate Authorities -== Using a proxy requiring custom Certificate Authorities (CA) -== JBang -== OpenRewrite something -== About Fluentd and Flyway -== About Graylog and Istio -== Installing JBoss Log Manager -== Troubleshooting with JBoss Logging -== Uninstalling Logstash -== About WebView -== Problems with gRPC and xDS -== Testing role-based access control in a heading -== Testing RBAC in a heading -== A Liquibase database -== Using Mockito -== Downloading the Eclipse Temurin distribution -== Configuring OpenTelemetry diff --git a/.vale/fixtures/RedHat/Hyphens/.vale.ini b/.vale/fixtures/RedHat/Hyphens/.vale.ini deleted file mode 100644 index 137a7d5..0000000 --- a/.vale/fixtures/RedHat/Hyphens/.vale.ini +++ /dev/null @@ -1,5 +0,0 @@ -; Vale configuration file to test the `Hyphens` rule -StylesPath = ../../../styles -MinAlertLevel = suggestion -[*.adoc] -RedHat.Hyphens = YES diff --git a/.vale/fixtures/RedHat/Hyphens/testinvalid.adoc b/.vale/fixtures/RedHat/Hyphens/testinvalid.adoc deleted file mode 100644 index 48c8aa2..0000000 --- a/.vale/fixtures/RedHat/Hyphens/testinvalid.adoc +++ /dev/null @@ -1,226 +0,0 @@ -ad-hoc -addon -auto-configure -auto-generated -auto-install -auto-number -back-up -bi-annual -bi-directional -bi-monthly -bi-weekly -bilevel -broad cast -broad-cast -call out -call-out -check-out -checkin -client-server -cloud-bursting -cloud-washing -co-author -co-existence -co-locate -co-operate -co-ordinate -co-requisite -co-worker -comma delimited -comma separated -command driven -command-language -container based -counter-clockwise -counter-measures -cross platform -cross reference -cross site scripting -crossplatform -cyber-attack -cyber-crime -cyber-security -cyber-space -daisy-chain -daisychain -de-bias -de-bug -desk top -desk-top -disk-label -disklabel -domain-name -dotted-decimal -double-word -down-load -down-stream -e-book -e-mail -extra-linguistic -extra-partition -firm-ware -floating-point -fly-out -fore-ground -gray-scale -help-desk -hot-add -hot-line -hot-plug -hot-swap -hyper-active -hyper-converged -hyper-sensitive -in-line -infra-red -infra-structure -inter-active -inter-cept -inter-related -intra-node -intra-partition -intra-record -intra-system -load-balance -load-balancing -macro-instruction -macro-structure -meta data -meta-class -meta-data -meta-file -meta-table -micro-chip -micro-circuit -micro-code -mid-day -mid-term -mid-year -mini-computer -mini-course -mini-disk -mouse-button -mousebutton -multi site -multi-channel -multi-cloud -multi-factor -multi-media -multi-path -multi-plexer -multi-point -multi-processing -multi-processor -multi-schema -multi-site -multi-table -multi-tenant -multi-tier -multi-tiered -multi-vendor -multicore -multiinstance -new-line -non-compliant -non-contiguous -non-heap -non-interactive -non-linear -non-negotiable -non-paired -non-system -non-zero -nonnative -off-boarding -off-load -omni-channel -on-boarding -on-line -op-code -open-source -OpenSource -opensource -over ride -over-lay -over-ride -over-strike -plug in -plug ins -plug-in -plug-ins -post-editing -post-install -post-installation -post-mortem -post-operation -post-requisite -pre-apply -pre-assembled -pre-cache -pre-compile -pre-configure -pre-defined -pre-enrollment -pre-establish -pre-formatted -pre-install -pre-installation -pre-operational -pre-process -pre-processor -pre-runtime -pseudo-code -pseudo-random -pseudo-text -re-direct -re-edit -re-examine -re-synchronize -recreate -reenable -remote-access -run-time -semi-colon -semi-conductor -set-up -sound-card -stand-alone -straight-forward -sub-address -sub-area -sub-capacity -sub-class -sub-command -sub-directory -sub-menu -sub-net -sub-network -sub-package -sub-tab -super user -super-class -super-object -super-script -super-user -time-frame -time-out -timeframe -trade-off -un-available -un-committed -un-formatted -un-install -un-ordered -under-lying -under-run -under-used -up grade -up selling -up stream -up time -up-grade -up-sell -up-selling -up-stream -up-time -video-mode diff --git a/.vale/fixtures/RedHat/Hyphens/testvalid.adoc b/.vale/fixtures/RedHat/Hyphens/testvalid.adoc deleted file mode 100644 index cd40125..0000000 --- a/.vale/fixtures/RedHat/Hyphens/testvalid.adoc +++ /dev/null @@ -1,152 +0,0 @@ -metadata -open source -override -plugins -plugin -superuser -time frame -upgrade -upselling -upstream -uptime -autoconfigure -autogenerate -autoinstall -autonumber -biannual -bidirectional -bimonthly -biweekly -bi-level -coauthor -coexistence -colocate -cooperate -coordinate -corequisite -coworker -counterclockwise -countermeasures -cyberattack -cybercrime -cybersecurity -cyberspace -extralinguistic -extrapartition -hyperactive -hypersensitive -infrared -infrastructure -interactive -intercept -interrelated -intranode -intrapartition -intrarecord -intrasystem -macroinstruction -macrostructure -metaclass -metafile -metatable -microchip -microcircuit -microcode -midday -midterm -midyear -minicomputer -minicourse -minidisk -mouse button -multisite -multichannel -multicloud -multifactor -multimedia -multipath -multiplexer -multipoint -multiprocessing -multiprocessor -multischema -multitable -multitenant -multitiered -multitiered -multivendor -multi-core -multi-instance -newline -noncompliant -noncontiguous -nonheap -noninteractive -nonlinear -nonnegotiable -nonpaired -nonsystem -nonzero -non-native -offboarding -offload -omnichannel -onboarding -online -opcode -overlay -override -overstrike -postediting -postinstallation -postmortem -postoperation -postrequisite -preapply -preassembled -precache -precompile -predefined -preenrollment -preestablish -preformatted -preinstallation -preoperational -preprocess -preprocessor -preruntime -pseudocode -pseudorandom -pseudotext -redirect -reedit -reexamine -resynchronize -re-create -re-enable -semicolon -semiconductor -subaddress -subarea -subcapacity -subclass -subcommand -subdirectory -submenu -subnet -subnetwork -subpackage -subtab -superclass -superobject -superscript -timeout -time out -unavailable -uncommitted -unformatted -unordered -underlying -underrun -underused -upsell diff --git a/.vale/fixtures/RedHat/MergeConflictMarkers/.vale.ini b/.vale/fixtures/RedHat/MergeConflictMarkers/.vale.ini deleted file mode 100644 index 22a7a18..0000000 --- a/.vale/fixtures/RedHat/MergeConflictMarkers/.vale.ini +++ /dev/null @@ -1,5 +0,0 @@ -; Vale configuration file to test the `MergeConflictMarkers` rule -StylesPath = ../../../styles -MinAlertLevel = error -[*.adoc] -RedHat.MergeConflictMarkers = YES diff --git a/.vale/fixtures/RedHat/MergeConflictMarkers/testinvalid.adoc b/.vale/fixtures/RedHat/MergeConflictMarkers/testinvalid.adoc deleted file mode 100644 index 93cee8a..0000000 --- a/.vale/fixtures/RedHat/MergeConflictMarkers/testinvalid.adoc +++ /dev/null @@ -1,3 +0,0 @@ -<<<<<<< HEAD -======= ->>>>>>> d14c1551c5 (test) diff --git a/.vale/fixtures/RedHat/MergeConflictMarkers/testvalid.adoc b/.vale/fixtures/RedHat/MergeConflictMarkers/testvalid.adoc deleted file mode 100644 index ac5e323..0000000 --- a/.vale/fixtures/RedHat/MergeConflictMarkers/testvalid.adoc +++ /dev/null @@ -1,3 +0,0 @@ -|======= -====== -======== diff --git a/.vale/fixtures/RedHat/OxfordComma/.vale.ini b/.vale/fixtures/RedHat/OxfordComma/.vale.ini deleted file mode 100644 index 99e44d5..0000000 --- a/.vale/fixtures/RedHat/OxfordComma/.vale.ini +++ /dev/null @@ -1,5 +0,0 @@ -; Vale configuration file to test the `OxfordComma` rule -StylesPath = ../../../styles -MinAlertLevel = suggestion -[*.adoc] -RedHat.OxfordComma = YES diff --git a/.vale/fixtures/RedHat/OxfordComma/testinvalid.adoc b/.vale/fixtures/RedHat/OxfordComma/testinvalid.adoc deleted file mode 100644 index 5c9eb8a..0000000 --- a/.vale/fixtures/RedHat/OxfordComma/testinvalid.adoc +++ /dev/null @@ -1,2 +0,0 @@ -For lunch you can have cheese, carrots or peanuts. -This blanket is available in white, green and blue. diff --git a/.vale/fixtures/RedHat/OxfordComma/testvalid.adoc b/.vale/fixtures/RedHat/OxfordComma/testvalid.adoc deleted file mode 100644 index 7661bfb..0000000 --- a/.vale/fixtures/RedHat/OxfordComma/testvalid.adoc +++ /dev/null @@ -1,2 +0,0 @@ -For lunch you can have cheese, carrots, or peanuts. -This blanket is available in white, green, and blue. diff --git a/.vale/fixtures/RedHat/PascalCamelCase/.vale.ini b/.vale/fixtures/RedHat/PascalCamelCase/.vale.ini deleted file mode 100644 index 1a5cea6..0000000 --- a/.vale/fixtures/RedHat/PascalCamelCase/.vale.ini +++ /dev/null @@ -1,5 +0,0 @@ -; Vale configuration file to test the `PascalCamelCase` rule -StylesPath = ../../../styles -MinAlertLevel = suggestion -[*.adoc] -RedHat.PascalCamelCase = YES diff --git a/.vale/fixtures/RedHat/PascalCamelCase/testinvalid.adoc b/.vale/fixtures/RedHat/PascalCamelCase/testinvalid.adoc deleted file mode 100644 index 37cbcf6..0000000 --- a/.vale/fixtures/RedHat/PascalCamelCase/testinvalid.adoc +++ /dev/null @@ -1,126 +0,0 @@ -APIService -BareMetalHost -BrokerTemplateInstance -BuildConfig -CatalogSource -CertificateSigningRequest -CloudCredential -ClusterAutoscaler -ClusterCSIDriver -ClusterNetwork -ClusterOperator -ClusterResourceQuota -ClusterRole -ClusterRoleBinding -ClusterServiceVersion -ClusterTask -ClusterVersion -ComponentStatus -ConsoleCLIDownload -ConsoleExternalLogLink -ConsoleLink -ConsoleNotification -ConsoleYAMLSample -ContainerRuntimeConfig -ControllerConfig -ControllerRevision -CredentialsRequest -CronJob -CSIDriver -CSINode -CSISnapshotController -CustomResourceDefinition -DeploymentConfig -DNSRecord -EgressNetworkPolicy -EndpointSlice -FeatureGate -FlowSchema -HelmChartRepository -HorizontalPodAutoscaler -HostSubnet -ImageContentSourcePolicy -ImagePruner -ImageSignature -ImageStream -ImageStreamImage -ImageStreamImport -ImageStreamMapping -ImageStreamTag -ImageTag -IngressClass -IngressController -innerStopPod -InstallPlan -IPPool -KubeAPIServer -KubeControllerManager -KubeletConfig -KubeScheduler -KubeStorageVersionMigrator -LimitRange -LocalResourceAccessReview -LocalSubjectAccessReview -MachineAutoscaler -MachineConfig -MachineConfigPool -MachineHealthCheck -MachineSet -MutatingWebhookConfiguration -NetNamespace -NetworkAttachmentDefinition -NetworkPolicy -newCustomerId -OAuthAccessToken -OAuthAuthorizeToken -OAuthClient -OAuthClientAuthorization -OpenShiftAPIServer -OpenShiftControllerManager -OperatorGroup -OperatorPKI -PackageManifest -PersistentVolume is an API object. -PodDisruptionBudget -PodMonitor -PodSecurityPolicyReview -PodSecurityPolicySelfSubjectReview -PodSecurityPolicySubjectReview -PodTemplate -PriorityClass -PriorityLevelConfiguration -ProjectRequest -PrometheusRule -RangeAllocation -ReillyAidan -ReplicaSet -ReplicationController -ResourceAccessReview -ResourceQuota -RoleBinding -RoleBindingRestriction -RuntimeClass -SecurityContextConstraints -SelfSubjectAccessReview -SelfSubjectRulesReview -ServiceAccount -ServiceCA -ServiceMonitor -StatefulSet -StorageClass -StorageState -StorageVersionMigration -SubjectAccessReview -SubjectRulesReview -TemplateInstance -ThanosRuler -TokenReview -UserIdentityMapping -UserThing -ValidatingWebhookConfiguration -VolumeAttachment -VolumeSnapshot -VolumeSnapshotClass -VolumeSnapshotContent -xmlHttpRequest is a camel case term. -. youTubeImporter is a camel case term in a list. diff --git a/.vale/fixtures/RedHat/PascalCamelCase/testvalid.adoc b/.vale/fixtures/RedHat/PascalCamelCase/testvalid.adoc deleted file mode 100644 index 41e85f1..0000000 --- a/.vale/fixtures/RedHat/PascalCamelCase/testvalid.adoc +++ /dev/null @@ -1,198 +0,0 @@ -// suppress inspection "IncorrectFormatting" for whole file -== camelCase term should not be flagged in headings -3scale -AGPLv -AMQ -API -APIs -AppStream -AsciiDoc -AssertJ -BaseOS -BitBucket -BlueStore -CaaS -CapEx -CentOS -CephFS -CheckTree -ClassLoader -CloudForms -CodeReady -ConfigMap -ConfigMaps -ConnectX -Convert2RHEL -CoreOS -CPUs -DaemonSet -DDoS -DevOps -DevWorkspace -DNSSec -eServer -etcd -eXpress -eXtenSion -FaaS -FCoE -FDs -FileStore -FireWire -FreeRADIUS -GbE -GBps -GiB -GitHub -GitLab -GitOps -GlusterFS -GNUPro -GnuTLS -GraalVM -GraphQL -GTID -GTIDs -HashBase -HdrHistogram -Helm -HyperShift -IaaS -IBoE -IconBurst -Identity -IdM -IDs -IKEv -InfiniBand -Infrastructure -InnoDB -IntelliJ -IntelliSense -IPoIB -IPsec -IPv -ISeries -ISVs -JavaScript -JBoss -JetBrains -JUnit -kBps -KiB -LangTags -LGPLv -libOSMesa -LibreOffice -libXNVCtrl -LightPulse -LinuxONE -LiquidIO -Log4Shell -ManageIQ -MariaDB -MBps -MegaRAID -MiB -MicroProfile -MongoDB -MoreUtils -MySQL -NetBIOS -NetcoredebugOutput -NetWeaver -NetworkManager -NetXen -NetXtreme -NFSv -NMState -Node.js -NuGet -NVidia -NVMe -OAuth -objectClass -OmniSharp -OneConnect -OpenEXR -OpenID -OpenIPMI -OpenJDK -OpenRAN -OpenRewrite -OpenSCAP -OpenShift -OpenSSH -OpenSSL -OpenStack -OpenTelemetry -OpenTracing -OperatorHub -OpEx -OSBuild -OSs -OTel -PaaS -PackageKit -PathTools -PCIe -PDFs -PipeWire -PostgreSQL -PostScript -PowerPC -PowerShell -ProLiant -PulseAudio -PyPA -PyPI -QLogic -ReaR -RedBoot -relaxngDatatype -RESTEasy -RHEL -RoCE -RPMs -SaaS -SeaBIOS -SELinux -SLAs -SmallRye -SmartNIC -SmartState -SQLite -StarOffice -STMicroelectronics -Subscription -SuperLU -SysV -TBps -TiB -TuneD -TypeScript -UltraSPARC -USBGuard -UUIDs -vCPUs -vCenter -vDisk -vHost -VMs -VMware -vSphere -vSwitch -WebAuthn -WebSocket -WireGuard -Words at the start of a sentence should not trigger the rule. -XEmacs -xPaaS -XString -XWayland -YouTube -ZCentral -[source,terminal] ----- -PersistentVolumeClaim term should not be triggered in a code block ----- diff --git a/.vale/fixtures/RedHat/PassiveVoice/.vale.ini b/.vale/fixtures/RedHat/PassiveVoice/.vale.ini deleted file mode 100644 index b49cb42..0000000 --- a/.vale/fixtures/RedHat/PassiveVoice/.vale.ini +++ /dev/null @@ -1,5 +0,0 @@ -; Vale configuration file to test the `PassiveVoice` rule -StylesPath = ../../../styles -MinAlertLevel = suggestion -[*.adoc] -RedHat.PassiveVoice = YES diff --git a/.vale/fixtures/RedHat/PassiveVoice/testinvalid.adoc b/.vale/fixtures/RedHat/PassiveVoice/testinvalid.adoc deleted file mode 100644 index bc545d3..0000000 --- a/.vale/fixtures/RedHat/PassiveVoice/testinvalid.adoc +++ /dev/null @@ -1,176 +0,0 @@ -It was decided -It was awoken -It was beat -It was become -It was been -It was begun -It was bent -It was beset -It was bet -It was bid -It was bidden -It was bitten -It was bled -It was blown -It was born -It was bought -It was bound -It was bred -It was broadcast -It was broken -It was brought -It was built -It was burnt -It was burst -It was cast -It was caught -It was chosen -It was clung -It was come -It was cost -It was crept -It was cut -It was dealt -It was dived -It was done -It was drawn -It was dreamt -It was driven -It was drunk -It was dug -It was eaten -It was fallen -It was fed -It was felt -It was fit -It was fled -It was flown -It was flung -It was forbidden -It was foregone -It was forgiven -It was forgotten -It was forsaken -It was fought -It was found -It was frozen -It was given -It was gone -It was gotten -It was ground -It was grown -It was heard -It was held -It was hidden -It was hit -It was hung -It was hurt -It was kept -It was knelt -It was knit -It was known -It was laid -It was lain -It was leapt -It was learnt -It was led -It was left -It was lent -It was let -It was lighted -It was lost -It was made -It was meant -It was met -It was misspelt -It was mistaken -It was mown -It was overcome -It was overdone -It was overtaken -It was overthrown -It was paid -It was pled -It was proven -It was put -It was quit -It was read -It was rid -It was ridden -It was risen -It was run -It was rung -It was said -It was sat -It was sawn -It was seen -It was sent -It was set -It was sewn -It was shaken -It was shaven -It was shed -It was shod -It was shone -It was shorn -It was shot -It was shown -It was shrunk -It was shut -It was slain -It was slept -It was slid -It was slit -It was slung -It was smitten -It was sold -It was sought -It was sown -It was sped -It was spent -It was spilt -It was spit -It was split -It was spoken -It was spread -It was sprung -It was spun -It was stolen -It was stood -It was stridden -It was striven -It was struck -It was strung -It was stuck -It was stung -It was stunk -It was sung -It was sunk -It was swept -It was swollen -It was sworn -It was swum -It was swung -It was taken -It was taught -It was thought -It was thrived -It was thrown -It was thrust -It was told -It was torn -It was trodden -It was understood -It was upheld -It was upset -It was wed -It was wept -It was withheld -It was withstood -It was woken -It was won -It was worn -It was wound -It was woven -It was written -It was wrung diff --git a/.vale/fixtures/RedHat/PassiveVoice/testvalid.adoc b/.vale/fixtures/RedHat/PassiveVoice/testvalid.adoc deleted file mode 100644 index a3ffc70..0000000 --- a/.vale/fixtures/RedHat/PassiveVoice/testvalid.adoc +++ /dev/null @@ -1,181 +0,0 @@ -It awoken -It beat -It become -It been -It begun -It bent -It beset -It bet -It bid -It bidden -It bitten -It bled -It blown -It born -It bought -It bound -It bred -It broadcast -It broken -It brought -It built -It burnt -It burst -It cast -It caught -It chosen -It clung -It come -It cost -It crept -It cut -It dealt -It decided -It dived -It done -It drawn -It dreamt -It driven -It drunk -It dug -It eaten -It fallen -It fed -It felt -It fit -It fled -It flown -It flung -It forbidden -It foregone -It forgiven -It forgotten -It forsaken -It fought -It found -It frozen -It given -It gone -It gotten -It ground -It grown -It heard -It held -It hidden -It hit -It hung -It hurt -It is deprecated -It is imported -It is supported -It is tested -It is trusted -It kept -It knelt -It knit -It known -It laid -It lain -It leapt -It learnt -It led -It left -It lent -It let -It lighted -It lost -It made -It meant -It met -It misspelt -It mistaken -It mown -It overcome -It overdone -It overtaken -It overthrown -It paid -It pled -It proven -It put -It quit -It read -It rid -It ridden -It risen -It run -It rung -It said -It sat -It sawn -It seen -It sent -It set -It sewn -It shaken -It shaven -It shed -It shod -It shone -It shorn -It shot -It shown -It shrunk -It shut -It slain -It slept -It slid -It slit -It slung -It smitten -It sold -It sought -It sown -It sped -It spent -It spilt -It spit -It split -It spoken -It spread -It sprung -It spun -It stolen -It stood -It stridden -It striven -It struck -It strung -It stuck -It stung -It stunk -It sung -It sunk -It swept -It swollen -It sworn -It swum -It swung -It taken -It taught -It thought -It thrived -It thrown -It thrust -It told -It torn -It trodden -It understood -It upheld -It upset -It wed -It wept -It withheld -It withstood -It woken -It won -It worn -It wound -It woven -It written -It wrung diff --git a/.vale/fixtures/RedHat/ProductCentricWriting/.vale.ini b/.vale/fixtures/RedHat/ProductCentricWriting/.vale.ini deleted file mode 100644 index 7d393ea..0000000 --- a/.vale/fixtures/RedHat/ProductCentricWriting/.vale.ini +++ /dev/null @@ -1,5 +0,0 @@ -; Vale configuration file to test the `ProductCentricWriting` rule -StylesPath = ../../../styles -MinAlertLevel = suggestion -[*.adoc] -RedHat.ProductCentricWriting = YES diff --git a/.vale/fixtures/RedHat/ProductCentricWriting/testinvalid.adoc b/.vale/fixtures/RedHat/ProductCentricWriting/testinvalid.adoc deleted file mode 100644 index 8697697..0000000 --- a/.vale/fixtures/RedHat/ProductCentricWriting/testinvalid.adoc +++ /dev/null @@ -1,5 +0,0 @@ -The tools allow customers to use a Kubernetes Network Policy to create microsegmentation between deployed application services on the cluster. -The `monitoring-rules-edit` rule permits you to create and silence alerts in the *Developer* perspective in the web console. -The `must-gather` tool enables the user to collect diagnostic information about your cluster. -LoadBalancer lets users assign an external load balancer to an associated service API object in your {product-title} cluster. -LoadBalancer lets you assign an external load balancer to an associated service API object in your {product-title} cluster. diff --git a/.vale/fixtures/RedHat/ProductCentricWriting/testvalid.adoc b/.vale/fixtures/RedHat/ProductCentricWriting/testvalid.adoc deleted file mode 100644 index e69de29..0000000 diff --git a/.vale/fixtures/RedHat/ReadabilityGrade/.vale.ini b/.vale/fixtures/RedHat/ReadabilityGrade/.vale.ini deleted file mode 100644 index 9a25382..0000000 --- a/.vale/fixtures/RedHat/ReadabilityGrade/.vale.ini +++ /dev/null @@ -1,5 +0,0 @@ -; Vale configuration file to test the `ReadabilityGrade` rule -StylesPath = ../../../styles -MinAlertLevel = suggestion -[*.adoc] -RedHat.ReadabilityGrade = YES diff --git a/.vale/fixtures/RedHat/ReadabilityGrade/testinvalid.adoc b/.vale/fixtures/RedHat/ReadabilityGrade/testinvalid.adoc deleted file mode 100644 index e69de29..0000000 diff --git a/.vale/fixtures/RedHat/ReadabilityGrade/testvalid.adoc b/.vale/fixtures/RedHat/ReadabilityGrade/testvalid.adoc deleted file mode 100644 index e69de29..0000000 diff --git a/.vale/fixtures/RedHat/ReleaseNotes/.vale.ini b/.vale/fixtures/RedHat/ReleaseNotes/.vale.ini deleted file mode 100644 index 54dd95f..0000000 --- a/.vale/fixtures/RedHat/ReleaseNotes/.vale.ini +++ /dev/null @@ -1,5 +0,0 @@ -; Vale configuration file to test the `ReleaseNotes` rule -StylesPath = ../../../styles -MinAlertLevel = suggestion -[*.adoc] -RedHat.ReleaseNotes = YES diff --git a/.vale/fixtures/RedHat/ReleaseNotes/testinvalid.adoc b/.vale/fixtures/RedHat/ReleaseNotes/testinvalid.adoc deleted file mode 100644 index 194cd76..0000000 --- a/.vale/fixtures/RedHat/ReleaseNotes/testinvalid.adoc +++ /dev/null @@ -1,2 +0,0 @@ -Now -Previously diff --git a/.vale/fixtures/RedHat/ReleaseNotes/testvalid.adoc b/.vale/fixtures/RedHat/ReleaseNotes/testvalid.adoc deleted file mode 100644 index 8beed02..0000000 --- a/.vale/fixtures/RedHat/ReleaseNotes/testvalid.adoc +++ /dev/null @@ -1,2 +0,0 @@ -With this update -Before this update diff --git a/.vale/fixtures/RedHat/RepeatedWords/.vale.ini b/.vale/fixtures/RedHat/RepeatedWords/.vale.ini deleted file mode 100644 index 78b328d..0000000 --- a/.vale/fixtures/RedHat/RepeatedWords/.vale.ini +++ /dev/null @@ -1,5 +0,0 @@ -; Vale configuration file to test the `SentenceLength` rule -StylesPath = ../../../styles -MinAlertLevel = suggestion -[*.adoc] -RedHat.RepeatedWords = YES diff --git a/.vale/fixtures/RedHat/RepeatedWords/testinvalid.adoc b/.vale/fixtures/RedHat/RepeatedWords/testinvalid.adoc deleted file mode 100644 index 8855b0f..0000000 --- a/.vale/fixtures/RedHat/RepeatedWords/testinvalid.adoc +++ /dev/null @@ -1,2 +0,0 @@ -This is is a sentence with a repeated word. -This is a test test. diff --git a/.vale/fixtures/RedHat/RepeatedWords/testvalid.adoc b/.vale/fixtures/RedHat/RepeatedWords/testvalid.adoc deleted file mode 100644 index 0740ca8..0000000 --- a/.vale/fixtures/RedHat/RepeatedWords/testvalid.adoc +++ /dev/null @@ -1,6 +0,0 @@ -This is a sentence without a repeated word. -This is a sentence with two instances of a word. -Allow searches to be performed on type, contributor, contributor type, and others. -This is a Text. Text is nice. -This is a text. Text is nice. -Select the THE checkbox. diff --git a/.vale/fixtures/RedHat/SelfReferentialText/.vale.ini b/.vale/fixtures/RedHat/SelfReferentialText/.vale.ini deleted file mode 100644 index 1de9278..0000000 --- a/.vale/fixtures/RedHat/SelfReferentialText/.vale.ini +++ /dev/null @@ -1,5 +0,0 @@ -; Vale configuration file to test the `SelfReferentialText` rule -StylesPath = ../../../styles -MinAlertLevel = suggestion -[*.adoc] -RedHat.SelfReferentialText = YES diff --git a/.vale/fixtures/RedHat/SelfReferentialText/testinvalid.adoc b/.vale/fixtures/RedHat/SelfReferentialText/testinvalid.adoc deleted file mode 100644 index 35ee939..0000000 --- a/.vale/fixtures/RedHat/SelfReferentialText/testinvalid.adoc +++ /dev/null @@ -1,11 +0,0 @@ -This topic describes something. -This module describes something. -Follow the steps in this module to configure something. -This assembly describes something. -Follow the steps in this assembly to configure something. -This chapter describes something. -Follow the steps in this chapter to configure something. -This section describes something. -Follow the steps in this section to configure something. -This subsection describes something. -Follow the steps in this subsection to configure something. diff --git a/.vale/fixtures/RedHat/SelfReferentialText/testvalid.adoc b/.vale/fixtures/RedHat/SelfReferentialText/testvalid.adoc deleted file mode 100644 index e69de29..0000000 diff --git a/.vale/fixtures/RedHat/SentenceLength/.vale.ini b/.vale/fixtures/RedHat/SentenceLength/.vale.ini deleted file mode 100644 index 2d28897..0000000 --- a/.vale/fixtures/RedHat/SentenceLength/.vale.ini +++ /dev/null @@ -1,5 +0,0 @@ -; Vale configuration file to test the `SentenceLength` rule -StylesPath = ../../../styles -MinAlertLevel = suggestion -[*.adoc] -RedHat.SentenceLength = YES diff --git a/.vale/fixtures/RedHat/SentenceLength/testinvalid.adoc b/.vale/fixtures/RedHat/SentenceLength/testinvalid.adoc deleted file mode 100644 index e69de29..0000000 diff --git a/.vale/fixtures/RedHat/SentenceLength/testvalid.adoc b/.vale/fixtures/RedHat/SentenceLength/testvalid.adoc deleted file mode 100644 index e69de29..0000000 diff --git a/.vale/fixtures/RedHat/SimpleWords/.vale.ini b/.vale/fixtures/RedHat/SimpleWords/.vale.ini deleted file mode 100644 index 10bbc0f..0000000 --- a/.vale/fixtures/RedHat/SimpleWords/.vale.ini +++ /dev/null @@ -1,5 +0,0 @@ -; Vale configuration file to test the `SimpleWords` rule -StylesPath = ../../../styles -MinAlertLevel = suggestion -[*.adoc] -RedHat.SimpleWords = YES diff --git a/.vale/fixtures/RedHat/SimpleWords/testinvalid.adoc b/.vale/fixtures/RedHat/SimpleWords/testinvalid.adoc deleted file mode 100644 index 9b63ea1..0000000 --- a/.vale/fixtures/RedHat/SimpleWords/testinvalid.adoc +++ /dev/null @@ -1,111 +0,0 @@ -absent -abundance -accentuate -accompany -accomplish -accorded -accordingly -accrue -accurate -acquiesce -acquire -address -addressees -adjacent to -adjustment -admissible -advantageous -advise -aggregate -aircraft -alleviate -allocate -alternatively -alternatives -ameliorate -amend -anticipate -apparent -approximate -ascertain -assistance -attain -attempt -authorize -belated -bestow -cease -collaborate -commence -compensate -component -comprise -concerning -confer -consequently -consolidate -constitutes -contains -convene -demonstrate -depart -designate -desire -determine -detrimental -disclose -discontinue -disseminate -eliminate -elucidate -employ -enclosed -encounter -endeavor -enumerate -equitable -equivalent -exclusively -expedite -facilitate -females -finalize -frequently -identical -incorrect -indication -initiate -itemized -jeopardize -liaise -maintain -methodology -modify -monitor -multiple -necessitate -notify -numerous -objective -obligate -optimum -permit -portion -possess -previous -previously -prioritize -procure -provide -purchase -relocate -solicit -state-of-the-art -subsequent -substantial -sufficient -terminate -transmit -utilization -utilize -utilizing diff --git a/.vale/fixtures/RedHat/SimpleWords/testvalid.adoc b/.vale/fixtures/RedHat/SimpleWords/testvalid.adoc deleted file mode 100644 index 9cd7d8f..0000000 --- a/.vale/fixtures/RedHat/SimpleWords/testvalid.adoc +++ /dev/null @@ -1,122 +0,0 @@ -about -add -agree -aim -allow -allowed -an address -ask -assign -award -bad -before -begin -best -bind -buy -carry out -cause -change -check -choices -choose -clear -compel -complete -count -decide -discover -discuss -divide -do -earlier -ease -end -enough -equal -exact -expect -explain -fair -find -find out -finish -form -forms -get -give -given -go with -goal -harmful -has -help -helpful -hurry -improve -include -included -inside -IP address -IPv4 address -IPv6 address -keep -large -late -later -latest -leave -let -listed -MAC address -many -meet -merge -method -most -move -next -next to -none -not here -offer -often -only -options -or -own -part -partner with -pay -plain -plane -plenty -prove -rank -request -right -risk -same -send -share -show -sign -so -speed up -start -stop -stress -support -tell -the address -total -try -use -want -watch -wish -women -work together -work with -wrong -you diff --git a/.vale/fixtures/RedHat/Slash/.vale.ini b/.vale/fixtures/RedHat/Slash/.vale.ini deleted file mode 100644 index 2d31a05..0000000 --- a/.vale/fixtures/RedHat/Slash/.vale.ini +++ /dev/null @@ -1,5 +0,0 @@ -; Vale configuration file to test the `Slash` rule -StylesPath = ../../../styles -MinAlertLevel = suggestion -[*.adoc] -RedHat.Slash = YES diff --git a/.vale/fixtures/RedHat/Slash/testinvalid.adoc b/.vale/fixtures/RedHat/Slash/testinvalid.adoc deleted file mode 100644 index c0c86b1..0000000 --- a/.vale/fixtures/RedHat/Slash/testinvalid.adoc +++ /dev/null @@ -1,3 +0,0 @@ -more/less -this/that -first/second/third diff --git a/.vale/fixtures/RedHat/Slash/testvalid.adoc b/.vale/fixtures/RedHat/Slash/testvalid.adoc deleted file mode 100644 index 0c25780..0000000 --- a/.vale/fixtures/RedHat/Slash/testvalid.adoc +++ /dev/null @@ -1,17 +0,0 @@ -/mnt/sysimage -07/2023 -192.168.0.0/16 -2023/07/21 -23/7 -C/C++ -client/server -I/O -input/output -Input/Output -N/A -read/write -SSL/TLS -TCP/IP -upstream/downstream -z/OS -z/OSMF diff --git a/.vale/fixtures/RedHat/SmartQuotes/.vale.ini b/.vale/fixtures/RedHat/SmartQuotes/.vale.ini deleted file mode 100644 index a2805ae..0000000 --- a/.vale/fixtures/RedHat/SmartQuotes/.vale.ini +++ /dev/null @@ -1,5 +0,0 @@ -; Vale configuration file to test the `SmartQuotes` rule -StylesPath = ../../../styles -MinAlertLevel = suggestion -[*.adoc] -RedHat.SmartQuotes = YES diff --git a/.vale/fixtures/RedHat/SmartQuotes/testinvalid.adoc b/.vale/fixtures/RedHat/SmartQuotes/testinvalid.adoc deleted file mode 100644 index 648df5a..0000000 --- a/.vale/fixtures/RedHat/SmartQuotes/testinvalid.adoc +++ /dev/null @@ -1,4 +0,0 @@ -‘Wrong‘ -’Also incorrect’ -″Bad″ -‶bad‶ diff --git a/.vale/fixtures/RedHat/SmartQuotes/testvalid.adoc b/.vale/fixtures/RedHat/SmartQuotes/testvalid.adoc deleted file mode 100644 index c2933d3..0000000 --- a/.vale/fixtures/RedHat/SmartQuotes/testvalid.adoc +++ /dev/null @@ -1,5 +0,0 @@ -"Looks good" -"this is fine" -Jim's hair is black -`fine()` -He's good to go. diff --git a/.vale/fixtures/RedHat/Spacing/.vale.ini b/.vale/fixtures/RedHat/Spacing/.vale.ini deleted file mode 100644 index 6e0f191..0000000 --- a/.vale/fixtures/RedHat/Spacing/.vale.ini +++ /dev/null @@ -1,5 +0,0 @@ -; Vale configuration file to test the `Spacing` rule -StylesPath = ../../../styles -MinAlertLevel = suggestion -[*.adoc] -RedHat.Spacing = YES diff --git a/.vale/fixtures/RedHat/Spacing/testinvalid.adoc b/.vale/fixtures/RedHat/Spacing/testinvalid.adoc deleted file mode 100644 index 0762032..0000000 --- a/.vale/fixtures/RedHat/Spacing/testinvalid.adoc +++ /dev/null @@ -1,2 +0,0 @@ -this. That -this.That diff --git a/.vale/fixtures/RedHat/Spacing/testvalid.adoc b/.vale/fixtures/RedHat/Spacing/testvalid.adoc deleted file mode 100644 index 706ccd9..0000000 --- a/.vale/fixtures/RedHat/Spacing/testvalid.adoc +++ /dev/null @@ -1,4 +0,0 @@ -this. That -https://rover.redhat.com/apps/ -www.example.com -docs.microsoft.com diff --git a/.vale/fixtures/RedHat/Spelling/.vale.ini b/.vale/fixtures/RedHat/Spelling/.vale.ini deleted file mode 100644 index ebe4e87..0000000 --- a/.vale/fixtures/RedHat/Spelling/.vale.ini +++ /dev/null @@ -1,5 +0,0 @@ -; Vale configuration file to test the `Spelling` rule -StylesPath = ../../../styles -MinAlertLevel = suggestion -[*.adoc] -RedHat.Spelling = YES diff --git a/.vale/fixtures/RedHat/Spelling/testinvalid.adoc b/.vale/fixtures/RedHat/Spelling/testinvalid.adoc deleted file mode 100644 index cd3c7aa..0000000 --- a/.vale/fixtures/RedHat/Spelling/testinvalid.adoc +++ /dev/null @@ -1,59 +0,0 @@ -ansible -antora -api -bitbucket -btrfs -centos -Centos -ceph -Classloader -crd -ctrl -Daemonset -dns -dotnet -gluster -Graal VM -graal vm -gui -homebrew -Ide -infinispan -intelephense -Intellij -Intellij IDEA -Jvm -kibana -kubespray -lombok -mattermost -microsoft azure -minikube -mokito -mokitto -Mysql -mysql -Netcoredebugoutput -nginx -Nuget -Oauth -Omnisharp -Openshift -Opentracing -php -podman -postgres -Postgresql -quarkus -redis -restic -Sbt -scm -svg -symfony -uber -velero -VMWare -woopra -yaml -zowe diff --git a/.vale/fixtures/RedHat/Spelling/testvalid.adoc b/.vale/fixtures/RedHat/Spelling/testvalid.adoc deleted file mode 100644 index 17ed7a2..0000000 --- a/.vale/fixtures/RedHat/Spelling/testvalid.adoc +++ /dev/null @@ -1,649 +0,0 @@ -// suppress inspection "IncorrectFormatting" for whole file -a .NET application -accessor -ACLs -adoc -AGPLv -Agroal -Allowlist -allowlist -Annobin -Ansible -Antora -API -APIs -Applixware -Asciidoctor -AssertJ -autoconfigure -autogenerate -autoinstall -autolink -automount -Automount -autonumber -autostart -Autostart -aws -AWS -backfilling -Backfilling -backport -backported -backtrace -Backtrace -bcrypt -bi-level -biannual -bidirectional -Bierner -bimonthly -bindable -Bindable -Bitbucket -biweekly -BOM -Bonjour -boolean -Boolean -bootable -Bootable -Bouncy Castle -breakpoint -Breakpoint -breakpoints -Breakpoints -btn -Btrfs -Bugzilla -build config -Buildah -camelCase -CentOS -Ceph -CephFS -cgroup -che -Che -Che-Theia -chrony -Chrony -Ciphertext -Civetweb -ClassLoader -classloading -Classloading -classpath -Cloudbursting -Cloudwashing -coauthor -CodeReady -coexistence -colocate -Colocate -colocation -Colocation -config -Config -config map -config maps -ConfigMap -ConfigMaps -configure -containerd -Containerfile -Containerfiles -Cookiecutter -cooperate -coordinate -corequisite -counterclockwise -countermeasures -coworker -CPU -CPUs -CR -CRD -CRDs -CRs -CSVs -Ctrl -CVEs -cyberattack -cybercrime -cybersecurity -cyberspace -Cygmon -DaemonSet -Datadog -declaratively -decompiler -defragmentation -deserialization -deserialize -deserialized -desynchronize -desynchronized -Dev -devfile -Devfile -devfiles -Devfiles -devworkspace -DevWorkspace -Dex -DNS -Docker -Dockerfile -Dockerfiles -Dotnet -downstream -Downstream -downstreaming -Downstreaming -Dyninst -Endevor -Endian -endif -eServer -Esprima -etcd -Exif -exposal -Exposal -extralinguistic -extranet -extrapartition -Fabrice -Facter -factories -Factories -factory -Factory -failback -Failback -failover -Failover -Failsafe -FDs -Fernflower -firewalld -Flathub -Flatpak -Fluentd -Flyway -Fortran -Funqy -Galera -Gbps -GCC -GID -GIDs -Git -GitHub -GitLab -glock -Glock -glocks -Glocks -Gluster -GNUPro -GraalVM -Gradle -Grafana -GraphQL -Graylog -Grayscale -greenboot -gRPC -GTIDs -GUI -hardcoding -Hashicorp -Heatmap -Helgrind -Helm -Homebrew -hostname -Hostname -htmltest -http -HTTP -https -HTTPS -hyperactive -Hyperconverged -hypersensitive -I/O -IDE -IDEs -IKEv -Infinispan -infrared -infrastructure -Inode -Intelephense -IntelliJ -interactive -intercept -interrelated -intranode -intrapartition -intrarecord -intrasystem -invocable -IPsec -IPv -ISeries -Istio -ISVs -Itanium -Item -Jakarta -Jandex -Java -Jave -JBang -JBoss -JetBrains -Jira -Jolokia -Journald -Journaling -Joyent -JUnit -JVM -Kafka -kbd -kdump -Kdump -Kerberos -Keycloak -Keylime -Keyring -Keyrings -keyspace -keystore -keytab -Keytab -keytabs -Keytabs -Kibana -Knative -Knowledgebase -Kogito -Kompose -kubelet -Kubernetes -Kubespray -Kylin -Laravel -Let's Encrypt -LGPLv -libOSMesa -librados -librbd -Libreswan -libvirt -Libvirt -Licensor -Liquibase -Liveness -Logstash -Lombok -Loopback -macroinstruction -macrostructure -Makefile -Matrixes -Mattermost -Maven -Mebibytes -metaclass -metadata -metafile -metatable -microchip -microcircuit -microcode -MicroProfile -Microsoft -Microsoft Azure -midday -Middleware -middleware -midterm -midyear -Millicores -minicomputer -minicourse -minidisk -Minikube -Minishift -Mirantis -Mixin -Mixins -Mockito -Modularization -MongoDB -monospace -mouse button -multi-core -multi-instance -multichannel -multicloud -Multicluster -multifactor -Multihost -multimedia -Multinode -multipath -Multipath -multiplexer -multipoint -multiprocessing -multiprocessor -multischema -multisite -multitable -multitenancy -Multitenant -multitenant -multithread -Multithread -multitiered -Multiuser -multivendor -Multizone -MySQL -Nagios -Namespace -Namespaces -Narayana -Neoverse -NetcoredebugOutput -Netty -Newdoc -newline -NFSv -Nginx -Node.js -non-native -noncompliant -noncontiguous -nonheap -noninteractive -nonlinear -nonnegotiable -nonpaired -nonsystem -nonzero -npm -NuGet -Nutanix -NVidia -NVMe -OAuth -objectClass -ocp -offboarding -offload -omnichannel -OmniSharp -Onboarding -onboarding -online -opcode -open source -OpenID -OpenJDK -OpenRewrite -OpenShift -OpenTelemetry -OpenTracing -Operator -OSBuild -osd -OSs -OSTree -overlay -overridable -override -overstrike -PCIe -PDFs -Petitboot -PHP -PIDs -pluggable -plugin -plugins -Podman -postediting -PostgreSQL -postinstall -postinstallation -postmortem -postoperation -postrequisite -PowerShell -preapply -preassembled -precache -precompile -precompiled -precompiles -preconfigure -preconfigured -Preconfigured -predefined -preenrollment -preestablish -preformatted -pregenerated -preinstall -preinstallation -preoperational -prepend -prepended -preprocess -preprocessor -preruntime -productize -productized -Prometheus -proxied -pseudocode -pseudorandom -pseudotext -Pulldown -Pytorch -qdmanage -qdstat -qeth -QLogic -Quarkiverse -Quarkus -Quiltflower -Qute -re-create -re-enable -Readonly -Realtime -reauthenticate -Rebalance -Rebalances -Rebalancing -Rebase -Rebased -Recertification -Recertifications -redirect -Redis -Redistributions -reedit -reenabled -reentrant -reexamine -refreshable -reindex -reindexing -relaxngDatatype -Reshard -Resharding -Reshards -RESTEasy -Restic -resynchronize -Resyncing -Rolfe -Rollout -Rollouts -Rollup -ROMs -rootful -rootless -Roundtable -Roundtables -RPMs -Rulebook -rulebook -ruleset -Runlevel -Runlevels -Runtime -Runtimes -Sakila -sbt -SCM -Scrollbar -SELinux -Semeru -semicolon -semiconductor -serializable -serialization -Serializer -Serverless -servlet -Shadowman -Sharding -Skopeo -SLA -SLAs -SmallRye -Spotify -startx -STMicroelectronics -Stratis -su -subaddress -subarea -subcapacity -subclass -Subcommand -subcommand -Subcommands -subdirectory -Submenu -submenu -Submenus -subnet -Subnetwork -subnetwork -Subnetworks -Subpackage -subpackage -Subpackages -Subpath -Subpaths -Substep -Substeps -subtab -Subtest -Subtests -Subuser -Subusers -Subvolume -Subvolumes -Suchow -superclass -superobject -superscript -superuser -SVG -Symfony -sysctl -Sysctl -sysctls -Sysctls -Systemd -Tekton -Telekom -Templated -Temurin -Tensorflow -Texinfo -Theia -time frame -timeout|time out -Tolerations -Toolset -traceback -Traceback -Traefik -Truststore -Uber -UIDs -umask -Umask -unavailable -Uncomment -uncommitted -Undercloud -underlying -underrun -underused -unformatted -Uninstallation -Unmount -Unmounting -unordered -Unported -Unstaged -Untrusted -upgrade -Upsell -upsell -Upselling -upselling -upstream -uptime -URI -URIs -URL -URLs -USBGuard -Valgrind -validator -vDisk -Velero -Vert.x -vHost -VMs -VMware -vsix -vSphere -WebAuthn -Webpack -WebSocket -wifi -Wildfly -Woopra -Wordpress -XString -XWayland -Yana -Yeoman -ZCentral -Zowe diff --git a/.vale/fixtures/RedHat/Symbols/.vale.ini b/.vale/fixtures/RedHat/Symbols/.vale.ini deleted file mode 100644 index c0e7dc2..0000000 --- a/.vale/fixtures/RedHat/Symbols/.vale.ini +++ /dev/null @@ -1,5 +0,0 @@ -; Vale configuration file to test the `Symbols` rule -StylesPath = ../../../styles -MinAlertLevel = suggestion -[*.adoc] -RedHat.Symbols = YES diff --git a/.vale/fixtures/RedHat/Symbols/testinvalid.adoc b/.vale/fixtures/RedHat/Symbols/testinvalid.adoc deleted file mode 100644 index ff84c29..0000000 --- a/.vale/fixtures/RedHat/Symbols/testinvalid.adoc +++ /dev/null @@ -1,2 +0,0 @@ -Don't use this & that. -* Don't use this! diff --git a/.vale/fixtures/RedHat/Symbols/testvalid.adoc b/.vale/fixtures/RedHat/Symbols/testvalid.adoc deleted file mode 100644 index 5929335..0000000 --- a/.vale/fixtures/RedHat/Symbols/testvalid.adoc +++ /dev/null @@ -1,15 +0,0 @@ -:!attribute: -:attribute!: - -Use the "!" symbol -Use the "&" symbol - -[source,terminal] ----- -$ if ! [[ -z $THING ]]; then echo "hihi"; fi ----- - -[source,terminal] ----- -echo "bye bye" && exit ----- diff --git a/.vale/fixtures/RedHat/TermsErrors/.vale.ini b/.vale/fixtures/RedHat/TermsErrors/.vale.ini deleted file mode 100644 index 0103e4c..0000000 --- a/.vale/fixtures/RedHat/TermsErrors/.vale.ini +++ /dev/null @@ -1,5 +0,0 @@ -; Vale configuration file to test the `TermsErrors` rule -StylesPath = ../../../styles -MinAlertLevel = suggestion -[*.adoc] -RedHat.TermsErrors = YES diff --git a/.vale/fixtures/RedHat/TermsErrors/testinvalid.adoc b/.vale/fixtures/RedHat/TermsErrors/testinvalid.adoc deleted file mode 100644 index 2297075..0000000 --- a/.vale/fixtures/RedHat/TermsErrors/testinvalid.adoc +++ /dev/null @@ -1,473 +0,0 @@ -10BASET -24/7 -a lot -a number of -abort -ac -accelerator key -acknowledgement -adapter card -adaptor -administrate -adviser -air wall -aka -all right -alphanumerical -alright -am -amongst -analogue -analyse -anticlockwise -appendices -application program interface -artefact -as long as -as per -autodetect -back slash -backside -backwards compatible -barcode -best of breed -Bidi -Big Blue -bit map -bitfield -bitness -bitrate -bitstring -black hat hacker -blink -blue screen of death -boot diskette -bootloader -bottle neck -breadcrumbing -break point -bring up -bufferpool -builtin -bunches of -burner -busmaster -busses -byte code -Camelcase -CamelCase -cancelation -cancelled -cancelling -canned -cardreader -case insensitive -catalogue -catastrophic error -CBE -CBTS -CD burner -centre -check box -check list -check mark -chipset -Christian name -chronologic -cipher text -clear text -cleartext -codepage -codepoint -codeset -cold backup -cold boot -cold start -colours -combo box -comes with -CommServer -comprised of -computer farm -computer ranch -connect with -containerised -context menu -contextual help -control point logical unit -controlling logical unit -convertor -copy book -cyber attack -cyber attacker -cyber crime -cyber defense -cyber hacker -cyber intelligence -cyber security -cyber space -cyber terror -cyber threat -cyberresilience -cypher text -data base -datacentre -datafile -dataflow -datamart -datamirroring -datapath -datapool -dataset -datasheet -datum -daylight savings time -dc -DDNAME -deconfigure -deinstall -deinstallation -demilitarized zone -demon -demount -deployment configuration -depress -deregister -descendent -details pane -diagnostic tests -different than -different to -dismiss -disrupter -domain mode -DOS environment -double quote -double word -down time -downwards compatible -drill up -dual boot -dualboot -dumpfile -eFix -Elastic Load Balancer -emphasise -end user -enum -env -EUI -evangelist -fatal -fill in -finalise -fire up -Firefox -first name -fixed disk drive -flavor -focussed -forename -forward compatible -freezes -G11N -g11n -gage -grayed out -grey -gzipped file -hard boot -hard copy -hard file -hardcode -hardcoded -health care -healthcheck -heart beat -hence -hostgroup -hotkey -HOWTO -imbed -in depth -in other words -in spite of -in the event -inactivate -incent -incentivize -inch pound -information technology -initial caps -Internet address -Intranet -invoke -io -IPI -irrecoverable -is shipped with -JavaBean -joblog -jobstream -judgement -keep in mind -kernelspace -kick off -L10N -l10n -labelled -labour -large page -last name -learnings -learnt -leave out -left most -left-arrow key -left-hand -left-justified -left-justify -left-most -line cord -link edit -link editing -live broker -live only -loadtime -log into -log off of -log onto -logfile -lots of -main directory -make file -man day -man hour -manipulation button -manpage -masterbrand -matrices -memory stick -menu driven -menubar -menudriven -microcomputer -motherboard -mountpoint -mouse button 1 -mouse button 2 -mouse over -multijobbing -MV -nameserver -network-centric computing -newsfeed -nextgen -non-secure -nonrecoverable -nonsecure -notion -NWSAA -offline storage -on demand -on ramp -on the fly -on the other hand -on-ramp -oops -OpenShit -ops -opt into -opting into -organise -organised -organising -orientate -pain point -parent task -parent/child -passive broker -pathname -PCOMM -perfcounter -perimeter network -phillips screw -phillips screwdriver -phone -PL/1 -plain-text -plaintext -planar board -Plug-and-Play -pm -Pod Cast -Podcast -pojo -pop-up list -pop-up menu -pop-up window -pops up -pow wow -poweron -practise -preventative -print friendly -prior to -program product -programmed operator -Programming Language/I -proof of concepts -pub/sub -publish-subscribe -quickstart -Quickstart -read-write -recognise -Red Hat Java -Red Hat Open Java Development Kit -Red Hat OpenJDK -regex -requestor -RHOJDK -right now -right-hand -right-justified -right-justify -right-most -round table -round-robin task dispatching -rule of thumb -S 390 -sanity check -schemata -screencap -screensaver -scroll bar -second name -secondary storage -segregate -segregation -selection button -send out -serial database -Sharename -ships with -short cut -shortcut key -shortcut menu -sign into -sign off of -signoff -signon -Simple Object Access Protocol -single quote -single signon -smartcard -smartpaper -SME routine -snapset -snapsets -so long as -sockets interface -socksified -soft boot -soft copy -specfile -spelt -spend -standalone mode -sunset -super page -swapspace -switch off -synch -sysprep function -system engineer -tablespace -TCP/IP network -teleprocessing line -testcase -the installer -There are many ways to write, for instance, using a pencil. -thin provisioned -third-party software vendor -thru -thumb drive -thumbstick -Thunderbird -tier 1 -tier-one -time box -time line -time stamp -timeslice -timezone -toggle off -tool bar -tool box -tool kit -tool tip -ToolTip -totalled -touch base -touchscreen -trouble shoot -trust store -try and -twisty -TY-RAP -typo -unallocate -uncheck -uncompilation -uncompile -uncompress -undeploy -underbar -unencrypt -unselect -untar -unzip -upgradable -UPI -upward compatible -USB thumb drive -useable -utilize -vanilla -versus -virtual diskette -virtual diskette -virtual diskette drive -virtual diskette drive -virtual DOS machine -virtual hard disk -virtual hard disk -w/ this -w/o -wait condition -war room -warm boot -warmstart -warning notice -web cast -web master -web site -webmistress -white hat hacker -whitepaper -wild card -wiring closet -wish -work flow -work group -work load -work space -work station -would like -XSA -xsite -zero out -zeroes -zonegroup -Zulu time diff --git a/.vale/fixtures/RedHat/TermsErrors/testvalid.adoc b/.vale/fixtures/RedHat/TermsErrors/testvalid.adoc deleted file mode 100644 index 72b02a0..0000000 --- a/.vale/fixtures/RedHat/TermsErrors/testvalid.adoc +++ /dev/null @@ -1,698 +0,0 @@ -/etc -/etc/ -10BASE-T -10BASE2 -12.00 AM -24x7 -a or b -a, b, or both -AC -access method -according to -acknowledgment -ad hoc -adapter -add a prefix to -add-on -administer -advisor -advocate -afterward -air gap -allowlist -alphanumeric -also known as -alternatively -although -AM -ambassador -AMD64 -analog -and so on -Apache Subversion -app -appendixes -Application Load Balancer -application programming interface -archive -artifact -as -as expected -as in -as needed -as well as per recipient -attacker -attention notice -auto-detect -auxiliary storage -back -backslash -backup -bar code -bean -benchmark -best in class -bidi -bimonthly -bit field -bit rate -bit string -bit value -bit version -bitmap -biweekly -blocklist -boot disk -boot loader -bottleneck -breadcrumb trail -breakpoint -broadcast -BTS -buffer pool -bug fix -built-in -bus master -buses -bytecode -cable tie -callout -camel case -cancel -canceled -canceling -cancellation -cannot -card -card reader -catalog -CD writer -cell phone -center of operations -challenge -change -check-in -checkbox -checklist -checkmark -checkout -child -chip set -chronological -CICS BTS -ciphertext -class-like -Classic Load Balancer -clear -click -client/server -close -cloudbursting -cloudwashing -code page -code point -code set -collect -colocate -colocation -combination box -comma-delimited -comma-separated values -command center -command language -Command Prompt -command-driven -Common Base Event -communicate -Communications Server -compared to -compatible with earlier versions -compatible with later versions -compilation -complete -component architecture -component model -component-based development -compress -compressed file -concept -concern -connect to -consist of -consumer -contact -container-based -containerized -context-sensitive help -control logical unit -control room -conversely -converter -Coordinated Universal Time -copybook -corporate brand -correct -counterclockwise -create -create retrieve update and delete -cross-platform -cross-reference -cross-site replication -cross-site scripting -cyber resilience -cyberattack -cyberattacker -cybercrime -cyberdefense -cyberhacker -cyberintelligence -cybersecurity -cyberspace -cyberterror -cyberthreat -daemon -daisy chain -data -data center -data enumeration -data file -data flow -data mart -data mirroring -data model -data path -data pool -data set -data sheet -database -Daylight Saving Time -DC -ddname -deactivate -deallocate -debias -debug -decompilation -decompile -decompress -decrypt -delete from the database -demo -demonstration -deployment -descendant -deselect -desktop -despite -details view -develop components -diagnostics -different from -difficulty -discontinue -disk label -diskette -diskette drive -dismount -disruptor -DMZ -domain name -DOS session -dotted decimal -double quotation mark -double right-click -double-byte -double-click -doubleword -download -downstream -downtime -drag -dual-boot -dump file -dynamically -earlier -ebook -Elastic Load Balancing -email -embed -emit -enable for the web -encourage -end -ensure -enter -environment -etc/ -evaluate -examine -executable files -executable program -executable routine -expenditure -expense -experiences -extended subarea addressing -extract -fail -fall back -fallback -firmware -fix -flash -floating point -flyout -for example -foreground -front end -front-end -Gateway Load Balancer -gauge -given name -globalization -graphical interface -graphical user interface -gray -grayscale -hard code -hard disk -hard disk drive -hard-coded -hardcopy -hardware restart -health check -healthcare -heartbeat -help -help desk -helper -host group -hot add -hot key -hot plug -hot swap -hotline -how-to -however -huge page -hyperconverged -I am -I/O -IBM -IBM S/390 -if -immediately -in case -in languages other than English -in real time -in-depth -inch-pound -include -included -includes -independent software vendor -influencer -information -initial capital letters -inline -insecure -installation program -installer-provisioned infrastructure -instant message -interface -interim fix -Internet email address -Internet Protocol network -intranet -IP address -IP network -issue -IT -Java -java-class-jar -java-package-add-on -JavaBeans -job log -job stream -judgment -kernel oops -kernel-space -keyboard shortcut -knowledge base -labeled -labor hour -laptop -left -Left Arrow key -left mouse button -left-align -left-aligned -leftmost -lessons -licensed program -link-edit -link-editing -list -live-only -load balance -load time -load-time -localization -lock up -log file -log in to -log off from -log on to -lower left -lower right -lower-left -lower-right -major vector -make the transition -makefile -man page -managed domain -many -master broker -matrixes -menu -menu bar -menu-driven -merge -metadata -method -migrate -mobile phone -motivate -mount point -Mouse -mouse button -move -move the mouse pointer over -Mozilla Firefox -Mozilla Thunderbird -ms -much -multichannel -multiprocessing -multisite -multitasking -multitenant -multitiered -name server -navigate -need -NetWare for SAA -network computing -Network Load Balancer -newline -news feed -next generation -no longer support -non-English-language -nonpageable -nonpartitioned database environment -not at the latest level -not case-sensitive -not displayed -notebook -now -offboarding -offensive security researcher -offline backup -offload -offsite -OK -omit -omnichannel -on-demand -onboarding -online -onsite -opcode -open -open source -OpenJDK -opens -OpenShift -operations -orient -outlay -override -pageable -parent process -parent-child -path name -PC -performance counter -person day -person hour -Personal Communications -Phillips screw -Phillips screwdriver -PL/I -plain text -plug-and-play -plugin -PM -podcast -point to -power cable -power cord -power-off -power-on -practice -preconfigured -predefined -preinstall -preinstalled -preplanned -press -press Ctrl and click -press Shift and click -preventive -previous -printer friendly -program operator -proofs of concept -provided that -pseudo-ops -pseudocode -publish/subscribe -pull-down -quick start -rather than -re-create -read/write -rear -recur -Red Hat build of OpenJDK -regardless of -regular expression -remember -remote access -remote access server -remove -replica -requester -required -restart -restart the system -retry -right -right mouse button -right-align -right-aligned -rightmost -roll back -rollback -root directory -round-robin scheduling -roundtable -rule -run time -runlevel -runtime -schemas -screen capture -screen saver -scrollbar -secondary -segmentation -self-hosted engine -self-hosted engine node -self-signed certificate -separate -separation -server cluster -server farm -server side -server-side -session management exit routine -setup -several -share name -shared components -shell prompt -shell script -shortcut -sign in to -sign off from -sign on to -sign-off -single quotation mark -single sign-on -slave broker -smart card -smart paper -snapshot set -SOAP -socket interface -SOCKS-enabled -softcopy -software to block pop-up ad windows -sort -sound card -spec file -specific -specify -spelled -standalone -standalone server -start -stop -stop error -stop responding -straightforward -sub-version -subcommand -subdirectory -submenu -subpackage -superuser -supplier -surname -swap space -sync -sync point -synchronize -sysprep -system board -systems engineer -table space -tap -telecommunication line -telecommunications closet -telephone -test -test case -text mode -text-based -that is -The .tar file -The .zip file -therefore -thin-provisioned -this clause that is restrictive -this clause, which is nonrestrictive -though -throughput -tier-1 -time frame -time out -time slice -time zone -timebox -timeline -timeout -timestamp -to -toggle -toolbar -toolbox -tooling -toolkit -tools -tooltip -topic-based information -totaled -touch-sensitive screen -tradeoff -training events -transmission line -troubleshoot -trusted certificate authority -truststore -try again -try to -turn off -turn on -twistie -type -typing error -typographical error -vCenter datacenter -un-customized -unavailable -unconfigure -uncustomized -underscore -uninstall -uninstallation -unmount -unrecoverable -unrecoverable error -unregister -upgrade -upgradeable -upper left -upper right -upper-left -upper-right -uppercase -upsell -upselling -upstream -uptime -URL -usable -USB flash drive -use -user -user-provisioned infrastructure -verify -version -video mode -virtual -virtual floppy disk -virtual floppy drive -virtual hard drive -wait state -want -warm start -web address -web seminar -web-based event -webcast -webinar -webmaster -website -when -white paper -Wi-Fi -wildcard -window -Windows 32-bit operating system -withdraw -withdraw from marketing -withdraw from service -worker -workflow -workgroup -workload -workspace -workstation -zero -zeros -zone group -Configuring the Compute Service for Instance Creation. Support for instance domain change-deltas, and for instances where. diff --git a/.vale/fixtures/RedHat/TermsSuggestions/.vale.ini b/.vale/fixtures/RedHat/TermsSuggestions/.vale.ini deleted file mode 100644 index 1a6c642..0000000 --- a/.vale/fixtures/RedHat/TermsSuggestions/.vale.ini +++ /dev/null @@ -1,5 +0,0 @@ -; Vale configuration file to test the `TermsSuggestions` rule -StylesPath = ../../../styles -MinAlertLevel = suggestion -[*.adoc] -RedHat.TermsSuggestions = YES diff --git a/.vale/fixtures/RedHat/TermsSuggestions/testinvalid.adoc b/.vale/fixtures/RedHat/TermsSuggestions/testinvalid.adoc deleted file mode 100644 index b712bd0..0000000 --- a/.vale/fixtures/RedHat/TermsSuggestions/testinvalid.adoc +++ /dev/null @@ -1,64 +0,0 @@ -above -afterwards -all caps -bare metal clusters -bare metal compute -bare metal configuration -bare metal control -bare metal environment -bare metal equipment -bare metal event -bare metal hardware -bare metal host -bare metal infrastructure -bare metal installation -bare metal installer -bare metal machine -bare metal media -bare metal node -bare metal provisioning -bare metal server -bare metal worker -below -bottom left -bottom right -bugfix -can not -choose -componentization -componentize -consumes -drag and drop -executable -frontend -gzip -higher -hit -in order to -information on -jar -launch -legacy -Navigate -once -operator -operators -refer to -segfault -shell -spawn -start up -Start using this. -tar -tar file -tarball -This clause which is nonrestrictive -This clause, that is restrictive -thus -translate -via -x64 -x86 -x86-64 -zip -zip file diff --git a/.vale/fixtures/RedHat/TermsSuggestions/testvalid.adoc b/.vale/fixtures/RedHat/TermsSuggestions/testvalid.adoc deleted file mode 100644 index 06f145c..0000000 --- a/.vale/fixtures/RedHat/TermsSuggestions/testvalid.adoc +++ /dev/null @@ -1,57 +0,0 @@ -64-bit x86 -about using -after -are not using -are using -bare-metal clusters -bare-metal compute -bare-metal configuration -bare-metal control -bare-metal environment -bare-metal equipment -bare-metal event -bare-metal hardware -bare-metal host -bare-metal infrastructure -bare-metal installation -bare-metal installer -bare-metal machine -bare-metal media -bare-metal node -bare-metal provisioning -bare-metal server -bare-metal worker -before -By using -by using -earlier -following -from -information about -later -lower left -lower right -on -Operator -program operator -security-profiles-operator -see this section -segmentation fault -shell prompt -shell script -something against which something else -something at which something else -something for which something else -something from which something else -something in which something else -something of which something else -something on which something else -something to which something else -something with which something else -something without which something else -this clause, which is nonrestrictive -through -to using -when using -When using -x86_64 diff --git a/.vale/fixtures/RedHat/TermsWarnings/.vale.ini b/.vale/fixtures/RedHat/TermsWarnings/.vale.ini deleted file mode 100644 index 9c1af69..0000000 --- a/.vale/fixtures/RedHat/TermsWarnings/.vale.ini +++ /dev/null @@ -1,5 +0,0 @@ -; Vale configuration file to test the `TermsWarnings` rule -StylesPath = ../../../styles -MinAlertLevel = suggestion -[*.adoc] -RedHat.TermsWarnings = YES diff --git a/.vale/fixtures/RedHat/TermsWarnings/testinvalid.adoc b/.vale/fixtures/RedHat/TermsWarnings/testinvalid.adoc deleted file mode 100644 index 5eddf18..0000000 --- a/.vale/fixtures/RedHat/TermsWarnings/testinvalid.adoc +++ /dev/null @@ -1,68 +0,0 @@ -all caps -architected -are updatable -as well as -BIOS -call up -carry on -carry out -click on -Ctrl-click -deselect -desired -destroy -destroyed -double click -double-click on -downgrade -entitlement -etc -execute -find out -hamburger -he -host name -I -illegal -in order to -ingests -insure -invokable -is updatable -kebab -kebab menu -kill -kilobytes -leverage -like -look at -may -non-English -on premise -on-prem -on-premises -opt into -opting into -preload -preloaded -print out -right double-click -sane -she -shift-click -spawn -start up -speed up -speeds up -switch on -tap on -tarball -terminate -tooling -transition -vs -Hybrid Cloud Console -Cloud Console -Red Hat Hybrid Cloud Console -the Cloud Console -The Cloud Console diff --git a/.vale/fixtures/RedHat/TermsWarnings/testvalid.adoc b/.vale/fixtures/RedHat/TermsWarnings/testvalid.adoc deleted file mode 100644 index f57a5a0..0000000 --- a/.vale/fixtures/RedHat/TermsWarnings/testvalid.adoc +++ /dev/null @@ -1,69 +0,0 @@ -accurate -accelerate -after -and -and so on -camel case -can -change -clear -colocate -colocation -delete -deleted -designed -discover -end -end -ensure -enter -examine -fall back -fallback -firmware -hostname -import -in languages other than English -in-house -incorrect -invalid -invocable -issue -KB -kB -load -load balance -make the transition -might -migrate -move -non-English-language -not allowed -obtain -on-premise -on-site -open -plugin -preinstall -preinstalled -print -process -repository -roll back -rollback -run -start -start -stop -stop -subscription -such as -tool -tools -upgrade -use -valid -verified -when -you -you diff --git a/.vale/fixtures/RedHat/UserReplacedValues/.vale.ini b/.vale/fixtures/RedHat/UserReplacedValues/.vale.ini deleted file mode 100644 index 7b57a11..0000000 --- a/.vale/fixtures/RedHat/UserReplacedValues/.vale.ini +++ /dev/null @@ -1,5 +0,0 @@ -; Vale configuration file to test the `PassiveVoice` rule -StylesPath = ../../../styles -MinAlertLevel = suggestion -[*.adoc] -RedHat.UserReplacedValues = YES diff --git a/.vale/fixtures/RedHat/UserReplacedValues/testinvalid.adoc b/.vale/fixtures/RedHat/UserReplacedValues/testinvalid.adoc deleted file mode 100644 index f4020c2..0000000 --- a/.vale/fixtures/RedHat/UserReplacedValues/testinvalid.adoc +++ /dev/null @@ -1,5 +0,0 @@ -This is ____ with hyphens. -This is ____ with hyphens and underscores. -This is ____ with hyphens and undersores. -This is ____ with hyphens and underscores. -This is ____ with hyphens and monospaced. diff --git a/.vale/fixtures/RedHat/UserReplacedValues/testvalid.adoc b/.vale/fixtures/RedHat/UserReplacedValues/testvalid.adoc deleted file mode 100644 index 8409b0f..0000000 --- a/.vale/fixtures/RedHat/UserReplacedValues/testvalid.adoc +++ /dev/null @@ -1,3 +0,0 @@ -This is ____. -This is __<{an-attribute-using-hyphens-in_a_user_replaced_value}>__. -This is an hyphen, not in a user-replaced value. diff --git a/.vale/styles/AsciiDoc/ClosedAttributeBlocks.yml b/.vale/styles/AsciiDoc/ClosedAttributeBlocks.yml deleted file mode 100644 index b3e65fc..0000000 --- a/.vale/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/.vale/styles/AsciiDoc/MatchingNumberedCallouts.yml b/.vale/styles/AsciiDoc/MatchingNumberedCallouts.yml deleted file mode 100644 index 3f61a60..0000000 --- a/.vale/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 = [] - } - } - } diff --git a/.vale/styles/AsciiDoc/SequentialNumberedCallouts.yml b/.vale/styles/AsciiDoc/SequentialNumberedCallouts.yml deleted file mode 100644 index 443c8f0..0000000 --- a/.vale/styles/AsciiDoc/SequentialNumberedCallouts.yml +++ /dev/null @@ -1,45 +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,}$" - - for line in text.split(scope, "\n") { - // trim trailing whitespace - line = text.trim_space(line) - //reset count if we hit a listing block delimiter - if text.re_match(listingblock_delim_regex, line) { - prev_num = 0 - } - - 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/.vale/styles/AsciiDoc/ValidAdmonitionBlocks.yml b/.vale/styles/AsciiDoc/ValidAdmonitionBlocks.yml deleted file mode 100644 index 1ebe018..0000000 --- a/.vale/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/.vale/styles/AsciiDoc/ValidCodeBlocks.yml b/.vale/styles/AsciiDoc/ValidCodeBlocks.yml deleted file mode 100644 index f7af5c1..0000000 --- a/.vale/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/.vale/styles/AsciiDoc/ValidConditions.yml b/.vale/styles/AsciiDoc/ValidConditions.yml deleted file mode 100644 index 62994e4..0000000 --- a/.vale/styles/AsciiDoc/ValidConditions.yml +++ /dev/null @@ -1,35 +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::.+\\[\\]|ifndef::.+\\[\\]|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) { - 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/.vale/styles/AsciiDoc/ValidTableBlocks.yml b/.vale/styles/AsciiDoc/ValidTableBlocks.yml deleted file mode 100644 index 8096be3..0000000 --- a/.vale/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/.vale/styles/OpenShiftAsciiDoc/AdditionalResourcesHeadingHasRoleID.yml b/.vale/styles/OpenShiftAsciiDoc/AdditionalResourcesHeadingHasRoleID.yml deleted file mode 100644 index a6ea2fc..0000000 --- a/.vale/styles/OpenShiftAsciiDoc/AdditionalResourcesHeadingHasRoleID.yml +++ /dev/null @@ -1,10 +0,0 @@ ---- -extends: existence -scope: raw -level: suggestion -nonword: true -link: https://github.com/openshift/openshift-docs/blob/main/contributing_to_docs/doc_guidelines.adoc#additional-resources-sections -message: "Additional resources heading is missing the '_additional-resources' role attribute declaration" -tokens: - - '(?|sh|.*\n\├|\[.*\]|\(.*\))' diff --git a/.vale/styles/OpenShiftAsciiDoc/HardWrappedLines.yml b/.vale/styles/OpenShiftAsciiDoc/HardWrappedLines.yml deleted file mode 100644 index 5a84f86..0000000 --- a/.vale/styles/OpenShiftAsciiDoc/HardWrappedLines.yml +++ /dev/null @@ -1,51 +0,0 @@ ---- -extends: script -message: "Avoid hard-wrapped lines." -level: warning -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" - - sentence_regex := "^.*(\\.|\\?|\\!|:)$" - list_regex := "^(\\.|\\*|-).*$" - hard_wrap_80_regex := "^.{65,80}$" - hard_wrap_100_regex := "^.{75,100}$" - asciidoc_markup := "^(.*\\[.*\\]|\\/\\/.*|=+.*|<(\\.|\\d+)>.*|>|#+.*|\\..+|\\|.*|a\\|.*|:.+|.*::|`.*`|ifdef::|endif::|image::|include::|link::|video::).*$" - listingblock_delim_regex := "^-{4}$" - inside_listingblock := false - - for line in text.split(scope, "\n") { - // trim trailing whitespace - line = text.trim_space(line) - //ignore content in codeblocks - if text.re_match(listingblock_delim_regex, line) && inside_listingblock == false { - inside_listingblock = true - } else if text.re_match(listingblock_delim_regex, line) && inside_listingblock == true { - inside_listingblock = false - } - - //ignore sentences - if !text.re_match(sentence_regex, line) && inside_listingblock == false { - //ignore AsciiDoc elements - if !text.re_match(asciidoc_markup, line) { - //ignore lists - if !text.re_match(list_regex, line) { - //match hard wrapped lines at 80 - if text.re_match(hard_wrap_80_regex, line) && inside_listingblock == false { - start := text.index(scope, line) - matches = append(matches, {begin: start, end: start + len(line)}) - //match hard wrapped lines at 100 - } else if text.re_match(hard_wrap_100_regex, line) && inside_listingblock == false { - start := text.index(scope, line) - matches = append(matches, {begin: start, end: start + len(line)}) - } - } - } - } - } diff --git a/.vale/styles/OpenShiftAsciiDoc/IdHasContextVariable.yml b/.vale/styles/OpenShiftAsciiDoc/IdHasContextVariable.yml deleted file mode 100644 index 6642212..0000000 --- a/.vale/styles/OpenShiftAsciiDoc/IdHasContextVariable.yml +++ /dev/null @@ -1,8 +0,0 @@ ---- -extends: existence -scope: raw -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: - - '(?{7}\s.*$' diff --git a/.vale/styles/RedHat/ObviousTerms.yml b/.vale/styles/RedHat/ObviousTerms.yml deleted file mode 100644 index fd3f2a3..0000000 --- a/.vale/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/.vale/styles/RedHat/OxfordComma.yml b/.vale/styles/RedHat/OxfordComma.yml deleted file mode 100644 index 2f9d108..0000000 --- a/.vale/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/.vale/styles/RedHat/PascalCamelCase.yml b/.vale/styles/RedHat/PascalCamelCase.yml deleted file mode 100644 index a2f3ea1..0000000 --- a/.vale/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/.vale/styles/RedHat/PassiveVoice.yml b/.vale/styles/RedHat/PassiveVoice.yml deleted file mode 100644 index 67b16af..0000000 --- a/.vale/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/.vale/styles/RedHat/ProductCentricWriting.yml b/.vale/styles/RedHat/ProductCentricWriting.yml deleted file mode 100644 index 3721699..0000000 --- a/.vale/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/.vale/styles/RedHat/README-IBM.adoc b/.vale/styles/RedHat/README-IBM.adoc deleted file mode 100644 index 7e27b01..0000000 --- a/.vale/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/.vale/styles/RedHat/README-proselint.md b/.vale/styles/RedHat/README-proselint.md deleted file mode 100644 index b08cef9..0000000 --- a/.vale/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/.vale/styles/RedHat/README-write-good.md b/.vale/styles/RedHat/README-write-good.md deleted file mode 100644 index ba919b6..0000000 --- a/.vale/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/.vale/styles/RedHat/ReadabilityGrade.yml b/.vale/styles/RedHat/ReadabilityGrade.yml deleted file mode 100644 index ad1e171..0000000 --- a/.vale/styles/RedHat/ReadabilityGrade.yml +++ /dev/null @@ -1,8 +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/.vale/styles/RedHat/ReleaseNotes.yml b/.vale/styles/RedHat/ReleaseNotes.yml deleted file mode 100644 index 10ee9c9..0000000 --- a/.vale/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/.vale/styles/RedHat/RepeatedWords.yml b/.vale/styles/RedHat/RepeatedWords.yml deleted file mode 100644 index 3893d9b..0000000 --- a/.vale/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/.vale/styles/RedHat/SelfReferentialText.yml b/.vale/styles/RedHat/SelfReferentialText.yml deleted file mode 100644 index 36adbf4..0000000 --- a/.vale/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/.vale/styles/RedHat/SentenceLength.yml b/.vale/styles/RedHat/SentenceLength.yml deleted file mode 100644 index c21f0bc..0000000 --- a/.vale/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/.vale/styles/RedHat/SimpleWords.yml b/.vale/styles/RedHat/SimpleWords.yml deleted file mode 100644 index dd8ed6e..0000000 --- a/.vale/styles/RedHat/SimpleWords.yml +++ /dev/null @@ -1,119 +0,0 @@ ---- -extends: substitution -ignorecase: true -level: suggestion -link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/simplewords/ -message: "Use simple language. Consider using '%s' rather than '%s'." -action: - name: replace -swap: - "approximate(?:ly)?": about - "objective(?! C?)": aim|goal - absent: none|not here - abundance: plenty - accentuate: stress - accompany: go with - accomplish: carry out|do - accorded: given - accordingly: so - accrue: add - accurate: right|exact - acquiesce: agree - acquire: get|buy - addressees: you - adjacent to: next to - adjustment: change - admissible: allowed - advantageous: helpful - advise: tell - aggregate: total - aircraft: plane - alleviate: ease - allocate: assign|divide - alternatively: or - alternatives: choices|options - ameliorate: improve - amend: change - anticipate: expect - apparent: clear|plain - ascertain: discover|find out - assistance: help - attain: meet - attempt: try - authorize: allow - belated: late - bestow: give - cease: stop|end - collaborate: work together - commence: begin - compensate: pay - component: part - comprise: form|include - concerning: about - confer: give|award - consequently: so - consolidate: merge - constitutes: forms - contains: has - convene: meet - demonstrate: show|prove - depart: leave - designate: choose - desire: want|wish - determine: decide|find - detrimental: bad|harmful - disclose: share|tell - discontinue: stop - disseminate: send|give - eliminate: end - elucidate: explain - employ: use - enclosed: inside|included - encounter: meet - endeavor: try - enumerate: count - equitable: fair - equivalent: equal - exclusively: only - expedite: hurry - facilitate: ease - females: women - finalize: complete|finish - frequently: often - identical: same - incorrect: wrong - indication: sign - initiate: start|begin - itemized: listed - jeopardize: risk - liaise: work with|partner with - maintain: keep|support - methodology: method - modify: change - monitor: check|watch - multiple: many - necessitate: cause - notify: tell - numerous: many - obligate: bind|compel - optimum: best|most - permit: let - portion: part - possess: own - previous: earlier - previously: before - prioritize: rank - procure: buy - provide: give|offer - purchase: buy - relocate: move - solicit: request - state-of-the-art: latest - subsequent: later|next - substantial: large - sufficient: enough - terminate: end - transmit: send - utilization: use - utilize: use - utilizing: using diff --git a/.vale/styles/RedHat/Slash.yml b/.vale/styles/RedHat/Slash.yml deleted file mode 100644 index 7584c39..0000000 --- a/.vale/styles/RedHat/Slash.yml +++ /dev/null @@ -1,27 +0,0 @@ ---- -extends: existence -ignorecase: true -level: warning -link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/slash/ -message: "Use either 'or' or 'and' in '%s'" -# source: "IBM - Slashes, p. 68" -scope: - - sentence - - heading -tokens: - - '(?__' - - '<[a-z_]+-[a-z_-]+>' diff --git a/.vale/styles/RedHat/Using.yml b/.vale/styles/RedHat/Using.yml deleted file mode 100644 index 869cdc9..0000000 --- a/.vale/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/.vale/styles/RedHat/collate-output.tmpl b/.vale/styles/RedHat/collate-output.tmpl deleted file mode 100644 index 449aa42..0000000 --- a/.vale/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/.vale/styles/RedHat/meta.json b/.vale/styles/RedHat/meta.json deleted file mode 100644 index 6099c80..0000000 --- a/.vale/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/.vale/styles/config/vocabularies/ELN/accept.txt b/.vale/styles/config/vocabularies/ELN/accept.txt new file mode 100644 index 0000000..9fa765c --- /dev/null +++ b/.vale/styles/config/vocabularies/ELN/accept.txt @@ -0,0 +1,29 @@ +btrfs +buildroot +centos +deliverables +eln +EPEL +ELN +ELN Extras +rhel +RHEL +CentOS +unbundle +downstreams +freeipa +libreoffice +openssl +libreport +gpsd +subpackage +cron +Koji +enablement +retagging +conditionalized +subpackages +unshipped +workgroup +distro +FESCo