Skip to content

Add details about how to handle all uppercase words

Marcel Amirault requested to merge docs-add-acronym-vale-rule-details into master

What does this MR do?

While reviewing a recent MR, a contributor mentioned that it wasn't clear how to handle things like protocols and other words that are all uppercase: !88873 (comment 965760013)

We've added guidelines for how to handle spelling exceptions (https://docs.gitlab.com/ee/development/documentation/testing.html#vale-spelling-test), and I think we should do the same for uppercase words/acronyms, to make it easier for our contributors to know how to handle these vale warnings.

This MR adds a new entry, following the same style as the spelling test guidelines above it, explaining how to handle vale warnings for all uppercase words/acronyms.

Related issues

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

Loading