help: Update "User groups".

- Documents user groups new UI.
- Splits documentation into "User groups" and "Manage User groups".

Fixes #18583.
This commit is contained in:
David Rosa 2023-12-07 20:55:18 -08:00 committed by Tim Abbott
parent c741c527d7
commit d0317a1792
7 changed files with 192 additions and 49 deletions

View File

@ -11,5 +11,6 @@ users at once, [notifying](/help/dm-mention-alert-notifications) them about a me
* [Setting up your organization](/help/getting-your-organization-started-with-zulip)
* [User groups](/help/user-groups)
* [Manage user groups](/help/manage-user-groups)
* [Invite users to join](/help/invite-users-to-join)
* [Getting started with Zulip](/help/getting-started-with-zulip)

View File

@ -2,7 +2,7 @@
{tab|desktop-web}
{relative|stream|all}
{relative|gear|stream-settings}
1. Click **Create stream** on the right, or click the **plus**
(<i class="fa fa-plus"></i>) icon in the upper right.

View File

@ -1,16 +1,18 @@
{start_tabs}
{tab|desktop-web}
{relative|gear|group-settings}
1. Click **Create user group** on the right, or click the **plus**
(<i class="fa fa-plus"></i>) icon in the upper right.
1. Enter a **Name** and **Description**.
1. Click **Create** in the bottom right corner
1. Fill out the requested info, and click **Create** in the bottom right corner
of the create user group panel.
1. Find the group in the list below, and add members. Zulip will notify
everyone who is added.
!!! warn ""
**Note**: You will only see the **Create user group** button if you have
permission to create user groups.
{end_tabs}

View File

