Add user moderation docs

This commit is contained in:
Ciaran Ainsworth 2022-01-20 19:39:43 +01:00 committed by Ciarán Ainsworth
parent b533dd8f21
commit d50b3dba6d
8 changed files with 183 additions and 3 deletions

View File

@ -47,6 +47,7 @@ hidden: true
moderator_documentation/index
moderator_documentation/reports/index
moderator_documentation/domains/index
moderator_documentation/users/index
```

View File

@ -9,7 +9,7 @@ If you no longer need a moderation rule, you can delete it completely. To do thi
3. Select {guilabel}`Moderation`. The {guilabel}`Reports` page opens.
4. Select {guilabel}`Domains` at the top of the page. The {guilabel}`Domains` page opens. You can see a list of known domains on this page.
5. Select the domain with the moderation rule you want to edit. The domain's moderation page opens.
6. Select {guilabel}`Edit` under the {guilabel}`This domain is subject to specific moderation rules` header.. The moderation policy form opens.
6. Select {guilabel}`Edit` under the {guilabel}`This domain is subject to specific moderation rules` header. The moderation policy form opens.
8. Select {guilabel}`Delete`. A {guilabel}`Delete this moderation rule?` warning appears.
9. Select {guilabel}`Delete moderation rule`.
@ -22,7 +22,7 @@ If you no longer need a moderation rule, you can delete it completely. To do thi
3. Select {guilabel}`Moderation`. The {guilabel}`Reports` page opens.
4. Select {guilabel}`Domains` at the top of the page. The {guilabel}`Domains` page opens. You can see a list of known domains on this page.
5. Select the domain with the moderation rule you want to edit. The domain's moderation page opens.
6. Select {guilabel}`Edit` under the {guilabel}`This domain is subject to specific moderation rules` header.. The moderation policy form opens.
6. Select {guilabel}`Edit` under the {guilabel}`This domain is subject to specific moderation rules` header. The moderation policy form opens.
8. Select {guilabel}`Delete`. A {guilabel}`Delete this moderation rule?` warning appears.
9. Select {guilabel}`Delete moderation rule`.

View File

@ -21,6 +21,6 @@ maxdepth: 1
add_rule
edit_rule
remove_rule
delete_rule
```

View File

@ -0,0 +1,43 @@
# Add a moderation rule
```{warning}
Purging a user's data removes all objects and caches associated to that user. This impacts users who have objects from these users in their libraries.
```
Add moderation rules to users to control how they can interact with your {term}`pod`. Moderation rules enable you to restrict content from a user showing on your pod.
To add a moderation rule to a user:
```{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. Select {guilabel}`Accounts` at the top of the page. The {guilabel}`Accounts` page opens. You can see a list of known accounts on this page.
5. Select the account you want to apply the rule to. The account's moderation page opens.
6. Select {guilabel}`Add a moderation policy`. The moderation policy form appears.
7. Enter the {guilabel}`Reason` you are applying the rule. Depending on your pod's configuration, users may be able to see this.
8. Choose your moderation rule:
- {guilabel}`Block everything` purge all content from the user and block all content.
- {guilabel}`Reject media` only reject media files such as audio files, avatars, and album art.
9. Select {guilabel}`Create` to save your rule.
```
```{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. Select {guilabel}`Accounts` at the top of the page. The {guilabel}`Accounts` page opens. You can see a list of known accounts on this page.
5. Select the account you want to apply the rule to. The account's moderation page opens.
6. Select {guilabel}`Add a moderation policy`. The moderation policy form appears.
7. Enter the {guilabel}`Reason` you are applying the rule. Depending on your pod's configuration, users may be able to see this.
8. Choose your moderation rule:
- {guilabel}`Block everything` purge all content from the user and block all content.
- {guilabel}`Reject media` only reject media files such as audio files, avatars, and album art.
9. Select {guilabel}`Create` to save your rule.
```
That's all there is to it! You've applied your moderation rule. The rule takes effect as soon as you create it.

View File

