Commit Graph

1588 Commits

Author SHA1 Message Date
David Rosa 782947cfa0 help center: Rename "Format your messages" > "Message formatting".
Consolidates the article's name in the left sidebar and page title.
2022-12-09 17:18:24 -08:00
David Rosa 430383831a help center: Update "Manage your uploaded files".
Updates the page to add undocumented features and to follow our
current help center documentation patterns.

Cross-links related articles.

Fixes #22815.
2022-12-09 17:15:40 -08:00
David Rosa 4ad47fd550 docs: Rename "operators" to "filters".
Changes all the uses of the word "operators" to "filters" in
contributor docs, help center, and landing page to align with
the updated help center documentation.
2022-12-09 13:52:13 -08:00
Sahil Batra f554af0d1c help: Update help docs for changing stream permission settings.
We changed the stream permission settings UI for setting widgets
to always be present in "General" section instead of a modal.
This commit updates the help center documentation to be consistent
with the new UI.

Fixes #19519.
2022-12-09 11:16:26 -08:00
Lauryn Menard 6759767b14 api-docs: Move include markdown macro files for API documentation.
Moves files in `templates/zerver/help/include` that are used
specifically for API documentation pages to be in a new directory:
`templates/zerver/api/include`.

Adds a boolean parameter to `render_markdown_path` to be used
for help center documentation articles.

Also moves the test file `empty.md` to the new directory since
this is the default directory for these special include macros
that are used in documentation pages.
2022-12-08 12:58:11 -08:00
Lauryn Menard 5f9dc76d54 integrations-docs: Move markdown macros include files.
Moves files in `templates/zerver/help/include` that are used
specifically for integrations documentation to be in a new
directory: `templates/zerver/integrations/include`.

Adds a boolean parameter to `render_markdown_path` to be used
for integrations documentation pages.
2022-12-08 12:58:11 -08:00
Lauryn Menard 53f705c7bd docs: Remove unused macros in `templates/zerver/help/include`. 2022-12-08 12:58:11 -08:00
Lauryn Menard 317c7c177e help-docs: Use `cloud-plus-only` macro in `saml-authentication`. 2022-12-08 12:58:11 -08:00
David Rosa c84bf16b2d help center: Improve documentation on the ? in-app reference.
Adds a sentence at the end of the intro section of each help center
page explaining that you can pull up a Keyboard shortcuts, Message
formatting, and Search filters reference from inside the app.

Adds/updates the in-app help section at the bottom of the page with
instructions for opening the reference.

Fixes #23758.
2022-12-08 12:05:05 -08:00
Anders Kaseorg 872f4b41c1 ci: Check that non-scripts aren’t marked executable.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2022-12-07 09:54:01 -08:00
Alya Abbott 35913a2297 help center: Make stream names bold on /help/setting-up-zulip-for-a-class. 2022-12-02 18:00:12 -08:00
Alya Abbott ec74416e5d help center: Rewrite /help/search-for-messages.
- Organize search terms into categories.
- To avoid technical-sounding jargon, use the term "filter" rather "operator".
- Be more specific and consistent in describing search queries.
- Change how user search is described, as we now show user name pills.
2022-12-02 18:00:12 -08:00
Prakhar Pratyush a59d6d6581 docs: Improve move messages to another stream instructions.
This commit adds a line to make it clear to the user that the
user may/mayn't have the permission to move messages between
streams.
2022-12-02 17:25:22 -08:00
Prakhar Pratyush 53da7c1928 docs: Rename "Move message" option to "Move messages".
This commit renames "Move message" option to "Move messages"
to make it more clear that the user can move multiple messages.
2022-12-02 17:25:22 -08:00
Prakhar Pratyush fd96d958a5 docs: Improve move a topic to another stream instructions.
This commit adds a line to make it clear to the user that the
user may/mayn't have the permission to use the "move topic" option.
2022-12-02 17:25:22 -08:00
Lauryn Menard 704e39f1b4 integrations-docs: Update text in `create-bot-construct-url.md`.
Revises the text about including a stream and a topic incoming
webhook URLs in `create-bot-construct-url.md` for clarity and
consistency.
2022-11-29 16:24:48 -08:00
Lauryn Menard 3fe2f208ae integrations-docs: Remove images of bot type dropdown menus.
Removes images of the bot type dropdown menus for creating new
bots because they are no longer up-to-date and picking an option
from a dropdown does not seem like it would require a screenshot.
2022-11-29 11:03:28 -08:00
David Rosa caacfd0bd9 help center: Update "Message a stream by email" to reflect new UI.
Updates the documentation to reflect recent changes to the UI.

