From 0e543c7bad7af581579b02c42f6c51392f7f524c Mon Sep 17 00:00:00 2001 From: Cynthia Lin Date: Tue, 17 Jan 2017 09:54:19 -0800 Subject: [PATCH] docs: Create and use *Administrator only feature* macro. --- .../zerver/help/add-a-custom-linkification-filter.md | 7 ++++--- templates/zerver/help/add-custom-emoji.md | 4 ++-- .../help/allow-anyone-to-join-without-an-invitation.md | 2 ++ templates/zerver/help/change-a-users-name.md | 9 +++++---- ...hange-the-default-language-for-your-organization.md | 5 +++-- templates/zerver/help/change-the-stream-description.md | 6 ++++-- templates/zerver/help/change-who-can-join-a-stream.md | 6 ++++-- .../zerver/help/change-your-organizations-name.md | 6 +++--- .../zerver/help/deactivate-or-reactivate-a-bot.md | 10 ++++++++-- .../zerver/help/deactivate-or-reactivate-a-user.md | 6 ++++-- templates/zerver/help/delete-a-stream.md | 2 ++ templates/zerver/help/edit-administrator-settings.md | 2 ++ templates/zerver/help/include/admin-only.md | 2 ++ templates/zerver/help/make-a-user-an-administrator.md | 5 +++-- .../only-allow-admins-to-create-new-streams-feature.md | 4 +++- .../help/only-allow-admins-to-invite-new-users.md | 8 ++++++-- templates/zerver/help/remove-someone-from-a-stream.md | 6 ++++-- templates/zerver/help/rename-a-stream.md | 5 +++-- .../restrict-editing-of-old-messages-and-topics.md | 9 +++++---- ...restrict-user-email-addresses-to-certain-domains.md | 9 ++++++--- .../zerver/help/set-default-streams-for-new-users.md | 7 ++++--- .../zerver/help/view-all-bots-in-your-organization.md | 8 ++++---- 22 files changed, 83 insertions(+), 45 deletions(-) create mode 100644 templates/zerver/help/include/admin-only.md diff --git a/templates/zerver/help/add-a-custom-linkification-filter.md b/templates/zerver/help/add-a-custom-linkification-filter.md index 6c129bc4e4..cec5016855 100644 --- a/templates/zerver/help/add-a-custom-linkification-filter.md +++ b/templates/zerver/help/add-a-custom-linkification-filter.md @@ -1,8 +1,9 @@ # Add a custom linkification filter -If you are an administrator of a Zulip organization, you can add custom -linkification filters to your organization that automatically turn phrases in -messages into links to other pages. +{!admin-only.md!} + +You can add custom linkification filters to your organization that +automatically turn phrases in messages into links to other pages. {!go-to-the.md!} [Filter Settings](/#administration/filter-settings) {!admin.md!} diff --git a/templates/zerver/help/add-custom-emoji.md b/templates/zerver/help/add-custom-emoji.md index ea63554781..e6cece2fcb 100644 --- a/templates/zerver/help/add-custom-emoji.md +++ b/templates/zerver/help/add-custom-emoji.md @@ -1,7 +1,7 @@ # Add custom emoji -If you are an administrator of a Zulip organization, you can add -custom emojis to your organization for other members to use. +If enabled by your Zulip organization administrator, you can add custom +emojis to your organization for other members to use. {!go-to-the.md!} [Emoji Settings](/#administration/emoji-settings) {!admin.md!} diff --git a/templates/zerver/help/allow-anyone-to-join-without-an-invitation.md b/templates/zerver/help/allow-anyone-to-join-without-an-invitation.md index 884408256c..ce592260db 100644 --- a/templates/zerver/help/allow-anyone-to-join-without-an-invitation.md +++ b/templates/zerver/help/allow-anyone-to-join-without-an-invitation.md @@ -1,5 +1,7 @@ # Allow anyone to join without an invitation +{!admin-only.md!} + By default, new users can join a Zulip organization with or without an email invitation. diff --git a/templates/zerver/help/change-a-users-name.md b/templates/zerver/help/change-a-users-name.md index f59c5b09b4..604f7adbf3 100644 --- a/templates/zerver/help/change-a-users-name.md +++ b/templates/zerver/help/change-a-users-name.md @@ -1,9 +1,10 @@ # Change a user's name -An administrator can change the name of another user. Ordinary users can -[change their own names](/help/change-your-name), but administrators can change -users' names when users are unavailable. -{!follow-steps.md!} change the name of a user using an administrator account. +{!admin-only.md!} + +Ordinary users can [change their own names](/help/change-your-name), but +administrators can change users' names when users are +unavailable. {!follow-steps.md!} change the name of a user. {!go-to-the.md!} [Users](/#administration/user-list-admin) {!admin.md!} diff --git a/templates/zerver/help/change-the-default-language-for-your-organization.md b/templates/zerver/help/change-the-default-language-for-your-organization.md index 3c995dbd6d..86952eeff7 100644 --- a/templates/zerver/help/change-the-default-language-for-your-organization.md +++ b/templates/zerver/help/change-the-default-language-for-your-organization.md @@ -1,7 +1,8 @@ # Change the default language -If you are an administrator of a Zulip organization, you can change the default -language of your organization by following the following steps. +{!admin-only.md!} + +{!follow-steps.md!} change the default language of your organization. {!go-to-the.md!} [Organization Settings](/#administration/organization-settings) {!admin.md!} diff --git a/templates/zerver/help/change-the-stream-description.md b/templates/zerver/help/change-the-stream-description.md index c209bbcbba..c5ea6f6fe7 100644 --- a/templates/zerver/help/change-the-stream-description.md +++ b/templates/zerver/help/change-the-stream-description.md @@ -1,7 +1,9 @@ # Change the stream description -If you are an administrator of a Zulip organization, you can change the -description of any stream in your organization. +{!admin-only.md!} + +{!follow-steps.md!} change the description of any stream in your +organization. {!subscriptions.md!} {!filter-streams.md!} diff --git a/templates/zerver/help/change-who-can-join-a-stream.md b/templates/zerver/help/change-who-can-join-a-stream.md index 3acaa83b2e..03dd3dd3c8 100644 --- a/templates/zerver/help/change-who-can-join-a-stream.md +++ b/templates/zerver/help/change-who-can-join-a-stream.md @@ -1,7 +1,9 @@ # Change the accessibility of a stream -If you are a Zulip organization administrator, you can change who can join your -stream by changing the stream's accessibility. +{!admin-only.md!} + +{!follow-steps.md!} change who can join your stream by changing the stream's +accessibility. Please note that any users that were previously subscribed to the stream will remain subscribed to the stream after you change the stream's accessibility. diff --git a/templates/zerver/help/change-your-organizations-name.md b/templates/zerver/help/change-your-organizations-name.md index 858e31a1ad..04a4f4e286 100644 --- a/templates/zerver/help/change-your-organizations-name.md +++ b/templates/zerver/help/change-your-organizations-name.md @@ -1,8 +1,8 @@ # Change your organization's name -Only an administrator can change the name of the organization. -{!follow-steps.md!} change the name of the organization -using an administrator account: +{!admin-only.md!} + +{!follow-steps.md!} change the name of your organization. {!go-to-the.md!} [Organization Settings](/#administration/organization-settings) {!admin.md!} diff --git a/templates/zerver/help/deactivate-or-reactivate-a-bot.md b/templates/zerver/help/deactivate-or-reactivate-a-bot.md index 31a40d4e70..dff9847bb5 100644 --- a/templates/zerver/help/deactivate-or-reactivate-a-bot.md +++ b/templates/zerver/help/deactivate-or-reactivate-a-bot.md @@ -1,7 +1,13 @@ # Deactivate or reactivate a bot -Zulip organization administrators have the ability to deactivate or reactivate any bots -in their organization. +{!admin-only.md!} + +{!follow-steps.md!} deactivate or reactivate any bots +in your organization. + +!!! tip "" + You can manage your own bots or integrations on the + [Your bots](/#settings/your-bots) {!settings.md!} ## Deactivate a bot diff --git a/templates/zerver/help/deactivate-or-reactivate-a-user.md b/templates/zerver/help/deactivate-or-reactivate-a-user.md index e7a5d99563..22de25ec95 100644 --- a/templates/zerver/help/deactivate-or-reactivate-a-user.md +++ b/templates/zerver/help/deactivate-or-reactivate-a-user.md @@ -1,7 +1,9 @@ # Deactivate or reactivate a user -Zulip organization administrators have the ability to deactivate or reactivate any -user's account in their organization. +{!admin-only.md!} + +{!follow-steps.md!} deactivate or reactivate any user's account in your +organization. ## Deactivate a user diff --git a/templates/zerver/help/delete-a-stream.md b/templates/zerver/help/delete-a-stream.md index 5d01bb25d9..d24cc60f12 100644 --- a/templates/zerver/help/delete-a-stream.md +++ b/templates/zerver/help/delete-a-stream.md @@ -1,5 +1,7 @@ # Delete a stream +{!admin-only.md!} + In Zulip, most of the stream administration is done on the subscription page. However, Zulip organization administrators must use their administration panels to delete streams. diff --git a/templates/zerver/help/edit-administrator-settings.md b/templates/zerver/help/edit-administrator-settings.md index 433cc133fc..48a245bf7e 100644 --- a/templates/zerver/help/edit-administrator-settings.md +++ b/templates/zerver/help/edit-administrator-settings.md @@ -1,5 +1,7 @@ # Edit [Administrator](/#administration) Settings +{!admin-only.md!} + 1. Click the cog () icon in the top right corner. 2. From the dropdown menu, choose the **Administration** option. diff --git a/templates/zerver/help/include/admin-only.md b/templates/zerver/help/include/admin-only.md new file mode 100644 index 0000000000..2b9ff35828 --- /dev/null +++ b/templates/zerver/help/include/admin-only.md @@ -0,0 +1,2 @@ +!!! warn "" + **Note:** This feature can only be controlled by organization administrators. diff --git a/templates/zerver/help/make-a-user-an-administrator.md b/templates/zerver/help/make-a-user-an-administrator.md index 9b672f3ab0..1ac72f87b5 100644 --- a/templates/zerver/help/make-a-user-an-administrator.md +++ b/templates/zerver/help/make-a-user-an-administrator.md @@ -1,9 +1,10 @@ # Make a user an administrator +{!admin-only.md!} + By default, everyone in an organization is a user; this limits them from modifying organization-wide settings, such as changing the organization name, -activating or deactivating users, deleting streams, etc. Zulip organization -administrators can give a user administrative rights. {!follow-steps.md!} +activating or deactivating users, deleting streams, etc. {!follow-steps.md!} give any user in your organization administrative rights. {!go-to-the.md!} [Users](/#administration/user-list-admin) diff --git a/templates/zerver/help/only-allow-admins-to-create-new-streams-feature.md b/templates/zerver/help/only-allow-admins-to-create-new-streams-feature.md index e1999abbf0..1ac605c567 100644 --- a/templates/zerver/help/only-allow-admins-to-create-new-streams-feature.md +++ b/templates/zerver/help/only-allow-admins-to-create-new-streams-feature.md @@ -1,6 +1,8 @@ # Only allow admins to create new streams -If you are a Zulip organization administrator, you can enable a setting that +{!admin-only.md!} + +By default, any user can create new streams. You can enable a setting that only allows administrators to create new streams in the organization. {!go-to-the.md!} [Organization settings](/#administration/organization-settings) diff --git a/templates/zerver/help/only-allow-admins-to-invite-new-users.md b/templates/zerver/help/only-allow-admins-to-invite-new-users.md index 40bbc0af5f..5ef986fe77 100644 --- a/templates/zerver/help/only-allow-admins-to-invite-new-users.md +++ b/templates/zerver/help/only-allow-admins-to-invite-new-users.md @@ -1,6 +1,10 @@ # Only allow admins to invite new users -If you are an administrator, you can change the setting to only allow administrators -to invite new users. + +{!admin-only.md!} + +By default, any user in your Zulip organization can invite new users. You +can change your organization's settings to only allow administrators to +invite new users. {!go-to-the.md!} [Organization settings](/#administration/organization-settings) {!admin.md!} diff --git a/templates/zerver/help/remove-someone-from-a-stream.md b/templates/zerver/help/remove-someone-from-a-stream.md index 5e3426ac7f..c542844d0d 100644 --- a/templates/zerver/help/remove-someone-from-a-stream.md +++ b/templates/zerver/help/remove-someone-from-a-stream.md @@ -1,7 +1,9 @@ # Remove someone from a stream -As an administrator, Zulip allows you to remove users from streams to help -manage your Zulip team. +{!admin-only.md!} + +Zulip allows you to remove users from streams to help manage your Zulip +team. {!subscriptions.md!} {!filter-streams.md!} diff --git a/templates/zerver/help/rename-a-stream.md b/templates/zerver/help/rename-a-stream.md index c18ad02a77..a034558fed 100644 --- a/templates/zerver/help/rename-a-stream.md +++ b/templates/zerver/help/rename-a-stream.md @@ -1,7 +1,8 @@ # Rename a stream -If you are an administrator of a Zulip organization, you can rename existing -streams by following the following steps. +{!admin-only.md!} + +{!follow-steps.md!} rename existing streams in your organization. {!subscriptions.md!} {!filter-streams.md!} diff --git a/templates/zerver/help/restrict-editing-of-old-messages-and-topics.md b/templates/zerver/help/restrict-editing-of-old-messages-and-topics.md index 322e4dded8..9f50713bb0 100644 --- a/templates/zerver/help/restrict-editing-of-old-messages-and-topics.md +++ b/templates/zerver/help/restrict-editing-of-old-messages-and-topics.md @@ -1,9 +1,10 @@ # Restrict editing of old messages and topics -If you are an administrator of a Zulip organization, you can easily change the -time limit that your organization's users have to change their messages after sending -them. Alternatively, you can choose to disable message editing for your organization -users. +{!admin-only.md!} + +You can easily change the time limit that your organization's users have to +change their messages after sending them. Alternatively, you can choose to +disable message editing for your organization users. {!go-to-the.md!} [Organization Settings](/#administration/organization-settings) {!admin.md!} diff --git a/templates/zerver/help/restrict-user-email-addresses-to-certain-domains.md b/templates/zerver/help/restrict-user-email-addresses-to-certain-domains.md index b3ca9abbf6..08e9acf97d 100644 --- a/templates/zerver/help/restrict-user-email-addresses-to-certain-domains.md +++ b/templates/zerver/help/restrict-user-email-addresses-to-certain-domains.md @@ -1,8 +1,11 @@ # Restrict user email addresses to certain domains -We allow administrators to block new users from signing up who are not in - the organization. The administrator can accomplish this by restricting - users to have email addresses only from the organization's domains. +{!admin-only.md!} + +Zulip allows organization administrators to block new users from signing up +who are not in their organization. The administrator can accomplish this by +restricting users to have email addresses only from the organization's +domains. {!go-to-the.md!} [Organization settings](/#administration/) {!admin.md!} diff --git a/templates/zerver/help/set-default-streams-for-new-users.md b/templates/zerver/help/set-default-streams-for-new-users.md index 9a43bcd493..082468dc8d 100644 --- a/templates/zerver/help/set-default-streams-for-new-users.md +++ b/templates/zerver/help/set-default-streams-for-new-users.md @@ -1,8 +1,9 @@ # Set default streams for new users -If you are an administrator of a Zulip organization, you can set the default -streams that new users are automatically subscribed to by following the -following steps. +{!admin-only.md!} + +{!follow-steps.md!} set the default streams that new users are automatically +subscribed to. {!go-to-the.md!} [Default streams](/#administration/default-streams-list) {!admin.md!} 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 c9bc58b862..f482d6ca16 100644 --- a/templates/zerver/help/view-all-bots-in-your-organization.md +++ b/templates/zerver/help/view-all-bots-in-your-organization.md @@ -1,8 +1,8 @@ # View all bots in your organization -If you are an administrator of a Zulip organization, you can view a list of all -bots in your organization, active or deactivated alike, by visiting the -[Bots](/#administration/bot-list-admin) -{!admin.md!} +{!admin-only.md!} + +You can view a list of all bots in your organization, active or deactivated +alike, by visiting the [Bots](/#administration/bot-list-admin) {!admin.md!} You can [deactivate or reactivate](/help/deactivate-or-reactivate-a-bot) any bots in your organization from this panel.