fix: restore Vale control directives to HTML passthrough format#3167
Merged
gtrivedi88 merged 1 commit intoJul 22, 2026
Merged
Conversation
gtrivedi88
requested review from
a team,
deerskindoll and
mkuznyetsov
as code owners
July 22, 2026 14:53
|
🎊 Navigate the preview: https://6a60dbdd1a7342c48781de78--eclipse-che-docs-pr.netlify.app 🎊 |
The RedHat.Spacing rule flags the text "RedHat.Spelling" inside Vale
control directives (both // and pass:[<!-- -->] formats) as improperly
joined words. Remove the directives entirely since {prod-checluster}
only produces a spelling warning, not an error.
Co-authored-by: Cursor <cursoragent@cursor.com>
gtrivedi88
force-pushed
the
fix-vale-control-directives
branch
from
July 22, 2026 14:57
938f633 to
72fd424
Compare
azatsarynnyy
approved these changes
Jul 22, 2026
1 task
gtrivedi88
added a commit
that referenced
this pull request
Jul 23, 2026
#3169) Backport of #3167 to 7.120.x. The RedHat.Spacing rule flags "RedHat.Spelling" text inside Vale control directives as improperly joined words. Remove the directives since {prod-checluster} only produces a spelling warning, not an error that would fail the build. Co-authored-by: Cursor <cursoragent@cursor.com>
This file contains hidden or 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
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.
Summary
// vale RedHat.Spelling = NO/YES) that triggerRedHat.Spacingerrors in CI{prod-checluster}attribute these directives were suppressing only produces a spelling warning (not an error), so the directives are unnecessaryRoot cause
The
RedHat.Spacingrule catches the text "RedHat.Spelling" inside the Vale control directive itself, interpreting it as two improperly joined words. This happens in both formats:// vale RedHat.Spelling = NO(AsciiDoc comment -- not recognized as a Vale directive)pass:[<!-- vale RedHat.Spelling = NO -->](HTML passthrough -- the rule fires before the directive is parsed)Removing the directives entirely resolves the circular problem. The underlying
{prod-checluster}text only triggers a warning, which does not fail the build.Test plan