Fixes #23471.
2022-11-28 20:22:49 -08:00
Alya Abbott dfd97542b3 help center: Document message actions. 2022-11-28 12:07:57 -08:00
Alya Abbott 3a3cf496a3 help center: Document @everyone and @stream mentions. 2022-11-24 09:15:27 -08:00
Anders Kaseorg 842a5bb54b message_flags: Allow updating flags by narrows and anchors.
Fixes #22893.

Signed-off-by: Anders Kaseorg <anders@zulip.com>
2022-11-16 21:13:44 -08:00
David Rosa a3c5c97488 help center: Document "Mark messages as unread" on mobile.
Fixes #23560.
2022-11-15 10:27:22 -08:00
Alya Abbott 86d8a9c626 help center: Document user cards. 2022-11-14 16:03:37 -08:00
Alya Abbott 3e6d7c11b0 help center: Add use cases to /help/marking-messages-as-unread. 2022-11-14 13:07:35 -08:00
Lauryn Menard 32d35bcec8 help-docs: Update mobile instructions for invisible mode. 2022-11-14 13:06:54 -08:00
Aman Agrawal fbe9a9e539 left_side_userlist: Remove feature from frontend.
Fixes #23517.

While this feature was added to Zulip very early, it has been troubled
for most of that time; it never looked great visually, had a lot of
implementation complexity around resize.js, and has a weird model (a
setting that changes the UI only in certain window sizes).

This option is not commonly used; while a significant portion of users
have it enabled, many of them just don't use window sizes where it
actually has an effect. So it's not clear that it will be missed if
removed; we got very few bug reports when it was completely broken for
a few days after we first integrated the new left sidebar private
messages design.

Even with it no longer being broken, it does not work very well with
the addition of the new PMs section in the left sidebar. (Having two
scrollbars in the sidebar looks quite awkward.) The new private
messages section in the left sidebar also addresses some of the use
cases for always keeping the Users list always visible, even in narrow
windows.

This option is only removed from frontend for now. To make this
decision easily reversible, the backend code of this feature
is still kept.
2022-11-14 12:23:55 -08:00
Lauryn Menard de12500f68 popovers: Rename "full profile" to "profile".
Now that we now longer have another thing called a "user profile", we
can simplify the name for this part of the UI.

Fixes #23530.
2022-11-14 12:16:22 -08:00
Lauryn Menard 9aacb15530 tabbed-sections: Update "via-user-profile" to be "via-user-card". 2022-11-14 12:16:22 -08:00
Lauryn Menard 48e2482bbd popovers: Rename "profile summary" to "user card".
This is a briefer and more intuitive name for this frequently accessed
part of the Zulip UI.
2022-11-14 12:15:54 -08:00
Alya Abbott 52a04b53ad help center: Clean up "Deactivate or reactivate a user" help page.
Also, removes now unused image in `/static/images/help`:
`deactivate-user-email.png`.

Fixes #23503.
2022-11-10 12:00:25 -08:00
Alya Abbott 343bd395ca help center: Make minor tweaks to Change a user's {role}/{name} pages.
- Factor out instructions for navigating to the "Manage this user" tab.
- Add links to related articles.
2022-11-10 12:00:25 -08:00
David Rosa 59df44f5ce help center: Migrate reusable content in "Import from Slack".
Moves reusable content to multiple Markdown macros.
2022-11-10 11:56:55 -08:00
David Rosa ba44f308dc help center: Tweak "Import from Slack" page for reusability.
We can reuse the content from multiple sections of the Slack article
to update "Import from Mattermost/Gitter/Rocket.Chat" by making small
wording tweaks.
2022-11-10 11:55:41 -08:00
David Rosa 8e21b6bf95 help center: Improve "analytics" article.
- Renames the page to "Usage statistics" (title & left sidebar).
- Adds an intro section that outlines the types of information
that can be found on the stats page.

