From 3ea34b3b7caadf9ffe290c0e609bb0346556a4a6 Mon Sep 17 00:00:00 2001 From: Rishi Gupta Date: Mon, 29 Oct 2018 22:40:33 -0700 Subject: [PATCH] user docs: Update docs to reflect new guests feature. --- .../zerver/help/add-a-bot-or-integration.md | 2 +- templates/zerver/help/add-custom-emoji.md | 2 +- .../help/add-or-remove-users-from-a-stream.md | 6 +-- .../zerver/help/bots-and-integrations.md | 2 +- .../help/configure-who-can-create-streams.md | 4 +- templates/zerver/help/create-a-stream.md | 4 +- templates/zerver/help/invite-users.md | 4 +- .../help/make-a-user-an-administrator.md | 2 +- .../help/only-allow-admins-to-add-emoji.md | 2 +- .../zerver/help/restrict-bot-creation.md | 2 +- templates/zerver/help/stream-permissions.md | 39 +++++++++++-------- 11 files changed, 38 insertions(+), 31 deletions(-) diff --git a/templates/zerver/help/add-a-bot-or-integration.md b/templates/zerver/help/add-a-bot-or-integration.md index 86f9f9685a..e3ca3a3797 100644 --- a/templates/zerver/help/add-a-bot-or-integration.md +++ b/templates/zerver/help/add-a-bot-or-integration.md @@ -1,6 +1,6 @@ # Add a bot -By default, anyone can add a bot to a Zulip organization. +By default, anyone other than guests can add a bot to a Zulip organization. A bot that sends content to or from another product is often called an **integration**. diff --git a/templates/zerver/help/add-custom-emoji.md b/templates/zerver/help/add-custom-emoji.md index 0997163a9f..1ba439848e 100644 --- a/templates/zerver/help/add-custom-emoji.md +++ b/templates/zerver/help/add-custom-emoji.md @@ -1,6 +1,6 @@ # Add custom emoji -By default, anyone can add custom emoji to a Zulip organization. Added emoji +By default, anyone other than guests can add custom emoji to a Zulip organization. Added emoji are available to all users. Organization administrators can also diff --git a/templates/zerver/help/add-or-remove-users-from-a-stream.md b/templates/zerver/help/add-or-remove-users-from-a-stream.md index 1cdc2a7e94..73f9e6fbe2 100644 --- a/templates/zerver/help/add-or-remove-users-from-a-stream.md +++ b/templates/zerver/help/add-or-remove-users-from-a-stream.md @@ -2,9 +2,9 @@ ## Add someone to a stream -Anyone subscribed to a stream can add users to that stream. Additionally, -anyone can add users to a public stream, whether or not they are subscribed -to the stream. +Anyone (other than guests) subscribed to a stream can add users to that +stream. Additionally, anyone (other than guests) can add users to a public +stream, whether or not they are subscribed to the stream. {relative|stream|all} diff --git a/templates/zerver/help/bots-and-integrations.md b/templates/zerver/help/bots-and-integrations.md index 1288f98f28..adc790efa9 100644 --- a/templates/zerver/help/bots-and-integrations.md +++ b/templates/zerver/help/bots-and-integrations.md @@ -68,7 +68,7 @@ A few more details: ## Adding bots -By default, anyone can [add a bot](/help/add-a-bot-or-integration) to a +By default, anyone other than guests can [add a bot](/help/add-a-bot-or-integration) to a Zulip organization, but administrators can [restrict bot creation](/help/restrict-bot-creation). Any bot that is added is visible and available for anyone to use. diff --git a/templates/zerver/help/configure-who-can-create-streams.md b/templates/zerver/help/configure-who-can-create-streams.md index 237c1efecd..b1bf00fbdb 100644 --- a/templates/zerver/help/configure-who-can-create-streams.md +++ b/templates/zerver/help/configure-who-can-create-streams.md @@ -2,10 +2,10 @@ {!admin-only.md!} -By default, any user can create new streams. However, you can restrict stream creation to +By default, anyone other than guests can create new streams. However, you can restrict stream creation to * **Organization administrators**, or -* **Organization administrators, and anyone with an account at least `N` days old**, +* **Organization administrators, and members with accounts at least `N` days old**, for any `N`. For corporations and other entities with controlled access, we highly diff --git a/templates/zerver/help/create-a-stream.md b/templates/zerver/help/create-a-stream.md index d54ce53873..78d29c0f16 100644 --- a/templates/zerver/help/create-a-stream.md +++ b/templates/zerver/help/create-a-stream.md @@ -1,10 +1,10 @@ # Create a stream -By default, anyone can create streams in a Zulip organization. +By default, all users other than guests can create streams. Organization administrators can [restrict stream creation](/help/configure-who-can-create-streams) to -admins only, or to users meeting a minimum account age. +admins only, or to members meeting a minimum account age. If you are an administrator setting up streams for the first time, we highly recommend reading our diff --git a/templates/zerver/help/invite-users.md b/templates/zerver/help/invite-users.md index a756a98491..96d9f9f5a0 100644 --- a/templates/zerver/help/invite-users.md +++ b/templates/zerver/help/invite-users.md @@ -1,7 +1,7 @@ # Invite users By default, users need an invitation to join your Zulip organization, and -any existing user can invite anyone else. +all members other than guests can invite others. Organization administrators can also [modify who can join and invite](/help/manage-who-can-join-and-invite) in a @@ -10,7 +10,7 @@ variety of ways. {relative|gear|invite} 1. Enter a list of **email addresses**, decide whether the new users should - **join as members or admins**, and select the **streams they should join**. + **join as admins, members, or guests**, and select the **streams they should join**. 1. Click **Invite**. diff --git a/templates/zerver/help/make-a-user-an-administrator.md b/templates/zerver/help/make-a-user-an-administrator.md index a248d3dc5a..b14d1f0b80 100644 --- a/templates/zerver/help/make-a-user-an-administrator.md +++ b/templates/zerver/help/make-a-user-an-administrator.md @@ -11,7 +11,7 @@ member an administrator, or revoke admin access from any other administrator. 1. Find the user you would like to manage. Click the **pencil** () to the right of their name. -1. Under **User role**, select **Member** or **Administrator**. +1. Under **User role**, select **Administrator**, **Member** or **Guest**. 1. Click **Save changes**. The new rights will take effect immediately. diff --git a/templates/zerver/help/only-allow-admins-to-add-emoji.md b/templates/zerver/help/only-allow-admins-to-add-emoji.md index 1f48cecd0b..ac1c217d2a 100644 --- a/templates/zerver/help/only-allow-admins-to-add-emoji.md +++ b/templates/zerver/help/only-allow-admins-to-add-emoji.md @@ -2,7 +2,7 @@ {!admin-only.md!} -By default, any user can [add custom emoji](/help/add-custom-emoji) to the +By default, anyone other than guests can [add custom emoji](/help/add-custom-emoji) to the organization. However, you can change your organization's settings to only allow administrators to add new emoji. diff --git a/templates/zerver/help/restrict-bot-creation.md b/templates/zerver/help/restrict-bot-creation.md index 2467209fbe..717a1b896d 100644 --- a/templates/zerver/help/restrict-bot-creation.md +++ b/templates/zerver/help/restrict-bot-creation.md @@ -2,7 +2,7 @@ {!admin-only.md!} -By default, anyone can [add a bot](/help/add-a-bot-or-integration) or +By default, anyone other than guests can [add a bot](/help/add-a-bot-or-integration) or integration to the Zulip organization. Organization administrators can change who is allowed to add bots. diff --git a/templates/zerver/help/stream-permissions.md b/templates/zerver/help/stream-permissions.md index 31d3f939a5..c862f5d786 100644 --- a/templates/zerver/help/stream-permissions.md +++ b/templates/zerver/help/stream-permissions.md @@ -3,7 +3,7 @@ Streams are similar to chatrooms, IRC channels, or email lists in that they determine who receives a message. There are three types of streams in Zulip. -* **Public**: Anyone can join, and anyone can view the complete message +* **Public**: Anyone other than guests can join, and anyone (other than guests) can view the complete message history without joining. * **Private, shared history**: You must be added by a member of the stream. The @@ -21,11 +21,14 @@ At a high level: messages or do things that would indirectly give them access to stream messages, like adding members or changing the stream privacy settings. -* Non-admins cannot easily see which private streams exist, or interact with +* Non-admin members cannot easily see which private streams exist, or interact with them in any way until they are added. Given a stream name, they can figure out whether a stream with that name exists, but cannot see any other details about the stream. +* From the perspective of a guest, all streams are private streams, and they + additionally can't add other members to the streams they are subscribed to. + There are two situations in which an organization administrator can access private stream messages: @@ -40,41 +43,45 @@ private stream messages: ### Public streams -| | Org admins | Stream members | Org members | -|--- |--- |--- |--- | +| | Org admins | Stream members | Org members | Guests +|--- |--- |--- |--- |--- | Join | ✔ | — | ✔ | -| Add others | ✔ | ✔ | ✔ | +| Add others | ✔ | [1] | ✔ | | See subscriber list | ✔ | ✔ | ✔ | | See full history | ✔ | ✔ | ✔ | | See estimated traffic | ✔ | ✔ | ✔ | -| Post | ✔ | [1] | | +| Post | ✔ | [2] | | | Change the privacy | ✔ | | | | Rename | ✔ | | | | Edit the description | ✔ | | | | Remove others | ✔ | | | | Delete | ✔ | | | -[1] Configurable. +[1] Yes, except for guests. + +[2] Configurable. ### Private streams -| | Org admins | Stream members | Org members | -|--- |--- |--- |--- | +| | Org admins | Stream members | Org members | Guests +|--- |--- |--- |--- |--- | Join | | — | | -| Add others | | ✔ | | +| Add others | | [1] | | | See subscriber list | ✔ | ✔ | | -| See full history | | [2] | | +| See full history | | [3] | | | See estimated traffic | ✔ | ✔ | | -| Post | ✔ | [1] | | -| Change the privacy | [3] | | | +| Post | ✔ | [2] | | +| Change the privacy | [4] | | | | Rename | ✔ | | | | Edit the description | ✔ | | | | Remove others | ✔ | | | | Delete | ✔ | | | -[1] Configurable. +[1] Yes, except for guests. -[2] Depends on the stream type. +[2] Configurable. -[3] Yes, but only if subscribed. If you have a private stream without an +[3] Depends on the stream type. + +[4] Yes, but only if subscribed. If you have a private stream without an admin, you'll have to add an admin in order to change the stream's privacy.