From dbc573584b48244365b7f9f5c8bc481055c4e3e9 Mon Sep 17 00:00:00 2001 From: Lyla Fischer Date: Tue, 24 Apr 2018 21:54:09 -0400 Subject: [PATCH] user docs: Use the {settings_tab} macro for four organization settings. --- templates/zerver/help/change-a-users-name.md | 3 +-- templates/zerver/help/configure-authentication-methods.md | 3 +-- templates/zerver/help/deactivate-or-reactivate-a-bot.md | 6 ++---- templates/zerver/help/deactivate-or-reactivate-a-user.md | 6 ++---- templates/zerver/help/make-a-user-an-administrator.md | 6 ++---- .../zerver/help/view-all-bots-in-your-organization.md | 5 ++++- zerver/lib/bugdown/help_settings_links.py | 8 ++++++++ 7 files changed, 20 insertions(+), 17 deletions(-) diff --git a/templates/zerver/help/change-a-users-name.md b/templates/zerver/help/change-a-users-name.md index 276f126245..0a210e9074 100644 --- a/templates/zerver/help/change-a-users-name.md +++ b/templates/zerver/help/change-a-users-name.md @@ -6,8 +6,7 @@ Ordinary users can [change their own names](/help/change-your-name), but administrators can change users' names when users are unavailable. Follow the following steps to change the name of a user. -1. Go to the [Users](/#organization/user-list-admin) -{!admin.md!} +{settings_tab|user-list-admin} 2. Click on the pencil () icon next to the name of the user you want to change. diff --git a/templates/zerver/help/configure-authentication-methods.md b/templates/zerver/help/configure-authentication-methods.md index 1357192ff7..3b924d0db4 100644 --- a/templates/zerver/help/configure-authentication-methods.md +++ b/templates/zerver/help/configure-authentication-methods.md @@ -10,8 +10,7 @@ only), and/or various other SSO methods (also currently on premise only). If you are unsure about what these mean, don't worry! Zulip allows logging in via email and password by default. -1. Go to the [Authentication methods](/#organization/auth-methods) -{!admin.md!} +{settings_tab|auth-methods} 2. Toggle the checkboxes next to the following options to configure your organization's authentication methods: diff --git a/templates/zerver/help/deactivate-or-reactivate-a-bot.md b/templates/zerver/help/deactivate-or-reactivate-a-bot.md index 302f245ce9..c9bb1415e4 100644 --- a/templates/zerver/help/deactivate-or-reactivate-a-bot.md +++ b/templates/zerver/help/deactivate-or-reactivate-a-bot.md @@ -11,8 +11,7 @@ in your organization. ## Deactivate a bot -1. Go to the [Bots](/#organization/bot-list-admin) -{!admin.md!} +{settings_tab|bot-list-admin} 4. Click the **Deactivate** button to the right of the bot that you want to deactivate. @@ -26,8 +25,7 @@ stricken through, confirming the success of the bot's deactivation. Zulip organization administrators can choose to reactivate a deactivated bot by following the following steps. -1. Go to the [Bots](/#organization/bot-list-admin) -{!admin.md!} +{settings_tab|bot-list-admin} 4. In the **Bots** section, click the **Reactivate** button to the right of the bot that you want to reactivate. diff --git a/templates/zerver/help/deactivate-or-reactivate-a-user.md b/templates/zerver/help/deactivate-or-reactivate-a-user.md index 549c4053be..4f583379ae 100644 --- a/templates/zerver/help/deactivate-or-reactivate-a-user.md +++ b/templates/zerver/help/deactivate-or-reactivate-a-user.md @@ -17,8 +17,7 @@ Instead, you should deactivate the user’s account using the Zulip **[organization administration interface](/help/change-your-organization-settings)**; this will also automatically deactivate any bots the user has created. -1. Go to the [Users](/#organization/user-list-admin) -{!admin.md!} +{settings_tab|user-list-admin} 4. Click the **Deactivate** button to the right of the user account that you want to deactivate. @@ -42,8 +41,7 @@ disappear, confirming the success of the account's deactivation. Zulip organization administrators can choose to reactivate a user's deactivated account by following the following steps. -1. Go to the [Deactivated users](/#organization/deactivated-users-admin) -{!admin.md!} +{settings_tab|deactivated-users-admin} 4. Click the **Reactivate** button to the right of the user account that you want to reactivate. diff --git a/templates/zerver/help/make-a-user-an-administrator.md b/templates/zerver/help/make-a-user-an-administrator.md index 97c23f039a..803d9184c0 100644 --- a/templates/zerver/help/make-a-user-an-administrator.md +++ b/templates/zerver/help/make-a-user-an-administrator.md @@ -7,8 +7,7 @@ modifying organization-wide settings, such as changing the organization name, activating or deactivating users, deleting streams, etc. Follow the following steps to give any user in your organization administrative rights. -1. Go to the [Users](/#organization/user-list-admin) -{!admin.md!} +{settings_tab|user-list-admin} 4. Click on the **Make admin** button for the user that you wish to make an administrator. @@ -20,8 +19,7 @@ reload and the user will gain administrative privileges immediately. Administrators can also revoke the administrative rights given to a user. -1. Go to the [Users](/#organization/user-list-admin) -{!admin.md!} +{settings_tab|user-list-admin} 2. Click on the **Remove admin** button. diff --git a/templates/zerver/help/view-all-bots-in-your-organization.md b/templates/zerver/help/view-all-bots-in-your-organization.md index e7873b7d52..f8612f8eab 100644 --- a/templates/zerver/help/view-all-bots-in-your-organization.md +++ b/templates/zerver/help/view-all-bots-in-your-organization.md @@ -3,6 +3,9 @@ {!admin-only.md!} You can view a list of all bots in your organization, active or deactivated -alike, by visiting the [Bots](/#organization/bot-list-admin) {!admin.md!} +alike. + +{settings_tab|bot-list-admin} + You can [deactivate or reactivate](/help/deactivate-or-reactivate-a-bot) any bots in your organization from this panel. diff --git a/zerver/lib/bugdown/help_settings_links.py b/zerver/lib/bugdown/help_settings_links.py index cc5602fdd9..119a517c9b 100644 --- a/zerver/lib/bugdown/help_settings_links.py +++ b/zerver/lib/bugdown/help_settings_links.py @@ -27,6 +27,14 @@ link_mapping = { '/#organization/organization-permissions'], 'emoji-settings': ['Manage organization', 'Custom emoji', '/#organization/emoji-settings'], + 'auth-methods': ['Manage organization', 'Authentication methods', + '/#organization/auth-methods'], + 'user-groups-admin': ['Manage organization', 'User groups', + '/#organization/user-groups-admin'], + 'user-list-admin': ['Manage organization', 'Users', '/#organization/user-list-admin'], + 'deactivated-users-admin': ['Manage organization', 'Deactivated users', + '/#organization/deactivated-users-admin'], + 'bot-list-admin': ['Manage organization', 'Bots', '/#organization/bot-list-admin'], } settings_markdown = """