Setup vale #92
Merged
Setup vale #92
Conversation
This file contains 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
Closed
Deploying with
|
| Latest commit: |
2a22846
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://eb4491be.klaw-docs.pages.dev |
| Branch Preview URL: | https://86-setup-vale.klaw-docs.pages.dev |
programmiri
force-pushed
the
86-setup-vale
branch
4 times, most recently
from
f807f54 to
70c59c1
Compare
Signed-off-by: Mirjam Aulbach <[email protected]>
Signed-off-by: Mirjam Aulbach <[email protected]>
Signed-off-by: Mirjam Aulbach <[email protected]>
Signed-off-by: Mirjam Aulbach <[email protected]>
programmiri
force-pushed
the
86-setup-vale
branch
from
70c59c1 to
91de8b5
Compare
Signed-off-by: Mirjam Aulbach <[email protected]>
programmiri
force-pushed
the
86-setup-vale
branch
from
9214eaa to
f5b5e51
Compare
mathieu-anderson
previously approved these changes
Sep 26, 2023
| nonword: true | ||
| action: | ||
| name: replace | ||
| swap: |
There was a problem hiding this comment.
Haha amazing. Will do this in my writing ^^
Signed-off-by: Mirjam Aulbach <[email protected]>
Signed-off-by: Mirjam Aulbach <[email protected]>
Signed-off-by: Mirjam Aulbach <[email protected]>
|
@mathieu-anderson I sneaked in two commits, one adding info about |
mathieu-anderson
approved these changes
Sep 26, 2023
harshini-rangaswamy
pushed a commit
that referenced
this pull request
Oct 4, 2023
* Add basic vale setup with base rules. * Fix some spelling inconsistencies * Add workflow for vale * Update documentation --------- Signed-off-by: Mirjam Aulbach <[email protected]>
muralibasani
added a commit
that referenced
this pull request
Oct 5, 2023
* Adding topic overview Signed-off-by: muralibasani <[email protected]> * Reviewed and edited content to add more information Signed-off-by: Harshini Rangaswamy <[email protected]> * Removed duplicate content Signed-off-by: Harshini Rangaswamy <[email protected]> * Run prettier check Signed-off-by: Harshini Rangaswamy <[email protected]> * (fix): Update custom css (#90) Update custom css Signed-off-by: Mirjam Aulbach <[email protected]> * Add workflow for linting and markdown-link-check (#87) - Add workflow for linting. - Add script to check markdown links. - Add explanation to script. - Add github workflow for link-check. - Add README for github workflows. --------- Signed-off-by: Mirjam Aulbach <[email protected]> * Setup vale (#92) * Add basic vale setup with base rules. * Fix some spelling inconsistencies * Add workflow for vale * Update documentation --------- Signed-off-by: Mirjam Aulbach <[email protected]> * Add tech docs for contributing (#96) * Add CONTRIBUTING file with first important information. * Update TOC and language. * Reviewed and updated sentences in the CONTRIBUTING file * Rewrote sentence to provide more clarity --------- Signed-off-by: Mirjam Aulbach <[email protected]> Signed-off-by: Harshini Rangaswamy <[email protected]> Co-authored-by: Harshini Rangaswamy <[email protected]> * (fix): 🐛 duplicate documentation pages created (#94) * Delete index.md file in concept and howto as they are generated in category.json --------- Signed-off-by: Mirjam Aulbach <[email protected]> * Configure vale more (#97) * Use style config instead of dic for common words. Signed-off-by: Mirjam Aulbach <[email protected]> * Add custom styles for heading and whitespaces. Signed-off-by: Mirjam Aulbach <[email protected]> * Add proselint Signed-off-by: Mirjam Aulbach <[email protected]> * Add branding file. Signed-off-by: Mirjam Aulbach <[email protected]> * Be more specific with config. Signed-off-by: Mirjam Aulbach <[email protected]> * Update vale workflow. Signed-off-by: Mirjam Aulbach <[email protected]> * Add updated style rules. Signed-off-by: Mirjam Aulbach <[email protected]> --------- Signed-off-by: Mirjam Aulbach <[email protected]> * Add additional rules (#108) * Add style rule for postgresdb Signed-off-by: Mirjam Aulbach <[email protected]> * Add rule for condensending language Signed-off-by: Mirjam Aulbach <[email protected]> * Add rule for use of race related words and update error. Signed-off-by: Mirjam Aulbach <[email protected]> --------- Signed-off-by: Mirjam Aulbach <[email protected]> * Update docs to use SSL correctly (#112) Signed-off-by: Devrishi <[email protected]> * Add first entries to style guide (#107) Add first entries to style guide. Signed-off-by: Mirjam Aulbach <[email protected]> * fixes: Update doc term klaw correctly (#114) * fixes: Update doc term klaw correctly --------- Signed-off-by: Basavarajakjbasuu <[email protected]> * (ci) Update vale workflow reporter (#115) * Remove vale action in favor for own setup for workflow Signed-off-by: Mirjam Aulbach <[email protected]> * Move klaw rule to temp branding again. Signed-off-by: Mirjam Aulbach <[email protected]> * Fix spelling error. Signed-off-by: Mirjam Aulbach <[email protected]> --------- Signed-off-by: Mirjam Aulbach <[email protected]> * Updated branding.yml and respective files to help docs to use the term "Confluent Cloud" correctly. (#122) Updated branding.yml and respective files to help docs to use the term Confluent Cloud correctly Signed-off-by: Roshan Goswami <[email protected]> * Update docs to use Klaw Cluster API correctly (#125) Update docs to use Klaw Cluster API corrrectly Signed-off-by: Devrishi <[email protected]> * Added readme to spelling-klaw-vocabulary file Signed-off-by: Harshini Rangaswamy <[email protected]> --------- Signed-off-by: muralibasani <[email protected]> Signed-off-by: Harshini Rangaswamy <[email protected]> Signed-off-by: Mirjam Aulbach <[email protected]> Signed-off-by: Devrishi <[email protected]> Signed-off-by: Basavarajakjbasuu <[email protected]> Signed-off-by: Roshan Goswami <[email protected]> Co-authored-by: muralibasani <[email protected]> Co-authored-by: Harshini Rangaswamy <[email protected]> Co-authored-by: Mirjam Aulbach <[email protected]> Co-authored-by: Devrishi Dutta <[email protected]> Co-authored-by: Basavaraja K J <[email protected]> Co-authored-by: Roshan <[email protected]> Co-authored-by: Harshini Rangaswamy <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
This PR introduces Vale. The setup is meant to be extended over time in order to establish a more strict style guide for our documentation. At the moment, Vale does basic spell checking.
This PR
.vale.iniand.github/vale