Skip to content

More cleanup for YAML reference doc

Marcel Amirault requested to merge docs-yaml-ref-cleaning into master

What does this MR do?

This is a comprehensive "light cleanup" of the YAML reference doc.

  • It fixes most warnings/suggestions from Vale
  • It updates a bunch of "introduced in" links to use the issues instead of the MRs.

Related issues

Related to #205397 (closed)

Author's checklist (required)

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

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

Merge request reports