Added .markdownlintignore to exclude legacy v1 documentation and blog posts
from markdown linting. This allows the team to focus on maintaining quality
for actively maintained documentation while avoiding the need to fix 200+
pre-existing lint errors in historical content.
Excluded paths:
- content/en/docs/v1/** (legacy v1 documentation with historical lint debt)
- content/en/blog/** (blog posts with varied formatting styles)
Fixed markdown linting errors in current documentation:
- content/en/docs/_index.md: Removed excessive blank lines
- content/en/docs/decisions/0001-pipeline-tools.md:
* Converted emphasis (**Pro**, **Con**) to proper h4 headings
* Improves document structure and accessibility
* Maintains visual hierarchy while meeting markdown standards
Fixed sample v1 files that were blocking CI:
- content/en/docs/v1/solution/tools/Crossplane/provider-kind/_index.md:
* Replaced hard tabs with spaces (MD010)
* Added language tags to code blocks (bash)
- content/en/docs/v1/solution/tools/kyverno integration/_index.md:
* Added blank line before list items (MD032)
* Added language tags to code blocks (bash)
Impact:
- task test:quick now passes cleanly
- CI pipeline markdown validation succeeds
- New documentation maintains high quality standards
- Legacy content preserved without blocking development
This approach balances:
1. Maintaining quality for actively developed docs
2. Not requiring massive refactoring of legacy content
3. Enabling clean CI/CD pipeline
4. Providing clear quality standards for future contributions
- Move all existing docs content (concepts, project, solution) to /docs/v1/
- Add legacy banner component to warn users about archived documentation
- Create v1 index page with legacy notice and redirect guidance
- Implement automatic banner display for all v1 paths
- Preserve all original content for reference during migration
This enables incremental content migration while maintaining access to
original documentation.
