novaburst/funquail
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Migrate to sphinx-design

Browse source
This commit is contained in:
Ciarán Ainsworth 2022-07-23 13:32:35 +00:00 • committed by JuniorJPDJ
commit 644ebce70a
367 changed files with 15740 additions and 14053 deletions
Download patch file Download diff file Expand all files Collapse all files

32
docs/moderator_documentation/allow_listing/add_domain.md
View file

@ -6,15 +6,20 @@ If you have allow-listing enabled, you need to add a domain to your allow-list t
:local:
```
```{dropdown} Required permissions
:::{dropdown} Required permissions
:icon: key
- {guilabel}`Moderation` – provides access to the administration and moderation menus.
```
:::
## Add a new domain
To add a domain that is not currently in your domains list:
```{tabbed} Desktop
::::{tab-set}
:::{tab-item} Desktop
:sync: 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.
@ -24,9 +29,10 @@ To add a domain that is not currently in your domains list:
6. Check ({fa}`check-square`) the checkbox labeled {guilabel}`Add to allow-list`.
7. Select {guilabel}`Add`.
```
:::
```{tabbed} Mobile
:::{tab-item} Mobile
:sync: 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.
@ -36,7 +42,8 @@ To add a domain that is not currently in your domains list:
6. Check ({fa}`check-square`) the checkbox labeled {guilabel}`Add to allow-list`.
7. Select {guilabel}`Add`.
```
:::
::::
That's it! You've added the domain to your pod's allow-list.
@ -44,7 +51,10 @@ That's it! You've added the domain to your pod's allow-list.
To add a domain that is already in your pod's domain list:
```{tabbed} Desktop
::::{tab-set}
:::{tab-item} Desktop
:sync: 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.
@ -54,9 +64,10 @@ To add a domain that is already in your pod's domain list:
6. Select {guilabel}`Add to allow-list` in the {guilabel}`Actions` dropdown.
7. Select {guilabel}`Go`. A green tick ({fa}`check`) appears next to the domain(s)
```
:::
```{tabbed} Mobile
:::{tab-item} Mobile
:sync: 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.
@ -66,6 +77,7 @@ To add a domain that is already in your pod's domain list:
6. Select {guilabel}`Add to allow-list` in the {guilabel}`Actions` dropdown.
7. Select {guilabel}`Go`. A green tick ({fa}`check`) appears next to the domain(s)
```
:::
::::
You're done! You've added the domain to your pod's allow-list.

19
docs/moderator_documentation/allow_listing/remove_domain.md
View file

@ -2,13 +2,18 @@
You can remove a domain from your {term}`pod's <Pod>` allow-list to stop communicating with it.
```{dropdown} Required permissions
:::{dropdown} Required permissions
:icon: key
- {guilabel}`Moderation` – provides access to the administration and moderation menus.
```
:::
To remove a domain from your allow-list:
```{tabbed} Desktop
::::{tab-set}
:::{tab-item} Desktop
:sync: desktop
1. Log in to your pod.
2. Select the wrench icon ({fa}`wrench`) at the top of the sidebar to open the {guilabel}`Administration` menu.
@ -18,9 +23,10 @@ To remove a domain from your allow-list:
6. Select {guilabel}`Remove from allow-list` in the {guilabel}`Actions` dropdown.
7. Select {guilabel}`Go`.
```
:::
```{tabbed} Mobile
:::{tab-item} Mobile
:sync: mobile
1. Log in to your pod.
2. Select the wrench icon ({fa}`wrench`) at the top of the screen to open the {guilabel}`Administration` menu.
@ -30,6 +36,7 @@ To remove a domain from your allow-list:
6. Select {guilabel}`Remove from allow-list` in the {guilabel}`Actions` dropdown.
7. Select {guilabel}`Go`.
```
:::
::::
You're done! You've removed the domain from your pod's allow-list.

32
docs/moderator_documentation/content/delete_content.md
View file

