DOCS-3005: Update Vale to add native MDX processing - #3014
Conversation
…atively Vale 3.18 added native MDX parsing, so the community MDX package and mdx2vast are no longer needed. Removing Packages = MDX from .vale.ini and the mdx2vast install step from CI produces identical lint output (verified against calico/, calico-enterprise/, and calico-cloud/).
✅ Deploy Preview for calico-docs-preview-next ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview succeeded!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
🟡 Changes recommended
The updated scripts/vale-lint.sh prerequisites comment no longer documents perl (which the script requires) and should clarify the minimum Vale version expectation after switching to native MDX parsing.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
This PR updates the documentation linting setup to rely on Vale’s native MDX parsing (introduced in Vale 3.18), removing the now-unnecessary community MDX package and mdx2vast dependency across local and CI linting flows.
Changes:
- Removed
Packages = MDXfrom.vale.inito stop using the external MDX package. - Removed the CI step that globally installs
mdx2vast. - Updated the local Vale wrapper script and contributor instructions to drop
mdx2vastas a prerequisite.
File summaries
| File | Description |
|---|---|
| scripts/vale-lint.sh | Removes mdx2vast dependency checks/prereqs and updates rationale for MDX variable substitution. |
| .vale.ini | Removes the MDX package configuration and updates related comments. |
| .github/workflows/vale.yml | Removes the mdx2vast global install step from Vale CI. |
| .github/copilot-instructions.md | Removes mention of the mdx2vast global prerequisite from repo instructions. |
Review details
- Files reviewed: 4/4 changed files
- Comments generated: 1
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| # Prerequisites: | ||
| # brew install vale ripgrep | ||
| # npm install -g mdx2vast | ||
| # vale sync |
Vale 3.18 added native MDX parsing, so the community MDX package and mdx2vast are no longer required.
Packages = MDXfrom.vale.ini.Install mdx2vast globallyCI step and its mention in.github/copilot-instructions.md.mdx2vastprerequisite fromscripts/vale-lint.sh.Verified locally that lint output is identical with and without
Packages = MDXacrosscalico/,calico-enterprise/, andcalico-cloud/.https://tigera.atlassian.net/browse/DOCS-3005