OpenShiftAsciiDoc - no alphanumeric charaters in headings #987
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| ; Vale configuration file to test the `HardWrappedLines` rule | ||
| StylesPath = ../../../styles | ||
| MinAlertLevel = error | ||
| [*.adoc] | ||
| OpenShiftAsciiDoc.HeadingsAlphanumeric = YES |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| //vale-fixture | ||
| = Don't Use: Special Characters in Headings | ||
|
|
||
| //vale-fixture | ||
| == No @Symbols! Here | ||
|
|
||
| //vale-fixture | ||
| == No periods. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -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\\{\\}'`-].*$" | ||||||
|
Member
There was a problem hiding this comment.
Suggested change
Collaborator
Author
There was a problem hiding this comment. Scrapped this version and moving to a tengo script. It was flagging on admonition blocks
Collaborator
Author
There was a problem hiding this comment. btw, I recall that whatever flavour of regex Value uses required double escapes to work |
||||||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes but Something like this is valid and gets caught too:
== Installing the .NET plugin
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah... bit of a clash there I guess. Maybe need an exclusion list. Apparently periods in headings break something in PV1.