From 669c2fd752c94ac984e373166672e5573fd9d176 Mon Sep 17 00:00:00 2001 From: Rishi Gupta Date: Mon, 17 Sep 2018 10:39:02 -0700 Subject: [PATCH] user docs: Update verify-your-message-was-successfully-sent. --- .../zerver/help/include/sidebar_index.md | 3 +- ...your-message-has-been-successfully-sent.md | 42 ------------------- ...rify-your-message-was-successfully-sent.md | 34 +++++++++++++++ 3 files changed, 35 insertions(+), 44 deletions(-) delete mode 100644 templates/zerver/help/verify-that-your-message-has-been-successfully-sent.md create mode 100644 templates/zerver/help/verify-your-message-was-successfully-sent.md diff --git a/templates/zerver/help/include/sidebar_index.md b/templates/zerver/help/include/sidebar_index.md index 78b09a5892..36fda841c0 100644 --- a/templates/zerver/help/include/sidebar_index.md +++ b/templates/zerver/help/include/sidebar_index.md @@ -31,8 +31,7 @@ * [Share and upload files](/help/share-and-upload-files) * [Enable Enter to send](/help/enable-enter-to-send) -* [Verify a message was sent](/help/verify-that-your-message-has-been-successfully-sent) - +* [Verify a message was sent](/help/verify-your-message-was-successfully-sent) * [Status messages](/help/format-your-message-using-markdown#status-messages) * [@-mention a user](/help/at-mention-a-team-member) * [Edit or delete a message](/help/edit-or-delete-a-message) diff --git a/templates/zerver/help/verify-that-your-message-has-been-successfully-sent.md b/templates/zerver/help/verify-that-your-message-has-been-successfully-sent.md deleted file mode 100644 index 457d95bf87..0000000000 --- a/templates/zerver/help/verify-that-your-message-has-been-successfully-sent.md +++ /dev/null @@ -1,42 +0,0 @@ -# Verify that your message has been successfully sent - -When you send a message in a chat tool, it can take a few hundred milliseconds -for your message to transmitted to the server, stored, and transmitted to active -clients by the server, depending on where you are located in relation to the -relevant server. - -Like most other chat tools, Zulip optimizes the experience for the -sender by "locally echoing" the message, i.e. displaying it in your -Zulip feed immediately, even though your browser may not get -confirmation that the message was received by the server until a few -hundred milliseconds later. - -Zulip is designed to store locally echoed message content in local -storage and resend it when your browser reconnects to the Internet. -This helps prevent issues where messages that you thought you had sent -never arrives. Once the client is able to deliver the message to the -server, and the server confirms receipt of the message, Zulip -rerenders the message to display the timestamp, so you can look for -the timestamp to determine whether a message has been successfully -received by the server. - -Follow the following steps to to see this in action. - -1. Disconnect your computer from the Internet. - -2. [Compose a message](/help/compose-and-reply) and click **Send**. - -3. After you send your message, it will appear below all the previous -messages, but with no timestamp. If the browser gets an error from -the server or otherwise cannot confirm receipt, it will report an -error in your browser window. - -4. Reconnect your computer to the Internet. - -5. A few seconds later, your message will be updated to contain the -timestamp on the right side of the message body. - -Zulip is designed to store locally echoed message content in local -storage and replay it when your browser reconnects to the Internet. -This should ensure that messages that users thought they had sent get -delivered eventually. diff --git a/templates/zerver/help/verify-your-message-was-successfully-sent.md b/templates/zerver/help/verify-your-message-was-successfully-sent.md new file mode 100644 index 0000000000..101bcb2a5c --- /dev/null +++ b/templates/zerver/help/verify-your-message-was-successfully-sent.md @@ -0,0 +1,34 @@ +# Verify your message was successfully sent + +When you send a message, it first goes to a Zulip server, and then the Zulip +server sends it out to all the recipients. + +Sometimes there can be delays if your device is on a poor network +connection. Zulip lets you know when your message successfully reaches the +server. + +## Verify that a message reached the Zulip server + +Look for a **timestamp** (like `4:53`) on the right side of the message. If +you see a timestamp, the message successfully reached the server. + +You can see what a message without a timestamp looks like by disconnecting +your computer from the internet, and sending a message. + +## When to resend + +By default, Zulip will try to resend the message when it is re-connected to +the internet. + +If Zulip gives up (or if the Zulip server returns an error), it will +add two **red icons** ( ) to the right side of +the message. If you don't see the red icons, there is no need to resend. + +If you do see the red icons, you can either + +* Click **resend** () + to attempt a resend. +* Click **cancel** () + to delete the message. +* Reload the page to cancel all messages with the red icons.