From c19ed72155378c7e684d771964ad027f57c4ca34 Mon Sep 17 00:00:00 2001 From: Achilleas Pipinellis Date: Tue, 12 Mar 2019 16:22:37 +0100 Subject: Merge EE docs into CE --- doc/tools/email.md | 38 ++++++++++++++++++++++++++++++++++++++ doc/tools/email1.png | Bin 0 -> 9590 bytes doc/tools/email2.png | Bin 0 -> 14902 bytes 3 files changed, 38 insertions(+) create mode 100644 doc/tools/email.md create mode 100644 doc/tools/email1.png create mode 100644 doc/tools/email2.png (limited to 'doc/tools') diff --git a/doc/tools/email.md b/doc/tools/email.md new file mode 100644 index 00000000000..ab39206ffa4 --- /dev/null +++ b/doc/tools/email.md @@ -0,0 +1,38 @@ +# Email from GitLab **[STARTER ONLY]** + +As a GitLab administrator you can email GitLab users from within GitLab. + +## Overview + +GitLab provides a simple tool to email all users or users of a chosen group or +project right from the admin area. Users will receive the email to their primary +email address. + +## Use-cases + +- Notify your users about a new project, a new feature, or a new product launch. +- Notify your users about a new deployment, or that will be downtime expected + for a particular reason. + +## Sending emails to users from within GitLab + +1. Go to the admin area using the wrench icon in the top right corner and + navigate to **Overview > Users > Send email to users**. + + ![admin users](email1.png) + +1. Compose an email and choose where it will be sent (all users or users of a + chosen group or project): + + ![compose an email](email2.png) + +## Unsubscribing from emails + +User can choose to unsubscribe from receiving emails from GitLab by following +the unsubscribe link from the email. Unsubscribing is unauthenticated in order +to keep the simplicity of this feature. + +On unsubscribe, user will receive an email notifying that unsubscribe happened. +The endpoint that provides the unsubscribe option is rate-limited. + +[ee]: https://about.gitlab.com/pricing/ diff --git a/doc/tools/email1.png b/doc/tools/email1.png new file mode 100644 index 00000000000..e79ccc3e9a9 Binary files /dev/null and b/doc/tools/email1.png differ diff --git a/doc/tools/email2.png b/doc/tools/email2.png new file mode 100644 index 00000000000..d073c0e42da Binary files /dev/null and b/doc/tools/email2.png differ -- cgit v1.2.1