help: Update documentation to use new "#groups" UI.

This commit is contained in:
Sahil Batra 2023-12-06 16:35:35 +05:30 committed by Tim Abbott
parent d43244313d
commit 17d25284a2
4 changed files with 33 additions and 10 deletions

View File

@ -1,12 +1,14 @@
{start_tabs} {start_tabs}
{settings_tab|user-groups-admin} {relative|group|all}
1. Click the **Add a new user group** button. 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. Enter a **Name** and **Description**.
1. Click **Save**. 1. 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 1. Find the group in the list below, and add members. Zulip will notify
everyone who is added. everyone who is added.

View File

@ -18,7 +18,7 @@ trying to send a message to a group of people, you'll want to either
{start_tabs} {start_tabs}
{settings_tab|user-groups-admin} {relative|group|all}
1. Find the group. 1. Find the group.
@ -37,7 +37,7 @@ trying to send a message to a group of people, you'll want to either
{start_tabs} {start_tabs}
{settings_tab|user-groups-admin} {relative|group|all}
1. Find the group. 1. Find the group.

View File

@ -25,6 +25,10 @@ gear_info = {
'<i class="fa fa-bolt"></i> Organization settings', '<i class="fa fa-bolt"></i> Organization settings',
"/#organization/organization-profile", "/#organization/organization-profile",
], ],
"group-settings": [
'<i class="zulip-icon zulip-icon-user-cog"></i> Group settings',
"/#groups/your",
],
"integrations": ['<i class="fa fa-github"></i> Integrations', "/integrations/"], "integrations": ['<i class="fa fa-github"></i> Integrations', "/integrations/"],
"stats": ['<i class="fa fa-bar-chart"></i> Usage statistics', "/stats"], "stats": ['<i class="fa fa-bar-chart"></i> Usage statistics', "/stats"],
"plans": ['<i class="fa fa-rocket"></i> Plans and pricing', "/plans/"], "plans": ['<i class="fa fa-rocket"></i> Plans and pricing', "/plans/"],
@ -104,6 +108,27 @@ def stream_handle_match(key: str) -> str:
return stream_instructions_no_link return stream_instructions_no_link
group_info = {
"all": ["All groups", "/#groups/all"],
"subscribed": ["Your groups", "/#groups/your"],
}
group_instructions_no_link = """
1. Click on the **gear** (<i class="fa fa-cog"></i>) icon in the upper
right corner of the web or desktop app.
1. Click **Group settings**.
"""
def group_handle_match(key: str) -> str:
if relative_help_links:
return f"1. Go to [{group_info[key][0]}]({group_info[key][1]})."
if key == "all":
return group_instructions_no_link + "\n\n1. Click **All groups** in the upper left."
return group_instructions_no_link
draft_instructions = """ draft_instructions = """
1. Click on <i class="fa fa-pencil"></i> **Drafts** in the left sidebar. 1. Click on <i class="fa fa-pencil"></i> **Drafts** in the left sidebar.
""" """
@ -163,6 +188,7 @@ LINK_TYPE_HANDLERS = {
"stream": stream_handle_match, "stream": stream_handle_match,
"message": message_handle_match, "message": message_handle_match,
"help": help_handle_match, "help": help_handle_match,
"group": group_handle_match,
} }

View File

@ -58,11 +58,6 @@ link_mapping = {
"Authentication methods", "Authentication methods",
"/#organization/auth-methods", "/#organization/auth-methods",
], ],
"user-groups-admin": [
"Organization settings",
"User groups",
"/#organization/user-groups-admin",
],
"user-list-admin": ["Organization settings", "Users", "/#organization/user-list-admin"], "user-list-admin": ["Organization settings", "Users", "/#organization/user-list-admin"],
"deactivated-users-admin": [ "deactivated-users-admin": [
"Organization settings", "Organization settings",