[go: up one dir, main page]

Draft: Add Vale locale-specific linting framework for translated documentation

What does this MR do and why?

Add Vale locale-specific linting framework for translated documentation

This commit establishes a Vale testing framework specifically for translated documentation in the doc-locale directory, separate from the existing English documentation linting.

Changes include:

  • Add locale_rules Vale style with ReferenceQuotationRemoval rule to detect Japanese quotation marks around links (「text」)
  • Create dedicated Vale configuration (.vale.ini) for localized docs
  • Add custom Vale output templates (vale.tmpl, vale-json.tmpl) for consistent formatting with existing tooling
  • Extend i18n_lint_doc.sh script to run locale-specific Vale rules alongside existing global Vale checks

The new framework allows for language-specific documentation quality checks that differ from English requirements, starting with Japanese quotation mark detection around reference links.

Relates to gitlab-com/localization/docs-site-localization#338 (closed)

References

Screenshots or screen recordings

Before After

How to set up and validate locally

MR acceptance checklist

Evaluate this MR against the MR acceptance checklist. It helps you analyze changes to reduce risks in quality, performance, reliability, security, and maintainability.

Merge request reports

Loading