diff --git a/.vale.ini b/.vale.ini new file mode 100644 index 00000000000..e7dc8d6ea7d --- /dev/null +++ b/.vale.ini @@ -0,0 +1,13 @@ +StylesPath = vale/styles +MinAlertLevel = suggestion +Vocab = Blog + + +[*.{md,rst}] + + +BasedOnStyles = Vale, RTD + + +Vale.Spelling = YES +Vale.Repetition = YES diff --git a/Swap.yml b/Swap.yml new file mode 100644 index 00000000000..68efb503d95 --- /dev/null +++ b/Swap.yml @@ -0,0 +1,6 @@ +extends: substitution +message: Use '%s' instead of '%s' +level: error +swap: + Read The Docs: Read the Docs + RTD: Read the Docs diff --git a/vale-linter.yml b/vale-linter.yml new file mode 100644 index 00000000000..25799d3ff6f --- /dev/null +++ b/vale-linter.yml @@ -0,0 +1,26 @@ +# Configuration of the Vale Linter ProBot tool + +Vale: + + # If this feature is enabled or disabled + Enabled: true + #Remove comment if needed to enable the bot. + #Enabled: false + + Paths: + # Path to the vale configuration file + Configuration: ".vale.ini" + + # Path to the folder of Vale docstyles to use/copy + # NOTE: If you update the styles path in _vale.ini remember to update this path too + Styles: "vale/styles/" + + Success: + Header: "PASSED" + Message: "The Vale Docs linter did not find any issues." + + + Error: + Header: "FAILED" + Message: "Try again" +