feat: Add minimal Vale configuration, existing package files #220
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,8 @@ | ||||||||||||
| StylesPath = styles | ||||||||||||
| MinAlertLevel = suggestion | ||||||||||||
|
|
||||||||||||
| Packages = Microsoft, Hugo | ||||||||||||
|
|
||||||||||||
| [*.{md}] | ||||||||||||
|
|
||||||||||||
| BasedOnStyles = Vale, Microsoft, NGINX | ||||||||||||
|
There was a problem hiding this comment. I see you've included NGINX Acronyms.yml Partially as a test, I set this up to avoid the rules associated with https://github.com/errata-ai/Microsoft/blob/master/Microsoft/Acronyms.yml
Suggested change
With this modification, I avoided this error message: There was a problem hiding this comment. I don't see the value in re-documenting how Vale works. I am going through active testing and adjustment of the rules: this PR is in a draft state while I do so, and as such, I am not accepting edit suggestions. There was a problem hiding this comment. I'm suggesting that we follow good coding practice. IOW, add comments that explain what's happening with the code.
Now you know what I'm looking for once you're ready to take this PR out of draft state. And even more, with this comment, I can remember what I think is needed when this PR is ready for review. |
||||||||||||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| extends: conditional | ||
| message: "'%s' has no definition." | ||
| level: suggestion | ||
| ignorecase: false | ||
| # Ensures that the existence of 'first' implies the existence of 'second'. | ||
| first: '\b([A-Z]{3,5})\b' | ||
| second: '(?:\b[A-Z][a-z]+ )+\(([A-Z]{3,5})\)' | ||
| # ... with the exception of these: | ||
| exceptions: | ||
| - API | ||
| - ASP | ||
| - CLI | ||
| - CPU | ||
| - CSS | ||
| - CSV | ||
| - DEBUG | ||
| - DELETE | ||
| - DOM | ||
| - DPI | ||
| - F5 | ||
| - FAQ | ||
| - GCC | ||
| - GDB | ||
| - GET | ||
| - GPU | ||
| - GTK | ||
| - GUI | ||
| - HTML | ||
| - HTTP | ||
| - HTTPS | ||
| - IDE | ||
| - IETF | ||
| - JAR | ||
| - JSON | ||
| - JSX | ||
| - LESS | ||
| - LLDB | ||
| - NET | ||
| - NOTE | ||
| - NVDA | ||
| - NGINX | ||
| - OSS | ||
| - PATH | ||
| - PATCH | ||
| - PHP | ||
| - POST | ||
| - PUT | ||
| - RAM | ||
| - REPL | ||
| - REST | ||
| - RSA | ||
| - SCM | ||
| - SCSS | ||
| - SDK | ||
| - SQL | ||
| - SSH | ||
| - SSL | ||
| - SVG | ||
| - TBD | ||
| - TCP | ||
| - TODO | ||
| - TMOS | ||
| - URI | ||
| - URL | ||
| - USB | ||
| - UTF | ||
| - VLAN | ||
| - VPN | ||
| - XML | ||
| - XSS | ||
| - YAML | ||
| - ZIP |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| extends: existence | ||
| message: "The word %s' is anthropomorphic. If possible, use a different word if you're referring to a product." | ||
| ignorecase: true | ||
| #code: false | ||
| level: error | ||
| tokens: | ||
| - decides | ||
| - knows | ||
| - listens | ||
| - hears | ||
| - sees | ||
| - walks |
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.
I want it clear that this is a PoC for now....
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.
Does the PR being in a draft state not create sufficient enough barrier to entry?
Someone would have to check out the branch to attempt to use it.
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.
I guess I don't understand your approach to this PR / change. Once it's taken out of draft, reviewed, and merged, I'm thinking this will be a PoC for a while -- until we're able to test this on a number of NGINX docs.
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.
I don't intend to swap this to a review state until it's been tested across multiple documentation sets, and even then, it's an optional artifact for people to interact with until it's enforced as a requirement by both consensus and CI tooling.