Skip to content

Docs: try out suggestion-level substitutions

Amy Qualls requested to merge docs-aqualls-substitution-suggestions into master

What does this MR do?

Our current substitutions file in Vale is set to the error level, which is not appropriate for all of the suggestions we want to make to the technical writing team. This commit adds another substitution file with a name that makes clear the items within it are at a suggestion level, rather than an error level.

Related issues

Part of &2497 (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.

Merge request reports

Loading