Skip to content

fix: restore Vale control directives to HTML passthrough format#3167

Merged
gtrivedi88 merged 1 commit into
eclipse-che:mainfrom
gtrivedi88:fix-vale-control-directives
Jul 22, 2026
Merged

fix: restore Vale control directives to HTML passthrough format#3167
gtrivedi88 merged 1 commit into
eclipse-che:mainfrom
gtrivedi88:fix-vale-control-directives

Conversation

@gtrivedi88

@gtrivedi88 gtrivedi88 commented Jul 22, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Removes Vale control directives (// vale RedHat.Spelling = NO/YES) that trigger RedHat.Spacing errors in CI
  • The {prod-checluster} attribute these directives were suppressing only produces a spelling warning (not an error), so the directives are unnecessary

Root cause

The RedHat.Spacing rule 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

  • Publication builder CI passes (0 errors)
  • Vale linting workflow passes
  • "Build and validate pull request" workflow passes

@gtrivedi88
gtrivedi88 requested review from a team, deerskindoll and mkuznyetsov as code owners July 22, 2026 14:53
@gtrivedi88
gtrivedi88 requested a review from azatsarynnyy July 22, 2026 14:53
@github-actions

github-actions Bot commented Jul 22, 2026

Copy link
Copy Markdown

🎊 Navigate the preview: https://6a60dbdd1a7342c48781de78--eclipse-che-docs-pr.netlify.app 🎊

@github-actions

github-actions Bot commented Jul 22, 2026

Copy link
Copy Markdown

Click here to review and test in web IDE: Contribute

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
gtrivedi88 force-pushed the fix-vale-control-directives branch from 938f633 to 72fd424 Compare July 22, 2026 14:57
@gtrivedi88
gtrivedi88 merged commit 7beb654 into eclipse-che:main Jul 22, 2026
6 checks passed
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants