Add at-mention to word list
What does this MR do?
I propose to add @mention to the A-Z word list.
In our docs, we've have a mix of formatting it with code formatting
and as regular word.
Google style guide advises to avoid using code-formatted words like real words (ref):
Not recommended: Retrieve information by
GET
ting the data.
As we use @mention as a verb, and so, will sometimes conjugate it, let's drop the code formatting.
Neither Google or Microsoft style guides describe @mention usage specifically.
Links:
- Here MSFT Support uses it like a regular word: https://support.microsoft.com/en-us/office/use-mentions-to-get-someone-s-attention-90701709-5dc1-41c7-aa48-b01d4a46e8c7.
- This Wikipedia page also doesn't use any special formatting: https://en.wikipedia.org/wiki/Mention_(blogging)#@_(at_sign)
Related issues
Author's checklist
-
Follow the: -
Ensure that the product tier badge is added to topic's h1
. -
Request a review based on the: - The documentation page's metadata.
- The associated Technical Writer.
If you are only adding documentation, do not add any of the following labels:
~"feature"
~"frontend"
~"backend"
~"bug"
~"database"
These labels cause the MR to be added to code verification QA issues.
Review 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. - 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 likeDefault behavior when you close an issue
. -
The headings (other than the page title) should be active. Instead of Configuring GDK
, say something likeConfigure 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 above reviews. Maintainer's review can occur before or after a technical writer review. -
Ensure a release milestone is set.