vale needs to have basic documentation and explained in doc guide

[maxandersen]

Describe the bug

we enabled vale (all great to iterate and experiment) but we don't seem to have documented that anywhere in contributing guide.

i.e.:

• explain it is not a blocker
• that you can add triage/needs-vale-rule-tweak
• document existence of https://github.com/quarkusio/quarkus/blob/c9e00898b30be0ed710087522da58b294bed6834/docs/.vale and that it is okey to submit PR's to improve it
• ensure the URLs referenced and explaining the rules actually exist:
  • i.e. https://github.com/quarkusio/quarkus/blob/c9e00898b30be0ed710087522da58b294bed6834/docs/.vale/styles/Quarkus/TermsSuggestions.yml#L18 refers to https://redhat-documentation.github.io/vale-at-red-hat/docs/reference-guide/termssuggestions that does not exist.
  • https://github.com/quarkusio/quarkus/blob/c9e00898b30be0ed710087522da58b294bed6834/docs/.vale/styles/Quarkus/Fluff.yml points to https://github.com/quarkusio/quarkus/blob/main/docs/src/main/asciidoc/doc-reference.adoc but I at least can't find what rules relate to "fluff" :)

https://redhat-documentation.github.io/vale-at-red-hat/docs/reference-guide/spelling/ is also broken url.

Expected behavior

No response

Actual behavior

No response

How to Reproduce?

No response

Output of uname -a or ver

No response

Output of java -version

No response

GraalVM version (if different from Java)

No response

Quarkus version or git rev

No response

Build tool (ie. output of mvnw --version or gradlew --version)

No response

Additional information

No response

[maxandersen]

i see https://quarkus.io/guides/doc-contribute-docs-howto exist but its very easy to miss. took me a while to locate.

I would suggest we outline the basics (mention vale and guidance) and then link to that doc AND at least mention how to deal with vale (the label, optionally, etc)

[ebullient]

Now that we have the gh action ans know what it looks like and have the label... we can join the dots

Some of what you mention above should go in the doc reference, with a few bits in the how to