Add Vale linter for doc quality checks

[iamrajiv]

Description

The Vale Linter (natural language linter) implements spell check and other basic rules. There are also style libraries and extension points.

https://github.com/errata-ai/vale

[iamrajiv]

@oleg-nenashev @StackScribe @vadasambar What do you think about Vale linter support? If yes then I can help with this.

[vadasambar]

@iamrajiv , thank you for the idea and thank you for showing interest in improving our documentation.

Sorry, I am not familiar with the tool. I just took a look at the tool for the first time and found it interesting. I can see us using it to improve our docs but this seems more like a tool to be used on the user's end to see if they can improve what they wrote. How do you think we could use it for our repo?

Some ideas I could think of:

1. Recommend using vale in our contributing guide
2. Find a way to use it with the netlify build/deploy pipeline

[iamrajiv]

Hey, @vadasambar Yeah we can use Vale locally or integrate with other tools. There is support for GitHub Actions too which we want to set up in this repository i.e. https://github.com/errata-ai/vale-action.

[vadasambar]

Looks like we had spell check in our Github actions but not anymore

@mowies , @thisthat sorry for the mention. Why did we remove Spell Check?

[thisthat]

Hi @vadasambar and @iamrajiv, that particular action had a security vulnerability that could have been used to obtain all GitHub secrets. For this reason, we decided to depend only on the minimal set of external actions to limit this risk. In the case of the spell check, we decided that it is more beneficial to install a spell checker on your IDE instead of having a dedicated action.

[vadasambar]

I guess the TODO for us here then would be:

1. Check if vale has such issues
2. Ask in #keptn-docs if we are already using spell check in the IDE and if people would be interested in migrating to vale. This is because we might have to migrate IDE spell-check to vale as well. This is so that if we use vale in PR github actions pipeline it does not complain that the docs do not follow vale's styles/guidelines/rules.

Based on 1 and 2 go well,

3. If we get a positive response from 2, we demo the tool to the community members that often contribute to docs i.e., #keptn-docs members
4. If they're happy with it, we add it to the pipeline
5. Create a PR to this repo, demo it in one of the Keptn user/dev meetings. Get it reviewed -> merge

I would like to hear opinions about this from other community members as well. Meanwhile, @iamrajiv we can do 1 and 2.

[StackScribe]

We need a common spell checker that runs through all the docs and reports problems. The spell checker in an IDE can help an individual check spelling, etc, but different IDEs may have variations in the dictionaries used and running an IDE should not be required for modifying the documentation.

[DavidPHirsch]

stale