diff --git a/.vale/fixtures/OpenShiftAsciiDoc/HeadingsAlphanumeric/.vale.ini b/.vale/fixtures/OpenShiftAsciiDoc/HeadingsAlphanumeric/.vale.ini new file mode 100644 index 000000000..72176ec71 --- /dev/null +++ b/.vale/fixtures/OpenShiftAsciiDoc/HeadingsAlphanumeric/.vale.ini @@ -0,0 +1,5 @@ +; Vale configuration file to test the `HardWrappedLines` rule +StylesPath = ../../../styles +MinAlertLevel = error +[*.adoc] +OpenShiftAsciiDoc.HeadingsAlphanumeric = YES diff --git a/.vale/fixtures/OpenShiftAsciiDoc/HeadingsAlphanumeric/testinvalid.adoc b/.vale/fixtures/OpenShiftAsciiDoc/HeadingsAlphanumeric/testinvalid.adoc new file mode 100644 index 000000000..56f28667e --- /dev/null +++ b/.vale/fixtures/OpenShiftAsciiDoc/HeadingsAlphanumeric/testinvalid.adoc @@ -0,0 +1,8 @@ +//vale-fixture += Don't Use: Special Characters in Headings + +//vale-fixture +== No @Symbols! Here + +//vale-fixture +== No periods. diff --git a/.vale/fixtures/OpenShiftAsciiDoc/HeadingsAlphanumeric/testvalid.adoc b/.vale/fixtures/OpenShiftAsciiDoc/HeadingsAlphanumeric/testvalid.adoc new file mode 100644 index 000000000..20130a4ee --- /dev/null +++ b/.vale/fixtures/OpenShiftAsciiDoc/HeadingsAlphanumeric/testvalid.adoc @@ -0,0 +1,9 @@ +//vale-fixture += Valid Headings with Alphanumeric Characters Only + +//vale-fixture +== Exceptions include attribute references like {product-name} + +== Also allow single quotes even though we don't like them + +== And `backticks` are allowed too even though I cannot remember if we allow them in the style guide \ No newline at end of file diff --git a/.vale/styles/OpenShiftAsciiDoc/HeadingsAlphanumeric.yml b/.vale/styles/OpenShiftAsciiDoc/HeadingsAlphanumeric.yml new file mode 100644 index 000000000..f6416573e --- /dev/null +++ b/.vale/styles/OpenShiftAsciiDoc/HeadingsAlphanumeric.yml @@ -0,0 +1,9 @@ +--- +extends: existence +scope: raw +level: error +link: https://github.com/openshift/openshift-docs/blob/main/contributing_to_docs/doc_guidelines.adoc#anchoring-in-module-files +message: "Headings should only contain alphanumeric characters." +nonword: true +tokens: + - "^=+\\s+.*[^a-zA-Z0-9\\s\\{\\}'`-].*$" \ No newline at end of file