Add report documentation, remove existing docs.

environments/review-docs-overh-oprtmo/deployments/9239
Ciaran Ainsworth 2022-01-20 10:43:38 +01:00 zatwierdzone przez Ciarán Ainsworth
rodzic c2756ad35c
commit 12910d7649
13 zmienionych plików z 319 dodań i 328 usunięć

Wyświetl plik

@ -44,7 +44,8 @@ caption: Moderator documentation
hidden: true
---
moderator/index
moderator_documentation/index
moderator_documentation/reports/index
```
@ -127,6 +128,20 @@ Want to host your own Funkwhale pod? Our admin documentation guides you through
---
{fa}`shield` Moderators
^^^^^^^^^^^^^^^^^^
Keeping your users safe from harassment and spam or clearing illegal content? Check out our moderator docs.
+++
```{link-button} moderator_documentation/index
:type: ref
:text: Get started
:classes: btn-outline-primary btn-block stretched-link
---
{fa}`code` Developers
^^^^^^^^^^^^^^^^^
@ -140,6 +155,7 @@ Want to use Funkwhale's API or help with the project? Our developer docs give yo
:classes: btn-outline-primary btn-block stretched-link
---
:column: col-lg-12 p-2
{fa}`users` Contributors
^^^^^^^^^^^^^^^^^^

Wyświetl plik

@ -1,91 +0,0 @@
Moderating Domains
==================
Moderation rules can be used to control how your instance interacts with other domains.
They can be useful for keeping unwanted material and users out of your instance.
Managing Domains
----------------
Add a Domain
^^^^^^^^^^^^
Adding a domain allows you to create rules pre-emptively and proactively moderate content on your
instance. Domains with which users have already interacted will appear in the domains list.
To add a new domain:
- Navigate to the "Moderation" menu under "Administration"
- Select "Domains" along the top
- In the top right, enter the URL of the domain you want to federate with in the "Add a domain" box and click "Add"
- You will then be taken to an overview page showing details about the instance
Purge Domain Data
^^^^^^^^^^^^^^^^^
.. warning::
Purging domain data will remove all tracks, libraries, and caches associated with
the domain. This can have severe knock-on effects for users who have any of these
in their favorites, playlists, or followed libraries. Be careful when performing
this action.
Purging data from a domain can be useful if a domain is uploading offensive or illegal
media you do not want served on your instance.
- Navigate to the "Moderation" menu under "Administration"
- Select "Domains" along the top
- Find the domain whose data you wish to purge and select the checkbox next to it
- Select "Purge" from the "Actions" drop-down menu and click on "Go"
- A pop up will appear warning you of the consequences. If you want to continue with the purge, click "Launch"
Moderation Rules
----------------
Add a Moderation Rule to a Domain
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Moderation rules can be useful for managing interaction with domains.
To add a moderation rule:
- Navigate to the "Moderation" menu under "Administration"
- Select "Domains" along the top
- Find the domain you wish to add a rule to and click on it
- In the top right, select "Add a moderation policy"
- Give a reason for your rule creation in the "Reason" box. This can help other moderators understand the action
- To block all interaction with the domain **and purge all content**, select "Block Everything"
- To only block media elements such as audio, avatars, and album art, select "Reject Media"
- When you have finished creating your rule, click "Create" to save the rule
Edit a Moderation Rule
^^^^^^^^^^^^^^^^^^^^^^
Sometimes a previously created moderation rule needs to be updated to lessen or increase
its severity.
To update an existing moderation rule:
- Navigate to the "Moderation" menu under "Administration"
- Select "Domains" along the top
- Find the domain whose rule you wish to edit and click on it
- In the top right, select "Update" under your existing rule
- Update the reason for your rule creation in the "Reason" box. This can help other moderators understand the action
- To block all interaction with the domain **and purge all content**, select "Block Everything"
- To only block media elements such as audio, avatars, and album art, select "Reject Media"
- When you have finished editing your rule, click "Create" to save the rule
Remove a Moderation Rule From a Domain
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If a domain is no longer subject to moderation, you can remove existing rules to enable
full federation with the instance again.
To remove a moderation rule from a domain:
- Navigate to the "Moderation" menu under "Administration"
- Select "Domains" along the top
- Find the domain you wish to remove a rule from and click on it
- In the top right, select "Update" under your existing rule
- Click on "Delete"
- A pop up will appear warning that the action is irreversible. If you want to continue, select "Delete moderation rule"

