Docs: how to turn Vale off and on inside a page
What does this MR do?
There are two methods for disabling Vale tests, and both of them have a caveat that needs explanation.
The GitLab style guide provides a section of information about what NOT to do. For obvious reasons, the text in this section will never pass an automated linting check. To prevent false positives, this MR disables tests on that portion of the page.
It also adds explanation into the style guide on how to disable all, or individual, tests for a portion of a page.
Also see a related issue on Vale's issue queue.
Related issues
Closes #208081 (closed)
Author's checklist
-
Follow the Documentation Guidelines and Style Guide. -
If applicable, update the permissions table. -
Link docs to and from the higher-level index page, plus other related docs where helpful. -
Apply the documentation label.
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
-
Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review. -
Ensure a release milestone is set. -
If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by 🤖 GitLab Bot 🤖