chore: add vale config for prose and spell checking #288
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Red Hat has a pretty good template for this thing [1] and it already understands RST. Might as well pick it up here. Fair warning, it's much more picky than I am. I'm not entirely sure if we should add it to the PR checker right now, as even my stuff was flagged to hell and back. [1] https://github.com/redhat-documentation/vale-at-red-hat Signed-off-by: Randolph Sapp <[email protected]>
StaticRocket
requested review from
VeeruPrudhvi,
aniket-l,
cshilwant,
praneethbajjuri and
uditkumarti
as code owners
Member
Author
|
I do want people to test this out and give their opinion before we go down this road. It'll be a lot of work to match Red Hat's standards for documentation. |
Member
Adding @jeevantelukula @sadik-smd @jsuhaas22 for reviews |
praneethbajjuri
approved these changes
May 12, 2025
cshilwant
approved these changes
May 15, 2025
sadik-smd
approved these changes
May 16, 2025
Contributor
|
This looks good. lets get this merged. and add to pr checker |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Red Hat has a pretty good template for this thing [1] and it already understands RST. Might as well pick it up here. Fair warning, it's much more picky than I am. I'm not entirely sure if we should add it to the PR checker right now, as even my stuff was flagged to hell and back.
[1] https://github.com/redhat-documentation/vale-at-red-hat
May be good enough to address #19 in the future though.