search

keptn-sandbox / new-keptn-docs-engine

GSoC 2022 Project: New Documentation Site Engine
https://keptn-experimental-docs-site.netlify.app/
Apache License 2.0
6 stars 2 forks source link

Add Vale linter for doc quality check #19

Closed iamrajiv closed 2 years ago

iamrajiv commented 2 years ago

Description

Vale is a command-line tool that brings code-like linting to prose life. To integrate Vale into the new documentation engine we need GitHub Action for Vale.

So, we will be using vale-action which is the official GitHub Action for Vale according to our new documentation engine.

vadasambar commented 2 years ago

Questions:

  1. Why did we choose Vale?
  2. What are the quality checks that we are supporting right now? And why those checks? (<- we should reach out to the community for feedback around what checks we should be including)
  3. Is the vale linter going to block PR merge (it seems to be doing that right now). If yes, is this the strategy going forward and what are the reasons for doing so? image