-
Notifications
You must be signed in to change notification settings - Fork 9
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(docs): Add vale style checker #419
base: main
Are you sure you want to change the base?
Conversation
@arturo-seijas @erinecon @gregory-schiano this is mergeable now, note that for github runners I have to explicitly install |
Co-authored-by: Christopher Bartz <[email protected]> Signed-off-by: Mariyan Dimitrov <[email protected]>
@erinecon Can you please comment if this is desired? Its seems to me related to https://warthogs.atlassian.net/browse/ISD-2717 . |
Yes, this is desired! Thanks for following up on this PR. |
Applicable spec:
Overview
Adds the vale action with the Canonical vale styles.
The Canonical styles are hosted at praecepta and we're making use of the recommended workflow that is supplied in the README.md. In addition to our operator-workflows, data-platform-doc-tools is using the same workflow.
The vale action being used is the official one.
Rationale
Vale is gaining adoption as a doc style checker, hence including it in our workflow to test things out (currently it will not fail the action).
Workflow Changes
The
test.yaml
contains a style checker job afterwoke
.Checklist
urgent
,trivial
,complex
)