Skip to content

Invert the quotes to fix code quality json, make messages active

What does this MR do?

As one step on the way towards enabling code quality for docs, we need to invert the quoting in the vale rules. The JSON is generating with double quotes around the message strings, so if there are double quotes inside the messages, it breaks the JSON. Changing to single quotes in messages, and double quotes outside the strings, seems to do the trick.

This is also a good opportunity for the docs team to review all the vale rule messages. We should make sure we're happy with the language before rolling them out to a more public view in MR diffs. These messages will be seen by all docs contributors, including first time contributors, so we should ensure the language makes the needed improvements clear to everyone.

Finally, it sets the code quality warning levels, to blocker (vale errors), warning (vale warnings), and info (vale suggestions), as per this screenshot:

Screen_Shot_2022-10-23_at_23.03.40

Related issues

Related to #378718 (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 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 Marcel Amirault

Merge request reports