@ -6,10 +6,12 @@ Deleting content from your pod deletes the files from the server. Deleting objec
Moderators can delete content from their {term}`pod` if required. Use this feature to handle content that violates your pod's rules.
```{dropdown} Required permissions
:::{dropdown} Required permissions
:icon: key
- {guilabel}`Moderation` – provides access to the administration menu.
- {guilabel}`Library` – provides access to the library menu.
```
:::
There are two ways to delete content:
@ -21,7 +23,10 @@ There are two ways to delete content:
If you want to delete a specific object:
```{tabbed} Desktop
::::{tab-set}
:::{tab-item} Desktop
:sync: desktop
1. Log in to your pod.
2. Select the wrench icon ({fa}`wrench`) at the top of the sidebar to open the {guilabel}`Administration` menu.
@ -39,9 +44,10 @@ If you want to delete a specific object:
7. Select {guilabel}`Delete`. A {guilabel}`Delete this {object}` warning appears.
8. Select {guilabel}`Delete`.
```
:::
```{tabbed} Mobile
:::{tab-item} Mobile
:sync: mobile
1. Log in to your pod.
2. Select the wrench icon ({fa}`wrench`) at the top of the screen to open the {guilabel}`Administration` menu.
@ -59,7 +65,8 @@ If you want to delete a specific object:
7. Select {guilabel}`Delete`. A {guilabel}`Delete this {object}` warning appears.
8. Select {guilabel}`Delete`.
```
:::
::::
That's it! You've deleted the object.
@ -67,7 +74,10 @@ That's it! You've deleted the object.
To delete several items at once:
```{tabbed} Desktop
::::{tab-set}
:::{tab-item} Desktop
:sync: desktop
1. Log in to your pod.
2. Select the wrench icon ({fa}`wrench`) at the top of the sidebar to open the {guilabel}`Administration` menu.
@ -86,9 +96,10 @@ To delete several items at once:
8. Select {guilabel}`Go`. A {guilabel}`Do you want to launch delete on {count} items` warning appears.
9. Select {guilabel}`Launch`.
```
:::
```{tabbed} Mobile
:::{tab-item} Mobile
:sync: mobile
1. Log in to your pod.
2. Select the wrench icon ({fa}`wrench`) at the top of the screen to open the {guilabel}`Administration` menu.
@ -107,6 +118,7 @@ To delete several items at once:
8. Select {guilabel}`Go`. A {guilabel}`Do you want to launch delete on {count} items` warning appears.
9. Select {guilabel}`Launch`.
```
:::
::::
You're done! You've deleted the selected objects from your pod.

19
docs/moderator_documentation/content/handle_edits.md
View file

@ -6,10 +6,12 @@ Users can edit content in their own libraries. Moderators don't need to approve
Users can suggest metadata edits on objects they can access. When a user suggests an edit, it's sent to the __Edits__ queue for review. Moderators and pod admins can accept or reject these edits.
```{dropdown} Required permissions
:::{dropdown} Required permissions
:icon: key
- {guilabel}`Moderation` – provides access to the administration menu.
- {guilabel}`Library` – provides access to the library menu.
```
:::
Each edit object contains the following information:
@ -23,7 +25,10 @@ Each edit object contains the following information:
To review suggested edits:
```{tabbed} Desktop
::::{tab-set}
:::{tab-item} Desktop
:sync: 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.
@ -33,9 +38,10 @@ To review suggested edits:
- {guilabel}`Reject` – reject the edit and leave the object in its current state.
- {guilabel}`Delete` – delete the edit suggestion without taking further action. The object remains in its current state.
```
:::
```{tabbed} Mobile
:::{tab-item} Mobile
:sync: 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.
@ -45,6 +51,7 @@ To review suggested edits:
- {guilabel}`Reject` – reject the edit and leave the object in its current state.
- {guilabel}`Delete` – delete the edit suggestion without taking further action. The object remains in its current state.
```
:::
::::
That's it! You've handled the edit request. You can use the filters on this page to search for historical requests.

19
docs/moderator_documentation/content/library_visibility.md
View file

