diff --git a/static/images/help/chevron-message-hover.png b/static/images/help/chevron-message-hover.png new file mode 100644 index 0000000000..e8a09e2f37 Binary files /dev/null and b/static/images/help/chevron-message-hover.png differ diff --git a/static/images/help/message-mute-topic.png b/static/images/help/message-mute-topic.png new file mode 100644 index 0000000000..eea0e370b5 Binary files /dev/null and b/static/images/help/message-mute-topic.png differ diff --git a/static/images/help/mute-stream-1.png b/static/images/help/mute-stream-1.png new file mode 100644 index 0000000000..872578bc1f Binary files /dev/null and b/static/images/help/mute-stream-1.png differ diff --git a/static/images/help/mute-topic.png b/static/images/help/mute-topic.png new file mode 100644 index 0000000000..ee1a58d1cb Binary files /dev/null and b/static/images/help/mute-topic.png differ diff --git a/static/images/help/topic-chevron-hover.png b/static/images/help/topic-chevron-hover.png new file mode 100644 index 0000000000..b1261893c3 Binary files /dev/null and b/static/images/help/topic-chevron-hover.png differ diff --git a/static/images/help/topic-mute-success.png b/static/images/help/topic-mute-success.png new file mode 100644 index 0000000000..d9125d349e Binary files /dev/null and b/static/images/help/topic-mute-success.png differ diff --git a/static/images/help/topic-muted.png b/static/images/help/topic-muted.png new file mode 100644 index 0000000000..305ac2c1ee Binary files /dev/null and b/static/images/help/topic-muted.png differ diff --git a/static/images/help/topic-spam-search.png b/static/images/help/topic-spam-search.png new file mode 100644 index 0000000000..5a5afe0b7d Binary files /dev/null and b/static/images/help/topic-spam-search.png differ diff --git a/templates/zerver/help/index.md b/templates/zerver/help/index.md index f7d3197e72..6ea94b0c1a 100644 --- a/templates/zerver/help/index.md +++ b/templates/zerver/help/index.md @@ -103,7 +103,7 @@ as a “**realm**”. ## Notifications * [Mute a stream](/help/mute-a-stream) -* Mute a topic +* [Mute a topic](/help/mute-topic) * Set notifications for a single stream * Configure desktop notifications * Configure audible notifications diff --git a/templates/zerver/help/mute-topic.md b/templates/zerver/help/mute-topic.md new file mode 100644 index 0000000000..9d92c2cedc --- /dev/null +++ b/templates/zerver/help/mute-topic.md @@ -0,0 +1,68 @@ +# Mute a topic + +If you would like to stop receiving notifications from a certain topic, you can +choose to mute it. + +There are two main ways of muting a topic; you can mute a topic through the +stream list or through your view. + +## Muting a topic through the stream list + +1. Find the stream list located at the left sidebar. + + ![Left sidebar](/static/images/help/left-sidebar.png) + +2. In the stream list, click on the stream that the topic you want to mute +belongs to. Upon clicking on the stream, a dropdown with all the topics in the +stream will appear. + + ![Stream topic dropdown](/static/images/help/mute-stream-1.png) + +3. In the stream list dropdown, hover over the topic to reveal a chevron +(![chevron](/static/images/help/chevron.png)) icon to the right of the topic. + + ![Stream topic dropdown chevron hover](/static/images/help/topic-chevron-hover.png) + +4. Upon clicking on the topic's chevron +(![chevron](/static/images/help/chevron.png)) icon, a dropdown with topic +actions will appear. To mute the topic, simply select the **Mute the topic (topic name)** +option from the dropdown. + + ![Stream topic dropdown mute topic](/static/images/help/mute-topic.png) + +5. Upon clicking **Mute the topic (topic name)**, a tooltip titled **Topic Muted** will +appear, and the topic will be grayed out in the stream list dropdown, confirming +the success of your muting of the topic. + + ![Topic mute success](/static/images/help/topic-muted.png) + +## Muting a topic through your view + +1. The default **Home** view displays all messages from unmuted streams and topics +that you've subscribed to. You can choose to search for messages belonging to +the topic that you wish to mute in the **Home** view. + + Alternatively, you can narrow your view to messages sent to the topic that + you want to mute by entering the search operator `topic:(topic name)` in the + search bar. + + ![Topic search](/static/images/help/topic-spam-search.png) + +2. Once you locate some messages belonging to the topic you want to mute, hover +over of the topic's messages to reveal a chevron +(![chevron](/static/images/help/chevron.png)) icon that replaces the timestamp +of the message. + + ![Chevron message hover](/static/images/help/chevron-message-hover.png) + +3. Upon clicking on the chevron (![chevron](/static/images/help/chevron.png)) icon, +a dropdown with message actions will appear. To mute the topic of the message, +simply select the **Mute the topic (topic name)** option from the dropdown. + + ![Chevron message dropdown](/static/images/help/message-mute-topic.png) + +4. Upon clicking **Mute the topic (topic name)**, a tooltip titled **Topic Muted** will + appear, and any messages belonging to the topic will disappear from your view, + confirming the success of your muting of the topic. + + ![Topic mute success](/static/images/help/topic-mute-success.png)