Commit Graph

214 Commits

Author SHA1 Message Date
David Rosa d24a689e9e help: Add heading on linking to messages in "Writing messages" section.
We should have a clear reference in the "Writing messages" sidebar
section on linking to other conversations below "Mention a user
or group" to clarify mentioning users vs linking to conversations.

This adds a link to the "Link to a message or conversation" article
with a different heading.
2023-08-11 11:13:22 -07:00
David Rosa 592d0e2794 help: Document "Starred messages" mobile feature. 2023-08-10 17:31:10 -07:00
David Rosa 347c3dce5e help: Update "View your starred messages" section.
- Adds instructions block and relative link to Starred messages.
- Adds "Toggle starred messages counter" subheading.
- Adds "Searching for messages" as a related article.
2023-08-10 17:31:10 -07:00
David Rosa c74f607a6d help: Update "Star a message" mobile instructions. 2023-08-10 17:31:10 -07:00
Karl Stolley fd766c828c docs: Document printable conversations. 2023-08-09 18:06:06 -07:00
David Rosa d346b9bd1c help: Document "Add video call" mobile feature. 2023-08-09 09:49:09 -07:00
David Rosa d40d6b625b help: Update "Emoji reactions" mobile instructions. 2023-08-08 10:27:04 -07:00
Alya Abbott 48846e61cd help: Link to /help/recent-conversations to define "conversation".
- Adds a link to the "Recent conversations" article whenever we use the
  term "conversation" as a technical term referring to topic or
  DM thread. This can help clarify meaning when the term is used in this
  specific way.
2023-08-07 10:10:21 -07:00
Ishita Gupta aa86533f22 UI redesign: more-less message interaction.
This commit encompasses the following changes:
* Replace the [More...] link with a button titled "Show more".
* Replace the [Show Less...] link with a button titled "Show less".
* Add various on-hover interactions to the buttons.
* In the condensed view, add fading to the bottom of the message to
  visually communicate that the message is truncated.
* Update /help/ description.

Fixes #22801.

Co-authored-by: Evy Kassirer <evy.kassirer@gmail.com>
2023-07-24 17:42:08 -07:00
Zixuan James Li 000761ac0c realm_playgrounds: Replace url_prefix with url_template.
Dropping support for url_prefix for RealmPlayground, the server now uses
url_template instead only for playground creation, retrieval and audit
logging upon removal.

This does the necessary handling so that url_template is expanded with
the extracted code.

Fixes #25723.

Signed-off-by: Zixuan James Li <p359101898@gmail.com>
2023-07-24 17:40:59 -07:00
David Rosa f64d5e1db6 help: Remove "Invite users" relative help link.
- Replaces `{relative|gear|invite}` with a Markdown include since
  we no longer use the `#invite` hash in the web-app.
2023-07-21 14:18:24 -07:00
David Rosa 0c122391bb help: Offer links to "Search filters" for logged in users.
- Replaces instructions for opening the search filters reference
  with `{relative|gear|search-filters}`.
2023-07-21 14:18:24 -07:00
David Rosa 901c6d8761 help: Offer links to "Message formatting" for logged in users.
- Replaces instructions for opening the message formatting reference
  with `{relative|gear|message-formatting}`.
2023-07-21 14:18:24 -07:00
David Rosa 4bb910f9fb help: Offer links to "Keyboard shortcuts" for logged in users.
- Replaces instructions for opening the keyboard shortcuts reference
  with `{relative|gear|keyboard-shortcuts}`.
2023-07-21 14:18:24 -07:00
David Rosa 930909c1b2 help: Offer links to "All messages" for logged in users.
- Replaces instructions for opening all messages with
  `{relative|message|all}`.
2023-07-21 14:18:24 -07:00
David Rosa a9a1946819 help: Offer links to "Recent conversations" for logged in users.
- Replaces Markdown include with `{relative|message|recent}`.
2023-07-21 14:18:24 -07:00
David Rosa 2c8c56184a help: Update "Message drafts" to follow current documentation patterns. 2023-07-17 17:25:25 -07:00
David Rosa 8093ba0263 help: Revise "Schedule a message".
- Removes `tip` block that does not apply to the "Send a scheduled
  message now" section.
- Adds relevant keyboard tips.
- Adds "Related articles" section.
2023-07-17 17:25:25 -07:00
David Rosa 3f5475b080 help: Update "Scheduled a message" to offer link for logged-in users.
- Replaces instruction for accessing "Scheduled messages" with
  `{relative|message|scheduled}`.