@ -6,14 +6,19 @@ You can only change the visibility of libraries stored on your {term}`pod`.
If a user has put copyrighted material in a public library, you can change the visibility of the library. This lets the user keep the content and protects your pod from legal issues.
```{dropdown} Required permissions
:::{dropdown} Required permissions
:icon: key
- {guilabel}`Moderation` – provides access to the administration menu.
- {guilabel}`Library` – provides access to the library menu.
```
:::
To change the visibility of a library:
```{tabbed} Desktop
::::{tab-set}
:::{tab-item} Desktop
:sync: 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.
@ -25,9 +30,10 @@ To change the visibility of a library:
- {guilabel}`Instance` – makes the library visible only to users who have an account on your pod.
- {guilabel}`Everyone` – makes the library visible to users across all pods.
```
:::
```{tabbed} Mobile
:::{tab-item} Mobile
:sync: 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.
@ -39,6 +45,7 @@ To change the visibility of a library:
- {guilabel}`Instance` – makes the library visible only to users who have an account on your pod.
- {guilabel}`Everyone` – makes the library visible to users across all pods.
```
:::
::::
That's it! You've updated the library's visibility. You should contact the user informing them of the action.

19
docs/moderator_documentation/domains/add_domain.md
View file

@ -2,13 +2,18 @@
Funkwhale records the domains of other {term}`Fediverse` servers when users interact with them. Once a domain is in your domains list, you can [add moderation rules](add_rule.md) to it.
```{dropdown} Required permissions
:::{dropdown} Required permissions
:icon: key
- {guilabel}`Moderation` – provides access to the administration and moderation menus.
```
:::
You can also add domains to this list at any time to create rules before users interact with them. To do this:
```{tabbed} Desktop
::::{tab-set}
:::{tab-item} Desktop
:sync: 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.
@ -17,9 +22,10 @@ You can also add domains to this list at any time to create rules before users i
5. Enter the URL of the Fediverse server you want to add in the {guilabel}`Add a domain` field.
6. Select {guilabel}`Add` to add the domain. The domain moderation page opens.
```
:::
```{tabbed} Mobile
:::{tab-item} Mobile
:sync: 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.
@ -28,6 +34,7 @@ You can also add domains to this list at any time to create rules before users i
5. Enter the URL of the Fediverse server you want to add in the {guilabel}`Add a domain` field.
6. Select {guilabel}`Add` to add the domain. The domain moderation page opens.
```
:::
::::
That's it! The domain is now in your domains list. You can now add moderation rules to this domain.

19
docs/moderator_documentation/domains/add_rule.md
View file

