diff options
author | Achilleas Pipinellis <axil@gitlab.com> | 2018-12-20 00:04:07 +0300 |
---|---|---|
committer | Achilleas Pipinellis <axil@gitlab.com> | 2018-12-20 00:04:07 +0300 |
commit | baad9fb8b90764e80ddda3a61873582ad7452aec (patch) | |
tree | 237703b7b7dfb4a22eba668cfa18bd0dbf5c34ad | |
parent | 7b0c5319d24c7fe0a9a2f2ff5e2409c4b2eb6604 (diff) | |
parent | d3b14e9d87cb81262a02d9367a344fcc34deeb96 (diff) |
Merge branch '45552-abuse-reports-functionality-is-undocumented' into 'master'
CE: Document the "Abuse reports" feature
Closes #45552
See merge request gitlab-org/gitlab-ce!22932
-rw-r--r-- | doc/administration/index.md | 1 | ||||
-rw-r--r-- | doc/user/abuse_reports.md | 53 | ||||
-rw-r--r-- | doc/user/admin_area/abuse_reports.md | 31 | ||||
-rw-r--r-- | doc/user/admin_area/img/abuse_report_blocked_user.png | bin | 0 -> 13821 bytes | |||
-rw-r--r-- | doc/user/admin_area/img/abuse_reports_page.png | bin | 0 -> 215813 bytes | |||
-rw-r--r-- | doc/user/index.md | 1 | ||||
-rw-r--r-- | doc/user/profile/account/delete_account.md | 3 |
7 files changed, 87 insertions, 2 deletions
diff --git a/doc/administration/index.md b/doc/administration/index.md index 6083806af6c..89132cd95f0 100644 --- a/doc/administration/index.md +++ b/doc/administration/index.md @@ -95,6 +95,7 @@ created in snippets, wikis, and repos. - [Postfix for incoming email](reply_by_email_postfix_setup.md): Set up a basic Postfix mail server with IMAP authentication on Ubuntu for incoming emails. +- [Abuse reports](../user/admin_area/abuse_reports.md): View and resolve abuse reports from your users. [reply by email]: reply_by_email.md [issues by email]: ../user/project/issues/create_new_issue.md#new-issue-via-email diff --git a/doc/user/abuse_reports.md b/doc/user/abuse_reports.md new file mode 100644 index 00000000000..1f4f598b121 --- /dev/null +++ b/doc/user/abuse_reports.md @@ -0,0 +1,53 @@ +# Abuse reports + +Report abuse from users to GitLab administrators. + +You can report a user through their: + +- [Profile](#reporting-abuse-through-a-users-profile) +- [Comments](#reporting-abuse-through-a-users-comment) +- [Issues and Merge requests](#reporting-abuse-through-a-users-issue-or-merge-request) + +## Reporting abuse through a user's profile + +To report abuse from a user's profile page: + +1. Click on the exclamation point report abuse button at the top right of the user's profile. +1. Complete an abuse report. +1. Click the **Send report** button. + +## Reporting abuse through a user's comment + +To report abuse from a user's comment: + +1. Click on the vertical ellipsis (⋮) more actions button to open the dropdown. +1. Select **Report as abuse**. +1. Complete an abuse report. +1. Click the **Send report** button. + + +NOTE: **Note:** +A URL to the reported user's comment will be +pre-filled in the abuse report's **Message** field. + +## Reporting abuse through a user's issue or merge request + +The **Report abuse** button is displayed at the top right of the issue or merge request: + +- When **Report abuse** is selected from the menu that appears when the **Close issue** or **Close merge request** button is clicked, for users that have permission to close the issue or merge request. +- When viewing the issue or merge request, for users that don't have permission to close the issue or merge request. + +With the **Report abuse** button displayed, to submit an abuse report: + +1. Click the **Report abuse** button. +1. Submit an abuse report. +1. Click the **Send report** button. + +NOTE: **Note:** +A URL to the reported user's issue or merge request will be pre-filled +in the abuse report's **Message** field. + +## Managing abuse reports + +Admins are able to view and resolve abuse reports. +For more information, see [abuse reports administration documentation](admin_area/abuse_reports.md). diff --git a/doc/user/admin_area/abuse_reports.md b/doc/user/admin_area/abuse_reports.md new file mode 100644 index 00000000000..01c2d9607f5 --- /dev/null +++ b/doc/user/admin_area/abuse_reports.md @@ -0,0 +1,31 @@ +# Abuse reports + +View and resolve abuse reports from GitLab users. + +Admins can view abuse reports in the admin area and are able to +resolve the reports by removing the reported user, blocking the reported user, or removing the report. + +## Reporting abuse + +To find out more about reporting abuse, see [abuse reports user documentation](../abuse_reports.md). + +## Resolving abuse reports + +To access abuse reports, go to **Admin area > Abuse Reports**. + +There are 3 ways to resolve an abuse report, with a button for each method: + +- Remove user & report: [Deletes the reported user](../profile/account/delete_account.md) from the instance and removes the abuse report from the list. +- Block user: Blocks the reported user from the instance and does not remove the abuse report from the list. +- Remove report: Removes the abuse report from the list and does not restrict the access for the reported user. + +![abuse-reports-page-image](img/abuse_reports_page.png) + +## Blocked users + +Blocking a user will not remove the abuse report from the list. + +Instead, the block button will be disabled and explain that the user is "Already blocked". +You are still able to remove the user and/or report if necessary. + +![abuse-report-blocked-user-image](img/abuse_report_blocked_user.png) diff --git a/doc/user/admin_area/img/abuse_report_blocked_user.png b/doc/user/admin_area/img/abuse_report_blocked_user.png Binary files differnew file mode 100644 index 00000000000..0cb4c7bb8ac --- /dev/null +++ b/doc/user/admin_area/img/abuse_report_blocked_user.png diff --git a/doc/user/admin_area/img/abuse_reports_page.png b/doc/user/admin_area/img/abuse_reports_page.png Binary files differnew file mode 100644 index 00000000000..81dbe976cda --- /dev/null +++ b/doc/user/admin_area/img/abuse_reports_page.png diff --git a/doc/user/index.md b/doc/user/index.md index 08995032cb1..fc68404d0c2 100644 --- a/doc/user/index.md +++ b/doc/user/index.md @@ -113,6 +113,7 @@ methods available in GitLab. user type (guest, reporter, developer, maintainer, owner). - [Feature highlight](feature_highlight.md): Learn more about the little blue dots around the app that explain certain features +- [Abuse reports](abuse_reports.md): Report abuse from users to GitLab administrators ## Groups diff --git a/doc/user/profile/account/delete_account.md b/doc/user/profile/account/delete_account.md index 49f0ce2cd79..b497cc414af 100644 --- a/doc/user/profile/account/delete_account.md +++ b/doc/user/profile/account/delete_account.md @@ -25,7 +25,7 @@ Here's a list of things that will not be deleted: Instead of being deleted, these records will be moved to a system-wide "Ghost User", whose sole purpose is to act as a container for such records. -When a user is deleted from an abuse report or spam log, these associated +When a user is deleted from an [abuse report](../../admin_area/abuse_reports.md) or spam log, these associated records are not ghosted and will be removed, along with any groups the user is a sole owner of. Administrators can also request this behaviour when deleting users from the [API](../../../api/users.md#user-deletion) or the @@ -35,4 +35,3 @@ admin area. [ce-10273]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/10273 [ce-10467]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/10467 [ce-11853]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/11853 - |