Skip to content

Add Vale as an English language linter

Amy Qualls requested to merge docs-20200114-add-vale-config into master

What does this MR do?

Vale (https://errata-ai.github.io/vale/) is a grammar, style, and word usage linter for the English language. This merge request adds an INI file for Vale (.vale.ini) to the root directory of the repository, and creates a hidden folder (doc/.linting) for the storage of linting tests.

Since the TW team uses multiple linting tools, and Vale also supports multiple collections of rules (called 'styles'), the path to the tests folder is doc/.linting/vale/styles/gitlab to support any future expansions that can't be predicted at this time.

The folder currently contains only a .gitkeep file to meet the goal of a MVC. Tests should be developed, vetted, and added in separate merge requests, but those MRs all depend on the addition of the INI file and the directory structure.

A brief explanation of Vale has also been added to doc/development/documentation/index.md.

Related issues

!22438 (closed) #38053 (closed)

Author's checklist

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Optional: Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by 🤖 GitLab Bot 🤖

Merge request reports