Adjust levels of Vale rules #48850
Merged
Adjust levels of Vale rules #48850
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
github-actions
bot
requested review from
mmcallister,
r0mant,
xinding33 and
zmb3
|
🤖 Vercel preview here: https://docs-hhfg9awuk-goteleport.vercel.app/docs/ver/preview |
ptgott
added
the
no-changelog
ptgott
force-pushed
the
paul.gottschling/2024-11-12-vale-leveling
branch
from
d098cc6
to
fd88c03
Compare
|
🤖 Vercel preview here: https://docs-92k37vkgh-goteleport.vercel.app/docs/ver/preview |
zmb3
approved these changes
Nov 25, 2024
Change the error levels of Vale style rules to pave the way for requiring the Vale linter. Use the `warning` level for all rules except for the step numbering rule. This mostly preserves the existing "check prose style" GitHub Actions job behavior, in which Vale style rules are optional. The one rule we require is to ensure that numbered `Step n/d` headings follow the correct numbering scheme.
ptgott
force-pushed
the
paul.gottschling/2024-11-12-vale-leveling
branch
from
fd88c03
to
40b877b
Compare
|
@zmb3 After speaking with the Docs Team, I've changed all rules except the step numbering rule to have the @mmcallister Would you have time to take a look at this? It implements one step we talked about at our meeting. Thanks! |
|
🤖 Vercel preview here: https://docs-1igietmjf-goteleport.vercel.app/docs |
mmcallister
approved these changes
Dec 2, 2024
public-teleport-github-review-bot
bot
removed request for
r0mant and
xinding33
ptgott
added a commit
that referenced
this pull request
Dec 2, 2024
Backports #48850 Change the error levels of Vale style rules to pave the way for requiring the Vale linter. Use the `warning` level for all rules except for the step numbering rule. This mostly preserves the existing "check prose style" GitHub Actions job behavior, in which Vale style rules are optional. The one rule we require is to ensure that numbered `Step n/d` headings follow the correct numbering scheme.
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.
Change the error levels of Vale style rules to pave the way for requiring the Vale linter.
If a style rule has the
rawscope, it is not currently possible to disable the rule within a document using HTML/MDX comments. Further, a rule with theerrorlevel causes Vale to exit with a nonzero error code if a page violates the rule. As a result, this change makes the following adjustments to the error levels of Vale style rules:error: styles where we want to ensure consistency/correctness, and where it is possible to disable the style using comments.warning: style rules that an author might need to ignore. This includes style rules with therawscope, which cannot be disabled using comments.For some style rules, change the scope from
rawto another scope that allows a docs author to disable the rule within a document using HTML/MDX-style comments.