Skip to content

Commit

Permalink
Feature/vale linter (github#586)
Browse files Browse the repository at this point in the history
* add vale linter

* add config

* add vale files

* add vocab

* fix typo

* add lowercase callout

* remove duplicate the

* add google documentation

Co-authored-by: Lana Brindley <github@lanabrindley.com>
  • Loading branch information
jacobprall and Loquacity authored Nov 9, 2021
1 parent 2c6c396 commit 1aeba87
Show file tree
Hide file tree
Showing 4 changed files with 36 additions and 1 deletion.
5 changes: 5 additions & 0 deletions .github/.vale.ini
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
StylesPath = .github/styles
MinAlertLevel = suggestion

[*.md]
BasedOnStyles = Vale
12 changes: 12 additions & 0 deletions .github/styles/vocab.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
eg
Hypertable
Hypertables
href
repo
url
urls
callout
Callout
Callouts
Postgres
api
18 changes: 18 additions & 0 deletions .github/workflows/vale-linter.yml
Original file line number Diff line number Diff line change
@@ -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}}
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 1aeba87

Please sign in to comment.