Commit Graph

93 Commits

Author SHA1 Message Date
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
David Rosa 061f1dc43b help: Add tip about `+` keyboard shortcut to "Emoji reactions" page.
Adds `keyboard_tip` to the "Add a new reaction" section.
2023-03-24 12:58:35 -07:00
David Rosa 707fa87c74 help: Document `=` keyboard shortcut.
Documents the new shortcut in the `?` menu, Keyboard Shortcuts page,
and Emoji Reactions page.
2023-03-24 12:58:35 -07:00
David Rosa 00988c7ea8 help: Document mark messages as read via recent conversations.
- Adds `via-recent-conversations` tab to document the feature.
- Changes `desktop-web` tab -> `via-left-sidebar` for consistency.
2023-03-24 12:09:58 -07:00
David Rosa 99f48ef587 help: Move how to open Recent Conversations to include block.
Replaces instruction in Reading topics and Recent conversations
with include block.
2023-03-24 12:09:58 -07:00
David Rosa f5272a0382 help: Fix link to production docs in "Start a call" page.
- Fixes hash fragment to match the correct section heading.
2023-03-23 12:18:06 -07:00
David Rosa 55ded41b89 help: Fix link to production docs in "Import from Gitter" page.
- Fixes link formatting and hash fragment to match the correct
  section heading.
2023-03-23 12:18:06 -07:00
David Rosa aa207b8207 help: Fix links to production docs.
We should normally be linking to the stable version of production
documentation, unless the page/section isn't there yet.
2023-03-23 12:18:06 -07:00
Joelute cc7e29b96f help: Merge two similar sections in `marking messages as read`.
Previously, there was a two similar sections in `marking messages as read`.
We want to move the intro paragraph from the second section to the first
section. Then drop the "Do not mark as read" section altogether.
2023-03-23 10:17:38 -07:00
Alex Vandiver 95bdfa8ff8 help: Improve and extend "Export your oganization" documentation.
- Document compliance exports.
- Make structure of all the sections consistent.
- Make other tweaks to improve clarity.

Co-authored-by: Alya Abbott <alya@zulip.com>
2023-03-22 11:56:14 -07:00
Alya Abbott fd703a9ee4 help: Clarify alert words documentation. 2023-03-21 15:49:16 -07:00
Alya Abbott b46e7ef78e help: Update "Trying out Zulip" documentation.
- Link to the new /try-zulip/ page instead of directly to CZO.
- Link to the communities directory.
- Tweak wording about creating a new organization.
2023-03-21 11:20:45 -07:00
Lauryn Menard 611d36a8d1 help: Revert changes to "pm-with" and "group-pm-with" search filters.
In commit f3a67f0e31, we updated the documented search filters
for direct messages, but these had not been changed in the backend
or the frontend of the codebase and therefore the newly documented
filters do not work. Reverts the documentation to the previous
search filters.
2023-03-21 13:26:41 -04:00
Anders Kaseorg b21d93cdd2 help: Fix import-self-hosted-server-tips indentation.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2023-03-18 00:09:43 -07:00
David Rosa f783e8b6ca help: Add a dedicated page on how to add emphasis to text.
- Adds "Via Markdown" instructions block.
- Adds "Via compose box buttons" instructions block.

Fixes part of #24209.
2023-03-16 10:51:57 -07:00
David Rosa 2e2747dfac help: Update Message formatting documentation.
- Updates intro paragraph in Message formatting page.
- Change Markdown syntax -> Markdown formatting.
- Reorders items in the Writing messages section of the left sidebar.
2023-03-16 10:51:57 -07:00
David Rosa b66d8dfd90 help: Add new "Writing messages" section.
Moves pages from "Sending messages" to a new help center section
to document what you can do in a Zulip message, and make this
information easy to find.

Fixes #24208.
2023-03-16 10:51:57 -07:00
Prakhar Pratyush 80a50741e5 help: Update 'Include organization name in subject line' documentation.
Document new "Automatic" configuration option.

This commit updates the help page 'email-notification.md' to reflect
the change in zulip#24075 from a checkbox to a dropdown for the
'Include organisation name in subject line' setting.
2023-03-16 10:49:07 -07:00
Alya Abbott 584124bb45 help: Improve "Deactivate your account" help page. 2023-03-15 15:32:47 -07:00
Joelute 682192ec3c help: Update broken link in `import from slack`.
Previously, the help center has a broken link that just points to
Slack's help center. With this change, we will remove and replace the
link to their OAuth scope section.
2023-03-13 16:57:02 -07:00
Alya Abbott 560ce87063 help: Tweak documentation on migrating from other chat tools.
- Add a note about the Slack-compatible webhook.
- Make page more consistent with documentation style guidelines.
2023-03-09 17:50:50 -08:00
David Rosa b9f7b64793 help: Add instructions for viewing status.
- Adds instructions blocks for web/desktop and mobile.
2023-03-09 16:14:14 -08:00