Standardize format of Vale configuration files
What does this MR do?
Makes all the Vale configuration files as similar as possible, with view to exporting these to other GitLab projects containing docs.
I've gone for the "minimal comments approach", with handy link out to the full ref. This is already true in a couple of files, so this is just making these ones more like the others.
Very tempted to relitigate the idea of moving this files:
- From:
doc/.linting/vale/styles/gitlab/ - To:
.vale/styles/gitlab/
But step at a time
CC @mjang1 @aqualls @marcel.amirault
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 Yorick Peterse