@ -120,6 +120,7 @@
* [User cards](/help/user-cards)
* [View someone's profile](/help/view-someones-profile)
* [Direct messages](/help/direct-messages)
* [User groups](/help/user-groups)
## Streams & topics
* [Streams and topics](/help/streams-and-topics)
@ -188,7 +189,7 @@
* [Custom profile fields](/help/custom-profile-fields)
* [Configure default new user settings](/help/configure-default-new-user-settings)
* [Configure organization language](/help/configure-organization-language)
* [User groups](/help/user-groups)
* [Manage user groups](/help/manage-user-groups)
* [Change a user's role](/help/change-a-users-role)
* [Change a user's name](/help/change-a-users-name)
* [Manage a user's stream subscriptions](/help/manage-user-stream-subscriptions)

160
help/manage-user-groups.md Normal file
View File

@ -0,0 +1,160 @@
# Manage user groups
## Create a user group
{!how-to-create-a-user-group.md!}
## User group options
There are several parameters you can set while creating a user group. All of
which you can change later.
* **User group name**: The user group name can be in any language, and can
include spaces and other punctuation.
* **User group description**: Lets users know what the group is used for.
* **Who can mention this group?**: Configures who is allowed to
[mention this group](/help/mention-a-user-or-group).
* **Choose members**: You can copy the membership from an existing stream or
user group, add all users, or enter users one by one.
## Change a user group's name or description
{start_tabs}
{tab|desktop-web}
{relative|group|all}
1. Select a user group.
1. Select the **General** tab on the right.
1. Click the **pencil** (<i class="fa fa-pencil"></i>) icon
to the right of the user group, and enter a new name or description.
{!save-changes.md!}
{end_tabs}
## Configure who can mention a user group
{start_tabs}
{tab|desktop-web}
{relative|group|all}
1. Select a user group.
1. Select the **General** tab on the right.
1. Under **Group permissions**, configure **Who can mention this group**.
{!save-changes.md!}
{end_tabs}
## Add users to a user group
{start_tabs}
{tab|desktop-web}
{relative|group|all}
1. Select a user group.
1. Select the **Members** tab on the right.
1. Under **Add members**, enter a name or email address. The typeahead
will only include users who aren't already members of the group.
1. Click **Add**. Zulip will notify everyone who is added to the group.
!!! tip ""
To add users in bulk, you can copy members from an
existing stream or user group.
{end_tabs}
## Remove users from a user group
{start_tabs}
{tab|desktop-web}
{relative|group|all}
1. Select a user group.
1. Select the **Members** tab on the right.
1. Under **Members**, find the user you would like to remove.
1. Click the **Remove** button in that row. Zulip will notify everyone who is
removed from the group.
!!! warn ""
**Note**: If you remove yourself from a user group, you
may no longer have permission to modify the user group.
{end_tabs}
## Delete a user group
{start_tabs}
{tab|desktop-web}
{relative|group|all}
1. Select a user group.
1. Click the **trash** <i class="fa fa-trash-o"></i> icon near the top right
corner of the user group settings panel.
1. Approve by clicking **Confirm**.
!!! warn ""
**Note**: Deleting a user group cannot be undone by anyone.
{end_tabs}
## Configure who can create and manage user groups
{!admin-only.md!}
By default, [all members](/help/roles-and-permissions) in a Zulip
organization can create user groups and manage user groups that they
are a member of. However, you can restrict that ability to specific
[roles](/help/roles-and-permissions).
Note that administrators and moderators can modify any user group,
while other organization members can only modify user groups to which
they belong. Guests cannot modify or create user groups.
{start_tabs}
{tab|desktop-web}
{settings_tab|organization-permissions}
1. Under **Other permissions**, configure **Who can create and manage user groups**.
{!save-changes.md!}
{end_tabs}
## Related articles
* [User groups](/help/user-groups)
* [Mention a user or group](/help/mention-a-user-or-group)
* [Create user groups](/help/create-user-groups)
* [Setting up your organization](/help/getting-your-organization-started-with-zulip)
* [Roles and permissions](/help/roles-and-permissions)

View File

@ -175,7 +175,7 @@ how to assign roles and permissions for a class.
- Set [who can create and manage user groups][user-group-permissions].
(Recommended: Admins and moderators)
[user-group-permissions]: /help/user-groups#configure-who-can-create-and-manage-user-groups
[user-group-permissions]: /help/manage-user-groups#configure-who-can-create-and-manage-user-groups
[move-between-streams]: /help/restrict-moving-messages#configure-who-can-move-messages-to-another-stream
#### Recommended roles and permissions for a department

View File

@ -1,7 +1,8 @@
# User groups
User groups allow you to [mention](/help/mention-a-user-or-group) multiple
users at once. When you mention a user group, everyone in the group is
users at once, and add users in bulk to an existing stream or user group.
When you mention a user group, everyone in the group is
[notified](/help/dm-mention-alert-notifications) as if they were
individually mentioned.
@ -10,67 +11,44 @@ trying to send a message to a group of people, you'll want to either
[create a stream](/help/create-a-stream), or send a
[group direct message](/help/direct-messages).
### Create a user group
{!how-to-create-a-user-group.md!}
### Modify a user group
## Browse and join user groups
{start_tabs}
{tab|desktop-web}
{relative|group|all}
1. Find the group.
1. Scroll through the list of user groups. You can use the **search box** near
the top of the menu to filter the list by group name or description.
1. Click on the group name or description to edit.
1. Add or remove users (including yourself). Click outside the box
to save. Zulip will notify everyone who is added or removed.
!!! warn ""
**Note**: If you remove yourself from a user group, you
may no longer have permission to modify the user group.
1. Click the **plus**
(<img src="/static/images/help/desktop-web-plus-icon.svg" alt="plus" class="help-center-icon"/>)
icon to the left of a user group to join the group.
{end_tabs}
### Delete a user group
## Leave a group
{start_tabs}
{relative|group|all}
{tab|desktop-web}
1. Find the group.
{relative|gear|group-settings}
1. Click the **trash** (<i class="fa fa-trash-o"></i>) icon in the top
right corner of the user group.
1. Approve by clicking **Confirm**.
!!! warn ""
**Note**: Deleting a user group cannot be undone by anyone.
1. Click the **checkmark**
(<img src="/static/images/help/desktop-web-check-icon.svg" alt="checkmark" class="help-center-icon"/>)
icon to the left of a user group to leave the group.
{end_tabs}
### Configure who can create and manage user groups
{!admin-only.md!}
By default, [all members](/help/roles-and-permissions) in a Zulip
organization can create user groups and manage user groups that they
are a member of. However, you can restrict that ability to specific
[roles](/help/roles-and-permissions).
Note that administrators and moderators can modify any user group,
while other organization members can only modify user groups to which
they belong. Guests cannot modify or create user groups.
## View a group's card
{start_tabs}
{settings_tab|organization-permissions}
{tab|desktop-web}
1. Under **Other permissions**, configure **Who can create and manage user groups**.
{!save-changes.md!}
1. Click on a user group's mention in a message to open their **group card**.
{end_tabs}
@ -78,5 +56,6 @@ they belong. Guests cannot modify or create user groups.
* [Mention a user or group](/help/mention-a-user-or-group)
* [Create user groups](/help/create-user-groups)
* [Manage user groups](/help/manage-user-groups)
* [Setting up your organization](/help/getting-your-organization-started-with-zulip)
* [Roles and permissions](/help/roles-and-permissions)