chore(ci): add vale (#2200)

.github/workflows/vale.yml

@@ -0,0 +1,23 @@
+name: Lint Docs
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  list-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Git checkout
+        uses: actions/checkout@v2
+
+      - name: Vale
+        uses: errata-ai/vale-action@master
+        with:
+          styles: https://vale-library.netlify.app/styles.zip
+          files: '["docs", "src", "README.md", "CODE_OF_CONDUCT.md", "CONTRIBUTING.md"]'
+          onlyAnnotateModifiedLines: true
+        env:
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

.gitignore

@@ -32,3 +32,5 @@ oclif.manifest.json
 
 tests/hugo-site/resources
 tests/hugo-site/out
+
+.github/styles

.vale.ini

@@ -0,0 +1,5 @@
+StylesPath = ./.github/styles
+MinAlertLevel = suggestion
+
+[*.md]
+BasedOnStyles = base, netlify-terms, smart-marks

CONTRIBUTING.md

@@ -79,6 +79,12 @@ We also test for a few other things:
 - Test coverage
 - Must work with Windows + Unix environments.
 
+### Lint docs per Netlify style guide
+
+1. [Install vale](https://docs.errata.ai/vale/install)
+2. Download the latest styles to the styles directory. For example: `wget -q -O styles.zip https://vale-library.netlify.app/styles.zip && unzip styles.zip -d .github/styles && rm styles.zip`
+3. Run vale: `vale docs src README.md CODE_OF_CONDUCT.md CONTRIBUTING.md`
+
 ## Pull Requests
 
 We actively welcome your pull requests.