docs: Update "Share and upload files" article. #25774
Conversation
|
@alya This is ready for review. |
|
Looks great overall! For mobile, we should also add instructions for sharing from other apps. This might be different for Android vs. iOS. I don't know if you have easy access to Android; this is what it looks like once you start the process:
|
|
@chrisbobbe In v27.208, will it say "Direct Message"? Or "Direct message"? |
alya
added
the
release goal
|
It'll say "Direct message". I lowercased the "m" in zulip/zulip-mobile#5735 because it seemed more consistent with our style, e.g., as declared under "Capitalization" here:
The "Share on Zulip" UI is currently offered on Android only; that feature on iOS is tracked in zulip/zulip-mobile#3277. |
drrosa
force-pushed
the
help-update-share-and-upload-files
branch
from
f16dd55 to
0b9e7a6
Compare
|
@alya I updated the PR and screenshots in the description to address your feedback. Is the level of detail for Sharing files okay or should we be more explicit by having separate instructions for streams and direct messages? |
|
Looks good to me! |
alya
added
the
integration review
|
@gnprice @chrisbobbe in case you have any feedback (before or after this is merged). |
- Adds via-markdown instructions block. - Adds via-compose-box-buttons instructions block. - Documents option to select multiple files. - Adds named image file example section.
- Documents uploading files via compose box buttons. - Documents sharing files from other Android apps.
drrosa
force-pushed
the
help-update-share-and-upload-files
branch
from
0b9e7a6 to
2ac2bfe
Compare
|
I updated the PR as discussed in the review comments. |
|
@alya it's probably worth your taking another look at the wording before I merge this. |
|
Looks good to me! Two tips in a row look a bit funny visually, but I think it's fine. |
|
Merged, thanks @drrosa! |
| Zulip will automatically generate a **thumbnail** for each file when you send | ||
| the message, if it can. Image thumbnails will be shown directly in the message, | ||
| and you can click on a thumbnail to [view the full image](/help/view-and-browse-images). |
There was a problem hiding this comment.
This text isn't really accurate. (I see it's pre-existing from before this PR.)
The truth is we don't generate thumbnails. We have an open issue for that:
(At one point we had an experimental implementation of generating thumbnails, and this text may have been written then. My recollection is that we never shipped that widely. In any case it's not operating now.)
We do in the message list show an image preview, at a small size, and it'd be reasonable for someone to call that piece of UI a "thumbnail". But we don't generate those — we just serve up the original uploaded image verbatim, and tell the browser to show it small. And because we're not doing anything to generate them, there's no "if it can"; we do the same thing for all images.
I'm not sure we need this paragraph at all. If we do want something like it, it should probably focus on the UI and not go into the backend technical details. Perhaps something like:
For images attached to a message, a small preview will be shown directly in the message. People reading the message can click on the preview to [view the full-size image][…].
| 1. Tap the | ||
| **paperclip** (<img src="/static/images/help/mobile-paperclip-icon.svg" alt="paperclip" class="mobile-icon"/>), | ||
| **image** (<img src="/static/images/help/mobile-image-icon.svg" alt="image" class="mobile-icon"/>), | ||
| or **camera** (<img src="/static/images/help/mobile-camera-icon.svg" alt="camera" class="mobile-icon"/>) | ||
| button at the bottom of the app to select one or more files. Zulip will |
There was a problem hiding this comment.
This is a bit confusing because it leaves it a mystery why there are these three different buttons, instead of just one.
Here's a description of the three (but it can probably be tightened for this context):
- Paperclip: Choose an arbitrary file on your device, using your device's file browser.
- Image: Choose an image from your device's image gallery.
- Camera: Take a photo with your device's camera, and share that.
In particular if you wanted to "select a file" and you use the camera button, you are definitely going to be disappointed because it won't offer you any existing files — its job is to help you take a new photo to share.
| 1. Select one or more files and tap the **Zulip** | ||
| (<img src="/static/images/logo/zulip-icon-circle.svg" alt="logo" class="mobile-icon"/>) | ||
| logo. |
There was a problem hiding this comment.
This is probably clearest if expanded to a couple of steps:
-
In the app that has the item you want to share, find the item and tap Share
to open the sharing menu. -
In the sharing menu, select Zulip
.
That "share" icon is this one, the share icon in the Material icon set. Fortunately this is one area where Android apps seem to be pretty consistent with each other.
There was a problem hiding this comment.
I also spent a bit of time looking for anything in Android's own user-facing documentation that we could link to. I didn't; the closest match is this:
https://support.google.com/android/answer/9110661
which is about finding files in the file-browser app, and mentions sharing them from there.
Screenshots and screen captures:
Current doc: https://zulip.com/help/share-and-upload-files
Current doc: https://zulip.com/help/insert-a-link
Self-review checklist
Communicate decisions, questions, and potential concerns.
Individual commits are ready for review (see commit discipline).
Completed manual review and testing of the following: