diff --git a/.vale/fixtures/Localization/AdjectivesWithNouns/.vale.ini b/.vale/fixtures/Localization/AdjectivesWithNouns/.vale.ini new file mode 100644 index 000000000..53abfadb3 --- /dev/null +++ b/.vale/fixtures/Localization/AdjectivesWithNouns/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `AdjectivesWithNouns` rule +StylesPath = ../../../styles +MinAlertLevel = warning +[*.adoc] +Localization.TermsWarnings = YES diff --git a/.vale/fixtures/Localization/AdjectivesWithNouns/testinvalid.adoc b/.vale/fixtures/Localization/AdjectivesWithNouns/testinvalid.adoc new file mode 100644 index 000000000..23d8fd52d --- /dev/null +++ b/.vale/fixtures/Localization/AdjectivesWithNouns/testinvalid.adoc @@ -0,0 +1,2 @@ +the following +the previous \ No newline at end of file diff --git a/.vale/fixtures/Localization/AdjectivesWithNouns/testvalid.adoc b/.vale/fixtures/Localization/AdjectivesWithNouns/testvalid.adoc new file mode 100644 index 000000000..bce5fb834 --- /dev/null +++ b/.vale/fixtures/Localization/AdjectivesWithNouns/testvalid.adoc @@ -0,0 +1,16 @@ +the following steps +the following functions +the following procedure +the following chapter +the following table +the following image +the following section +the previous steps +the previous functions +the previous procedure +the previous chapter +the previous table +the previous image +the previous section +this function is +those instructions are \ No newline at end of file diff --git a/.vale/fixtures/Localization/CommonlyMisusedWords/.vale.ini b/.vale/fixtures/Localization/CommonlyMisusedWords/.vale.ini new file mode 100644 index 000000000..daa49591f --- /dev/null +++ b/.vale/fixtures/Localization/CommonlyMisusedWords/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `CommonlyMisusedWords` rule +StylesPath = ../../../styles +MinAlertLevel = warning +[*.adoc] +Localization.TermsWarnings = YES diff --git a/.vale/fixtures/Localization/CommonlyMisusedWords/testinvalid.adoc b/.vale/fixtures/Localization/CommonlyMisusedWords/testinvalid.adoc new file mode 100644 index 000000000..9c8596802 --- /dev/null +++ b/.vale/fixtures/Localization/CommonlyMisusedWords/testinvalid.adoc @@ -0,0 +1,10 @@ +The product allows you to +This product allows you to +The product allows +This product allows +The interface allows +The UI allows +The application allows +This feature allows you to + + diff --git a/.vale/fixtures/Localization/CommonlyMisusedWords/testvalid.adoc b/.vale/fixtures/Localization/CommonlyMisusedWords/testvalid.adoc new file mode 100644 index 000000000..5a0c09c8d --- /dev/null +++ b/.vale/fixtures/Localization/CommonlyMisusedWords/testvalid.adoc @@ -0,0 +1,8 @@ +might +enable +abbreviation +can +cannot +Red Hat allows you to +Red Hat allows + diff --git a/.vale/fixtures/Localization/Modals/.vale.ini b/.vale/fixtures/Localization/Modals/.vale.ini new file mode 100644 index 000000000..ea5f042a9 --- /dev/null +++ b/.vale/fixtures/Localization/Modals/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `Modals` rule +StylesPath = ../../../styles +MinAlertLevel = warning +[*.adoc] +Localization.TermsWarnings = YES diff --git a/.vale/fixtures/Localization/Modals/testinvalid.adoc b/.vale/fixtures/Localization/Modals/testinvalid.adoc new file mode 100644 index 000000000..a5f9ab836 --- /dev/null +++ b/.vale/fixtures/Localization/Modals/testinvalid.adoc @@ -0,0 +1,8 @@ +should +could +would +will +supposed to +ought to be +may +shall diff --git a/.vale/fixtures/Localization/Modals/testvalid.adoc b/.vale/fixtures/Localization/Modals/testvalid.adoc new file mode 100644 index 000000000..276ba6281 --- /dev/null +++ b/.vale/fixtures/Localization/Modals/testvalid.adoc @@ -0,0 +1,5 @@ +might +can +cannot +must + diff --git a/.vale/fixtures/Localization/PhrasalVerbs/.vale.ini b/.vale/fixtures/Localization/PhrasalVerbs/.vale.ini new file mode 100644 index 000000000..b8567c2e5 --- /dev/null +++ b/.vale/fixtures/Localization/PhrasalVerbs/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `PhrasalVerbs` rule +StylesPath = ../../../styles +MinAlertLevel = warning +[*.adoc] +Localization.TermsWarnings = YES diff --git a/.vale/fixtures/Localization/PhrasalVerbs/testinvalid.adoc b/.vale/fixtures/Localization/PhrasalVerbs/testinvalid.adoc new file mode 100644 index 000000000..ec465e40b --- /dev/null +++ b/.vale/fixtures/Localization/PhrasalVerbs/testinvalid.adoc @@ -0,0 +1,17 @@ +carry out +allow for +carry on +count on +end up +get at +click on +call up +find out +print out +start up +switch on +tap on +fill in +fill out +picks up +gives up \ No newline at end of file diff --git a/.vale/fixtures/Localization/PhrasalVerbs/testvalid.adoc b/.vale/fixtures/Localization/PhrasalVerbs/testvalid.adoc new file mode 100644 index 000000000..549112a10 --- /dev/null +++ b/.vale/fixtures/Localization/PhrasalVerbs/testvalid.adoc @@ -0,0 +1,8 @@ +do +allow +enable +continue +depend +result +imply +click diff --git a/.vale/fixtures/Localization/WordswithMultipleMeanings/.vale.ini b/.vale/fixtures/Localization/WordswithMultipleMeanings/.vale.ini new file mode 100644 index 000000000..070abe10b --- /dev/null +++ b/.vale/fixtures/Localization/WordswithMultipleMeanings/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `WordswithMultipleMeanings` rule +StylesPath = ../../../styles +MinAlertLevel = warning +[*.adoc] +Localization.TermsWarnings = YES diff --git a/.vale/fixtures/Localization/WordswithMultipleMeanings/testinvalid.adoc b/.vale/fixtures/Localization/WordswithMultipleMeanings/testinvalid.adoc new file mode 100644 index 000000000..e5ba83fb0 --- /dev/null +++ b/.vale/fixtures/Localization/WordswithMultipleMeanings/testinvalid.adoc @@ -0,0 +1,5 @@ +as +at once +once +while +since diff --git a/.vale/fixtures/Localization/WordswithMultipleMeanings/testvalid.adoc b/.vale/fixtures/Localization/WordswithMultipleMeanings/testvalid.adoc new file mode 100644 index 000000000..a46092314 --- /dev/null +++ b/.vale/fixtures/Localization/WordswithMultipleMeanings/testvalid.adoc @@ -0,0 +1,9 @@ +after +one time +because +during +at the same time +as soon as +as much as +as long as + diff --git a/.vale/fixtures/RedHat/SelfReferentialText/testinvalid.adoc b/.vale/fixtures/RedHat/SelfReferentialText/testinvalid.adoc index 35ee939f7..d86cfd489 100644 --- a/.vale/fixtures/RedHat/SelfReferentialText/testinvalid.adoc +++ b/.vale/fixtures/RedHat/SelfReferentialText/testinvalid.adoc @@ -9,3 +9,12 @@ 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. +The following module describes something. +The previous module describes something. +This is a module. +These are modules. +Those are modules. +Theirs module. +Hers module. +His module. + diff --git a/.vale/styles/Localization/AdjectivesWithNouns.yml b/.vale/styles/Localization/AdjectivesWithNouns.yml new file mode 100644 index 000000000..ffd7997d1 --- /dev/null +++ b/.vale/styles/Localization/AdjectivesWithNouns.yml @@ -0,0 +1,11 @@ +--- +extends: sequence +message: "Do not use adjectives without a noun following them. For example, use 'Complete the following steps' instead of 'Complete the following'." +link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/using/ +level: warning +action: + name: edit +tokens: + - the following + - the previous + diff --git a/.vale/styles/Localization/CommonlyMisusedWords.yml b/.vale/styles/Localization/CommonlyMisusedWords.yml new file mode 100644 index 000000000..2bf73b82e --- /dev/null +++ b/.vale/styles/Localization/CommonlyMisusedWords.yml @@ -0,0 +1,17 @@ +--- +extends: existence +ignorecase: true +level: suggestion +link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/termswarnings/ +message: 'Only use allow if you are talking about permission. For ability, use enable.' +# source: https://github.com/redhat-documentation/vale-at-red-hat/issues/515 +tokens: + - The product allows you to + - This product allows you to + - The product allows + - This product allows + - The interface allows + - The UI allows + - The application allows + - This feature allows you to + diff --git a/.vale/styles/Localization/Modals.yml b/.vale/styles/Localization/Modals.yml new file mode 100644 index 000000000..dbc417c39 --- /dev/null +++ b/.vale/styles/Localization/Modals.yml @@ -0,0 +1,15 @@ +--- +extends: existence +ignorecase: true +level: warning +link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/termswarnings/ +message: "Avoid using modals like 'should', 'may', or 'will' because they can introduce uncertainty." +# source: https://github.com/redhat-documentation/vale-at-red-hat/issues/515 +tokens: + - should + - could + - would + - will + - supposed to be + - ought to be + diff --git a/.vale/styles/Localization/PhrasalVerbs.yml b/.vale/styles/Localization/PhrasalVerbs.yml new file mode 100644 index 000000000..211e9a7e4 --- /dev/null +++ b/.vale/styles/Localization/PhrasalVerbs.yml @@ -0,0 +1,25 @@ +--- +extends: substitution +ignorecase: true +level: warning +link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/termswarnings/ +message: "Avoid using phrasal verbs. Consider using '%s' rather than '%s'." +scope: sentence +action: + name: replace +swap: + # Start each error message with "Do not use ..." + # Error messages must be single quoted. +carry out: do +allow for: allow|enable +carry on: continue +count on: depend +end up: result +get at: imply +click on: click +find out: find +print out: print +start up | switch on: start +tap on: tap +picks up: takes +fill in: complete \ No newline at end of file diff --git a/.vale/styles/Localization/WordswithMultipleMeanings.yml b/.vale/styles/Localization/WordswithMultipleMeanings.yml new file mode 100644 index 000000000..9abb06aca --- /dev/null +++ b/.vale/styles/Localization/WordswithMultipleMeanings.yml @@ -0,0 +1,14 @@ +--- +extends: existence +ignorecase: true +level: warning +link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/termswarnings/ +message: "Avoid words that have multiple meanings. For example, instead of words like "as" or "since" which have multiple meanings, use "because"." +# source: https://github.com/redhat-documentation/vale-at-red-hat/issues/515 +tokens: + - as + - at once + - once + - while + - since +