mirror of https://github.com/zulip/zulip.git
docs: Update `docs/production/` files to use channel.
Updates descriptive text that refer to Zulip channels in the `docs/production` files to use channel instead of stream. Part of the stream to channel rename project.
This commit is contained in:
parent
64d8a18b76
commit
42efea4e19
|
@ -153,7 +153,7 @@ login form.
|
||||||
You may also want to configure Zulip's settings for [inviting new
|
You may also want to configure Zulip's settings for [inviting new
|
||||||
users](https://zulip.com/help/invite-new-users). If LDAP is the
|
users](https://zulip.com/help/invite-new-users). If LDAP is the
|
||||||
only enabled authentication method, the main use case for Zulip's
|
only enabled authentication method, the main use case for Zulip's
|
||||||
invitation feature is selecting the initial streams for invited users
|
invitation feature is selecting the initial channels for invited users
|
||||||
(invited users will still need to use their LDAP password to create an
|
(invited users will still need to use their LDAP password to create an
|
||||||
account).
|
account).
|
||||||
|
|
||||||
|
|
|
@ -12,9 +12,9 @@ because it enables:
|
||||||
documentation](https://zulip.com/integrations/doc/email) for
|
documentation](https://zulip.com/integrations/doc/email) for
|
||||||
details.
|
details.
|
||||||
|
|
||||||
Once this integration is configured, each stream will have a special
|
Once this integration is configured, each channel will have a special
|
||||||
email address displayed on the stream settings page. Emails sent to
|
email address displayed on the channel settings page. Emails sent to
|
||||||
that address will be delivered into the stream.
|
that address will be delivered into the channel.
|
||||||
|
|
||||||
There are two ways to configure Zulip's email gateway:
|
There are two ways to configure Zulip's email gateway:
|
||||||
|
|
||||||
|
|
|
@ -59,7 +59,7 @@ service (or back):
|
||||||
- Zulip also has an [HTML archive
|
- Zulip also has an [HTML archive
|
||||||
tool](https://github.com/zulip/zulip-archive), which is primarily
|
tool](https://github.com/zulip/zulip-archive), which is primarily
|
||||||
intended for public archives, but can also be useful to
|
intended for public archives, but can also be useful to
|
||||||
inexpensively preserve public stream conversations when
|
inexpensively preserve public channel conversations when
|
||||||
decommissioning a Zulip organization.
|
decommissioning a Zulip organization.
|
||||||
|
|
||||||
- It's possible to set up [PostgreSQL streaming
|
- It's possible to set up [PostgreSQL streaming
|
||||||
|
@ -264,7 +264,7 @@ a few downsides in comparison:
|
||||||
- All users will have their passwords randomized and be logged out of
|
- All users will have their passwords randomized and be logged out of
|
||||||
their accounts, both on web and mobile clients.
|
their accounts, both on web and mobile clients.
|
||||||
- All bots and integrations will need to be updated with new API keys.
|
- All bots and integrations will need to be updated with new API keys.
|
||||||
- Users, streams, and messages are usually renumbered, which will
|
- Users, channels, and messages are usually renumbered, which will
|
||||||
break most links from external programs referencing these objects.
|
break most links from external programs referencing these objects.
|
||||||
|
|
||||||
### Consider upgrading
|
### Consider upgrading
|
||||||
|
|
|
@ -173,7 +173,7 @@ and privacy in mind:
|
||||||
|
|
||||||
- The numeric message ID generated by your Zulip server.
|
- The numeric message ID generated by your Zulip server.
|
||||||
- Metadata on the message's sender (name and avatar URL).
|
- Metadata on the message's sender (name and avatar URL).
|
||||||
- Metadata on the message's recipient (stream name + ID, topic,
|
- Metadata on the message's recipient (channel name + ID, topic,
|
||||||
direct message recipients, etc.).
|
direct message recipients, etc.).
|
||||||
- A timestamp.
|
- A timestamp.
|
||||||
- The message's content.
|
- The message's content.
|
||||||
|
|
|
@ -206,14 +206,14 @@ installing Zulip with a dedicated database server.
|
||||||
- **Disk for database:** SSD disk is highly recommended. For
|
- **Disk for database:** SSD disk is highly recommended. For
|
||||||
installations where most messages have <100 recipients, 10 GB per 1M
|
installations where most messages have <100 recipients, 10 GB per 1M
|
||||||
messages of history is sufficient plus 1 GB per 1000 users is
|
messages of history is sufficient plus 1 GB per 1000 users is
|
||||||
sufficient. If most messages are to public streams with 10K+ users
|
sufficient. If most messages are to public channels with 10K+ users
|
||||||
subscribed (like on chat.zulip.org), add 20 GB per (1000 user
|
subscribed (like on chat.zulip.org), add 20 GB per (1000 user
|
||||||
accounts) per (1M messages to public streams).
|
accounts) per (1M messages to public channels).
|
||||||
|
|
||||||
- **Example:** When
|
- **Example:** When
|
||||||
[the Zulip development community](https://zulip.com/development-community/) server
|
[the Zulip development community](https://zulip.com/development-community/) server
|
||||||
had 12K user accounts (~300 daily actives) and 800K messages of
|
had 12K user accounts (~300 daily actives) and 800K messages of
|
||||||
history (400K to public streams), it was a default configuration
|
history (400K to public channels), it was a default configuration
|
||||||
single-server installation with 16 GB of RAM, 4 cores (essentially
|
single-server installation with 16 GB of RAM, 4 cores (essentially
|
||||||
always idle), and its database was using about 100 GB of disk.
|
always idle), and its database was using about 100 GB of disk.
|
||||||
|
|
||||||
|
|
|
@ -51,10 +51,10 @@ The Zulip server-side configuration is straightforward:
|
||||||
|
|
||||||
## Additional options
|
## Additional options
|
||||||
|
|
||||||
- To enable the creation of guest accounts without automatically subscribing them to any initial streams,
|
- To enable the creation of guest accounts without automatically subscribing them to any initial channels,
|
||||||
add `"create_guests_without_streams": True` to your client's config dict in `SCIM_CONFIG`.
|
add `"create_guests_without_streams": True` to your client's config dict in `SCIM_CONFIG`.
|
||||||
This option is particularly useful for organizations that prefer to manually invite new guest users
|
This option is particularly useful for organizations that prefer to manually invite new guest users
|
||||||
to the appropriate streams.
|
to the appropriate channels.
|
||||||
|
|
||||||
Example configuration with the additional option:
|
Example configuration with the additional option:
|
||||||
|
|
||||||
|
|
|
@ -99,26 +99,26 @@ strength allowed is controlled by two settings in
|
||||||
parser which escapes content to protect against cross-site scripting
|
parser which escapes content to protect against cross-site scripting
|
||||||
attacks.
|
attacks.
|
||||||
|
|
||||||
- Zulip supports both public streams and private streams.
|
- Zulip supports both public channels and private channels.
|
||||||
|
|
||||||
- Any non-guest user can join any public stream in the organization,
|
- Any non-guest user can join any public channel in the organization,
|
||||||
and can view the complete message history of any public stream
|
and can view the complete message history of any public channel
|
||||||
without joining the stream. Guests can only access streams that
|
without joining the channel. Guests can only access channels that
|
||||||
another user adds them to.
|
another user adds them to.
|
||||||
|
|
||||||
- Organization owners and administrators can see and modify most
|
- Organization owners and administrators can see and modify most
|
||||||
aspects of a private stream, including the membership and
|
aspects of a private channel, including the membership and
|
||||||
estimated traffic. Owners and administrators generally cannot see
|
estimated traffic. Owners and administrators generally cannot see
|
||||||
messages sent to private streams or do things that would
|
messages sent to private channels or do things that would
|
||||||
indirectly give them access to those messages, like adding members
|
indirectly give them access to those messages, like adding members
|
||||||
or changing the stream privacy settings.
|
or changing the channel privacy settings.
|
||||||
|
|
||||||
- Non-admins cannot easily see which private streams exist, or interact
|
- Non-admins cannot easily see which private channels exist, or interact
|
||||||
with them in any way until they are added. Given a stream name, they can
|
with them in any way until they are added. Given a channel name, they can
|
||||||
figure out whether a stream with that name exists, but cannot see any
|
figure out whether a channel with that name exists, but cannot see any
|
||||||
other details about the stream.
|
other details about the channel.
|
||||||
|
|
||||||
- See [Stream permissions](https://zulip.com/help/stream-permissions) for more details.
|
- See [Channel permissions](https://zulip.com/help/stream-permissions) for more details.
|
||||||
|
|
||||||
- Zulip supports editing the content and topics of messages that have
|
- Zulip supports editing the content and topics of messages that have
|
||||||
already been sent. As a general philosophy, our policies provide
|
already been sent. As a general philosophy, our policies provide
|
||||||
|
@ -143,21 +143,21 @@ strength allowed is controlled by two settings in
|
||||||
and bots.
|
and bots.
|
||||||
|
|
||||||
- Owners and administrators have the ability to deactivate and
|
- Owners and administrators have the ability to deactivate and
|
||||||
reactivate other human and bot users, archive streams, add/remove
|
reactivate other human and bot users, archive channels, add/remove
|
||||||
administrator privileges, as well as change configuration for the
|
administrator privileges, as well as change configuration for the
|
||||||
organization.
|
organization.
|
||||||
|
|
||||||
Being an organization administrator does not generally provide the ability
|
Being an organization administrator does not generally provide the ability
|
||||||
to read other users' direct messages or messages sent to private
|
to read other users' direct messages or messages sent to private
|
||||||
streams to which the administrator is not subscribed. There are two
|
channels to which the administrator is not subscribed. There are two
|
||||||
exceptions:
|
exceptions:
|
||||||
|
|
||||||
- Organization owners may get access to direct messages via some types of
|
- Organization owners may get access to direct messages via some types of
|
||||||
[data export](https://zulip.com/help/export-your-organization).
|
[data export](https://zulip.com/help/export-your-organization).
|
||||||
|
|
||||||
- Administrators can change the ownership of a bot. If a bot is subscribed
|
- Administrators can change the ownership of a bot. If a bot is subscribed
|
||||||
to a private stream, then an administrator can indirectly get access to
|
to a private channel, then an administrator can indirectly get access to
|
||||||
stream messages by taking control of the bot, though the access will be
|
channel messages by taking control of the bot, though the access will be
|
||||||
limited to what the bot can do. (E.g. incoming webhook bots cannot read
|
limited to what the bot can do. (E.g. incoming webhook bots cannot read
|
||||||
messages.)
|
messages.)
|
||||||
|
|
||||||
|
@ -181,7 +181,7 @@ strength allowed is controlled by two settings in
|
||||||
you should rotate the user's Zulip API key.
|
you should rotate the user's Zulip API key.
|
||||||
|
|
||||||
- Guest users are like Members, but they do not have automatic access
|
- Guest users are like Members, but they do not have automatic access
|
||||||
to public streams.
|
to public channels.
|
||||||
|
|
||||||
- Zulip supports several kinds of bots with different capabilities.
|
- Zulip supports several kinds of bots with different capabilities.
|
||||||
|
|
||||||
|
@ -192,7 +192,7 @@ strength allowed is controlled by two settings in
|
||||||
notifications, or create other bots).
|
notifications, or create other bots).
|
||||||
- Bots with the `can_forge_sender` permission can send messages that appear to have been sent by
|
- Bots with the `can_forge_sender` permission can send messages that appear to have been sent by
|
||||||
another user. They also have the ability to see the names of all
|
another user. They also have the ability to see the names of all
|
||||||
streams, including private streams. This is important for implementing
|
channels, including private channels. This is important for implementing
|
||||||
integrations like the Jabber, IRC, and Zephyr mirrors.
|
integrations like the Jabber, IRC, and Zephyr mirrors.
|
||||||
|
|
||||||
These bots cannot be created by Zulip users, including
|
These bots cannot be created by Zulip users, including
|
||||||
|
|
|
@ -8,7 +8,7 @@ provide free, interactive support for the vast majority of questions about
|
||||||
running a Zulip server.
|
running a Zulip server.
|
||||||
|
|
||||||
To report a problem or ask a question, please start a new topic in the
|
To report a problem or ask a question, please start a new topic in the
|
||||||
[#production help][production-help] stream in the [Zulip development community
|
[#production help][production-help] channel in the [Zulip development community
|
||||||
][chat-zulip-org]:
|
][chat-zulip-org]:
|
||||||
|
|
||||||
- Describe what you are trying to do and any problems you've encountered.
|
- Describe what you are trying to do and any problems you've encountered.
|
||||||
|
|
Loading…
Reference in New Issue