paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-09 16:37:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

help: Update "Change stream description".

Browse Source 
- Updates page to follow current help center documentation patterns.
- Revises intro text.
- Adds `tip` to change stream description via stream settings.
This commit is contained in:
David Rosa
2023-09-06 23:10:59 -07:00
committed by Tim Abbott
parent 069c34b514
commit a3ae87ccb7
1 changed files with 13 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
help/change-the-stream-description.md
View File

@@ -1,32 +1,32 @@
# Change the stream description
# Change a stream's description
{!admin-only.md!}
Streams descriptions are displayed when viewing the stream in the
web and desktop apps, and can be used to explain the purpose of a
stream and link to usage guidelines, resources, or related streams.
Stream descriptions can be used to explain the purpose of a stream and link to
usage guidelines, resources, or related streams.
Stream descriptions support Zulip's standard [Markdown
formatting][markdown-formatting], with the exception that image
previews are disabled.
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:
`[link text](URL)`.
{start_tabs}
{tab|desktop-web}
{relative|stream|all}
1. Select a stream.
{!select-stream-view-general.md!}
1. Click the **pencil** (<i class="fa fa-pencil"></i>)
to the right of the stream name. Enter a new description.
1. Click the **pencil** (<i class="fa fa-pencil"></i>) icon
to the right of the stream name, and enter a new description.
{!save-changes.md!}
!!! tip ""
Use [Markdown formatting][markdown-formatting] to include a link to a
website, Zulip [message][message-link], or [topic][topic-link] in the
stream description: `[link text](URL)`.
{!stream-settings-general-tab-tip.md!}
{end_tabs}
@@ -34,5 +34,4 @@ previews are disabled.
[markdown-formatting]: /help/format-your-message-using-markdown
[message-link]: /help/link-to-a-message-or-conversation#get-a-link-to-a-specific-message
[topic-link]:
/help/link-to-a-message-or-conversation#get-a-link-to-a-specific-topic
[topic-link]: /help/link-to-a-message-or-conversation#get-a-link-to-a-specific-topic