Skip to content

Commit

Permalink
Setting up vale linter using Microsoft, Readability, and Hugo package…
Browse files Browse the repository at this point in the history
…s with CNCF vocabulary additions

Signed-off-by: Nate W <[email protected]>
  • Loading branch information
nate-double-u committed Jun 18, 2023
1 parent da23ea7 commit df0f4b3
Show file tree
Hide file tree
Showing 5 changed files with 61 additions and 0 deletions.
33 changes: 33 additions & 0 deletions .github/styles/Vocab/CNCF/accept.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
Aniszczyk
API
(?i)approvers
architected
(?i)autoscal*
cloud native
CNCF
containerd
cyber
datacenter(s\b|\b)
Datadog
declaratively
gRPC
idempotence
Ispas
Jihoon
K8s
Katelin
KubeCon
(?i)multitenan*
misconfiguration
open source
overdemand
Ramer
reusability
rollout
Seo
Seokho
(?i)serverless
SRE
subnet
virtualiz*
VM
3 changes: 3 additions & 0 deletions .github/styles/Vocab/CNCF/reject.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
cloud-native
K8
open-source
13 changes: 13 additions & 0 deletions .github/workflows/vale.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
name: Editorial review
on: [pull_request]

jobs:
vale:
name: runner / vale
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: errata-ai/vale-action@reviewdog
with:
files: content/en
fail_on_error: true
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,7 @@
public/
resources/
node_modules/
.github/styles/*
!.github/styles/Vocab
.hugo_build.lock
.DS_Store
10 changes: 10 additions & 0 deletions .vale.ini
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
StylesPath = .github/styles

MinAlertLevel = error

Packages = Microsoft, Readability, Hugo
Vocab = CNCF

[*.md]
BasedOnStyles = Vale, Microsoft, Readability
Microsoft.Contractions = NO

0 comments on commit df0f4b3

Please sign in to comment.