add vale-linter +markdownlint

.github/workflows/vale-check.yml

@@ -0,0 +1,33 @@
+name: Vale Linter Check
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  vale-quality-check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Vale
+        run: |
+          wget https://github.com/errata-ai/vale/releases/download/v3.9.0/vale_3.9.0_Linux_64-bit.tar.gz
+          tar -xvzf vale_3.9.0_Linux_64-bit.tar.gz
+          sudo mv vale /usr/local/bin/
+
+      - name: Run Vale Smoke Test
+        run: |
+          cd docs-linter
+          vale sync
+          vale smoke-test.md --no-exit
+
+      - name: Install Markdownlint
+        run: sudo npm install -g markdownlint-cli
+
+      - name: Run Markdownlint (Format Check)
+        run: |
+          cd docs-linter
+          markdownlint --config .markdownlint.json smoke-test.md || true

docs-linter/.markdownlint.json

@@ -0,0 +1,8 @@
+{
+  "default": true,
+  "MD013": false,
+  "MD024": false,
+  "MD033": false,
+  "MD034": false,
+  "MD041": false
+}

docs-linter/.vale.ini

@@ -0,0 +1,26 @@
+StylesPath = styles
+MinAlertLevel = suggestion
+Vocab = terms
+Packages = Microsoft
+
+[*.{md,mdx}]
+BasedOnStyles = Vale, Microsoft, custom-rules
+TokenIgnores = (https?://[^\s\)]+), (`.+?`), (\*\*.+?\*\*)
+BlockIgnores = (?s)(^---\n.*?\n---)
+
+# Disable noisy Microsoft rules
+Microsoft.Accessibility = NO
+Microsoft.Gender = NO
+Microsoft.GenderBias = NO
+Microsoft.Vocab = NO
+Microsoft.Acronyms = NO
+Microsoft.Foreign = NO
+Microsoft.Avoid = NO
+Microsoft.Terms = NO
+Microsoft.Passive = NO
+Microsoft.HeadingAcronyms = NO
+Microsoft.GeneralURL = NO
+Microsoft.SentenceLength = NO
+Microsoft.Adverbs = NO
+Microsoft.We = NO
+Microsoft.FirstPerson = NO

docs-linter/smoke-test.md

@@ -0,0 +1,16 @@
+# Smoke Test File
+
+This is a paragraph with trailing spaces at the end.
+(That line has spaces, triggering MD009).
+
+# A Second H1 Header (Violation: MD025)
+
+#### Skipped Header Level (Violation: MD001 - H1 to H4)
+
+Here is a list of Vale violations:
+
+1. **Branding:** We use netfoundry and github in our daily work.
+2. **Passive Voice:** The file was opened by the admin.
+3. **Wordiness:** In order to login, you must utilize the key.
+4. **First Person:** I decided to push the code myself.
+5. **Spelling:** This is a testtoken for moret esting.

docs-linter/styles/Microsoft/Auto.yml

@@ -0,0 +1,11 @@
+extends: existence
+message: "In general, don't hyphenate '%s'."
+link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/a/auto
+ignorecase: true
+level: error
+action:
+  name: convert
+  params:
+    - simple
+tokens:
+  - 'auto-\w+'

docs-linter/styles/Microsoft/ComplexWords.yml

@@ -0,0 +1,14 @@
+extends: substitution
+message: "Consider using '%s' instead of '%s'"
+level: warning
+ignorecase: true
+# This rule swaps complex words for simpler ones (e.g. utilize -> use)
+swap:
+  utilize: use
+  utilization: use
+  facilitate: help
+  leverage: use
+  commence: start
+  terminate: end
+  subsequently: later
+

docs-linter/styles/Microsoft/Contractions.yml

@@ -0,0 +1,50 @@
+extends: substitution
+message: "Use '%s' instead of '%s'."
+link: https://docs.microsoft.com/en-us/style-guide/word-choice/use-contractions
+level: error
+ignorecase: true
+action:
+  name: replace
+swap:
+  are not: aren't
+  cannot: can't
+  could not: couldn't
+  did not: didn't
+  do not: don't
+  does not: doesn't
+  has not: hasn't
+  have not: haven't
+  how is: how's
+  is not: isn't
+
+  'it is(?!\.)': it's
+  'it''s(?=\.)': it is
+
+  should not: shouldn't
+
+  "that is(?![.,])": that's
+  'that''s(?=\.)': that is
+
+  'they are(?!\.)': they're
+  'they''re(?=\.)': they are
+
+  was not: wasn't
+
+  'we are(?!\.)': we're
+  'we''re(?=\.)': we are
+
+  'we have(?!\.)': we've
+  'we''ve(?=\.)': we have
+
+  were not: weren't
+
+  'what is(?!\.)': what's
+  'what''s(?=\.)': what is
+
+  'when is(?!\.)': when's
+  'when''s(?=\.)': when is
+
+  'where is(?!\.)': where's
+  'where''s(?=\.)': where is
+
+  will not: won't

docs-linter/styles/Microsoft/Dashes.yml

@@ -0,0 +1,13 @@
+extends: existence
+message: "Remove the spaces around '%s'."
+link: https://docs.microsoft.com/en-us/style-guide/punctuation/dashes-hyphens/emes
+ignorecase: true
+nonword: true
+level: error
+action:
+  name: edit
+  params:
+    - trim
+    - " "
+tokens:
+  - '\s[—–]\s|\s[—–]|[—–]\s'

docs-linter/styles/Microsoft/DateFormat.yml

@@ -0,0 +1,8 @@
+extends: existence
+message: Use 'July 31, 2016' format, not '%s'.
+link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/date-time-terms
+ignorecase: true
+level: error
+nonword: true
+tokens:
+  - '\d{1,2} (?:Jan(?:uary)?|Feb(?:ruary)?|Mar(?:ch)?|Apr(?:il)|May|Jun(?:e)|Jul(?:y)|Aug(?:ust)|Sep(?:tember)?|Oct(?:ober)|Nov(?:ember)?|Dec(?:ember)?) \d{4}'

docs-linter/styles/Microsoft/DateNumbers.yml

@@ -0,0 +1,40 @@
+extends: existence
+message: "Don't use ordinal numbers for dates."
+link: https://docs.microsoft.com/en-us/style-guide/numbers#numbers-in-dates
+level: error
+nonword: true
+ignorecase: true
+raw:
+  - \b(?:Jan(?:uary)?|Feb(?:ruary)?|Mar(?:ch)?|Apr(?:il)|May|Jun(?:e)|Jul(?:y)|Aug(?:ust)|Sep(?:tember)?|Oct(?:ober)|Nov(?:ember)?|Dec(?:ember)?)\b\s*
+tokens:
+  - first
+  - second
+  - third
+  - fourth
+  - fifth
+  - sixth
+  - seventh
+  - eighth
+  - ninth
+  - tenth
+  - eleventh
+  - twelfth
+  - thirteenth
+  - fourteenth
+  - fifteenth
+  - sixteenth
+  - seventeenth
+  - eighteenth
+  - nineteenth
+  - twentieth
+  - twenty-first
+  - twenty-second
+  - twenty-third
+  - twenty-fourth
+  - twenty-fifth
+  - twenty-sixth
+  - twenty-seventh
+  - twenty-eighth
+  - twenty-ninth
+  - thirtieth
+  - thirty-first

docs-linter/styles/Microsoft/DateOrder.yml

@@ -0,0 +1,8 @@
+extends: existence
+message: "Always spell out the name of the month."
+link: https://docs.microsoft.com/en-us/style-guide/numbers#numbers-in-dates
+ignorecase: true
+level: error
+nonword: true
+tokens:
+  - '\b\d{1,2}/\d{1,2}/(?:\d{4}|\d{2})\b'

docs-linter/styles/Microsoft/Ellipses.yml

@@ -0,0 +1,9 @@
+extends: existence
+message: "In general, don't use an ellipsis."
+link: https://docs.microsoft.com/en-us/style-guide/punctuation/ellipses
+nonword: true
+level: warning
+action:
+  name: remove
+tokens:
+  - '\.\.\.'

docs-linter/styles/Microsoft/FirstPerson.yml

@@ -0,0 +1,16 @@
+extends: existence
+message: "Use first person (such as '%s') sparingly."
+link: https://docs.microsoft.com/en-us/style-guide/grammar/person
+ignorecase: true
+level: warning
+nonword: true
+tokens:
+  - (?:^|\s)I(?=\s)
+  - (?:^|\s)I(?=,\s)
+  - \bI'd\b
+  - \bI'll\b
+  - \bI'm\b
+  - \bI've\b
+  - \bme\b
+  - \bmy\b
+  - \bmine\b

docs-linter/styles/Microsoft/Gender.yml

@@ -0,0 +1,8 @@
+extends: existence
+message: "Don't use '%s'."
+link: https://github.com/MicrosoftDocs/microsoft-style-guide/blob/master/styleguide/grammar/nouns-pronouns.md#pronouns-and-gender
+level: error
+ignorecase: true
+tokens:
+  - he/she
+  - s/he

docs-linter/styles/Microsoft/HeadingColons.yml

@@ -0,0 +1,8 @@
+extends: existence
+message: "Capitalize '%s'."
+link: https://docs.microsoft.com/en-us/style-guide/punctuation/colons
+nonword: true
+level: error
+scope: heading
+tokens:
+  - ':\s[a-z]'

docs-linter/styles/Microsoft/HeadingPunctuation.yml

@@ -0,0 +1,13 @@
+extends: existence
+message: "Don't use end punctuation in headings."
+link: https://docs.microsoft.com/en-us/style-guide/punctuation/periods
+nonword: true
+level: warning
+scope: heading
+action:
+  name: edit
+  params:
+    - trim_right
+    - ".?!"
+tokens:
+  - "[a-z][.?!]$"

docs-linter/styles/Microsoft/Headings.yml

@@ -0,0 +1,28 @@
+extends: capitalization
+message: "'%s' should use sentence-style capitalization."
+link: https://docs.microsoft.com/en-us/style-guide/capitalization
+level: suggestion
+scope: heading
+match: $sentence
+indicators:
+  - ':'
+exceptions:
+  - Azure
+  - CLI
+  - Code
+  - Cosmos
+  - Docker
+  - Emmet
+  - I
+  - Kubernetes
+  - Linux
+  - macOS
+  - Marketplace
+  - MongoDB
+  - REPL
+  - Studio
+  - TypeScript
+  - URLs
+  - Visual
+  - VS
+  - Windows

docs-linter/styles/Microsoft/Hyphens.yml

@@ -0,0 +1,14 @@
+extends: existence
+message: "'%s' doesn't need a hyphen."
+link: https://docs.microsoft.com/en-us/style-guide/punctuation/dashes-hyphens/hyphens
+level: warning
+ignorecase: false
+nonword: true
+action:
+  name: edit
+  params:
+    - regex
+    - "-"
+    - " "
+tokens:
+  - '\b[^\s-]+ly-\w+\b'

docs-linter/styles/Microsoft/Negative.yml

@@ -0,0 +1,13 @@
+extends: existence
+message: "Form a negative number with an en dash, not a hyphen."
+link: https://docs.microsoft.com/en-us/style-guide/numbers
+nonword: true
+level: error
+action:
+  name: edit
+  params:
+    - regex
+    - "-"
+    - "–"
+tokens:
+  - '(?<=\s)-\d+(?:\.\d+)?\b'

docs-linter/styles/Microsoft/Ordinal.yml

@@ -0,0 +1,13 @@
+extends: existence
+message: "Don't add -ly to an ordinal number."
+link: https://docs.microsoft.com/en-us/style-guide/numbers
+level: error
+action:
+  name: edit
+  params:
+    - trim
+    - ly
+tokens:
+  - firstly
+  - secondly
+  - thirdly

docs-linter/styles/Microsoft/OxfordComma.yml

@@ -0,0 +1,8 @@
+extends: existence
+message: "Use the Oxford comma in '%s'."
+link: https://docs.microsoft.com/en-us/style-guide/punctuation/commas
+scope: sentence
+level: suggestion
+nonword: true
+tokens:
+  - '(?:[^\s,]+,){1,} \w+ (?:and|or) \w+[.?!]'

docs-linter/styles/Microsoft/Percentages.yml

@@ -0,0 +1,7 @@
+extends: existence
+message: "Use a numeral plus the units."
+link: https://docs.microsoft.com/en-us/style-guide/numbers
+nonword: true
+level: error
+tokens:
+  - '\b[a-zA-z]+\spercent\b'

docs-linter/styles/Microsoft/Plurals.yml

@@ -0,0 +1,7 @@
+extends: existence
+message: "Don't add '%s' to a singular noun. Use plural instead."
+ignorecase: true
+level: error
+link: https://learn.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/s/s-es
+raw:
+  - '\(s\)|\(es\)'