@ -0,0 +1,31 @@
# Delete a moderation rule
If you no longer need a moderation rule, you can delete it completely. 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. Select {guilabel}`Users` at the top of the page. The {guilabel}`Users` page opens. You can see a list of known users on this page.
5. Select the user with the moderation rule you want to edit. The user's moderation page opens.
6. Select {guilabel}`Edit` under the {guilabel}`This user is subject to specific moderation rules` header. The moderation policy form opens.
8. Select {guilabel}`Delete`. A {guilabel}`Delete this moderation rule?` warning appears.
9. Select {guilabel}`Delete moderation rule`.
```
```{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. Select {guilabel}`Users` at the top of the page. The {guilabel}`Users` page opens. You can see a list of known users on this page.
5. Select the user with the moderation rule you want to edit. The user's moderation page opens.
6. Select {guilabel}`Edit` under the {guilabel}`This user is subject to specific moderation rules` header. The moderation policy form opens.
8. Select {guilabel}`Delete`. A {guilabel}`Delete this moderation rule?` warning appears.
9. Select {guilabel}`Delete moderation rule`.
```
That's it! You've deleted your moderation rule. Content from the user will no longer get blocked.

View File

@ -0,0 +1,45 @@
# Edit a moderation rule
```{warning}
Purging a user's data removes all objects and caches associated to that user. This impacts users who have objects from these users in their libraries.
```
You can change a moderation rule on a user at any time. 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. Select {guilabel}`Users` at the top of the page. The {guilabel}`Users` page opens. You can see a list of known users on this page.
5. Select the user with the moderation rule you want to edit. The user's moderation page opens.
6. Select {guilabel}`Edit` under the {guilabel}`This user is subject to specific moderation rules` header. The moderation policy form opens.
7. __Optional__ Edit the following settings:
- {guilabel}`Enabled` toggle this switch to enable or disable the rule without deleting it.
- {guilabel}`Reason` update the reason for the moderation rule.
8. __Optional__ Update your moderation rule:
- {guilabel}`Block everything` purge all content from this user and block all content.
- {guilabel}`Reject media` only reject media files such as audio files, avatars, and album art.
9. Select {guilabel}`Update` to save your rule.
```
```{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. Select {guilabel}`Users` at the top of the page. The {guilabel}`Users` page opens. You can see a list of known users on this page.
5. Select the user with the moderation rule you want to edit. The user's moderation page opens.
6. Select {guilabel}`Edit` under the {guilabel}`This user is subject to specific moderation rules` header. The moderation policy form opens.
7. __Optional__ Edit the following settings:
- {guilabel}`Enabled` toggle this switch to enable or disable the rule without deleting it.
- {guilabel}`Reason` update the reason for the moderation rule.
8. __Optional__ Update your moderation rule:
- {guilabel}`Block everything` purge all content from this user and block all content.
- {guilabel}`Reject media` only reject media files such as audio files, avatars, and album art.
9. Select {guilabel}`Update` to save your rule.
```
You're done! The changes to the rule take effect as soon as you update it.

View File

@ -0,0 +1,25 @@
# Moderate external users
You can add moderation rules to control how external users can interact with your {term}`pod`. This lets you filter users from other pods without applying rules to their whole [domain](../domains/index.md).
```{toctree}
---
caption: Manage external users
maxdepth: 1
---
purge_users
```
```{toctree}
---
caption: Manage moderation rules
maxdepth: 1
---
add_rule
edit_rule
delete_rule
```

View File

@ -0,0 +1,35 @@
# Purge user data
```{warning}
Purging a user's data removes all objects and caches associated to that user. This impacts users who have objects from these users in their libraries.
```
When users follow users from another domain their content is visible on your {term}`pod`. If a user posts illegal or offensive content you can purge the content associated with them. 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. Select {guilabel}`Accounts` at the top of the page. The {guilabel}`Accounts` page opens. You can see a list of known accounts on this page.
5. Select the checkbox ({fa}`square`) next to the account(s) you want to purge. Selected accounts show a tick ({fa}`check-square`).
6. Select {guilabel}`Purge` in the {guilabel}`Actions` dropdown.
7. Select {guilabel}`Go`. A {guilabel}`Do you want to launch purge on {count} element(s)` warning appears.
8. Select {guilabel}`Launch`.
```
```{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. Select {guilabel}`Accounts` at the top of the page. The {guilabel}`Accounts` page opens. You can see a list of known accounts on this page.
5. Select the checkbox ({fa}`square`) next to the account(s) you want to purge. Selected accounts show a tick ({fa}`check-square`).
6. Select {guilabel}`Purge` in the {guilabel}`Actions` dropdown.
7. Select {guilabel}`Go`. A {guilabel}`Do you want to launch purge on {count} element(s)` warning appears.
8. Select {guilabel}`Launch`.
```
You're done! Your pod clears all the content associated with the selected users.