The make lint target previously linted only Markdown. Now it validates markdown, front matter, and prose.
The make target make lint-prose is added.
The make target make lint-markdown is added (previously make lint).
The .vale folder is added with vale styles and vocabulary
The .vale.ini file is added with vale configuration
Add workflow/action to run the linting for PRs
The file src/content/reference/fleet-management/clusters/introduction_cluster_api.md is updated to comply with most rules, except for one: it uses K8s, which is on our list of terms to avoid.
Regarding the workflow added
I couldn't get the vale-action to work, so I decided to download and execute the binaries for vale and reviewdog directly.
The workflow only reports errors for the files touched.
The implementation can be improved to execute Vale only on the modified files.
Towards https://github.com/giantswarm/roadmap/issues/3406
This adds prose linting for content.
This PR does't make all content compliant.
Run
make lint-proseor, for slightly faster execution, runvale --glob '!{src/content/vintage/**,src/content/changes/**}' src/contentYou can find one annotation on the commit https://github.com/giantswarm/docs/pull/2189/commits/2f625c523d17dcfc97f65361d71f8a206e09f11d.
Changes
make linttarget previously linted only Markdown. Now it validates markdown, front matter, and prose.make lint-proseis added.make lint-markdownis added (previouslymake lint)..valefolder is added with vale styles and vocabulary.vale.inifile is added with vale configurationsrc/content/reference/fleet-management/clusters/introduction_cluster_api.mdis updated to comply with most rules, except for one: it usesK8s, which is on our list of terms to avoid.Regarding the workflow added
I couldn't get the
vale-actionto work, so I decided to download and execute the binaries for vale and reviewdog directly.The workflow only reports errors for the files touched.
The implementation can be improved to execute Vale only on the modified files.