Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .vale.ini
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ MinAlertLevel = suggestion
BasedOnStyles = Netwrix

[docs/kb/**/*.md]
BasedOnStyles =
BasedOnStyles = NetwrixKB
32 changes: 32 additions & 0 deletions .vale/styles/NetwrixKB/Contractions.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
extends: existence
message: "Write '%s' out in full for KB articles (e.g., 'do not', 'cannot', 'you will')."
level: warning
ignorecase: true
tokens:
- "don't"
- "doesn't"
- "didn't"
- "can't"
- "wouldn't"
- "shouldn't"
- "couldn't"
- "isn't"
- "aren't"
- "wasn't"
- "weren't"
- "hasn't"
- "haven't"
- "hadn't"
- "you'll"
- "it's"
- "there's"
- "that's"
- "won't"
- "we're"
- "they're"
- "you're"
- "he's"
- "she's"
- "we've"
- "they've"
- "you've"
10 changes: 10 additions & 0 deletions .vale/styles/NetwrixKB/FirstPersonPlural.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
extends: existence
message: "Avoid first person plural '%s'. Rewrite without 'we', 'our', 'us', or 'ours'."
level: warning
ignorecase: true
nonword: true
tokens:
- '\bwe\b'
- '\bour\b'
- '\bours\b'
- '\bus\b'
6 changes: 6 additions & 0 deletions .vale/styles/NetwrixKB/HeadingCase.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
extends: capitalization
message: "Use title case for KB article headings."
level: warning
match: $title
style: Chicago
scope: heading
18 changes: 18 additions & 0 deletions .vale/styles/NetwrixKB/ImpersonalFiller.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
extends: existence
message: "Remove '%s' and state the point directly."
level: warning
ignorecase: true
nonword: true
tokens:
- '\bit should be noted that\b'
- '\bit is important to note that\b'
- '\bit is important to ensure that\b'
- '\bit is important to\b'
- '\bit is recommended that\b'
- '\bit is necessary to\b'
- '\bit is possible to\b'
- '\bit is worth noting that\b'
- '\bit must be noted that\b'
- '\bas mentioned previously\b'
- '\bas previously mentioned\b'
- '\bneedless to say\b'
7 changes: 7 additions & 0 deletions .vale/styles/NetwrixKB/NoteThat.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
extends: existence
message: "Avoid '%s'. Use a blockquote callout instead: '> **NOTE:** ...' or '> **IMPORTANT:** ...'"
level: warning
ignorecase: true
tokens:
- '\bnote that\b'
- '\bplease note\b'
7 changes: 7 additions & 0 deletions .vale/styles/NetwrixKB/Please.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
extends: existence
message: "Avoid 'please' in instructions. Be direct."
level: warning
ignorecase: true
nonword: true
tokens:
- '\bplease(?!\s+note)\b'
13 changes: 13 additions & 0 deletions .vale/styles/NetwrixKB/Utilize.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
extends: substitution
message: "Use '%s' — avoid 'utilize' and its variants."
level: warning
ignorecase: true
swap:
'\butilizes\b': 'uses'
'\butilized\b': 'used'
'\butilizing\b': 'using'
'\butilize\b': 'use'
'\butilises\b': 'uses'
'\butilised\b': 'used'
'\butilising\b': 'using'
'\butilise\b': 'use'
10 changes: 10 additions & 0 deletions .vale/styles/NetwrixKB/WeakLinkText.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
extends: existence
message: "Avoid generic link text '%s'. Write descriptive link text that describes the destination or action."
level: warning
ignorecase: true
tokens:
- '\bclick here\b'
- '\bthis link\b'
- '\blearn more\b'
- '\bsee more\b'
- '\bread more\b'
Loading