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 GETting 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:
  • Documentation Guidelines.
  • Style Guide.
• 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 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 above reviews. Maintainer's review can occur before or after a technical writer review.
• Ensure a release milestone is set.

changed milestone to %14.2

added Technical Writing docsnon-content documentation tw-style twdoing labels

assigned to @msedlakjakubowski

	1 Warning
	90bc3e40: Commits that change 30 or more lines across at least 3 files should describe these changes in the commit body. For more information, take a look at our Commit message guidelines.

	1 Message
	This merge request adds or changes documentation files. A review from the Technical Writing team before you merge is recommended. Reviews can happen after you merge.

Documentation review

The following files require a review from a technical writer:

• doc/development/cicd/templates.md
• doc/development/contributing/index.md
• doc/development/documentation/styleguide/word_list.md
• doc/user/profile/notifications.md
• doc/user/project/issues/issue_data_and_actions.md
• doc/user/todos.md

The review does not need to block merging this merge request. See the:

• Metadata for the *.md files that you've changed. The first few lines of each *.md file identify the stage and group most closely associated with your docs change.
• The Technical Writer assigned for that stage and group.
• Documentation workflows for information on when to assign a merge request for review.

If needed, you can retry the danger-review job that generated this comment.

Generated by Danger

changed title from Add @mention to word list to Add @mention to word list

changed title from Add @mention to word list to Add {++}@mention{++} to word list

changed title from Add {-@-}mention{--} to word list to Add at-mention to word list

@gl-docsteam This is a proposal to add @mention to the word list. WDYT?

@dianalogan I'm assigning you as the DRI reviewer for when you're back.

requested review from @dianalogan

@msedlakjakubowski Nice catch. Related to the page we added to the training about not "verbing" command words, like "GETting".

added tw-testing label

approved this merge request

@axil, thanks for approving this merge request.

This is the first time the merge request is approved. To ensure full test coverage, a new pipeline has been started.

For more info, please refer to the following links:

• rspec minimal jobs
• merging a merge request.

@msedlakjakubowski You are a brave person for opening this MR, and I wish you the best in getting it merged. Please let me know if there's anything I can do to help.

Thanks a lot for the feedback y'all!

I'll address the various points here altogether.

@sselhorn

Can you clarify what "write together" means? I wasn't quite sure.

I meant write the @ and mention as one word, as opposed to separated by a space.

Does "spell out @" mean "spell out at"?

Yes

Is there a reason to not use backticks?

In my proposal, I wanted to drop the backticks so we can permanently make @mention a verb, like the sources I pointed to.

@sselhorn @marcel.amirault @eread I'm fine with switching to saying just "mention". I think it would be fine to include the links for now, at least first occurrence per page, pointing at https://docs.gitlab.com/ee/user/project/issues/issue_data_and_actions.html#mentions. In the future, when I finally delete the page*, we could maybe create a separate little page for this, because it's not issue-exclusive.

*Apologies I still haven't done this, but things of higher priority has always bubbled up.

added 478 commits

• 5a3ba17d...4991cc1d - 476 commits from branch master
• ffa07f04 - Add @mention to word list
• 90bc3e40 - Say "mention" instead of @ mention

Compare with previous version

added 1 commit

• be8b62f1 - Remove at mention from spelling exceptions

Compare with previous version

approved this merge request

approved this merge request

changed milestone to %14.3

added 1 commit

• 8f007fef - Apply 1 suggestion(s) to 1 file(s)

Compare with previous version

@dianalogan This should be ready for you.

Looks good, thanks @msedlakjakubowski

resolved all threads

merged

mentioned in commit 0b940939

added workflowstaging label

added workflowcanary label and removed workflowstaging label

added workflowproduction label and removed workflowcanary label

added releasedcandidate label

added releasedpublished label and removed releasedcandidate label

added tw-weight3 label

added typemaintenance label