Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

help: Rename and redirect change-the-stream-description for channel. 

This also contains in-file edits for help/message-retention-policy.md,
help/create-a-channel.md, and help/configure-automated-notices.md.
This commit is contained in:
Lauryn Menard 2024-05-02 16:41:09 +02:00 committed by Tim Abbott
parent c10c570b89
commit 500f476de9
12 changed files with 50 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
help/change-the-stream-description.md → help/change-the-channel-description.md
View File

@ -1,14 +1,14 @@
# Change a stream's description
# Change a channel's description
{!admin-only.md!}
Stream descriptions can be used to explain the purpose of a stream and link to
usage guidelines, resources, or related streams.
Channel descriptions can be used to explain the purpose of a channel and link to
usage guidelines, resources, or related channels.
Stream descriptions support Zulip's standard [Markdown
Channel descriptions support Zulip's standard [Markdown
formatting][markdown-formatting], with the exception that image previews are
disabled. Use Markdown formatting to include a link to a website, Zulip
[message][message-link], or [topic][topic-link] in the stream description:
[message][message-link], or [topic][topic-link] in the channel description:
`[link text](URL)`.
{start_tabs}
@ -17,12 +17,12 @@ disabled. Use Markdown formatting to include a link to a website, Zulip
{relative|stream|all}
1. Select a stream.
1. Select a channel.
{!select-channel-view-general.md!}
1. Click the **pencil** (<i class="fa fa-pencil"></i>) icon
to the right of the stream name, and enter a new description.
to the right of the channel name, and enter a new description.
{!save-changes.md!}
@ -34,9 +34,9 @@ disabled. Use Markdown formatting to include a link to a website, Zulip
{!stream-name-long-press-menu.md!}
1. Tap **Stream settings**.
1. Tap **Channel settings**.
1. Tap **Edit stream**, and enter a new description.
1. Tap **Edit channel**, and enter a new description.
1. Tap **Save**.

20
help/configure-automated-notices.md
View File

@ -4,29 +4,29 @@ The Zulip sends automated notices via **Notification Bot** to notify users about
changes in their organization or account. Some types of notices can be
configured, or disabled altogether.
Notices sent to streams are translated into the language that the organization
Notices sent to channels are translated into the language that the organization
has configured as the [language for automated messages and invitation
emails](/help/configure-organization-language). The topic name is also
translated. Notices sent directly to users will use [their preferred
language](/help/change-your-language).
## Notices about streams
## Notices about channels
Notices about channel settings changes, such as [name](/help/rename-a-channel),
[description](/help/change-the-stream-description),
[description](/help/change-the-channel-description),
[permission](/help/channel-permissions) and
[policy](/help/channel-posting-policy) updates are sent to the
“stream events” topic in the stream that was modified.
“channel events” topic in the channel that was modified.
### New stream announcements
### New channel announcements
{!admin-only.md!}
When creating a new [public channel](/help/channel-permissions), the
stream creator can choose to advertise the new stream via an automated
notice. You can configure what stream Zulip uses for these notices, or
channel creator can choose to advertise the new channel via an automated
notice. You can configure what channel Zulip uses for these notices, or
disable these notices entirely. The topic for these messages is “new
streams”.
channels”.
New [private](/help/channel-permissions) channels are never announced.
@ -34,7 +34,7 @@ New [private](/help/channel-permissions) channels are never announced.
{settings_tab|organization-settings}
1. Under **Automated messages and emails**, configure **New stream
1. Under **Automated messages and emails**, configure **New channel
announcements**.
{!save-changes.md!}
@ -83,7 +83,7 @@ Zulip announces new features and other important product changes via automated
messages. This is designed to help users discover new features they may find
useful, including new configuration options.
These announcements are posted to the “Zulip updates” topic in the stream selected by
These announcements are posted to the “Zulip updates” topic in the channel selected by
organization administrators. You can read update messages whenever it's
convenient, or [mute](/help/mute-a-topic) the topic if you are not interested.
If you organization does not want to receive these announcements, they can be

14
help/create-a-channel.md
View File

