feat(VoiceTone): Add doc for actions by GitLab
What does this MR do?
Add guidance for describing actions that GitLab does for the user.
There is confusion across the team, whether to use first person "we" or "GitLab" to describe actions that GitLab, the application does, for example sending a verification email. This leads to inconsistency across the UI.
Recent Slack thread (internal, 90 days retention time).
Does this MR meet the acceptance criteria?
-
The MR title and commit messages meet the Pajamas commit conventions. -
The “What does this MR do?” section in the MR description is filled out, explaining the reasons for and scope of the proposed changes, per “Say why not just what”. - For example, if the MR is focused on usage guidelines, addressing accessibility challenges could be added in a separate MR.
-
Relevant label(s) are applied to the MR. -
The MR is added to a milestone. -
If creating a new component page from scratch, it follows the page template structure. -
Content follows the Pajamas voice and tone guidelines, falling back on the GitLab Documentation Style Guide when needed. -
Related pages are cross-linked, where helpful. Component pages have related components and patterns defined in their Markdown front matter. -
If embedding a Figma file, it follows the Figma embed guide. -
Review requested from any GitLab designer or directly from a maintainer or trainee maintainer.
Links
Edited by Marcin Sedlak-Jakubowski