Add vale #1004
Add vale #1004
Conversation
We don't currently have any custom rules, but I wouldn't say "vocabulary suffices". This PR is a level up, but it's also the beginning of a really long journey. I'm pretty sure that we'll find many more "human rules" which are not enforced by Vale and which we will address with future PRs. Said PRs might introduce custom rules. |
|
I'm amazed at how much "just" adding Vale itself and the vocabulary did! Super well done! |
| - id: vale | ||
| name: "Vale: A linter for prose" | ||
| entry: ./scripts/vale.sh | ||
| language: script |
There was a problem hiding this comment.
I'd suggest managing it fully with pre-commit rather than split it:
- id: vale
name: "Vale: A linter for prose"
entry: vale
files: .*\.md$
language: python
additional_dependencies:
- vale==3.9.1.0Then you can remove the script, the requirement entry and the workflow lint check.
| - Date: 2021-02-02 | ||
|
|
||
| ## Context and Problem Statement | ||
|
|
||
| To increase adoption of Welkin, we were asked to observe the [Principle of Least Astonishment](https://en.wikipedia.org/wiki/Principle_of_least_astonishment). Currently, Welkin's handing of kubeconfig is astonishing. Most tools in the ecosystem use the standard `KUBECONFIG` environment variable and kubecontext implemented in the client-go library. These tools leave it up to the user to set `KUBECONFIG` or use the default `~/.kube/config`. Similarly, there is a default kubecontext which can be overwritten via command-line. Tools that get cluster credentials generate a context related to the name of the cluster. | ||
| To increase adoption of Welkin, we were asked to observe the [Principle of Least Astonishment](https://en.wikipedia.org/wiki/Principle_of_least_astonishment). Currently, Welkin's handing of kubeconfig is astonishing. Most tools in the ecosystem use the standard `KUBECONFIG` environment variable and KUBECONFIG context implemented in the client-go library. These tools leave it up to the user to set `KUBECONFIG` or use the default `~/.kube/config`. Similarly, there is a default KUBECONFIG context which can be overwritten via command-line. Tools that get cluster credentials generate a context related to the name of the cluster. |
There was a problem hiding this comment.
To align with Kubernetes documentation this should be "kubeconfig context", they only capitalise to refer to the env variable.
| @@ -47,5 +47,5 @@ When using the local-volume-provisioner please create dedicated partitions and m | |||
|
|
|||
| - [local-volume-provisioner](https://github.com/kubernetes-sigs/sig-storage-local-static-provisioner/tree/v2.5.0) | |||
| - [local-path-provisioner](https://github.com/rancher/local-path-provisioner) | |||
| - [hostPath](https://kubernetes.io/docs/concepts/storage/volumes/#hostpath) | |||
| - [`hostPath`](https://kubernetes.io/docs/concepts/storage/volumes/#hostpath) | |||
There was a problem hiding this comment.
If this is going to be hostpath then local should be local as well.
Quality gates:
At last, my greatest work completed.
This PR adds Vale a "linter for prose". It's essentially a spellchecker on steroids. The PR also fixes all spelling errors detected by Vale.