elastisys / compliantkubernetes

Documentation for the Compliant Kubernetes project
https://elastisys.io/compliantkubernetes
Apache License 2.0
120 stars 32 forks source link

Use vale to systematically improve the quality of pages #789

Open cristiklein opened 8 months ago

cristiklein commented 8 months ago

Let's use vale.sh to reduce the probability of introducing spelling and grammar mistakes. Vale should be triggered at three levels:

  1. Local development, via vim or VSCode integration (see VIM ALE.)
  2. Pre-commit
  3. CI at PR creation time (likely by running pre-commit run --all via GitHub Actions).
cristiklein commented 8 months ago

The terms-internal project could serve as inspiration for implementation.