dvc.org
dvc.org copied to clipboard
iterative
Introduce vale linter
Add a new workflow for running https://vale.sh/ on P.R.
Added a bunch of rules ("styles") but I have no idea which ones make sense for our docs. Please review them
It can be tested locally by installing https://vale.sh/ and running from the root:
vale content/docs/start
E: Note that there's a VS Code extension too. - @jorgeorpinel
Example of error and warning on markdown file:
https://github.com/iterative/dvc.org/pull/3716/files#diff-b1dd216e145355375d79e34394c0c99b634227f74ee3d1534406363c4c042d96
Very promising @daavoo ! It will take some time to go through the existing packages and rules to create a good base config, and then possibly write our own rules as well of course. Then check which repos could use this, talk to the product least, etc... It will take some time but I'll follow up on this.
Keeping open as a draft to play around with for now.
nstead there should be a flake8-like convention - config file(s) should state categories to include/exclude + overrides... rather than the entire upstream lists.
How do we pull updates from upsteam lists?
This is a limitation of the tool itself -> https://github.com/errata-ai/vale/issues If there are better open source alternatives, I don't really care which tool to use.
See https://github.com/iterative/dvc.org/pull/3716#discussion_r918830373 for the reasoning of the setup, given the tool limitations.
Also these lists are mostly super controversial. Numerous examples too upsetting to list (some examples given below). The linter's highly misguided suggestions will likely be super triggering.Can we have a minimal no-brainer subset instead?
Note that these are pre-defined packages I copy-pasted so we can remove what we don't need but reuse the rest (as there is no better way of doing it per the limitations mentioned above).
We can absolutely have a minimal subset. I just opened this to showcase the setup and push the discussion. I expect the @iterative/docs team to refine and prune the rules to match our criteria and use case. Don't hesitate to edit or remove rules directly on the P.R.