@ -6,13 +6,18 @@ Purging a domain's data removes all objects and caches associated to that domain
Add moderation rules to domains to control how they can interact with your {term}`pod`. Moderation rules enable you to restrict content from a domain showing on your pod.
```{dropdown} Required permissions
:::{dropdown} Required permissions
:icon: key
- {guilabel}`Moderation` – provides access to the administration and moderation menus.
```
:::
To add a moderation rule to a domain:
```{tabbed} Desktop
::::{tab-set}
:::{tab-item} Desktop
:sync: 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.
@ -26,9 +31,10 @@ To add a moderation rule to a domain:
- {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
:::{tab-item} Mobile
:sync: 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.
@ -42,6 +48,7 @@ To add a moderation rule to a domain:
- {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.

27
docs/moderator_documentation/domains/delete_rule.md
View file

@ -2,13 +2,18 @@
If you no longer need a moderation rule, you can delete it completely. This allows the other server to interact with your pod normally.
```{dropdown} Required permissions
:::{dropdown} Required permissions
:icon: key
- {guilabel}`Moderation` – provides access to the administration and moderation menus.
```
:::
To delete an existing moderation rule:
```{tabbed} Desktop
::::{tab-set}
:::{tab-item} Desktop
:sync: 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.
@ -16,12 +21,13 @@ To delete an existing moderation rule:
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.
8. Select {guilabel}`Delete`. A {guilabel}`Delete this moderation rule?` warning appears.
9. Select {guilabel}`Delete moderation rule`.
7. Select {guilabel}`Delete`. A {guilabel}`Delete this moderation rule?` warning appears.
8. Select {guilabel}`Delete moderation rule`.
```
:::
```{tabbed} Mobile
:::{tab-item} Mobile
:sync: 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.
@ -29,9 +35,10 @@ To delete an existing moderation rule:
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.
8. Select {guilabel}`Delete`. A {guilabel}`Delete this moderation rule?` warning appears.
9. Select {guilabel}`Delete moderation rule`.
7. Select {guilabel}`Delete`. A {guilabel}`Delete this moderation rule?` warning appears.
8. Select {guilabel}`Delete moderation rule`.
```
:::
::::
That's it! You've deleted your moderation rule. Content from the domain will no longer get blocked.

19
docs/moderator_documentation/domains/edit_rule.md
View file

@ -6,13 +6,18 @@ Purging a domain's data removes all objects and caches associated to that domain
You can change a moderation rule on a domain at any time.
```{dropdown} Required permissions
:::{dropdown} Required permissions
:icon: key
- {guilabel}`Moderation` – provides access to the administration and moderation menus.
```
:::
To update an existing moderation rule:
```{tabbed} Desktop
::::{tab-set}
:::{tab-item} Desktop
:sync: 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.
@ -28,9 +33,10 @@ To update an existing moderation rule:
- {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
:::{tab-item} Mobile
:sync: 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.
@ -46,6 +52,7 @@ To update an existing moderation rule:
- {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.

19
docs/moderator_documentation/domains/purge_domain.md
View file

@ -6,13 +6,18 @@ Purging a domain's data removes all objects and caches associated to that domain
When users follow content from another domain that content is visible on your {term}`pod`. If a domain hosts illegal or offensive content you can purge the content associated with it.
```{dropdown} Required permissions
:::{dropdown} Required permissions
:icon: key
- {guilabel}`Moderation` – provides access to the administration and moderation menus.
```
:::
To purge content from a domain:
```{tabbed} Desktop
::::{tab-set}
:::{tab-item} Desktop
:sync: 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.
@ -23,9 +28,10 @@ To purge content from a domain:
7. Select {guilabel}`Go`. A {guilabel}`Do you want to launch purge on {count} items` warning appears.
8. Select {guilabel}`Launch`.
```
:::
```{tabbed} Mobile
:::{tab-item} Mobile
:sync: 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.
@ -36,6 +42,7 @@ To purge content from a domain:
7. Select {guilabel}`Go`. A {guilabel}`Do you want to launch purge on {count} items` warning appears.
8. Select {guilabel}`Launch`.
```
:::
::::
You're done! Your pod clears all the content associated with the selected domains.

19
docs/moderator_documentation/external_users/add_rule.md
View file

@ -6,13 +6,18 @@ Purging a user's data removes all objects and caches associated to that user. Th
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.
```{dropdown} Required permissions
:::{dropdown} Required permissions
:icon: key
- {guilabel}`Moderation` – provides access to the administration and moderation menus.
```
:::
To add a moderation rule to a user:
```{tabbed} Desktop
::::{tab-set}
:::{tab-item} Desktop
:sync: 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.
@ -26,9 +31,10 @@ To add a moderation rule to a user:
- {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
:::{tab-item} Mobile
:sync: 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.
@ -42,6 +48,7 @@ To add a moderation rule to a user:
- {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.

27
docs/moderator_documentation/external_users/delete_rule.md
View file

@ -2,13 +2,18 @@
If you no longer need a moderation rule, you can delete it completely. This allows the user to interact with your pod normally.
```{dropdown} Required permissions
:::{dropdown} Required permissions
:icon: key
- {guilabel}`Moderation` – provides access to the administration and moderation menus.
```
:::
To delete an existing moderation rule:
```{tabbed} Desktop
::::{tab-set}
:::{tab-item} Desktop
:sync: 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.
@ -16,12 +21,13 @@ To delete an existing moderation rule:
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`.
7. Select {guilabel}`Delete`. A {guilabel}`Delete this moderation rule?` warning appears.
8. Select {guilabel}`Delete moderation rule`.
```
:::
```{tabbed} Mobile
:::{tab-item} Mobile
:sync: 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.
@ -29,9 +35,10 @@ To delete an existing moderation rule:
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`.
7. Select {guilabel}`Delete`. A {guilabel}`Delete this moderation rule?` warning appears.
8. Select {guilabel}`Delete moderation rule`.
```
:::
::::
That's it! You've deleted your moderation rule. Content from the user will no longer get blocked.

19
docs/moderator_documentation/external_users/edit_rule.md
View file

@ -6,13 +6,18 @@ Purging a user's data removes all objects and caches associated to that user. Th
You can change a moderation rule on a user at any time.
```{dropdown} Required permissions
:::{dropdown} Required permissions
:icon: key
- {guilabel}`Moderation` – provides access to the administration and moderation menus.
```
:::
To update an existing moderation rule:
```{tabbed} Desktop
::::{tab-set}
:::{tab-item} Desktop
:sync: 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.
@ -28,9 +33,10 @@ To update an existing moderation rule:
- {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
:::{tab-item} Mobile
:sync: 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.
@ -46,6 +52,7 @@ To update an existing moderation rule:
- {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.

19
docs/moderator_documentation/external_users/purge_users.md
View file

@ -6,13 +6,18 @@ Purging a user's data removes all objects and caches associated to that user. Th
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.
```{dropdown} Required permissions
:::{dropdown} Required permissions
:icon: key
- {guilabel}`Moderation` – provides access to the administration and moderation menus.
```
:::
To purge a user's content:
```{tabbed} Desktop
::::{tab-set}
:::{tab-item} Desktop
:sync: 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.
@ -23,9 +28,10 @@ To purge a user's content:
7. Select {guilabel}`Go`. A {guilabel}`Do you want to launch purge on {count} element(s)` warning appears.
8. Select {guilabel}`Launch`.
```
:::
```{tabbed} Mobile
:::{tab-item} Mobile
:sync: 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.
@ -36,6 +42,7 @@ To purge a user's content:
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.

32
docs/moderator_documentation/internal_users/handle_registration.md
View file

@ -2,9 +2,11 @@
{term}`Pod` admins can enable manual sign-up validation. This setting requires moderators to approve or refuse account creations.
```{dropdown} Required permissions
:::{dropdown} Required permissions
:icon: key
- {guilabel}`Moderation` – provides access to the administration and moderation menus.
```
:::
Requests appear in the {guilabel}`User Requests` list. Each request contains the following information:
@ -24,7 +26,10 @@ Requests appear in the {guilabel}`User Requests` list. Each request contains the
To approve a sign-up request:
```{tabbed} Desktop
::::{tab-set}
:::{tab-item} Desktop
:sync: 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.
@ -33,9 +38,10 @@ To approve a sign-up request:
5. Read through the details of the request.
6. Select {guilabel}`Approve` in the {guilabel}`Actions` section.
```
:::
```{tabbed} Mobile
:::{tab-item} Mobile
:sync: 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.
@ -44,7 +50,8 @@ To approve a sign-up request:
5. Read through the details of the request.
6. Select {guilabel}`Approve` in the {guilabel}`Actions` section.
```
:::
::::
That's it! You've approved the user's sign-up request. The user can now log in.
@ -52,7 +59,10 @@ That's it! You've approved the user's sign-up request. The user can now log in.
To refuse a sign-up request:
```{tabbed} Desktop
::::{tab-set}
:::{tab-item} Desktop
:sync: 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.
@ -61,9 +71,10 @@ To refuse a sign-up request:
5. Read through the details of the request.
6. Select {guilabel}`Refuse` in the {guilabel}`Actions` section.
```
:::
```{tabbed} Mobile
:::{tab-item} Mobile
:sync: 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.
@ -72,6 +83,7 @@ To refuse a sign-up request:
5. Read through the details of the request.
6. Select {guilabel}`Refuse` in the {guilabel}`Actions` section.
```
:::
::::
That's it! You've refused the user's sign-up request. The user can't log in to your pod.

40
docs/moderator_documentation/reports/handle_content.md
View file

@ -6,10 +6,12 @@ Deleting reported objects is irreversible. This action deletes the associated fi
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.
```{dropdown} Required permissions
:::{dropdown} Required permissions
:icon: key
- {guilabel}`Moderation` – provides access to the administration and moderation menus.
- {guilabel}`Library` – enables the moderator to delete objects.
```
:::
```{contents}
:local:
@ -19,29 +21,34 @@ You can handle content reports from the {guilabel}`Reports` page or from the rep
To handle a content report from the {guilabel}`Reports` page:
```{tabbed} Desktop
::::{tab-set}
:::{tab-item} Desktop
:sync: 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.
- {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
:::{tab-item} Mobile
:sync: 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.
- {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.
@ -49,7 +56,10 @@ Resolving the report assigns it to you so other moderators know who handled the
If you want to edit an object to change its metadata:
```{tabbed} Desktop
::::{tab-set}
:::{tab-item} Desktop
:sync: 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.
@ -63,9 +73,10 @@ If you want to edit an object to change its metadata:
10. Search for the report.
11. Select {guilabel}`Resolve` in the {guilabel}`Actions` section.
```
:::
```{tabbed} Mobile
:::{tab-item} Mobile
:sync: 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.
@ -79,6 +90,7 @@ If you want to edit an object to change its metadata:
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.

19
docs/moderator_documentation/reports/handle_users.md
View file

@ -2,29 +2,36 @@
If a user has reported another user on your pod, you can make changes to the reported user's profile. Use the user's moderation page to take the appropriate steps to handle the report.
```{dropdown} Required permissions
:::{dropdown} Required permissions
:icon: key
- {guilabel}`Moderation` – provides access to the administration and moderation menus.
```
:::
To open a user's moderation page:
```{tabbed} Desktop
::::{tab-set}
:::{tab-item} Desktop
:sync: 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
:::{tab-item} Mobile
:sync: 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:

36
docs/moderator_documentation/reports/internal_notes.md
View file

@ -2,26 +2,32 @@
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.
```{dropdown} Required permissions
:::{dropdown} Required permissions
:icon: key
- {guilabel}`Moderation` – provides access to the administration and moderation menus.
```
:::
## Add notes to a report
You can add notes to __Unresolved__ and __Resolved__ reports. To add an internal note:
```{tabbed} Desktop
::::{tab-set}
1. Log in to your {term}`pod`.
:::{tab-item} Desktop
:sync: 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
:::{tab-item} Mobile
:sync: 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.
@ -30,7 +36,8 @@ You can add notes to __Unresolved__ and __Resolved__ reports. To add an internal
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
@ -40,7 +47,10 @@ Deleting an internal note is irreversible. Make sure you are not deleting anythi
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
::::{tab-set}
:::{tab-item} Desktop
:sync: 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.
@ -49,15 +59,17 @@ You can delete your own notes and the notes of other moderators. You can do this
5. Find the note you want to delete in the {guilabel}`Internal notes` section.
6. Select {guilabel}`Delete`
```
:::
```{tabbed} Mobile
:::{tab-item} Mobile
:sync: mobile
1. Log in to your {term}`pod`.
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`
```
:::
::::

21
docs/moderator_documentation/reports/search_reports.md
View file

@ -2,11 +2,16 @@
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.
```{dropdown} Required permissions
- {guilabel}`Moderation` – provides access to the administration and moderation menus.
```
:::{dropdown} Required permissions
:icon: key
```{tabbed} Desktop
- {guilabel}`Moderation` – provides access to the administration and moderation menus.
:::
::::{tab-set}
:::{tab-item} Desktop
:sync: 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.
@ -18,9 +23,10 @@ The {guilabel}`Reports` page contains filters that enable you to search for repo
- Select the criteria for {guilabel}`Ordering` of your search results.
- Select which {guilabel}`Order` you want to see your search results in.
```
:::
```{tabbed} Mobile
:::{tab-item} Mobile
:sync: 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.
@ -32,6 +38,7 @@ The {guilabel}`Reports` page contains filters that enable you to search for repo
- 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.

19
docs/moderator_documentation/reports/view_reports.md
View file

@ -2,29 +2,36 @@
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.
```{dropdown} Required permissions
:::{dropdown} Required permissions
:icon: key
- {guilabel}`Moderation` – provides access to the administration and moderation menus.
```
:::
## Check the Reports page
You can see a list of unresolved reports by going to the {guilabel}`Reports` page. To do this:
```{tabbed} Desktop
::::{tab-set}
:::{tab-item} Desktop
:sync: 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
:::{tab-item} Mobile
:sync: 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: