mirror of
https://github.com/gravitational/teleport.git
synced 2026-09-19 10:37:19 +08:00
The step of the Lint (Docs) GitHub Actions workflow that checks prose style using the Vale linter currently always passes because no Vale styles have the `error` level. This change fixes the remaining Vale warnings and sets most Vale styles to the `error` level so the prose check makes a difference in CI. It Keeps the warning level for rules with the `raw` scope since they cannot be ignored with MDX comments. The plan is to move these to remark so authors can ignore them if necessary. Edit the `capitalization` Vale rule to allow "kubernetes service account" (though it may be necessary to enforce "Kubernetes" capitalization at some point in a separate style rule). Don't apply the `messaging.protocol-products` check on titles or sidebar labels, since we currently use title case in titles, where a phrase like "Database Access" works without being a product name. Also clarify the message printed to the top of the style check output re: ignoring Vale rules using comments.