Commit 908a1957 authored by Achilleas Pipinellis's avatar Achilleas Pipinellis

Merge branch 'docs/fix-notifications-topic' into 'master'

Fix structure and add  notification level

See merge request gitlab-org/gitlab-ce!22528
parents bbe25533 746d7730
...@@ -10,31 +10,32 @@ You can find notification settings under the user profile. ...@@ -10,31 +10,32 @@ You can find notification settings under the user profile.
Notification settings are divided into three groups: Notification settings are divided into three groups:
* Global Settings - Global settings
* Group Settings - Group settings
* Project Settings - Project settings
Each of these settings have levels of notification: Each of these settings have levels of notification:
* Disabled - turns off notifications - Watch: Receive notifications for any activity.
* Participating - receive notifications from related resources - On Mention: Receive notifications when `@mentioned` in comments.
* Watch - receive notifications from projects or groups user is a member of - Participate: Receive notifications for threads you have participated in.
* Global - notifications as set at the global settings - Disabled: Turns off notifications.
* Custom - user will receive notifications when mentioned, is participant and custom selected events. - Custom: Receive notifications for custom selected events.
- Global: For groups and projects, notifications as per global settings.
#### Global Settings ### Global Settings
Global Settings are at the bottom of the hierarchy. Global settings are at the bottom of the hierarchy.
Any setting set here will be overridden by a setting at the group or a project level. Any setting set here will be overridden by a setting at the group or a project level.
Group or Project settings can use `global` notification setting which will then use Group or Project settings can use `global` notification setting which will then use
anything that is set at Global Settings. anything that is set at Global Settings.
#### Group Settings ### Group Settings
![notification settings](img/notification_group_settings.png) ![notification settings](img/notification_group_settings.png)
Group Settings are taking precedence over Global Settings but are on a level below Project or Subgroup Settings: Group settings are taking precedence over Global Settings but are on a level below Project or Subgroup settings:
``` ```
Group < Subgroup < Project Group < Subgroup < Project
...@@ -46,11 +47,11 @@ Organization like this is suitable for users that belong to different groups but ...@@ -46,11 +47,11 @@ Organization like this is suitable for users that belong to different groups but
same need for being notified for every group they are member of. same need for being notified for every group they are member of.
These settings can be configured on group page under the name of the group. It will be the dropdown with the bell icon. They can also be configured on the user profile notifications dropdown. These settings can be configured on group page under the name of the group. It will be the dropdown with the bell icon. They can also be configured on the user profile notifications dropdown.
#### Project Settings ### Project Settings
![notification settings](img/notification_project_settings.png) ![notification settings](img/notification_project_settings.png)
Project Settings are at the top level and any setting placed at this level will take precedence of any Project settings are at the top level and any setting placed at this level will take precedence of any
other setting. other setting.
This is suitable for users that have different needs for notifications per project basis. This is suitable for users that have different needs for notifications per project basis.
These settings can be configured on project page under the name of the project. It will be the dropdown with the bell icon. They can also be configured on the user profile notifications dropdown. These settings can be configured on project page under the name of the project. It will be the dropdown with the bell icon. They can also be configured on the user profile notifications dropdown.
...@@ -73,11 +74,12 @@ Below is the table of events users can be notified of: ...@@ -73,11 +74,12 @@ Below is the table of events users can be notified of:
### Issue / Merge request events ### Issue / Merge request events
In most of the below cases, the notification will be sent to: In most of the below cases, the notification will be sent to:
- Participants: - Participants:
- the author and assignee of the issue/merge request - the author and assignee of the issue/merge request
- authors of comments on the issue/merge request - authors of comments on the issue/merge request
- anyone mentioned by `@username` in the issue/merge request title or description - anyone mentioned by `@username` in the issue/merge request title or description
- anyone mentioned by `@username` in any of the comments on the issue/merge request - anyone mentioned by `@username` in any of the comments on the issue/merge request
...with notification level "Participating" or higher ...with notification level "Participating" or higher
- Watchers: users with notification level "Watch" - Watchers: users with notification level "Watch"
- Subscribers: anyone who manually subscribed to the issue/merge request - Subscribers: anyone who manually subscribed to the issue/merge request
...@@ -129,16 +131,19 @@ Notification emails include headers that provide extra content about the notific ...@@ -129,16 +131,19 @@ Notification emails include headers that provide extra content about the notific
| X-GitLab-NotificationReason | The reason for being notified. "mentioned", "assigned", etc | | X-GitLab-NotificationReason | The reason for being notified. "mentioned", "assigned", etc |
#### X-GitLab-NotificationReason #### X-GitLab-NotificationReason
This header holds the reason for the notification to have been sent out, This header holds the reason for the notification to have been sent out,
where reason can be `mentioned`, `assigned`, `own_activity`, etc. where reason can be `mentioned`, `assigned`, `own_activity`, etc.
Only one reason is sent out according to its priority: Only one reason is sent out according to its priority:
- `own_activity` - `own_activity`
- `assigned` - `assigned`
- `mentioned` - `mentioned`
The reason in this header will also be shown in the footer of the notification email. For example an email with the The reason in this header will also be shown in the footer of the notification email. For example an email with the
reason `assigned` will have this sentence in the footer: reason `assigned` will have this sentence in the footer:
`"You are receiving this email because you have been assigned an item on {configured GitLab hostname}"` `"You are receiving this email because you have been assigned an item on {configured GitLab hostname}"`
**Note: Only reasons listed above have been implemented so far** NOTE: **Note:**
Further implementation is [being discussed here](https://gitlab.com/gitlab-org/gitlab-ce/issues/42062) Only reasons listed above have been implemented so far.
Further implementation is [being discussed](https://gitlab.com/gitlab-org/gitlab-ce/issues/42062).
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment