Skip to content

Clarify notification emails docs

Marcin Sedlak-Jakubowski requested to merge msj-emails into master

What does this MR do?

In the Notification emails doc:

For SaaS:

  • Call out that the opt-out in the notifications does not opt users out of all emails. The best case is to make sure that users are clear about what this is turning on/off, and tell them how to opt-out of other emails.

For Self-Hosted

  • Say product marketing emails are turned on by default and can be disabled by the administrator.
  • The emails are generated and automatically sent by the self-hosted version and sent based on actions of the user. At no time is any personal information sent to GitLab by the tool or by the company by virtue of turning this on.
  • Make it clear that turning off these emails only turns of the automatically generated emails from the system, and it will not opt them out of all emails.

Related issues

gitlab-org/growth/team-tasks#364 (closed)

Author's checklist (required)

Do not add the feature, frontend, backend, ~"bug", or database labels if you are only updating documentation. These labels will cause the MR to be added to code verification QA issues.

When applicable:

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

For more information about labels, see Technical Writing workflows - Labels.

For suggestions that you are confident don't need to be reviewed, change them locally and push a commit directly to save others from unneeded reviews. For example:

  • Clear typos, like this is a typpo.
  • Minor issues, like single quotes instead of double quotes, Oxford commas, and periods.

For more information, see our documentation on Merging a merge request.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by Nick Gaskill

Merge request reports

Loading