Skip to content

Update Vale test comments for search results

Amy Qualls requested to merge docs-aqualls-tidy-rule-comments into master

What does this MR do?

To provide a SSOT for our current list of Vale rules in technical-writing#342 (closed), we've created a subsection (https://docs.gitlab.com/ee/development/documentation/testing.html#vale-result-types) that links to search results showing the rules currently flagged error, warning, or suggestion. Some suggestions were made in the issue (and !50238 (merged)) about improving the information returned in the search results.

I didn't take all of the suggestions. It looks like the search returns the matching line, plus the two lines below it, so lines 1-3 are critical. This MR reviews each existing test and puts as much information as possible about what the test DOES on line 3, to help users who encounter these rules through search.

I'm not wedded to the exact wording in the comments. Line 3 just needs to be a clear / concise / standalone statement that doesn't break in the middle of a sentence.

Related issues

Closes technical-writing#342 (closed)

Author's checklist (required)

Do not add the feature, frontend, backend, ~"bug", or database labels if you are only updating documentation. These labels will cause the MR to be added to code verification QA issues.

When applicable:

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

  • 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.

For more information about labels, see Technical Writing workflows - Labels.

For suggestions that you are confident don't need to be reviewed, change them locally and push a commit directly to save others from unneeded reviews. For example:

  • Clear typos, like this is a typpo.
  • Minor issues, like single quotes instead of double quotes, Oxford commas, and periods.

For more information, see our documentation on Merging a merge request.

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 Amy Qualls

Merge request reports

Loading