Wyświetl plik

@ -1,16 +0,0 @@
Moderator Documentation
=========================
This documentation is targeted at instance moderators. Moderators have enhanced permissions
which allow them to handle reports and moderate federated accounts and domains.
Moderation Guides
-----------------
.. toctree::
:maxdepth: 2
reports
domains
users
listing

Wyświetl plik

@ -1,94 +0,0 @@
Allow-Listing
=============
The Allow-Listing feature grants pod moderators
and administrators greater control over federation
by allowing you to create a pod-wide allow-list.
When allow-listing is enabled, your pod's users will only
be able to interact with pods included in the allow-list.
Any messages, activity, uploads, or modifications to
libraries and playlists will only be shared with pods
on the allow-list. Pods which are not included in the
allow-list will not have access to your pod's content
or messages and will not be able to send anything to
your pod.
Enabling Allow-Listing
----------------------
.. warning::
If your pod is already federating proceed with caution.
Enabling the Allow-Listing feature will initially block
all activity from external domains as the list will be
empty
To enable allow-listing:
- Navigate to the "Settings" menu
- Go to the "Moderation" section
- Toggle the "Enable allow-listing" radio button
- Click "Save" to commit the change
Once enabled, you can start adding domains to your
allow-list.
Adding/Removing Domains
-----------------------
Add a New Domain
^^^^^^^^^^^^^^^^
- Navigate to the "Moderation" menu. Any domains currently
in the allow-list will be visible here with a green check
mark next to their name. Other pods with which you have previously
interacted will also be visible here
- Type the domain name of the pod you wish to allow into
the "Add a Domain" input box in the top-right of the screen
- Tick the "Add to allow-list" tickbox
- Click "Add" to add the domain
Add a Known Domain
^^^^^^^^^^^^^^^^^^
- Navigate to the "Moderation" menu. Any domains currently
in the allow-list will be visible here with a green check
mark next to their name. Other pods with which you have previously
interacted will also be visible here
- Click on the tickbox next to the domain(s) you wish to add to
the allow-list
- Select "Add to allow-list" from the drop-down menu titled "Actions"
and click "Go" to add the domain(s)
Remove a Domain
^^^^^^^^^^^^^^^
To remove a domain from the allow-list:
- Navigate to the "Moderation" menu. Any domains currently
in the allow-list will be visible here with a green check
mark next to their name. Other pods with which you have previously
interacted will also be visible here
- Click on the tickbox next to the domain(s) you wish to remove
from the allow-list
- Select "Remove from allow-list" from the drop-down menu titled
"Actions" and click "Go" to remove the domain(s)
Purging Existing Content
------------------------
Moderators can add and remove domains at any time, and removing
a domain from the allow-list will effectively block all future
content from being received on your pod. Previously received
messages and content from pods not on the allow-list will remain
until you purge it from your pod. To do this:
- Navigate to the "Moderation" menu. Any domains currently
in the allow-list will be visible here with a green check
mark next to their name. Other pods with which you have
previously interacted will also be visible here
- Click on the tickbox next to the domain(s) you wish to purge
received messages from
- Select "Purge" from the drop-down menu titled "Actions"
and click "Go" to purge the messages

Wyświetl plik

