Commit Graph

233 Commits

Author SHA1 Message Date
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
palashb01 dee63680df docs: Update time format and Emoticon help page.
Updated the title and description in the 'enable-emoticon-translation'
file and renamed the file accordingly. Added a new bullet point for
'time format' in the 'configure-new-user-settings.md' file and updated
the sidebar index by replacing the title 'Use 24-hour time' with
'Change the time format'.
2023-03-09 16:12:45 -08:00
palashb01 3dd84910f4 display_settings: Rename and reorder the theme dropdown menu.
Rename 'Sync with computer' to 'Automatic (follows system settings)',
'Light Theme' to 'Light' and 'Dark Theme' to 'Dark', and rename the
color scheme label to 'Theme'.

Reorder the dropdown menu to have light theme before dark theme.
2023-03-09 16:12:45 -08:00
palashb01 af07db7971 display_settings: Rename 'Theme' section to 'Emoji'.
Rename the 'Theme' section to 'Emoji'. Since there is no 'Theme' section
anymore, replace the 'theme-settings' classname with
'emoji-display-settings' in the 'settings_display.js' file.

The existing "Theme" selector dropdown is moved from the now the
'Emoji' section to the 'General' section.
2023-03-09 16:12:45 -08:00
palashb01 2067c71a93 display_settings: Rename and update the 'language-time' section.
Rename the 'language-time' title to 'General'. As the 'language-time'
section no longer exists, replace the 'lang-time-settings' classname
with the 'general-settings' classname in the 'settings_display.js' file.

Updated the 'change-the-time-format.md' and 'change-your-language.md'
documentation files to reflect these changes.

To pass the puppeteer_test Replaced the 'lang-time-settings-status'
classname to 'general-settings-status' inside 'settings.test.ts' file.
2023-03-09 16:12:45 -08:00
David Rosa 49081b9682 help: Move "Configure how links open" to the Apps section.
- Moves page to the "Apps" section of the sidebar.
- Adds "in mobile apps" to the top-of-page title.

Follow-up to #24447.
2023-03-09 16:11:51 -08:00
David Rosa 010b362b29 help: Add “Configure how links open” page.
- Documents "Open links with in-app browser" option.
2023-03-08 15:56:04 -08:00
Alya Abbott 46fd215893 help: Link to /apps from help center. 2023-03-07 15:03:49 -08:00
Alya Abbott dbf92c4e2f help: Drop outdated "Zulip in a terminal" help page. 2023-03-07 15:03:49 -08:00
Alya Abbott d23e48441a help: Improve Supported browsers article.
- Simplify explanations, and make them consistent with documentation
  style guide.
- Add related articles.
2023-03-07 15:03:49 -08:00
Lauryn Menard d9d17eb87e help: Add article for supported browsers.
Creates new help article for supported web browsers. Also updates
links in the `/apps` landing page as well as the unsupported-browser
template and the `set-up-your-account` article.

Fixes #14732.
2023-03-07 12:01:48 -08:00
David Rosa 1429c3cf10 help: Document "Who can unsubscribe others from this stream?" setting.
- Updates "Remove others" row in "Stream permissions" tables.
- Adds a section to "Add or remove users from a stream" describing
  how to configure the new setting.
- Documents the new setting in "Create a stream".
- Documents "Message retention period" setting in "Create a stream".

Fixes #24340.
2023-03-07 11:06:52 -08:00
Alya Abbott 2b50428ac5 help: Add context/motivation to Support the Zulip project help page. 2023-03-07 11:03:04 -08:00
David Rosa 140e62d024 help: Add open link icon in "Add a custom linkifier". 2023-03-03 14:19:20 -08:00
Alya Abbott 157b5ada90 help: Expand introduction on /help/support-zulip-project.
Also minor tweaks to the details below.
2023-03-02 12:17:50 -08:00
David Rosa 74e4b01580 help: Update "private message" -> "direct message" term.
Updates all help center pages to match new DM term in Zulip UI.
2023-02-28 16:55:13 -08:00
David Rosa 3a4d800ee9 help: Update "PMs, mentions, and alerts" -> "DMs, mentions, and alerts".
- Updates page content and page name in the sidebar index.
2023-02-28 16:55:13 -08:00
David Rosa bac486d1dc help: Update "Restrict private messages" -> "Restrict direct messages".
- Updates page content and page name in the sidebar index.
2023-02-28 16:55:13 -08:00
David Rosa 3c7437b717 help: Update "Reading private messages" -> "Reading direct messages".
- Updates page content and page name in the sidebar index.
- Updates include blocks.
2023-02-28 16:55:13 -08:00
David Rosa 9c7c71f286 help: Update "Private messages" -> "Direct messages".
- Updates page content and page name in the sidebar index.
- Updates include blocks.
2023-02-28 16:55:13 -08:00
David Rosa 15fd5299af help: Update filenames "private message" -> "direct message".
Renames files, updates references, and adds URL redirects.
2023-02-28 16:55:13 -08:00
David Rosa d098e8275d help: Document stream notifications mobile feature.
- Documents how to set default notifications for all streams and
  single streams from within the mobile app.
