From e1e6409774aa9d5971e63ddec967b9523212d185 Mon Sep 17 00:00:00 2001 From: Ciaran Ainsworth Date: Fri, 21 Jan 2022 18:40:26 +0100 Subject: [PATCH] Move things around, start documenting internal users --- docs/index.md | 3 +- .../{users => external_users}/add_rule.md | 0 .../{users => external_users}/delete_rule.md | 0 .../{users => external_users}/edit_rule.md | 0 .../{users => external_users}/index.md | 0 .../{users => external_users}/purge_users.md | 0 docs/moderator_documentation/index.md | 6 +- .../internal_users/handle_registration.md | 73 +++++++++++++++++++ .../internal_users/index.md | 25 +++++++ .../internal_users/manage_users.md | 3 + 10 files changed, 108 insertions(+), 2 deletions(-) rename docs/moderator_documentation/{users => external_users}/add_rule.md (100%) rename docs/moderator_documentation/{users => external_users}/delete_rule.md (100%) rename docs/moderator_documentation/{users => external_users}/edit_rule.md (100%) rename docs/moderator_documentation/{users => external_users}/index.md (100%) rename docs/moderator_documentation/{users => external_users}/purge_users.md (100%) create mode 100644 docs/moderator_documentation/internal_users/handle_registration.md create mode 100644 docs/moderator_documentation/internal_users/index.md create mode 100644 docs/moderator_documentation/internal_users/manage_users.md diff --git a/docs/index.md b/docs/index.md index 14c9aedef..17e055208 100644 --- a/docs/index.md +++ b/docs/index.md @@ -46,8 +46,9 @@ hidden: true moderator_documentation/index moderator_documentation/reports/index +moderator_documentation/internal_users/index moderator_documentation/domains/index -moderator_documentation/users/index +moderator_documentation/external_users/index moderator_documentation/allow_listing/index ``` diff --git a/docs/moderator_documentation/users/add_rule.md b/docs/moderator_documentation/external_users/add_rule.md similarity index 100% rename from docs/moderator_documentation/users/add_rule.md rename to docs/moderator_documentation/external_users/add_rule.md diff --git a/docs/moderator_documentation/users/delete_rule.md b/docs/moderator_documentation/external_users/delete_rule.md similarity index 100% rename from docs/moderator_documentation/users/delete_rule.md rename to docs/moderator_documentation/external_users/delete_rule.md diff --git a/docs/moderator_documentation/users/edit_rule.md b/docs/moderator_documentation/external_users/edit_rule.md similarity index 100% rename from docs/moderator_documentation/users/edit_rule.md rename to docs/moderator_documentation/external_users/edit_rule.md diff --git a/docs/moderator_documentation/users/index.md b/docs/moderator_documentation/external_users/index.md similarity index 100% rename from docs/moderator_documentation/users/index.md rename to docs/moderator_documentation/external_users/index.md diff --git a/docs/moderator_documentation/users/purge_users.md b/docs/moderator_documentation/external_users/purge_users.md similarity index 100% rename from docs/moderator_documentation/users/purge_users.md rename to docs/moderator_documentation/external_users/purge_users.md diff --git a/docs/moderator_documentation/index.md b/docs/moderator_documentation/index.md index 96d29ec54..5502f8457 100644 --- a/docs/moderator_documentation/index.md +++ b/docs/moderator_documentation/index.md @@ -10,13 +10,17 @@ 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. +## Moderate your pod's users + +As a moderator, you are responsible for moderating the behavior of users on your pod. Funkwhale provides you with tools to help you handle users that violate your pod's rules. Check out our [Moderate your pod's users](internal_users/index.md) section for more information. + ## Moderate external domains As {term}`fediverse` software, Funkwhale interacts with other software over federation. Read through the [Moderate external domains](domains/index.md) section to handle content from other servers. ## Moderate external users -You can moderate how external users interact with users on your pod. Check out the [Moderate external users](users/index.md) guides to learn how to manage users from other servers. +You can moderate how external users interact with users on your pod. Check out the [Moderate external users](external_users/index.md) guides to learn how to manage users from other servers. ## Manage your allow-list diff --git a/docs/moderator_documentation/internal_users/handle_registration.md b/docs/moderator_documentation/internal_users/handle_registration.md new file mode 100644 index 000000000..3858295ca --- /dev/null +++ b/docs/moderator_documentation/internal_users/handle_registration.md @@ -0,0 +1,73 @@ +# Handle user registrations + +{term}`Pod` admins can enable manual sign-up validation. This setting requires moderators to approve or refuse account creations. + +Requests appear in the {guilabel}`User Requests` list. Each request contains the following information: + +- The user the request was {guilabel}`Submitted by` +- The {guilabel}`Creation date` of the request. +- __Optional__ – any responses the user left to fields in the sign-up form. +- The {guilabel}`Status` of the request. +- Which moderator the request is {guilabel}`Assigned to`. +- The {guilabel}`Resolution date` of the request. +- Any {guilabel}`Internal notes` left by the moderators. + +```{contents} +:local: +``` + +## Approve a sign-up request + +To approve a sign-up request: + +```{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}`User Requests` at the top of the screen. A list of pending requests appears. +5. Read through the details of the request. +6. Select {guilabel}`Approve` 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. Select {guilabel}`User Requests` at the top of the screen. A list of pending requests appears. +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. + +## Refuse a sign-up request + +To refuse a sign-up request: + +```{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}`User Requests` at the top of the screen. A list of pending requests appears. +5. Read through the details of the request. +6. Select {guilabel}`Refuse` 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. Select {guilabel}`User Requests` at the top of the screen. A list of pending requests appears. +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. diff --git a/docs/moderator_documentation/internal_users/index.md b/docs/moderator_documentation/internal_users/index.md new file mode 100644 index 000000000..fb5083d86 --- /dev/null +++ b/docs/moderator_documentation/internal_users/index.md @@ -0,0 +1,25 @@ +# Moderate your pod's users + +Funkwhale provides you the tools you need to moderate users on your pod. Use these tools to tackle harassment and problematic content. + +{term}`Pod` admins can also enable manual sign-up validation. With this setting enabled, moderators need to approve or reject any user who signs up. + +```{toctree} +--- +caption: Moderate users +maxdepth: 1 +--- + +manage_users + +``` + +```{toctree} +--- +caption: Handle user registrations +maxdepth: 1 +--- + +handle_registration + +``` diff --git a/docs/moderator_documentation/internal_users/manage_users.md b/docs/moderator_documentation/internal_users/manage_users.md new file mode 100644 index 000000000..f7eadbc0b --- /dev/null +++ b/docs/moderator_documentation/internal_users/manage_users.md @@ -0,0 +1,3 @@ +# Manage users on your pod + +I