2023-07-17 17:25:25 -07:00
David Rosa 8bd3c4ea2b help: Update "Text emphasis" page to be consistent with other pages.
- Adds "Examples" subheading.
- Adds Markdown includes for intro text and examples.
2023-07-17 11:17:24 -07:00
David Rosa 73213a444b help: Update sidebar title and related articles of Video calls page. 2023-07-17 11:17:24 -07:00
David Rosa 94caacaba9 help: Update sidebar title and related articles of Polls page. 2023-07-17 11:17:24 -07:00
David Rosa d03bd13550 help: Update sidebar title and related articles of Animated GIFs page. 2023-07-17 11:17:24 -07:00
David Rosa bfed711f54 help: Add a dedicated page on how to format paragraphs and sections. 2023-07-17 11:17:24 -07:00
David Rosa d127a6d317 help: Add a dedicated page on how to start a collaborative to-do list. 2023-07-17 11:17:24 -07:00
David Rosa 5f8d5eeb22 help: Add a dedicated page on how to format tables. 2023-07-17 11:17:24 -07:00
David Rosa 8c1e1f3f89 help: Add a dedicated page on how to format global times. 2023-07-17 11:17:24 -07:00
David Rosa 5c0e7ca43c help: Add a dedicated page on how to use /me action messages. 2023-07-17 11:17:24 -07:00
nimish c238327899 settings: Change "Display settings" to "Preferences".
This includes changing the URL to #settings/preferences, with a
transparent redirect so that existing links, like the one from Welcome
Bot, continue to work.
2023-07-12 07:09:03 -07:00
Lauryn Menard 07e199729c help-docs: Update article on disabling welcome emails.
Updates the article on disabling welcome emails to note that the
initial email on account creation will always be sent.
2023-07-11 14:15:52 -07:00
Lauryn Menard e1c809a71e api-docs: Clarify what topics are returned by `get-stream-topics`.
Updates the main description for the `get-stream-topics` endpoint
so that it is clear that the topics for private streams with protected
history are limited to the topics / messages the user has access to.

