Skip to content

Merge the two suggestion Vale lists

Kati Paizee requested to merge kpaizee-merge-substitution-vale-rules into master

What does this MR do?

As discussed in #382360 (closed), propose merging the contents of SubstitutionSuggestions.yml and SubstitutionWarnings.yml into a single file.

Reasons for this change:

  • Not clear why some of these are suggestions and why some are warnings.
  • Easier to maintain going forward.

Possible cons for this change:

  • If we move all of these to 'warning', it generates about 1755 warnings. The SubstitutionWarnings.yml file previously generated about 179 warnings and SubstitutionSuggestions.yml generated almost 1600.
    • This could have a big impact on the docs/code quality MR diff - it might make the diff very noisy?

Related issues

#382360 (closed)

Author's checklist

If you are a GitLab team member and only adding documentation, do not add any of the following labels:

  • ~"frontend"
  • ~"backend"
  • ~"type::bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Reviewer's checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

If you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • Ensure a release milestone is set.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.
Edited by Kati Paizee

Merge request reports