[documentation] Fix Vale errors, warnings and suggestions
See original GitHub issueDescription
PR https://github.com/Quansight/qhub/pull/871 and https://github.com/Quansight/qhub/pull/873 integrated the Vale CI to the GitHub Actions and added the Google developer documentation style guide for language checks.
However, we have a lot of errors, warnings and suggestions generated and we did not get the opportunity to fix all of them. Currently, the CI runs only on modified lines, hence we don’t generate a lot of noise but for local usage, we would ideally like it to be fixed.
Recommended steps
To have a stab at fixing these issues, here are some recommended steps:
- Install Vale CLI: https://docs.errata.ai/vale/install
- Run Vale on the documentation source:
vale docs/
- Find and fix the issues in batches and open a PR after a significant change.
- If you discover an anti-pattern, make a fix on the Vale configuration hosted over
tests/vale/styles/
- If Vale detects a typo issue, that isn’t actually one, add it to the
vocab.txt
. - If Vale detects grammatical issues, find the relevant YAML that defines the style and add exceptions.
- If Vale detects a typo issue, that isn’t actually one, add it to the
For more background on working with Vale, please refer: https://docs.errata.ai/vale/styles
Issue Analytics
- State:
- Created 2 years ago
- Reactions:2
- Comments:5 (4 by maintainers)
Top Results From Across the Web
add tag to suppress Vale errors/warnings for specific case #52
Some errors/warnings reported by Vale are perfectly valid English prose. Ultimately, Vale just provides suggestions, potential issues and ...
Read more >Audit Vale rules and reduce the number of Vale warnings ... - GitLab
We need to work on reducing these as much as possible, as all warnings are likely docs debt, and all suggestions are potential...
Read more >Vale - High Performance Computing
The purpose of Vale here is to standardize the documentation process and ... Set to suggestion , thereby including the levels error, warning...
Read more >How to automate linting your documentation using Vale and ...
Run the command vale sample.md from your terminal to let Vale find errors, warnings, and suggestions in the files. This will help you...
Read more >Change inspection severity - DataGrip - JetBrains
Inspection severity levels indicate how seriously the detected code problems affect your project. In DataGrip, there is a set of predefined ...
Read more >
Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free
Top Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
@HarshCasper says that all of these vale issues can be done by next week
@HarshCasper - I am interested in this issue, so please assign it to me. I will start working on it starting next week. Thanks!