diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-01-21 14:21:10 +0000 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-01-21 14:21:10 +0000 |
commit | cb0d23c455b73486fd1015f8ca9479b5b7e3585d (patch) | |
tree | d7dc129a407fd74266d2dc561bebf24665197c2f /doc/user/project/service_desk.md | |
parent | c3e911be175c0aabfea1eb030f9e0ef23f5f3887 (diff) | |
download | gitlab-ce-cb0d23c455b73486fd1015f8ca9479b5b7e3585d.tar.gz |
Add latest changes from gitlab-org/gitlab@12-7-stable-ee
Diffstat (limited to 'doc/user/project/service_desk.md')
-rw-r--r-- | doc/user/project/service_desk.md | 82 |
1 files changed, 52 insertions, 30 deletions
diff --git a/doc/user/project/service_desk.md b/doc/user/project/service_desk.md index fad4af7102a..e9fce474040 100644 --- a/doc/user/project/service_desk.md +++ b/doc/user/project/service_desk.md @@ -48,43 +48,65 @@ users will only see the thread through email. ## Configuring Service Desk -> **Note:** -Service Desk is enabled on GitLab.com. If you're a -[Silver subscriber](https://about.gitlab.com/pricing/#gitlab-com), -you can skip the step 1 below; you only need to enable it per project. - -1. [Set up incoming email](../../administration/incoming_email.md#set-it-up) for the GitLab instance. This must - support [email sub-addressing](../../administration/incoming_email.md#email-sub-addressing). -1. Navigate to your project's **Settings > General** and scroll down to the **Service Desk** - section. -1. If you have the correct access and a Premium license, - you will see an option to set up Service Desk: - - ![Activate Service Desk option](img/service_desk_disabled.png) - -1. Checking that box will enable Service Desk for the project, and show a - unique email address to email issues to the project. These issues will be - [confidential](issues/confidential_issues.md), so they will only be visible to project members. - - **Warning**: this email address can be used by anyone to create an issue on - this project, whether or not they have access to your GitLab instance. - We recommend **putting this behind an alias** so that it can be changed if - needed, and **[enabling Akismet](../../integration/akismet.md)** on your GitLab instance to add spam - checking to this service. Unblocked email spam would result in many spam +NOTE: **Note:** +Service Desk is enabled on GitLab.com. If you're a [Silver subscriber](https://about.gitlab.com/pricing/#gitlab-com), +you can skip step 1 below; you only need to enable it per project. + +If you have the correct access and a Premium license, you have the option to set up Service Desk. +Follow these steps to do so: + +1. [Set up incoming email](../../administration/incoming_email.md#set-it-up) for the GitLab instance. + This must support [email sub-addressing](../../administration/incoming_email.md#email-sub-addressing). +1. Navigate to your project's **Settings > General** and locate the **Service Desk** section. +1. Enable the **Activate Service Desk** toggle. This reveals a unique email address to email issues + to the project. These issues will be [confidential](issues/confidential_issues.md), so they will + only be visible to project members. Note that in GitLab 11.7, we updated the generated email + address's format. The older format is still supported, however, allowing existing aliases or + contacts to continue working. + + DANGER: **Danger:** + This email address can be used by anyone to create an issue on this project, whether or not they + have access to your GitLab instance. We recommend **putting this behind an alias** so it can be + changed if needed, and **[enabling Akismet](../../integration/akismet.md)** on your GitLab + instance to add spam checking to this service. Unblocked email spam would result in many spam issues being created, and may disrupt your GitLab service. + If you have [templates](description_templates.md) in your repository, you can optionally select + one from the selector menu to append it to all Service Desk issues. + ![Service Desk enabled](img/service_desk_enabled.png) - _In GitLab 11.7, we updated the format of the generated email address. - However the older format is still supported, allowing existing aliases - or contacts to continue working._ +Service Desk is now enabled for this project! You should be able to access it from your project +navigation's **Issues** menu. + +![Service Desk Navigation Item](img/service_desk_nav_item.png) + +### Using customized email templates + + > [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/2460) in [GitLab Premium](https://about.gitlab.com/pricing/) 12.7. + +When a user submits a new issue using Service Desk, or when a new note is created on a Service Desk issue, an email is sent to the author. + +The body of these email messages can customized by using templates. To create a new customized template, +create a new Markdown (`.md`) file inside the `.gitlab/service_desk_templates/` +directory in your repository. Commit and push to your default branch. + +#### Thank you email -1. If you have [templates](description_templates.md) in your repository, then you can optionally - select one of these templates from the dropdown to append it to all Service Desk issues. +The **Thank you email** is the email sent to a user after they submit an issue. +The file name of the template has to be `thank_you.md`. +You can use `%{ISSUE_ID}` placeholder which will be replaced by an issue iid in the email and +`%{ISSUE_PATH}` placeholder which will be replaced by project path and the issue iid. +As the service desk issues are created as confidential (only project members can see them) +the response email doesn't provide the issue link. -1. Service Desk is now enabled for this project! You should be able to access it from your project's navigation **Issue submenu**: +#### New note email - ![Service Desk Navigation Item](img/service_desk_nav_item.png) +The **New note email** is the email sent to a user when the issue they submitted has a new comment. +The file name of the template has to be `new_note.md`. +You can use `%{ISSUE_ID}` placeholder which will be replaced by an issue iid +in the email, `%{ISSUE_PATH}` placeholder which will be replaced by + project path and the issue iid and `%{NOTE_TEXT}` placeholder which will be replaced by the note text. ## Using Service Desk |