And updates that documentation and the help center documentation for
bot permissions / abilities, to clarify that bots have the same
restriction and can only access messages / topics that are sent after
the bot (not the bot's owner) subscribed to the stream.
2023-06-26 20:26:30 -07:00
David Rosa 719e92ffb8 help: Document Markdown formatting for wildcard mentions.
- Documents wildcard mentions (`@all`, `@everyone`, `@stream`),
  linking to /help/mention-a-user-or-group#mention-everyone-on-a-stream
  from the intro text.

Fixes #25783.
2023-06-19 13:46:58 -07:00
Anders Kaseorg 639efc5ce1 docs: Update Transifex URLs.
https://help.transifex.com/en/articles/7171815-web-application-s-domain-change

Signed-off-by: Anders Kaseorg <anders@zulip.com>
2023-06-12 17:38:41 -07:00
Alya Abbott 03659004a9 docs: Link to new guide on suggesting features and improvements. 2023-06-12 17:05:42 -07:00
Alya Abbott 9258acce14 docs: Link to new "Reporting bugs" guide. 2023-06-12 16:04:00 -07:00
Alya Abbott 052a109ba4 docs: Improve instructions for reporting bugs.
- Create a dedicated "Reporting bugs" page to learly document
where and how bugs should be reported.
- Drop "Reporting issues" section from the Contributing guide.
- Delete "Bug report guidelines" page.
2023-06-12 14:31:45 -07:00
David Rosa 474dd4896d help: Rename private messages -> direct messages in mobile docs.
- Updates the help center to use "direct messages" in mobile
  instructions.

Fixes #25870.
2023-06-08 09:44:42 -07:00
Akarsh Jain e20e7482ca invite: Restructure "Invite user" modal for improved user experience.
This commit revamps the invite type section of the "Invite user" modal
to provide a more intuitive user experience. The section now includes a
radio button option with two choices: "Send an email" and "Generate an
invite link." The email input box is hidden when the "Generate an invite
link" option is selected.

Fixes #24692.
2023-06-06 17:48:29 -07:00
rht 1c84f02f57 slack import: Convert threads to nicely named Zulip topics.
Fixes #9006.
2023-05-30 16:35:19 -07:00
Alya Abbott 173e5389af help: Define "conversation" in /help/include/recent-conversations.md.
Also link to definition from /help/marking-mesages-as-read.
2023-05-30 13:01:52 -07:00
David Rosa 0b19d5cd5e help: Document "Inbox view" mobile feature.
- Adds a new page under the "Reading messages" section documenting
the Inbox view on mobile.
- Adds Inbox, expand more, and expand less SVG mobile icons.
- Cross-links with "Recent conversations" and "All messages".
2023-05-30 10:40:41 -07:00
Alya Abbott 457ff73082 help: Update suggested review sites on Support the Zulip project page. 2023-05-29 14:41:41 -07:00
Alya Abbott 3ca20e3ea8 help: Document quick way to check Zulip version.
Version number was added to top section of gear menu in
4df8c6610f.

Version number was added to "About Zulip" in
668b5137b0.
2023-05-29 08:39:01 -07:00
Alya Abbott c97deb6be2 help: Tweak docs on keyboard shortcuts for composing messages.
- Adjust the order in keyboard shortucts help menu and help center.
- Make minor wording improvements.
2023-05-28 19:18:34 -07:00
David Rosa 299d13646e help: Tweak wording for inserting a link via Markdown. 2023-05-28 15:08:49 -07:00
David Rosa 122bd3fcc1 help: Add mobile instructions to "Share and upload files".
- Documents uploading files via compose box buttons.
- Documents sharing files from other Android apps.
2023-05-28 15:08:49 -07:00
David Rosa d89933b885 help: Update "Share and upload files" article.
- Adds via-markdown instructions block.
- Adds via-compose-box-buttons instructions block.
- Documents option to select multiple files.
- Adds named image file example section.
2023-05-28 15:08:49 -07:00
Alya Abbott 084331010c help: Update /help/edit-or-delete-a-message for clarity and consistency. 2023-05-24 12:40:18 -07:00
David Rosa 9ee584f206 help: Document "Delete message" mobile feature. 2023-05-24 12:40:18 -07:00
David Rosa 7551d96e1c help: Add instructions block to "Delete a message" on Desktop/Web. 2023-05-24 12:40:18 -07:00
David Rosa 84fb9ab817 help: Document "Edit message" mobile feature. 2023-05-24 12:40:18 -07:00
Mateusz Mandera 22cd8a28d2 docs: Mention SAML SLO support at /help/saml-authentication. 2023-05-23 13:01:15 -07:00
Alya Abbott 9ca00a1eff help: Document keyboard navigation for scheduling a message. 2023-05-19 16:53:31 -07:00
David Rosa 19eb98a74a help: Document "User list style" display setting.
- Documents the "User list style" (under Settings > Display settings)
- Adds new section to /help/status-and-availability#statuses

Fixes #23492.
2023-05-18 16:17:56 -07:00
David Rosa 7fc474c7a6 help: Update "Restrict stream invitation" page.
- Renames page title to "Restrict stream membership management".
- Renames section about "Who can add users to streams" setting.
- Adds new section "Configure who can remove users".
- Updates help/stream-permissions

Fixes #25264.
2023-05-18 12:50:54 -07:00
David Rosa 55127b6178 help: Add intro section to help/add-or-remove-users-from-a-stream.
- Adds an intro section about what's possible by consolidating
  references to permissions.
2023-05-18 12:50:54 -07:00
Karl Stolley 386d87635e popovers: Shorten 'Quote or reply' label.
This removes the previous "or forward" text from the message
actions popover, and keeps the documentation in sync with the
new text. Internationalization tests are updated, too.

Fixes #25603.
2023-05-16 12:36:29 -07:00
David Rosa 62553f8303 help: Restructure /help/mute-a-topic.
- Create separate sections for muted vs. unmuted streams.
- Combine instructions for muting/unmuting topics.

Fixes #25311.
2023-05-15 17:52:04 -07:00
David Rosa eec7dedc17 help: Update links to renamed article "Starting a new direct message". 2023-05-15 16:13:55 -07:00
David Rosa be14ec2cab help: Rename "Starting a new private thread" to "... new direct message".
With the private messages -> direct messages migration, we should
rename the "Starting a new private thread" help center article.

- Renames article to "Starting a new direct message"
- Updates relevant section in /help/getting-started-with-zulip
- Fixes typo in /help/send-group-dm
- Updates file names and adds URL redirect.

Fixes #25506.
2023-05-15 16:13:55 -07:00
Alya Abbott 435446dd92 help: Fix typo in mute-unmute-intro.md. 2023-05-11 10:53:38 -07:00
Alya Abbott 8e1098f102 help: Document message forwarding on /help/quote-and-reply. 2023-05-10 11:37:36 -07:00
Alya Abbott aae6d98c92 help: Add a tip about switching from stream to DM compose. 2023-05-10 11:37:36 -07:00
Alya Abbott de763f2894 help: Update "Staring a new topic" page to describe stream dropdown. 2023-05-10 11:37:36 -07:00
Alya Abbott a9d0656605 help: Document stream/DM switcher on "Mastering the compose box" page. 2023-05-10 11:37:36 -07:00
Joelute 245c855376 user_setting: Update wording for "Mark messages as read on scroll" setting.
Previously, the user setting "Mark messages as read on scroll" sounded
quite awkward and possibly confusing at times. We should update the text
to something more clear and concise. This change will change "Mark messages
as read on scroll" to "Automatically mark messages as read".

The help center article is also fixed to name which setting is being
adjusted.
2023-05-08 15:49:47 -07:00
Alya Abbott fd233bd33d help: Add numbers to single-step "Mesage drafts" instructions. 2023-05-05 13:30:51 -07:00
Alya Abbott 301e4c922d help: Add "Schedule a message" help center page.
Fixes #25407.
2023-05-05 13:30:51 -07:00
Alya Abbott 312912b535 help: Use standard formatting for button labels on /custom-emoji.md. 2023-05-05 13:30:51 -07:00
Sahil Batra e3598c80ec settings: Move setting to allow message content in email notifications.
We move "Allow message content in message notification emails" setting
from "Other settings" subsection to "Automated messages and emails"
subsection.

Fixes #25339.
2023-05-02 13:42:38 -07:00
N-Shar-ma c6ba33b7b4 hotkey: Repurpose `s` to toggle conversation view and remove `shift+s`.
Earlier, the `s` hotkey just narrowed to the stream of the selected
message (to a topic), while `shift+s` narrowed to the conversation view
(topic / dm) of the selected message.

Now, the `shift+s` hotkey has been removed (but retained for toggling
subscription to a stream when the stream overlay is active), and the `s`
hotkey takes on double duty: if the current view is not topic / dm, it
narrows to that, else when in topic view, it switches to stream view. It
has no effect when in dm view. Documentation has been updated for this
both in the help center, and the in-app `Keyboard shortcuts` menu.

A deprecation notice has been added for `shift+s` as well.

Fixes: #24226.
2023-05-01 20:32:58 -07:00
Tim Abbott 7ae7b753da help: Improve /help/add-a-custom-linkifier page.
- Structure page around linkifier use cases.
- Add documentation (with examples) for advanced lnkifier types.
- Put examples in to tabs blocks.
2023-04-27 15:39:54 -07:00
Tim Abbott 5c528f164c help: Use correct unmute icon for unmute. 2023-04-25 17:56:47 -07:00
David Rosa 6608f2b211 help: Update links for muting / unmuting topics and streams. 2023-04-25 15:04:24 -07:00
Alya Abbott dd4b391229 help: Cover unmuting topics in /help/mute-a-topic. 2023-04-25 15:04:24 -07:00
Lauryn Menard 9880fcb936 narrow: Document new filters `is:dm`, `dm` and `dm-including`.
Documents narrows now have support for new filters for direct messages:
`is:dm`, `dm`, and `dm-including`. Also documents that `is:private`,
`pm-with` and `group-pm-with` are now legacy aliases for these three
new filters respectively.

Note that API documentation references the help center documentation
for search/narrow filters.

Fixes #24806.
2023-04-25 09:07:08 -07:00
Ujjawal Modi 449febf036 streams: Make stream settings and create stream UI more consistent.
This commit make changes in create stream panel by moving
announce stream option below stream description and adds a
"Stream permissions" section heading just above
"Who can access the stream?" and also rewords the text
"Announce stream".

Also now announce stream option is only shown if the user creating
stream have access to the announcement stream name. When option
is not shown, default behaviour is to announce public and
web-public streams.

Fixes #23327.
2023-04-24 17:02:33 -07:00
Joelute e2c4033d75 help: Add instructions for `do not mark messages as read`.
As a follow up to #24309, we want to add a new tab with desktop/web
instructionsto the "Configure whether messages are automatically marked as
read" section.The paragraph has also been tweaked to accommodate the new
feature.
2023-04-24 15:58:59 -07:00
N-Shar-ma 3a64c8c0db compose: Change video call url text to "Join video call.".
Earlier it was "Click here to join video call".
2023-04-20 15:04:26 -07:00
David Rosa 93062b3ec4 help: Update Message formatting section and page on Mentions. 2023-04-20 10:42:49 -07:00
David Rosa b6b217681a help: Improve emoji and emoticon documentation. 2023-04-20 10:42:49 -07:00
Alya Abbott 983c1e5318 help: Update /help/require-topics.
There is no longer a special permissions exception for adding a
topic to messages without one.
2023-04-19 20:28:29 -07:00
Alya Abbott e8dfe9eefd help: Update "Disable welcome emails" help page.
Drop unnecessary details about number and content of welcome emails,
which were no longer accurate.
2023-04-19 20:28:07 -07:00
Alya Abbott 303b7d6d9f help: Document new "Rename topic" option. 2023-04-19 17:11:02 -07:00
Zixuan James Li 268f858f39 linkifier: Support URL templates for linkifiers.
This swaps out url_format_string from all of our APIs and replaces it
with url_template. Note that the documentation changes in the following
commits  will be squashed with this commit.

We change the "url_format" key to "url_template" for the
realm_linkifiers events in event_schema, along with updating
LinkifierDict. "url_template" is the name chosen to normalize
mixed usages of "url_format_string" and "url_format" throughout
the backend.

The markdown processor is updated to stop handling the format string
interpolation and delegate the task template expansion to the uri_template
library instead.

This change affects many test cases. We mostly just replace "%(name)s"
with "{name}", "url_format_string" with "url_template" to make sure that
they still pass. There are some test cases dedicated for testing "%"
escaping, which aren't relevant anymore and are subject to removal.
But for now we keep most of them as-is, and make sure that "%" is always
escaped since we do not use it for variable substitution any more.

Since url_format_string is not populated anymore, a migration is created
to remove this field entirely, and make url_template non-nullable since
we will always populate it. Note that it is possible to have
url_template being null after migration 0422 and before 0424, but
in practice, url_template will not be None after backfilling and the
backend now is always setting url_template.

With the removal of url_format_string, RealmFilter model will now be cleaned
with URL template checks, and the old checks for escapes are removed.

We also modified RealmFilter.clean to skip the validation when the
url_template is invalid. This avoids raising mulitple ValidationError's
when calling full_clean on a linkifier. But we might eventually want to
have a more centric approach to data validation instead of having
the same validation in both the clean method and the validator.

Fixes #23124.

Signed-off-by: Zixuan James Li <p359101898@gmail.com>
2023-04-19 12:20:49 -07:00
Aman Agrawal 8c744752ed stream_privacy: Use new lock and hashtag icons.
This commit doesn't modify the lock and hashtag icon in settings.
2023-04-10 23:41:30 -07:00
David Rosa 95d34540a3 help: Add a dedicated page on how to format spoiler blocks. 2023-03-30 09:39:35 -07:00
Alya Abbott 0afd37dbae help: Add a dedicated page on how to format quotes. 2023-03-30 09:39:35 -07:00
David Rosa 56c03de927 help: Add a dedicated page on how to format LaTeX. 2023-03-30 09:39:35 -07:00
David Rosa 9c3efa6880 help: Update Message formatting section and page on code blocks. 2023-03-30 09:39:35 -07:00
David Rosa dad5869c1f help: Add a dedicated page on how to format links.
Also remove the Images section from the "Message formatting" help
page, and drop unused markdown-image.png.

Fixes part of #24209.
2023-03-30 09:39:35 -07:00
Mateusz Mandera e3f754fb9b help center: Document SAML configuration steps with Auth0.
Auth0 is another SAML IdP that we haven't detailed the instructions for
yet.
2023-03-30 09:11:55 -07:00
Alya Abbott 1bea42dd44 help: Drop deprecated "Organize the streams sidebar" page. 2023-03-27 17:14:09 -07:00
David Rosa 4508fb5d5c help: Add a dedicated page on how to format lists.
- Updates example and screenshot for numbered lists.
2023-03-24 15:19:08 -07:00
Alex Vandiver 2ab79c0477 web: Save a 301 redirect from /self-hosting to /self-hosting/. 2023-03-24 14:51:01 -07:00
Alex Vandiver 3e307781dd web: Save a 301 redirect from /for/x to /for/x/. 2023-03-24 14:51:01 -07:00
Alex Vandiver b5731c55b7 web: Save two 301 redirects from /privacy to /privacy/ to /policies/privacy. 2023-03-24 14:51:01 -07:00
Alex Vandiver d9daeb13e0 web: Save a needless 301 redirect from /apps to /apps/. 2023-03-24 14:51:01 -07:00
Alex Vandiver c686c5ed0f web: Save a needless 301 redirect from /plans to /plans/. 2023-03-24 14:51:01 -07:00
Alex Vandiver a1570ff3dd web: Save a needless 301 redirect from /integrations to /integrations/. 2023-03-24 14:51:01 -07:00