Commit f39754fa authored by Victor Wu's avatar Victor Wu

Merge branch '8476-epic-notification-docs' into 'master'

Add doc for epic state change notifications

Closes #8476

See merge request gitlab-org/gitlab-ee!8528
parents a078ee4e a9a11cab
......@@ -5,6 +5,7 @@ The ability to contribute conversationally is offered throughout GitLab.
You can leave a comment in the following places:
- issues
- epics
- merge requests
- snippets
- commits
......@@ -283,7 +284,7 @@ in order to allow you to submit them all as a single action.
### Starting a review
In order to start a review, simply write a comment on a diff as normal under the **Changes** tab
In order to start a review, simply write a comment on a diff as normal under the **Changes** tab
in an MR and click on the **Start a review** button.
![Starting a review](img/mr_review_start.png)
......@@ -314,13 +315,13 @@ Review comments can also resolve/unresolve [resolvable discussions](#resolvable-
When replying to a comment, you will see a checkbox that you can click in order to resolve or unresolve
the discussion once published.
![Resolve checkbox](img/mr_review_resolve.png)
![Resolve checkbox](img/mr_review_resolve.png)
![Unresolve checkbox](img/mr_review_unresolve.png)
If a particular pending comment will resolve or unresolve the discussion, this will be shown on the pending
comment itself.
![Resolve status](img/mr_review_resolve2.png)
![Resolve status](img/mr_review_resolve2.png)
![Unresolve status](img/mr_review_unresolve2.png)
### Submitting a review
......
......@@ -71,18 +71,18 @@ Below is the table of events users can be notified of:
| Group access level changed | User | Sent when user group access level is changed |
| Project moved | Project members [1] | [1] not disabled |
### Issue / Merge request events
### Issue / Epics / Merge request events
In most of the below cases, the notification will be sent to:
- Participants:
- the author and assignee of 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 any of the comments on the issue/merge request
- anyone mentioned by `@username` in the issue/epic/merge request title or description
- anyone mentioned by `@username` in any of the comments on the issue/epic/merge request
...with notification level "Participating" or higher
- Watchers: users with notification level "Watch"
- Subscribers: anyone who manually subscribed to the issue/merge request
- Subscribers: anyone who manually subscribed to the issue/epic/merge request
- Custom: Users with notification level "custom" who turned on notifications for any of the events present in the table below
| Event | Sent to |
......@@ -106,6 +106,8 @@ In most of the below cases, the notification will be sent to:
| Failed pipeline | The author of the pipeline |
| Successful pipeline | The author of the pipeline, if they have the custom notification setting for successful pipelines set |
| New epic | |
| Close epic | |
| Reopen epic | |
In addition, if the title or description of an Issue or Merge Request is
changed, notifications will be sent to any **new** mentions by `@username` as
......
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