2023-02-24 11:35:20 -08:00
Alya Abbott e65f48b619 help: Document modifying email visibility on sign-up. 2023-02-24 09:30:32 -08:00
N-Shar-ma 599a32bee9 hotkey: Add `z` shortcut to zoom to message `near` view.
A new hotkey, lowercase `z` (for `zoom`) has been implemented to allow
the user to go to the near view of the selected message with 1 keypress.
Documentation has been added for this both in the help center, and the
in-app `Keyboard shortcuts` menu.

The effect is identical to clicking on a message's timestamp, which
links to that message's near view.

Fixes: #24227.
2023-02-23 17:47:45 -08:00
David Rosa ff865368c5 help: Add "Do not mark messages as read" section.
- Adds a section to describe why someone would want to set the
setting to never mark messages as read on mobile.
2023-02-23 15:45:52 -08:00
David Rosa 901ae068f5 help: Update formatting of mobile icon references.
- Updates icon references to follow current help center documentation
  patterns: **icon_name** (icon_image).
2023-02-23 15:04:38 -08:00
David Rosa 295b49e487 help: Document how to change the language of the mobile app. 2023-02-23 15:04:38 -08:00
David Rosa 95867e6f3e help: Document dark-theme mobile feature.
- Documents "Night mode" option.
- Adds Related articles section.
2023-02-23 11:48:59 -08:00
Alya Abbott faa69940d7 help: Add section on privacy settings to /help/review-your-settings.
Also move "Review your settings" page to the "Account basics" section
in the left sidebar.
2023-02-23 11:48:32 -08:00
David Rosa 2b9b0acaa4 help: Update URL references to new "Configure email visibility" page. 2023-02-10 18:15:56 -08:00
Alya Abbott 9ea3572017 help: Document new user setting for configuring email visibility.
- Adds a URL redirect from the old page to the new page.
2023-02-10 18:15:56 -08:00
David Rosa 8c047275a4 help: Update URLs to match "Restrict moving messages" title.
Updates all references to the new URL and adds a URL redirect.

Follow up to #24329.
2023-02-10 15:56:16 -08:00
David Rosa 3254023fa3 help: Update URLs to match "Restrict message editing and deletion" title.
Updates all references to the new URL and adds a URL redirect.

Follow up to #24329.
2023-02-10 15:56:16 -08:00
Alya Abbott 66919ffa90 help: Update documentation on editing and moving messages.
- Updates reflect recent settings changes.
- Also update links from other help pages.
2023-02-08 16:44:26 -08:00
David Rosa e3c75ee0a9 help: Cross-link Do Not Disturb with other Notifications pages.
Fixes part of #24169.
2023-02-07 16:00:46 -08:00
David Rosa 6567a45488 help: Document Do Not Disturb feature in Desktop app.
Documents the Do Not Disturb option with a dedicated page in
the Notifications section.

The capitalization is not our standard style because the desktop app
doesn't follow that style convention.

Fixes #24169.
2023-02-07 16:00:46 -08:00
Alya Abbott ac63c791eb help: Link to https://zulip.com/values/ from supporting-zulip-motivation.md. 2023-01-26 14:46:57 -08:00
Alya Abbott 4749e9acb0 help: Tweak Support the Zulip project page. 2023-01-26 14:46:57 -08:00
Alya Abbott f552465c2d help center: Document supporting Zulip and linking to the Zulip website. 2023-01-26 10:59:23 -08:00
David Rosa 0030c8d115 help: Document "Mute/Unmute stream" mobile app feature.
Fixes #22196.
2023-01-26 10:32:47 -08:00
David Rosa 776a05c4c2 help center: Update "Mute a stream" and "Pin a stream" pages.
Update pages to follow our current help center documentation patterns.
2023-01-26 10:32:47 -08:00
David Rosa 99b3c1c9d4 help: Move "Admins only" banner in "Deactivate/reactivate a bot".
Moves the "Admins only" banner from the top of the page to the
"Via organization settings" instruction tabs.
2023-01-26 10:18:25 -08:00
David Rosa 8d1db6482f help center: Update relative gear menu macro for organization settings.
Renames "Manage organization" to "Organization settings" to reflect
changes in the previous commit.
2023-01-26 10:17:45 -08:00
Lauryn Menard dedea23745
help-docs: Move help center documentation to top level directory.
These files are not Jinja2 templates, so there's no reason that they needed
to be inside `templates/zerver`. Moving them to the top level reflects their
importance and also makes it feel nicer to work on editing the help center content, 
without it being unnecessary buried deep in the codebase.
2023-01-25 14:08:29 -08:00