diff --git a/.github/styles/Vocab/CNCF/accept.txt b/.github/styles/Vocab/CNCF/accept.txt new file mode 100644 index 0000000000..736d240cc2 --- /dev/null +++ b/.github/styles/Vocab/CNCF/accept.txt @@ -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 diff --git a/.github/styles/Vocab/CNCF/reject.txt b/.github/styles/Vocab/CNCF/reject.txt new file mode 100644 index 0000000000..4ae304cf23 --- /dev/null +++ b/.github/styles/Vocab/CNCF/reject.txt @@ -0,0 +1,3 @@ +cloud-native +K8 +open-source diff --git a/.github/workflows/vale.yml b/.github/workflows/vale.yml new file mode 100644 index 0000000000..5816877632 --- /dev/null +++ b/.github/workflows/vale.yml @@ -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 diff --git a/.gitignore b/.gitignore index 499b89d879..f357b495d5 100644 --- a/.gitignore +++ b/.gitignore @@ -2,5 +2,7 @@ public/ resources/ node_modules/ +.github/styles/* +!.github/styles/Vocab .hugo_build.lock .DS_Store diff --git a/.vale.ini b/.vale.ini new file mode 100644 index 0000000000..34de79eab9 --- /dev/null +++ b/.vale.ini @@ -0,0 +1,10 @@ +StylesPath = .github/styles + +MinAlertLevel = error + +Packages = Microsoft, Readability, Hugo +Vocab = CNCF + +[*.md] +BasedOnStyles = Vale, Microsoft, Readability +Microsoft.Contractions = NO