Skip to content

Commit 516c92b

Browse files
tashiantashian
committed
Merge branch 'main' into josh/fleet-integration
2 parents 4aa586f + 63979d5 commit 516c92b

144 files changed

Lines changed: 4258 additions & 1496 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/mdl.config.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@
4040
"pattern": "^https://www.gnu.org"
4141
},
4242
{
43-
"pattern": "^https://freedesktop.org"
43+
"pattern": "^https://.*freedesktop.org"
4444
},
4545
{
4646
"pattern": "^https://www.hashicorp.com"

‎.github/workflows/link-check.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ jobs:
2727
- name: Check changed files only (PR)
2828
if: github.event_name == 'pull_request'
2929
run: |
30-
CHANGED_FILES=$(git diff --name-only origin/${{ github.base_ref }}...HEAD -- '*.mdx')
30+
CHANGED_FILES=$(git diff --name-only --diff-filter=ACMR origin/${{ github.base_ref }}...HEAD -- '*.mdx')
3131
if [ -z "$CHANGED_FILES" ]; then
3232
echo "No .mdx files changed"
3333
exit 0

‎.github/workflows/vale.yml‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: Vale Prose Lint
2+
3+
on:
4+
push:
5+
branches: [main]
6+
paths:
7+
- '**.mdx'
8+
- '**.md'
9+
- '.vale.ini'
10+
- '.vale/**'
11+
pull_request:
12+
paths:
13+
- '**.mdx'
14+
- '**.md'
15+
- '.vale.ini'
16+
- '.vale/**'
17+
18+
jobs:
19+
prose:
20+
name: Lint Prose
21+
runs-on: ubuntu-latest
22+
steps:
23+
- name: Checkout
24+
uses: actions/checkout@v4
25+
26+
- name: Vale Lint
27+
uses: errata-ai/vale-action@v2
28+
with:
29+
files: .
30+
fail_on_error: true
31+
reporter: github-pr-review
32+
vale_flags: "--glob='!step-cli/reference/**'"
33+
env:
34+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

‎.vale.ini‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
StylesPath = .vale/styles
2+
MinAlertLevel = warning
3+
4+
Packages = Google, write-good
5+
6+
Vocab = Smallstep
7+
8+
SkippedScopes = script, style, pre, figure, code
9+
IgnoredScopes = code, tt, img, url, a
10+
11+
[*.{md,mdx}]
12+
BasedOnStyles = Vale, Google, write-good, Smallstep
13+
14+
# Disable Vale.Terms - conflicts with case-variant vocabulary entries
15+
Vale.Terms = NO
16+
17+
# Disable Google.Quotes - technical docs often place punctuation outside quotes for clarity
18+
Google.Quotes = NO
19+
20+
# Disable rules that are too strict for technical documentation
21+
write-good.Passive = NO
22+
Google.Will = NO
23+
Google.We = NO
24+
25+
# Disable overly aggressive write-good rules
26+
# TooWordy flags common tech terms like "implement", "multiple", "additional", "obtain"
27+
write-good.TooWordy = NO
28+
# Weasel flags words like "usually", "various" which are often appropriate in docs
29+
write-good.Weasel = NO
30+
31+
# Units rule requires spaces in durations like "168h" which doesn't match Go conventions
32+
Google.Units = NO
33+
34+
# WordList substitutions like CLI→"command-line tool" and "application"→"app" don't fit tech docs
35+
Google.WordList = NO
36+
37+
# FirstPerson rule doesn't fit docs with user-perspective examples ("I want to...", "My device...")
38+
Google.FirstPerson = NO
39+
40+
# Exclamation points are sometimes appropriate for friendly/community content
41+
Google.Exclamation = NO
42+
43+
# Slang like "TL;DR" is acceptable in developer-focused technical documentation
44+
Google.Slang = NO
45+
46+
# "There is/There are" constructions are acceptable in technical documentation
47+
write-good.ThereIs = NO
48+
49+
# DateFormat matches version numbers like "10.0.15063" incorrectly
50+
Google.DateFormat = NO
51+
52+
53+
TokenIgnores = (@smallstep/[a-zA-Z0-9-]+), \
54+
(_[a-zA-Z0-9_]+_), \
55+
([a-zA-Z]+_[a-zA-Z_]+)
56+
57+
BlockIgnores = (?s)<Alert.*?</Alert>, \
58+
(?s)<CodeBlock.*?</CodeBlock>, \
59+
(?s)<Code>.*?</Code>, \
60+
(?s)^---\n.*?\n---
61+

‎.vale/styles/Google/AMPM.yml‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
extends: existence
2+
message: "Use 'AM' or 'PM' (preceded by a space)."
3+
link: "https://developers.google.com/style/word-list"
4+
level: error
5+
nonword: true
6+
tokens:
7+
- '\d{1,2}[AP]M\b'
8+
- '\d{1,2} ?[ap]m\b'
9+
- '\d{1,2} ?[aApP]\.[mM]\.'

‎.vale/styles/Google/Acronyms.yml‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
extends: conditional
2+
message: "Spell out '%s', if it's unfamiliar to the audience."
3+
link: 'https://developers.google.com/style/abbreviations'
4+
level: suggestion
5+
ignorecase: false
6+
# Ensures that the existence of 'first' implies the existence of 'second'.
7+
first: '\b([A-Z]{3,5})\b'
8+
second: '(?:\b[A-Z][a-z]+ )+\(([A-Z]{3,5})\)'
9+
# ... with the exception of these:
10+
exceptions:
11+
- API
12+
- ASP
13+
- CLI
14+
- CPU
15+
- CSS
16+
- CSV
17+
- DEBUG
18+
- DOM
19+
- DPI
20+
- FAQ
21+
- GCC
22+
- GDB
23+
- GET
24+
- GPU
25+
- GTK
26+
- GUI
27+
- HTML
28+
- HTTP
29+
- HTTPS
30+
- IDE
31+
- JAR
32+
- JSON
33+
- JSX
34+
- LESS
35+
- LLDB
36+
- NET
37+
- NOTE
38+
- NVDA
39+
- OSS
40+
- PATH
41+
- PDF
42+
- PHP
43+
- POST
44+
- RAM
45+
- REPL
46+
- RSA
47+
- SCM
48+
- SCSS
49+
- SDK
50+
- SQL
51+
- SSH
52+
- SSL
53+
- SVG
54+
- TBD
55+
- TCP
56+
- TODO
57+
- URI
58+
- URL
59+
- USB
60+
- UTF
61+
- XML
62+
- XSS
63+
- YAML
64+
- ZIP

‎.vale/styles/Google/Colons.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
extends: existence
2+
message: "'%s' should be in lowercase."
3+
link: 'https://developers.google.com/style/colons'
4+
nonword: true
5+
level: warning
6+
scope: sentence
7+
tokens:
8+
- '(?<!:[^ ]+?):\s[A-Z]'

‎.vale/styles/Google/Contractions.yml‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
extends: substitution
2+
message: "Use '%s' instead of '%s'."
3+
link: 'https://developers.google.com/style/contractions'
4+
level: suggestion
5+
ignorecase: true
6+
action:
7+
name: replace
8+
swap:
9+
are not: aren't
10+
cannot: can't
11+
could not: couldn't
12+
did not: didn't
13+
do not: don't
14+
does not: doesn't
15+
has not: hasn't
16+
have not: haven't
17+
how is: how's
18+
is not: isn't
19+
it is: it's
20+
should not: shouldn't
21+
that is: that's
22+
they are: they're
23+
was not: wasn't
24+
we are: we're
25+
we have: we've
26+
were not: weren't
27+
what is: what's
28+
when is: when's
29+
where is: where's
30+
will not: won't

‎.vale/styles/Google/DateFormat.yml‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
extends: existence
2+
message: "Use 'July 31, 2016' format, not '%s'."
3+
link: 'https://developers.google.com/style/dates-times'
4+
ignorecase: true
5+
level: error
6+
nonword: true
7+
tokens:
8+
- '\d{1,2}(?:\.|/)\d{1,2}(?:\.|/)\d{4}'
9+
- '\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}'

‎.vale/styles/Google/Ellipses.yml‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
extends: existence
2+
message: "In general, don't use an ellipsis."
3+
link: 'https://developers.google.com/style/ellipses'
4+
nonword: true
5+
level: warning
6+
action:
7+
name: remove
8+
tokens:
9+
- '\.\.\.'

0 commit comments

Comments
 (0)