help_docs: Reorganize notification docs under three umbrella pages.

With minor URL migration work by Eeshan Garg.
This commit is contained in:
Alya Abbott
2021-09-20 12:02:46 -07:00
committed by Tim Abbott
parent 491f763f4e
commit 0f9d0f5a86
18 changed files with 197 additions and 107 deletions

View File

@@ -1,21 +0,0 @@
# Alert words
Zulip lets you to specify **alert words or phrases** that notify you whenever
the alert word is included in a message. Alert words are case-insensitive.
### Add an alert word or phrase
{start_tabs}
{settings_tab|alert-words}
1. Add a word or phrase.
1. Click **Add alert word**.
{end_tabs}
## Related articles
* [Notification settings](/help/pm-mention-alert-notifications) for alert
words, PMs, and mentions

View File

@@ -1,16 +0,0 @@
# Change notification sound
You can change the sound Zulip uses for audible desktop notifications.
### Change notification sound
{start_tabs}
{settings_tab|notifications}
1. Under **Desktop message notifications**, configure
**Notification sound**.
{end_tabs}
You can select "None" to completely disable audible desktop notifications in Zulip.

View File

@@ -18,7 +18,7 @@ preference settings, including the following:
* [Emoji theme](/help/emoji-and-emoticons#change-your-emoji-set) * [Emoji theme](/help/emoji-and-emoticons#change-your-emoji-set)
* Notification settings, including: * Notification settings, including:
* [What types of messages trigger notifications][default-notifications] * [What types of messages trigger notifications][default-notifications]
* [Configurations for email notifications](/help/configure-message-notification-emails) * [Configurations for email notifications](/help/email-notifications)
[default-notifications]: /help/stream-notifications#set-default-notifications-for-all-streams [default-notifications]: /help/stream-notifications#set-default-notifications-for-all-streams

View File

@@ -1,4 +1,29 @@
# Troubleshooting desktop notifications # Desktop notifications
Zulip offers visual and audible desktop notifications. You can
customize whether [stream messages](/help/stream-notifications),
[private messages](/help/pm-mention-alert-notifications) and
[mentions](/help/pm-mention-alert-notifications#wildcard-mentions)
trigger desktop notifications.
## Change notification sound
You can change the sound Zulip uses for audible desktop notifications.
### Change notification sound
{start_tabs}
{settings_tab|notifications}
1. Under **Desktop message notifications**, configure
**Notification sound**.
{end_tabs}
You can select "None" to completely disable audible desktop notifications in Zulip.
## Troubleshooting desktop notifications
First, make sure you have enabled First, make sure you have enabled
[desktop notifications for PMs](/help/pm-mention-alert-notifications) or for the [desktop notifications for PMs](/help/pm-mention-alert-notifications) or for the
@@ -73,3 +98,9 @@ Alternate instructions:
3. Configure the notification style that you would like Zulip to use. 3. Configure the notification style that you would like Zulip to use.
{end_tabs} {end_tabs}
## Related articles
* [Stream notifications](/help/stream-notifications)
* [PMs, mentions, and alerts](/help/pm-mention-alert-notifications)
* [Email notifications](/help/email-notifications)
* [Mobile notifications](/help/mobile-notifications)

View File

@@ -1,25 +0,0 @@
# Disable new login emails
By default, Zulip sends an email whenever you log in to Zulip. These emails
help you protect your account; if you see a login email at a time or from a
device you don't recognize, you should
[change your password](/help/change-your-password) right away.
In typical usage, these emails are sent infrequently, since all Zulip apps
(web, mobile, desktop, and terminal) keep you logged in to any organization
you've interacted with in the last 1-2 weeks.
However, there are situations (usually due to corporate security policy) in
which you may have to log in every day, and where getting login emails can
feel excessive.
### Disable new login emails
{start_tabs}
{settings_tab|notifications}
1. Under **Other emails**, toggle
**Send email notifications for new logins to my account**.
{end_tabs}

View File

@@ -1,17 +1,19 @@
# Configure message notification emails # Email notifications
## Message notification emails
Zulip can be configured to send message notification emails for [PMs Zulip can be configured to send message notification emails for [PMs
and mentions](/help/pm-mention-alert-notifications), as well as and mentions](/help/pm-mention-alert-notifications), as well as
[stream messages](/help/stream-notifications). [stream messages](/help/stream-notifications).
You can [respond to Zulip messages directly][reply-from-email] by replying to message You can [respond to Zulip messages directly][reply-from-email] by
notification emails, unless you are replying to message notification emails, unless you are connecting to
connecting to a self-hosted Zulip server whose system administrator a self-hosted Zulip server whose system administrator has not
has not configured the [incoming email gateway][incoming-email-gateway]. configured the [incoming email gateway][incoming-email-gateway].
[incoming-email-gateway]: https://zulip.readthedocs.io/en/latest/production/email-gateway.html [incoming-email-gateway]: https://zulip.readthedocs.io/en/latest/production/email-gateway.html
## Delay before sending emails ### Delay before sending emails
To reduce the number of emails you receive, Zulip To reduce the number of emails you receive, Zulip
delays sending message notification emails for a configurable period delays sending message notification emails for a configurable period
@@ -41,7 +43,7 @@ To configure the delay for message notification emails:
{end_tabs} {end_tabs}
## Include organization name in subject line ### Include organization name in subject line
If you belong to multiple Zulip organizations, it can be helpful to have the If you belong to multiple Zulip organizations, it can be helpful to have the
name of the organization in the subject line of your message notification emails. name of the organization in the subject line of your message notification emails.
@@ -56,7 +58,7 @@ name of the organization in the subject line of your message notification emails
{end_tabs} {end_tabs}
## Hide message content ### Hide message content
For security or compliance reasons, you may want to hide the content of your For security or compliance reasons, you may want to hide the content of your
Zulip messages from your email. Organization admins can do this at an Zulip messages from your email. Organization admins can do this at an
@@ -75,6 +77,48 @@ being sent through your email.
{end_tabs} {end_tabs}
## New login emails
By default, Zulip sends an email whenever you log in to Zulip. These emails
help you protect your account; if you see a login email at a time or from a
device you don't recognize, you should
[change your password](/help/change-your-password) right away.
In typical usage, these emails are sent infrequently, since all Zulip apps
(web, mobile, desktop, and terminal) keep you logged in to any organization
you've interacted with in the last 1-2 weeks.
However, there are situations (usually due to corporate security policy) in
which you may have to log in every day, and where getting login emails can
feel excessive.
### Disable new login emails
{start_tabs}
{settings_tab|notifications}
1. Under **Other emails**, toggle
**Send email notifications for new logins to my account**.
{end_tabs}
## Low-traffic newsletter
Zulip sends out a low-traffic newsletter (expect 2-4 emails a year)
announcing major changes in Zulip.
### Managing your newsletter subscription
{start_tabs}
{settings_tab|notifications}
1. Under **Other emails**, toggle
**Send me Zulip's low-traffic newsletter (a few emails a year)**.
{end_tabs}
## Related articles ## Related articles
* [Using Zulip via email](/help/using-zulip-via-email) * [Using Zulip via email](/help/using-zulip-via-email)

View File

@@ -22,5 +22,5 @@ being sent through the email system.
## Related articles ## Related articles
* [Hide message content in emails](/help/configure-message-notification-emails#hide-message-content), * [Hide message content in emails](/help/email-notifications#hide-message-content),
as an individual. as an individual.

View File

@@ -110,12 +110,9 @@
* [Mute a stream](/help/mute-a-stream) * [Mute a stream](/help/mute-a-stream)
* [Mute a topic](/help/mute-a-topic) * [Mute a topic](/help/mute-a-topic)
* [Mute a user](/help/mute-a-user) * [Mute a user](/help/mute-a-user)
* [Alert words](/help/add-an-alert-word) * [Email notifications](/help/email-notifications)
* [Message notification emails](/help/configure-message-notification-emails) * [Desktop notifications](/help/desktop-notifications)
* [Disable new login emails](/help/disable-new-login-emails) * [Mobile notifications](/help/mobile-notifications)
* [Change notification sound](/help/change-notification-sound)
* [Troubleshoot desktop notifications](/help/troubleshooting-desktop-notifications)
* [Test mobile notifications](/help/test-mobile-notifications)
## Apps ## Apps
* [Desktop installation guides](/help/desktop-app-install-guide) * [Desktop installation guides](/help/desktop-app-install-guide)

View File

@@ -0,0 +1,34 @@
# Mobile notifications
In Zulip, you can customize whether [stream
messages](/help/stream-notifications), [private
messages](/help/pm-mention-alert-notifications) and
[mentions][notifications-wildcard-mentions] trigger mobile
notifications. You can also adjust whether notifications will be sent
while you are online.
[notifications-wildcard-mentions]: /help/pm-mention-alert-notifications#wildcard-mentions
## Mobile notifications while online
You can customize whether or not Zulip will send mobile push
notifications while you are actively using one of the Zulip apps.
!!! tip ""
When testing mobile notifications, make sure Zulip is
configured to send mobile notifications even when you're online.
{start_tabs}
{settings_tab|notifications}
1. Under **Mobile message notifications**, check or uncheck
**Send mobile notifications even if I'm online** as desired.
{end_tabs}
## Related articles
* [Stream notifications](/help/stream-notifications)
* [PMs, mentions, and alerts](/help/pm-mention-alert-notifications)
* [Email notifications](/help/email-notifications)
* [Desktop notifications](/help/desktop-notifications)

View File

@@ -3,7 +3,7 @@
Messages from muted streams do not show up in **All messages** or generate Messages from muted streams do not show up in **All messages** or generate
notifications, unless you are notifications, unless you are
[mentioned](/help/mention-a-user-or-group). Messages from muted streams [mentioned](/help/mention-a-user-or-group). Messages from muted streams
do not generate [alert word](/help/add-an-alert-word) notifications. do not generate [alert word](/help/pm-mention-alert-notifications#alert-words) notifications.
Muted streams still appear in the left sidebar, though they are grayed out. Muted streams still appear in the left sidebar, though they are grayed out.

View File

@@ -1,7 +1,7 @@
# Mute a topic # Mute a topic
Messages from muted topics do not show up in **All messages** or generate Messages from muted topics do not show up in **All messages** or generate
notifications (including [alert word](/help/add-an-alert-word) notifications (including [alert word](/help/pm-mention-alert-notifications#alert-words)
notifications), unless you are notifications), unless you are
[mentioned](/help/mention-a-user-or-group). They also do not contribute to [mentioned](/help/mention-a-user-or-group). They also do not contribute to
stream unread counts. stream unread counts.

View File

@@ -1,14 +1,16 @@
# PMs, mentions, and alerts # PMs, mentions, and alerts
You can configure desktop, mobile, and email notifications for You can configure desktop, mobile, and email notifications for
[private messages](/help/private-messages), [mentions](/help/mention-a-user-or-group), and [private messages](/help/private-messages),
[alert words](/help/add-an-alert-word). [mentions](/help/mention-a-user-or-group), and [alert
words](#alert-words).
{start_tabs} {start_tabs}
{settings_tab|notifications} {settings_tab|notifications}
1. Toggle the notification settings under **Private messages, @-mentions, and alert words**. 1. Toggle the notification settings under **Private messages,
@-mentions, and alert words**.
{end_tabs} {end_tabs}
@@ -39,7 +41,27 @@ streams in your [Stream settings](/help/stream-notifications), and
administrators can [restrict use of wildcard administrators can [restrict use of wildcard
mentions](/help/restrict-wildcard-mentions) in large streams. mentions](/help/restrict-wildcard-mentions) in large streams.
## Alert words
Zulip lets you to specify **alert words or phrases** that notify you whenever
the alert word is included in a message. Alert words are case-insensitive.
### Add an alert word or phrase
{start_tabs}
{settings_tab|alert-words}
1. Add a word or phrase.
1. Click **Add alert word**.
{end_tabs}
## Related articles ## Related articles
* [Add an alert word](/help/add-an-alert-word) * [Desktop notifications](/help/desktop-notifications)
* [Email notifications](/help/email-notifications)
* [Mobile notifications](/help/mobile-notifications)
* [Restrict wildcard mentions](/help/restrict-wildcard-mentions) * [Restrict wildcard mentions](/help/restrict-wildcard-mentions)
* [Stream notifications](/help/stream-notifications)

View File

@@ -36,7 +36,7 @@ Here is the **full list of search operators**.
* `streams:public`: Search the history of all [public * `streams:public`: Search the history of all [public
streams](/help/change-the-privacy-of-a-stream) in the organization. streams](/help/change-the-privacy-of-a-stream) in the organization.
* `is:alerted`: See [alert words](/help/add-an-alert-word). * `is:alerted`: See [alert words](/help/pm-mention-alert-notifications#alert-words).
* `is:mentioned`: See [mentions](/help/mention-a-user-or-group). * `is:mentioned`: See [mentions](/help/mention-a-user-or-group).
* `is:starred`: See [starred messages](/help/star-a-message). * `is:starred`: See [starred messages](/help/star-a-message).
* `is:resolved`: Search messages in [resolved topics](/help/resolve-a-topic). * `is:resolved`: Search messages in [resolved topics](/help/resolve-a-topic).

View File

@@ -35,4 +35,9 @@ explicitly set a notification preference.
## Related articles ## Related articles
* [Desktop notifications](/help/desktop-notifications)
* [Email notifications](/help/email-notifications)
* [Mobile notifications](/help/mobile-notifications)
* [Mute a stream](/help/mute-a-stream) * [Mute a stream](/help/mute-a-stream)
* [Mute a topic](/help/mute-a-topic)
* [PMs, mentions, and alerts](/help/pm-mention-alert-notifications)

View File

@@ -1,17 +0,0 @@
# Test mobile notifications
Zulip supports configuring mobile notifications to skip sending mobile
push notifications when you are currently actively using one of the
Zulip apps.
When testing mobile notifications, you should make sure Zulip is
configured to send mobile notifications even when you're online.
{start_tabs}
{settings_tab|notifications}
1. Under **Mobile message notifications**, enable
**Send mobile notifications even if I'm online**.
{end_tabs}

View File

@@ -476,6 +476,12 @@ def write_instrumentation_reports(full_suite: bool, include_webhooks: bool) -> N
"help/community-topic-edits", "help/community-topic-edits",
"help/about-streams-and-topics", "help/about-streams-and-topics",
"help/delete-a-stream", "help/delete-a-stream",
"help/add-an-alert-word",
"help/change-notification-sound",
"help/configure-message-notification-emails",
"help/disable-new-login-emails",
"help/test-mobile-notifications",
"help/troubleshooting-desktop-notifications",
"for/working-groups-and-communities/", "for/working-groups-and-communities/",
"help/only-allow-admins-to-add-emoji", "help/only-allow-admins-to-add-emoji",
"api/delete-stream", "api/delete-stream",

View File

@@ -219,7 +219,7 @@ paths:
- type: object - type: object
description: | description: |
Event sent to a user's clients when that user's set of configured Event sent to a user's clients when that user's set of configured
[alert words](/help/add-an-alert-word) have changed. [alert words](/help/pm-mention-alert-notifications#alert-words) have changed.
properties: properties:
id: id:
$ref: "#/components/schemas/EventIdSchema" $ref: "#/components/schemas/EventIdSchema"
@@ -5111,7 +5111,7 @@ paths:
<td><code>has_alert_word</code></td> <td><code>has_alert_word</code></td>
<td> <td>
Whether the message contains any of the current user's Whether the message contains any of the current user's
<a href="/help/add-an-alert-word">configured alert words</a>. <a href="/help/pm-mention-alert-notifications#alert-words">configured alert words</a>.
Cannot be changed by the user directly, but Cannot be changed by the user directly, but
can change if the message is edited to add/remove can change if the message is edited to add/remove
one of the current user's alert words. one of the current user's alert words.
@@ -8773,7 +8773,7 @@ paths:
description: | description: |
Present if `alert_words` is present in `fetch_event_types`. Present if `alert_words` is present in `fetch_event_types`.
An array of strings, each an [alert word](/help/add-an-alert-word) An array of strings, each an [alert word](/help/pm-mention-alert-notifications#alert-words)
that the current user has configured. that the current user has configured.
items: items:
type: string type: string

View File

@@ -759,7 +759,37 @@ urls += [
), ),
path( path(
"help/configure-missed-message-emails", "help/configure-missed-message-emails",
RedirectView.as_view(url="/help/configure-message-notification-emails", permanent=True), RedirectView.as_view(url="/help/email-notifications", permanent=True),
),
path(
"help/add-an-alert-word",
RedirectView.as_view(
url="/help/pm-mention-alert-notifications#alert-words", permanent=True
),
),
path(
"help/test-mobile-notifications",
RedirectView.as_view(url="/help/mobile-notifications", permanent=True),
),
path(
"help/troubleshooting-desktop-notifications",
RedirectView.as_view(
url="/help/desktop-notifications#troubleshooting-desktop-notifications", permanent=True
),
),
path(
"help/change-notification-sound",
RedirectView.as_view(
url="/help/desktop-notifications#change-notification-sound", permanent=True
),
),
path(
"help/configure-message-notification-emails",
RedirectView.as_view(url="/help/email-notifications", permanent=True),
),
path(
"help/disable-new-login-emails",
RedirectView.as_view(url="/help/email-notifications#new-login-emails", permanent=True),
), ),
# This redirect is particularly important, because the old URL # This redirect is particularly important, because the old URL
# appears in links from Welcome Bot messages. # appears in links from Welcome Bot messages.