@ -1,44 +0,0 @@
Handling user reports
=====================
:doc:`Users can submit reports </users/reports>` in various places. When they do so,
their report ends up in a moderation queue until it is reviewed and resolved by a moderator.
View unresolved reports
-----------------------
Assuming you have the moderation permission, you'll find a "Moderation" link in the sidebar.
Clicking on this link will bring you to the list of unresolved reports. For convenience,
the number of unresolved reports (if any) is also displayed directly next to this link, and updated in real time
when new reports are submitted.
E-mail notifications
-------------------
In addition to the web UI, all moderators will receive a notification e-mail whenever a report is
submitted or resolved providing your pod has a valid e-mail sending configuration.
This notification will include a link to review and handle the report, as well as additional
information about the report itself.
Handling reports
----------------
When viewing the moderation queue, you will be presented with the list of unresolved reports.
Each report in the queue should include all the information you need to handle it, in particular:
- Who submitted the report (or the e-mail adress of the submitter if it's an accountless report)
- The report content
- A link to the reported object, and a copy of this object data at the time the report was submitted
When you mark a report as resolved, the report will simply be removed from the queue, and you can proceed to the next one.
Doing so will also assign the report to you, so other moderators can see who handled a given report.
Internal Notes
--------------
Whenever you need to perform an action because of a report, you can use the included form to leave a note to other moderators, or even yourself, for reference.
These notes are viewable by instance admins and moderators only.

Wyświetl plik

@ -1,82 +0,0 @@
Moderating Users
==================
Moderation rules can be used to control how your instance interacts with accounts on other domains.
They can be useful for keeping unwanted material and users out of your instance.
Managing Accounts
-----------------
Purge Account Data
^^^^^^^^^^^^^^^^^^
.. warning::
Purging account data will remove all tracks, libraries, and caches associated with
the account. This can have severe knock-on effects for users who have any of these
in their favorites, playlists, or followed libraries. Be careful when performing
this action.
Purging data from an account can be useful if the account is uploading offensive or illegal
media you do not want served on your instance.
- Navigate to the "Moderation" menu under "Administration"
- Select "Accounts" along the top
- Find the account whose data you wish to purge and select the checkbox next to it
- Select "Purge" from the "Actions" drop-down menu and click on "Go"
- A pop up will appear warning you of the consequences. If you want to continue with the purge, click "Launch"
Moderation Rules
----------------
Add a Moderation Rule to an Account
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. note::
Moderation rules only apply to accounts on other instances
Moderation rules can be useful for managing interaction with Accounts.
To add a moderation rule:
- Navigate to the "Moderation" menu under "Administration"
- Select "Accounts" along the top
- Find the Account you wish to add a rule to and click on it
- In the top right, select "Add a moderation policy"
- Give a reason for your rule creation in the "Reason" box. This can help other moderators understand the action
- To block all interaction with the account **and purge all content**, select "Block Everything"
- To only block media elements such as audio, avatars, and album art, select "Reject Media"
- When you have finished creating your rule, click "Create" to save the rule
Edit a Moderation Rule
^^^^^^^^^^^^^^^^^^^^^^
Sometimes a previously created moderation rule needs to be updated to lessen or increase
its severity.
To update an existing moderation rule:
- Navigate to the "Moderation" menu under "Administration"
- Select "Accounts" along the top
- Find the account whose rule you wish to edit
- In the top right, select "Update" under your existing rule
- Update the reason for your rule creation in the "Reason" box. This can help other moderators understand the action
- To block all interaction with the account **and purge all content**, select "Block Everything"
- To only block media elements such as audio, avatars, and album art, select "Reject Media"
- When you have finished editing your rule, click "Create" to save the rule
Remove a Moderation Rule From an Account
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If an account is no longer subject to moderation, you can remove existing rules to enable
full federation with the instance again.
To remove a moderation rule from an Account:
- Navigate to the "Moderation" menu under "Administration"
- Select "Accounts" along the top
- Find the account you wish to remove a rule from and click on it
- In the top right, select "Update" under your existing rule
- Click on "Delete"
- A pop up will appear warning that the action is irreversible. If you want to continue, select "Delete moderation rule"

Wyświetl plik

@ -0,0 +1,11 @@
# Get started
{term}`Pod` moderators are responsible for . Follow the guides in our moderator documentation to handle moderation tasks.
```{contents}
:local:
```
## Handle user reports
One of the most important duties of a moderator is handling reports. If a user finds content that violates your pod's rules or the law, they can report it. Users can also report other users if they have broken the rules of your pod. Follow the guides in the [Reports](reports/index.md) section to learn how to handle these reports.

Wyświetl plik

@ -0,0 +1,79 @@
# Handle reported content
```{warning}
Deleting reported objects is irreversible. This action deletes the associated files from the pod.
```
You can handle content reports from the {guilabel}`Reports` page or from the reported object's moderation page. You only need to open the moderation page to edit objects.
```{contents}
:local:
```
## Handle reports from the Reports page
To handle a content report from the {guilabel}`Reports` page:
```{tabbed} Desktop
1. Log in to your {term}`pod`.
2. Select the wrench icon ({fa}`wrench`) at the top of the sidebar to open the {guilabel}`Administration` menu.
3. Select {guilabel}`Moderation`. The {guilabel}`Reports` page opens.
4. [Search for the report](search_reports.md).
5. Select an action from the {guilabel}`Actions` section:
- {guilabel}`Resolve` – resolve the report with no further action.
- {guilabel}`Delete reported object` – delete the object associated with the report. If you delete an artist or album, this deletes all files associated with the object.
```
```{tabbed} Mobile
1. Log in to your {term}`pod`.
2. Select the wrench icon ({fa}`wrench`) at the top of the screen to open the {guilabel}`Administration` menu.
3. Select {guilabel}`Moderation`. The {guilabel}`Reports` page opens.
4. [Search for the report](search_reports.md).
5. Select an action from the {guilabel}`Actions` section:
- {guilabel}`Resolve` – resolve the report with no further action.
- {guilabel}`Delete reported object` – delete the object associated with the report. If you delete an artist or album, this deletes all files associated with the object.
```
Resolving the report assigns it to you so other moderators know who handled the report. Add [internal notes](internal_notes.md) to keep a record of your changes.
## Edit content in the moderation page
If you want to edit an object to change its metadata:
```{tabbed} Desktop
1. Log in to your {term}`pod`.
2. Select the wrench icon ({fa}`wrench`) at the top of the sidebar to open the {guilabel}`Administration` menu.
3. Select {guilabel}`Moderation`. The {guilabel}`Reports` page opens.
4. [Search for the report](search_reports.md).
5. Select {guilabel}`Open in moderation interface` in the {guilabel}`Reported object` section. The object's moderation page opens.
6. Select {guilabel}`Edit`. The {guilabel}`Edit` page opens.
7. Edit the details on this page. Leave a {guilabel}`Summary` of your changes for reference.
8. Select {guilabel}`Submit and apply edit`.
9. Return to the {guilabel}`Reports` page.
10. Search for the report.
11. Select {guilabel}`Resolve` in the {guilabel}`Actions` section.
```
```{tabbed} Mobile
1. Log in to your {term}`pod`.
2. Select the wrench icon ({fa}`wrench`) at the top of the screen to open the {guilabel}`Administration` menu.
3. Select {guilabel}`Moderation`. The {guilabel}`Reports` page opens.
4. [Search for the report](search_reports.md).
5. Select {guilabel}`Open in moderation interface` in the {guilabel}`Reported object` section. The object's moderation page opens.
6. Select {guilabel}`Edit`. The {guilabel}`Edit` page opens.
7. Edit the details on this page. Leave a {guilabel}`Summary` of your changes for reference.
8. Select {guilabel}`Submit and apply edit`.
9. Return to the {guilabel}`Reports` page.
10. Search for the report.
11. Select {guilabel}`Resolve` in the {guilabel}`Actions` section.
```
Resolving the report assigns it to you so other moderators know who handled the report. Add [internal notes](internal_notes.md) to keep a record of your changes.

Wyświetl plik

@ -0,0 +1,29 @@
# Handle reported users
If a user has reported another user on your pod, you need to open the reported user's moderation page. To do this:
```{tabbed} Desktop
1. Log in to your {term}`pod`.
2. Select the wrench icon ({fa}`wrench`) at the top of the sidebar to open the {guilabel}`Administration` menu.
3. Select {guilabel}`Moderation`. The {guilabel}`Reports` page opens.
4. [Search for the report](search_reports.md) and select {guilabel}`Open in moderation interface` under {guilabel}`Reported object`. The user's moderation page opens.
```
```{tabbed} Mobile
1. Log in to your {term}`pod`.
2. Select the wrench icon ({fa}`wrench`) at the top of the page to open the {guilabel}`Administration` menu.
3. Select {guilabel}`Moderation`. The {guilabel}`Reports` page opens.
4. [Search for the report](search_reports.md) and select {guilabel}`Open in moderation interface` under {guilabel}`Reported object`. The user's moderation page opens.
```
You can change the following settings in the moderation interface:
- {guilabel}`Login status` – disable this switch to prevent the user being able to log in.
- {guilabel}`Permissions` – add or remove permissions associated with the user.
- {guilabel}`Upload quota` – change the amount of data (in megabytes) that the user can upload.
Once you have made your changes, return to the {guilabel}`Reports` page and {guilabel}`Resolve` the report. Resolving the report assigns it to you so other moderators know who handled the report. Add [internal notes](internal_notes.md) to keep a record of your changes.

Wyświetl plik

@ -0,0 +1,41 @@
# Reports
As a Funkwhale moderator, you have extra permissions. These permissions enable you to handle reports submitted by users and anonymous browsers.
When a user submits a report it ends up in the moderation queue on the {guilabel}`Reports` page. Moderators can use the tools on this page to handle the report.
Each report contains information that can help you handle the reported object:
- The user who submitted the report.
- The report {guilabel}`Category`. You can change this if it is not correct.
- The date the user submitted the report.
- The message the user posted with the report (if applicable).
- The {guilabel}`Status` of the report.
- Any {guilabel}`Internal notes` left by moderators.
- A summary of the {guilabel}`Reported object`.
- A list of available {guilabel}`Actions`.
Follow the guides in this section to start handling reports submitted to your {term}`pod`.
```{toctree}
---
caption: Use the reports page
maxdepth: 1
---
view_reports
search_reports
internal_notes
```
```{toctree}
---
caption: Handle reports
maxdepth: 1
---
handle_content
handle_users
```

Wyświetl plik

@ -0,0 +1,59 @@
# Use internal notes
Use internal notes to add information to a report. This can be a summary of your actions or an update on your investigation. Internal notes are only visible to pod admins and moderators.
## Add notes to a report
You can add notes to __Unresolved__ and __Resolved__ reports. To add an internal note:
```{tabbed} Desktop
1. Log in to your {term}`pod`.
2. Select the wrench icon ({fa}`wrench`) at the top of the sidebar to open the {guilabel}`Administration` menu.
3. Select {guilabel}`Moderation`. The {guilabel}`Reports` page opens.
4. [Search for the report](search_reports.md).
5. {guilabel}`Write` your note in the {guilabel}`Internal notes` section. This input field supports Markdown syntax. You can {guilabel}`Preview` how the note will look to other users.
6. Select {guilabel}`Add note` to save your note.
```
```{tabbed} Mobile
1. Log in to your {term}`pod`.
2. Select the wrench icon ({fa}`wrench`) at the top of the screen to open the {guilabel}`Administration` menu.
3. Select {guilabel}`Moderation`. The {guilabel}`Reports` page opens.
4. [Search for the report](search_reports.md).
5. {guilabel}`Write` your note in the {guilabel}`Internal notes` section. This input field supports Markdown syntax. You can {guilabel}`Preview` how the note will look to other users.
6. Select {guilabel}`Add note` to save your note.
```
## Delete notes from a report
```{warning}
Deleting an internal note is irreversible. Make sure you are not deleting anything important.
```
You can delete your own notes and the notes of other moderators. You can do this for both __Resolved__ and __Unresolved__ reports. To delete an internal note:
```{tabbed} Desktop
1. Log in to your {term}`pod`.
2. Select the wrench icon ({fa}`wrench`) at the top of the sidebar to open the {guilabel}`Administration` menu.
3. Select {guilabel}`Moderation`. The {guilabel}`Reports` page opens.
4. [Search for the report](search_reports.md).
5. Find the note you want to delete in the {guilabel}`Internal notes` section.
6. Select {guilabel}`Delete`
```
```{tabbed} Mobile
1. Log in to your {term}`pod`.
2. Select the wrench icon ({fa}`wrench`) at the top of the screen to open the {guilabel}`Administration` menu.
3. Select {guilabel}`Moderation`. The {guilabel}`Reports` page opens.
4. [Search for the report](search_reports.md).
5. Find the note you want to delete in the {guilabel}`Internal notes` section.
6. Select {guilabel}`Delete`
```

Wyświetl plik

@ -0,0 +1,33 @@
# Search for reports
The {guilabel}`Reports` page contains filters that enable you to search for reports. Use these filters to find reports by category, status, or key words.
```{tabbed} Desktop
1. Log in to your {term}`pod`.
2. Select the wrench icon ({fa}`wrench`) at the top of the sidebar to open the {guilabel}`Administration` menu.
3. Select {guilabel}`Moderation`. The {guilabel}`Reports` page opens.
4. Use the filters to find the report you want:
- Enter key words in the {guilabel}`Search` field. This enables you to search for content in the report's {guilabel}`Message` section. Hit {kbd}`⏎ Return` to update your search.
- Filter reports by {guilabel}`Status`.
- Filter reports by {guilabel}`Category`.
- Select the criteria for {guilabel}`Ordering` of your search results.
- Select which {guilabel}`Order` you want to see your search results in.
```
```{tabbed} Mobile
1. Log in to your {term}`pod`.
2. Select the wrench icon ({fa}`wrench`) at the top of the screen to open the {guilabel}`Administration` menu.
3. Select {guilabel}`Moderation`. The {guilabel}`Reports` page opens.
4. Use the filters to find the report you want:
- Enter key words in the {guilabel}`Search` field. This enables you to search for content in the report's {guilabel}`Message` section. Hit {kbd}`⏎ Return` to update your search.
- Filter reports by {guilabel}`Status`.
- Filter reports by {guilabel}`Category`.
- Select the criteria for {guilabel}`Ordering` of your search results.
- Select which {guilabel}`Order` you want to see your search results in.
```
Once you have found the required report, you can handle the reported [user](handle_users.md) or [content](handle_content.md). You can also update the [internal notes](internal_notes.md) on the report.

Wyświetl plik

@ -0,0 +1,50 @@
# View unresolved reports
When a user reports an object on your {term}`pod`, the report gets sent to a moderation queue. You can check this moderation queue to handle any reports that users have submitted.
## Check the Reports page
You can see a list of unresolved reports by going to the {guilabel}`Reports` page. To do this:
```{tabbed} Desktop
1. Log in to your {term}`pod`.
2. Select the wrench icon ({fa}`wrench`) at the top of the sidebar to open the {guilabel}`Administration` menu.
3. Select {guilabel}`Moderation`. The {guilabel}`Reports` page opens.
```
```{tabbed} Mobile
1. Log in to your {term}`pod`.
2. Select the wrench icon ({fa}`wrench`) at the top of the screen to open the {guilabel}`Administration` menu.
3. Select {guilabel}`Moderation`. The {guilabel}`Reports` page opens.
```
That's it! A list of unresolved reports appears on the screen. The summary contains the following information:
- The user who submitted the report.
- The report {guilabel}`Category`.
- The date the user submitted the report.
- The message the user posted with the report (if applicable).
- The {guilabel}`Status` of the report.
- Any {guilabel}`Internal notes` left by moderators.
- A summary of the {guilabel}`Reported object`.
- A list of available {guilabel}`Actions`.
Use the tools on this page the handle the reported [content](handle_content.md) or [user](handle_users.md).
## Email notifications
When a user submits a report, an email gets sent to all pod moderators. This email contains a summary of the report including:
- The user who submitted the report.
- The object that the user reported.
- A link to the object on your pod.
- A link to the object's moderation page.
- The message the user posted with the report (if applicable).
- A link to the report.
- A link to the {guilabel}`Reports` page.
Follow the links in the email to view the report.