Skip to content

Draft: Lint documentation using Vale

Tan Le requested to merge vale-doc-lint into main

What does this MR do and why?

This MR adds documentation linting with Vale. This is to keep the documentation consistent across GitLab projects as per the guidelines and improve doc review efficiency. GitLab styles are lifted from GitLab project.

The documentation lint can be run via:

  • Manually run via make vale-tests.
  • Automatically via lefhook pre-commit and pre-push hook.
  • Checked via CI in vale job.

Screenshots, screen recordings, or links to review app

These are strongly recommended to assist reviewers and reduce the time to merge your change.

How to set up and validate locally

Numbered steps to set up and validate the change are strongly suggested.

  1. Configure a local GitLab Docs environment: https://gitlab.com/gitlab-org/gitlab-docs/-/blob/main/doc/setup.md.

Merge request acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

Edited by Tan Le

Merge request reports