@ -23,23 +23,23 @@ There are several parameters you can set while creating a channel. All but
* **Channel description**: Helps users decide whether to subscribe when they
are browsing channels.
* **Announce new stream in the [stream configured by your organization](/help/configure-automated-notices#new-stream-announcements)**:
Posts a message in the "new streams" topic advertising the new stream.
* **Announce new channel in the [channel configured by your organization](/help/configure-automated-notices#new-channel-announcements)**:
Posts a message in the "new channels" topic advertising the new channel.
* **Who can access the stream?**: See [Channel permissions](/help/channel-permissions).
* **Who can access the channel?**: See [Channel permissions](/help/channel-permissions).
* **Default channel for new users**: Whether new users will be [automatically
subscribed](/help/set-default-channels-for-new-users) to the new channel.
* **Who can post to the stream?**: See [Channel permissions](/help/channel-permissions).
* **Who can post to the channel?**: See [Channel permissions](/help/channel-permissions).
* **Who can unsubscribe others from this stream?**: See
* **Who can unsubscribe others from this channel?**: See
[Restrict channel membership management](/help/configure-who-can-invite-to-channels#configure-who-can-remove-users).
* **Message retention period**: See
[Message retention policy](/help/message-retention-policy#configure-message-retention-policy-for-individual-streams).
[Message retention policy](/help/message-retention-policy#configure-message-retention-policy-for-individual-channels).
* **Choose subscribers**: You can copy the membership from an existing stream or
* **Choose subscribers**: You can copy the membership from an existing channel or
[user group](/help/user-groups), add all users, or enter users one by one.
## Related articles

4
help/custom-emoji.md
View File

@ -3,12 +3,12 @@
Custom emoji can be used by all users in an organization (including
bots). They are supported everywhere that Zulip supports emoji,
including [emoji reactions][emoji-reactions],
[messages][emoji-messages], [stream descriptions][emoji-streams] and
[messages][emoji-messages], [channel descriptions][emoji-channels] and
[user statuses][emoji-status].
[emoji-reactions]: /help/emoji-reactions
[emoji-messages]: /help/format-your-message-using-markdown#emoji-and-emoticons
[emoji-streams]: /help/change-the-stream-description
[emoji-channels]: /help/change-the-channel-description
[emoji-status]: /help/status-and-availability
## Add custom emoji

2
help/include/sidebar_index.md
View File

@ -208,7 +208,7 @@
* [Add or remove users from a channel](/help/add-or-remove-users-from-a-channel)
* [Set default channels for new users](/help/set-default-channels-for-new-users)
* [Rename a channel](/help/rename-a-channel)
* [Change a stream's description](/help/change-the-stream-description)
* [Change a channel's description](/help/change-the-channel-description)
* [Change the privacy of a stream](/help/change-the-privacy-of-a-stream)
* [Delete or archive a stream](/help/archive-a-stream)

18
help/message-retention-policy.md
View File

@ -7,16 +7,16 @@ search of your complete history.
Zulip supports configuring both a global organization-level message
retention policy, as well as retention policies for individual
streams. These policies control how many days a message is stored
channels. These policies control how many days a message is stored
before being automatically deleted (the default being forever).
Zulip's system supports:
* Setting an organization-level retention policy, which applies to
all direct messages and all streams without a specific policy.
* Setting a retention policy for individual streams, which overrides
the organization-level policy for that stream. This can be used to
just delete messages on specific streams, to only retain messages
forever on specific streams, or just to have a different retention
all direct messages and all channels without a specific policy.
* Setting a retention policy for individual channels, which overrides
the organization-level policy for that channel. This can be used to
just delete messages on specific channels, to only retain messages
forever on specific channels, or just to have a different retention
period.
In Zulip Cloud, message retention policies are available on the Zulip
@ -36,17 +36,17 @@ Standard hosting.
{end_tabs}
### Configure message retention policy for individual streams
### Configure message retention policy for individual channels
{start_tabs}
{relative|stream|all}
1. Select a stream.
1. Select a channel.
{!select-channel-view-general.md!}
1. Under **Stream permissions**, configure the
1. Under **Channel permissions**, configure the
**Message retention period**.
{!save-changes.md!}

2
help/moderating-open-organizations.md
View File

@ -28,7 +28,7 @@ problematic behavior.
* Restrict who can [create channels](/help/configure-who-can-create-channels), or
monitor new streams by enabling [new stream
announcements](/help/configure-automated-notices#new-stream-announcements).
announcements](/help/configure-automated-notices#new-channel-announcements).
* Restrict who can [add custom emoji](/help/custom-emoji#change-who-can-add-custom-emoji).
* Restrict who can [move messages to another
stream](/help/restrict-moving-messages#configure-who-can-move-messages-to-another-stream),

2
web/templates/stream_settings/announce_stream_checkbox.hbs
View File

@ -9,5 +9,5 @@
}}
</strong>
{{/if}}
{{> ../help_link_widget link="/help/configure-automated-notices#new-stream-announcements"}}
{{> ../help_link_widget link="/help/configure-automated-notices#new-channel-announcements"}}
</label>

2
web/templates/stream_settings/change_stream_info_modal.hbs
View File

@ -7,7 +7,7 @@
<div>
<label for="change_stream_description" class="modal-field-label">
{{t 'Description' }}
{{> ../help_link_widget link="/help/change-the-stream-description" }}
{{> ../help_link_widget link="/help/change-the-channel-description" }}
</label>
<textarea id="change_stream_description" class="settings_textarea" name="stream_description" maxlength="{{ max_stream_description_length }}">{{ stream_description }}</textarea>
</div>

2
web/templates/stream_settings/stream_creation_form.hbs
View File

@ -16,7 +16,7 @@
<section class="block">
<label for="create_stream_description" class="settings-field-label">
{{t "Channel description" }}
{{> ../help_link_widget link="/help/change-the-stream-description" }}
{{> ../help_link_widget link="/help/change-the-channel-description" }}
</label>
<input type="text" name="stream_description" id="create_stream_description" class="settings_text_input"
placeholder="{{t 'Channel description' }}" value="" autocomplete="off" maxlength="{{ max_stream_description_length }}" />

1
zerver/lib/url_redirects.py
View File

@ -115,6 +115,7 @@ HELP_DOCUMENTATION_REDIRECTS: List[URLRedirect] = [
"/help/set-default-streams-for-new-users", "/help/set-default-channels-for-new-users"
),
URLRedirect("/help/rename-a-stream", "/help/rename-a-channel"),
URLRedirect("/help/change-the-stream-description", "/help/change-the-channel-description"),
]
LANDING_PAGE_REDIRECTS = [

14
zerver/openapi/zulip.yaml
View File

@ -4504,7 +4504,7 @@ paths:
Since these automated messages are sent by the server, this field is
primarily relevant to clients containing UI for changing it.
[new-stream-announce]: /help/configure-automated-notices#new-stream-announcements
[new-stream-announce]: /help/configure-automated-notices#new-channel-announcements
**Changes**: In Zulip 9.0 (feature level 241), renamed 'notifications_stream_id'
to `new_stream_announcements_stream_id`.
@ -9297,7 +9297,7 @@ paths:
description:
type: string
description: |
The [description](/help/change-the-stream-description)
The [description](/help/change-the-channel-description)
to use for a new stream being created, in text/markdown format.
Clients should use the `max_stream_description_length` returned
@ -15689,7 +15689,7 @@ paths:
Since these automated messages are sent by the server, this field is
primarily relevant to clients containing UI for changing it.
[new-stream-announce]: /help/configure-automated-notices#new-stream-announcements
[new-stream-announce]: /help/configure-automated-notices#new-channel-announcements
**Changes**: In Zulip 9.0 (feature level 241), renamed 'realm_notifications_stream_id'
to `realm_new_stream_announcements_stream_id`.
@ -17865,7 +17865,7 @@ paths:
an organization administrator editing any property of a stream,
including:
- Stream [name](/help/rename-a-channel) and [description](/help/change-the-stream-description)
- Stream [name](/help/rename-a-channel) and [description](/help/change-the-channel-description)
- Stream [permissions](/help/channel-permissions), including
[privacy](/help/change-the-privacy-of-a-stream) and [who can
send](/help/channel-posting-policy).
@ -17892,7 +17892,7 @@ paths:
properties:
description:
description: |
The new [description](/help/change-the-stream-description) for
The new [description](/help/change-the-channel-description) for
the stream, in text/markdown format.
Clients should use the `max_stream_description_length` returned
@ -19976,7 +19976,7 @@ components:
description:
type: string
description: |
The [description](/help/change-the-stream-description) of the stream in text/markdown format,
The [description](/help/change-the-channel-description) of the stream in text/markdown format,
intended to be used to prepopulate UI for editing a stream's
description.
@ -19984,7 +19984,7 @@ components:
rendered_description:
type: string
description: |
The [description](/help/change-the-stream-description) of the stream rendered as HTML, intended to
The [description](/help/change-the-channel-description) of the stream rendered as HTML, intended to
be used when displaying the stream description in a UI.
One should use the standard Zulip rendered_markdown CSS when