diff --git a/.github/.vale.ini b/.github/.vale.ini new file mode 100644 index 000000000000..111bdd33b741 --- /dev/null +++ b/.github/.vale.ini @@ -0,0 +1,5 @@ +StylesPath = .github/styles +MinAlertLevel = suggestion + +[*.md] +BasedOnStyles = Vale \ No newline at end of file diff --git a/.github/styles/vocab.txt b/.github/styles/vocab.txt new file mode 100644 index 000000000000..0475d8aebe66 --- /dev/null +++ b/.github/styles/vocab.txt @@ -0,0 +1,12 @@ +eg +Hypertable +Hypertables +href +repo +url +urls +callout +Callout +Callouts +Postgres +api \ No newline at end of file diff --git a/.github/workflows/vale-linter.yml b/.github/workflows/vale-linter.yml new file mode 100644 index 000000000000..432fbcbf15de --- /dev/null +++ b/.github/workflows/vale-linter.yml @@ -0,0 +1,18 @@ +name: Linting +on: [push] + +jobs: + prose: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@master + + - name: Vale + uses: errata-ai/vale-action@v1.4.0 + with: + config: https://raw.githubusercontent.com/errata-ai/vale/master/.vale.ini + styles: | + https://github.com/errata-ai/Google/releases/latest/download/Google.zip + env: + GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} \ No newline at end of file diff --git a/README.md b/README.md index 50fadf3c3045..0dfae75e1eb8 100644 --- a/README.md +++ b/README.md @@ -83,7 +83,7 @@ of an on-disk folder with the same name as the parent. - **type**: In some special cases, a tree element may have a special `type` associated with it. This is rarely needed in day-to-day documentation updates, but when -specific functionality is required, it may be necessary to inquire about other page types. Currently `page` and `directory` the the two magjor supported types in documentation. +specific functionality is required, it may be necessary to inquire about other page types. Currently `page` and `directory` the two major supported types in documentation. - **excerpt**: For a few select nodes in a tree, the `excerpt` may be used to create navigation "cards" on high-level landing pages. It is only intended to