Fixes #23449.
2022-11-10 11:27:42 -08:00
David Rosa 47a8eb0b66 help center: Document viewing @-mentions.
Adds "View your mentions" page to document how to access @-mentions
and the @ indicator for unread @-mentions on desktop/web and mobile.

Fixes #23422.

Co-authored-by: Alya Abbott <alya@zulip.com>
2022-11-09 15:51:44 -08:00
David Rosa a9f2ec27d6 help center: Document notification triggers.
Documents the top checkboxes section for controlling mobile, desktop,
and email notifications.

Fixes #23371.
2022-11-08 17:45:04 -08:00
Alya Abbott 9937b8112d help center: Update documentation on reading private messages.
- Describe the new PMs section in the left sidebar.
- Mention Recent conversations.

Fixes #23420.
2022-11-08 17:44:46 -08:00
David Rosa 81f3307da0 help center: Mention stream section labels.
Updates the relevant help center articles to reflect that the
sections for Pinned and Inactive streams in the left sidebar
now have labels.

Fixes #23423.
2022-11-08 10:44:57 -08:00
David Rosa 2eaff50a59 help center: Document viewing read receipts on mobile.
Adds instructions for viewing read receipts in the mobile app.

Fixes #23479.
2022-11-08 10:43:50 -08:00
Alya Abbott 04dcca370b help center: Drop extraneous Desktop/Web tab from /help/emoji-reactions.
It is better not to use a tab in the instructions for how to
"Toggle whether names of reacting users are displayed", as this setting
applies to both web/desktop and mobile apps.

The instructions themselves still indicate that the setting is controlled
via the web/desktop app.
2022-11-08 08:09:04 -08:00
David Rosa 69bf8193a0 help center: Mention "Scroll to bottom" to mark Topics and PMs as read.
Updates "Reading Topics" and "Reading PMs" where only the keyboard
shortcut for this action is mentioned.

Fixes #23425.
2022-11-07 10:49:55 -08:00
Tim Abbott b3e1f546f3 Revert "help-docs: Revise the article on searching for messages."
This reverts commit 8410990c42.

We'd like to rework this article more substantially.
2022-11-07 10:40:28 -08:00
Alya Abbott 4316f47f8d help center: Update list of fields in full profile.
Also add documentation on what fields are shown in the mobile app.
2022-11-04 14:41:09 -07:00
Lauryn Menard 8410990c42 help-docs: Revise the article on searching for messages.
Updates the first part of the article to discuss the basics of
the search feature. Adds sub-headers / sections to the list of
search operators. Makes the exluding messages a section header
instead of a sub-section of the list.
2022-11-03 12:17:37 -07:00
Lauryn Menard 6f1d9ce466 help-docs: Fix "group-pm-with" format in search for messages article.
Updates the help center article on searching for messages to have
the correct format for the "group-pm-with" operator.

Also, reorders the list so that the private message searches are
all together, and the `streams:public` operator is last so that
it stands out a bit more.
2022-11-03 12:17:37 -07:00
Alya Abbott d9dde2b4d9 help center: Add a detail to /help/mute-a-stream.
Indicate that muted streams are sorted to the bottom of their section.
2022-11-02 17:05:28 -07:00
Alya Abbott b33245902a help-center: Add tip about how to add a link to a stream description.
Fixes part of #16701.
2022-10-31 14:41:44 -07:00
Alya Abbott 7d95f5caea help center: Clearly refer to mobile apps on /help/mobile-notifications.
Addresses user confusion about whether "mobile notifications" might refer
to text messages.
2022-10-28 11:41:11 -07:00
Alya Abbott 6c88ca91b1 help center: Update emoji reactions documentation.
- Document new option for toggling whether names are displayed.
- Add mobile instructions.
- Other organization and wording improvements.
2022-10-27 12:56:19 -07:00
David Rosa 53b18f819a help: Add "View messages sent by user" page.
Some options in the profile menu are not documented in the help center.

Documents "View messages sent".
Documents "View messages with yourself".
Links `sender:me` search operator to the relevant section on this page.

Fixes: #23203.
2022-10-26 13:16:57 -07:00