help: Update documentation on bots.

Adds new tab to `zerver/lib/markdown/tabbed_sections.py` to document
managing bots from both personal settings and organization settings.

Documents adding bots from the organization settings Bots panel.

Separates instructions for deactivating and reactivating a bot from
both personal settings and organization settings.

Fixes a few formatting issues such as missing bold formatting and
heading level.

Fixes: #23066.
This commit is contained in:
David Rosa 2022-10-15 22:27:03 -04:00 committed by Tim Abbott
parent 24f344dc40
commit d9dd272a78
7 changed files with 76 additions and 14 deletions

View File

@ -12,11 +12,23 @@ is visible and available for anyone to use.
{start_tabs}
{tab|via-personal-settings}
{settings_tab|your-bots}
2. Click **Add a new bot**.
1. Click **Add a new bot**.
3. Fill out the fields, and click **Create bot**.
1. Fill out the fields, and click **Add**.
{tab|via-organization-settings}
{settings_tab|bot-list-admin}
1. Click **Add a new bot**.
1. Fill out the fields, and click **Add**.
{end_tabs}
!!! warn ""
@ -25,8 +37,6 @@ is visible and available for anyone to use.
Nearly all third-party integrations should use **Incoming webhook**
as the **bot type**.
{end_tabs}
Depending on the type of bot you're creating, you may need to download its
`.zuliprc` configuration file. For that, click the **download**
(<i class="fa fa-download"></i>) icon under the bot's name.

View File

@ -9,7 +9,7 @@ Bots allow you to
A bot that sends content to or from another product is often called an
**integration**.
### Pre-made bots
## Pre-made bots
Zulip natively supports integrations with over one hundred products, and with
almost a thousand more through Zapier and IFTTT. If you're looking to add an

View File

@ -9,17 +9,64 @@ add. Organization admins can prevent users from reactivating bots by
Organization administrators can also deactivate or reactivate any existing
bot, regardless of who owns them.
### Deactivate or reactivate a bot
## Deactivate a bot
{start_tabs}
{tab|via-personal-settings}
{settings_tab|your-bots}
1. Click the **deactivate bot** (<i class="fa fa-user-times"></i>) icon on the profile
card for the bot you want to deactivate.
1. Approve by clicking **Deactivate**.
!!! tip ""
You can also click the **pencil** (<i class="fa fa-pencil"></i>) icon,
scroll down to the bottom, and click **Deactivate bot**.
{tab|via-organization-settings}
{settings_tab|bot-list-admin}
4. Find the bot that you would like to manage and click
**Deactivate** or **Reactivate** to its right.
1. In the **Actions** column, click the **deactivate bot** (<i class="fa fa-user-times"></i>)
icon for the bot you want to deactivate.
1. Approve by clicking **Deactivate**.
!!! tip ""
You can also click the **pencil** (<i class="fa fa-pencil"></i>) icon,
scroll down to the bottom, and click **Deactivate bot**.
{end_tabs}
## Reactivate a bot
{start_tabs}
{tab|via-personal-settings}
{settings_tab|your-bots}
1. Click the **Inactive bots** tab.
1. Click **Reactivate bot** on the profile card for the bot you want to reactivate.
{tab|via-organization-settings}
{settings_tab|bot-list-admin}
1. In the **Actions** column, click the **reactivate bot** (<i class="fa fa-user-plus"></i>)
icon for the bot you want to reactivate.
1. Approve by clicking **Confirm**.
{end_tabs}
## Related articles
* [Bots and integrations](/help/bots-and-integrations)

View File

@ -10,7 +10,7 @@ active bot in the organization.
{settings_tab|your-bots}
1. Click the pencil (<i class="fa fa-pencil"></i>) icon on the profile
1. Click the **pencil** (<i class="fa fa-pencil"></i>) icon on the profile
card for the bot you want to edit.
1. Edit bot information as desired, and click **Save changes**.
@ -25,8 +25,8 @@ active bot in the organization.
{settings_tab|bot-list-admin}
1. In the **Actions** column, click the pencil (<i class="fa fa-pencil"></i>) icon for the
bot you want to edit.
1. In the **Actions** column, click the **pencil** (<i class="fa fa-pencil"></i>)
icon for the bot you want to edit.
1. Edit bot information as desired, and click **Save changes**.

View File

@ -6,7 +6,7 @@ By default, anyone other than guests can [add a bot](/help/add-a-bot-or-integrat
integration to the Zulip organization. Organization administrators can
change who is allowed to add bots.
### Configure who can add bots
## Configure who can add bots
{start_tabs}

View File

@ -26,7 +26,7 @@ link_mapping = {
],
"display-settings": ["Personal settings", "Display settings", "/#settings/display-settings"],
"notifications": ["Personal settings", "Notifications", "/#settings/notifications"],
"your-bots": ["Personal settings", "Bots", "/#settings/your-bots"],
"your-bots": ["Personal settings", "your Bots", "/#settings/your-bots"],
"alert-words": ["Personal settings", "Alert words", "/#settings/alert-words"],
"uploaded-files": ["Personal settings", "Uploaded files", "/#settings/uploaded-files"],
"muted-topics": ["Personal settings", "Muted topics", "/#settings/muted-topics"],
@ -64,7 +64,11 @@ link_mapping = {
"Deactivated users",
"/#organization/deactivated-users-admin",
],
"bot-list-admin": ["Manage organization", "Bots", "/#organization/bot-list-admin"],
"bot-list-admin": [
"Manage organization",
"your organization's Bots",
"/#organization/bot-list-admin",
],
"default-streams-list": [
"Manage organization",
"Default streams",

View File

@ -77,6 +77,7 @@ TAB_SECTION_LABELS = {
"web-public-streams": "Web-public streams",
"via-user-profile": "Via the user's profile",
"via-organization-settings": "Via organization settings",
"via-personal-settings": "Via personal settings",
"default-subdomain": "Default subdomain",
"custom-subdomain": "Custom subdomain",
"zulip-cloud": "Zulip Cloud",