Commit Graph

267 Commits

Author SHA1 Message Date
Alya Abbott 2b17fb4d2f help: Move instructions for managing topic notifications to /include. 2023-10-12 11:59:12 -07:00
Alya Abbott 6c836cfd26 help: Update /help/mute-a-topic to reflect UI changes.
Also combine instructions for muted and unmuted streams.
2023-10-12 11:59:12 -07:00
Alya Abbott f2f6f6c48c help: Tighten content on /help/printing-messages. 2023-10-10 18:27:48 -07:00
Anders Kaseorg 835ee69c80 docs: Fix grammar errors found by mwic.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2023-10-09 13:24:09 -07:00
Eeshan Garg f3465dea08 demo-orgs: Add UI for converting to permanent organization.
Adds warning banner to the organization settings overlay/tabs
for demo organizations. For owners, clicking on the link in the
banner opens a modal to convert the demo organization into a
permanent organization.

For admins that are not owners, clicking on the link will go
to the help center article on demo organizations.

Non-admin users will not see the warning banner.

The modal for converting a demo organization requires the owner
to have set their email address. Once the owner's email address
is set, then the organization can be made permanent by changing
the subdomain of the organization. The deletion date for the
demo organization will be removed as part of updating the
subdomain.

The organization owner must also have updated the organization
type to be any value other than unsepecified to convert the
demo organization to a permanent organization. The modal's
submit button will be disabled if that is the value for the
organization type in the form. The demo organizations created
in the dev environment now have their organization type set to
unspecified on creation.

This is a part of #19523.

Co-authored by: Lauryn Menard <lauryn@zulip.com>
2023-10-03 09:11:41 -07:00
Alya Abbott 31af4fb24b help: Document option to add stream to default streams when creating.
Option was introduced in #24216.
2023-09-27 14:10:08 -07:00
Alya Abbott 611996aaa9 help: Improve /help/view-a-messages-edit-history.
- Drop unnecessary heading.
- Reorganize and tighten content.
2023-09-27 14:07:41 -07:00
Alya Abbott 6b92e71453 help: Tweak wording in help/add-a-custom-linkifier. 2023-09-27 11:32:32 -07:00
David Rosa 9c20be8ffc help: Document "Show unread count for" display preference.
- Adds a new page in "Reading messages" section to document this new
  feature.
2023-09-24 15:28:50 -07:00
David Rosa de9220830b help: Document troubleshooting screen for mobile notifications.
- Adds instructions for getting to the "Troubleshooting" screen and
  contacting Zulip support.
2023-09-21 16:36:53 -07:00
David Rosa 448788c545 help: Add mobile instructions to change the privacy of a stream. 2023-09-21 08:57:22 -07:00
David Rosa be932400e3 help: Add mobile instructions to change stream description. 2023-09-21 08:57:22 -07:00
David Rosa ef0f418078 help: Add mobile instructions to rename a stream. 2023-09-21 08:57:22 -07:00
David Rosa f2180875e0 help: Update "Change the privacy of a stream".
- Updates page to follow current help center documentation patterns.
- Adds `tip` to change a stream's privacy via stream settings.
2023-09-21 08:57:22 -07:00
David Rosa a3ae87ccb7 help: Update "Change stream description".
- Updates page to follow current help center documentation patterns.
- Revises intro text.
- Adds `tip` to change stream description via stream settings.
2023-09-21 08:57:22 -07:00
David Rosa 069c34b514 help: Update "Rename a stream".
- Updates page to follow current help center documentation patterns.
- Adds Markdown include `tip` to rename stream via stream settings.
2023-09-21 08:57:22 -07:00
David Rosa 2ebf7ae643 help: Add mobile instructions in "Starting a new topic".
- Adds mobile instructions block.
- Adds two more related articles.
2023-09-21 08:41:40 -07:00
David Rosa 6588190918 help: Delete "Start a new topic" page in favor of "Starting a new topic".
- Deletes page, updates references, and adds URL redirect.
2023-09-21 08:41:40 -07:00
David Rosa 83883b08a6 help: Add "View your bots" page.
- Adds new page with instructions for how to view your personal bots.

Fixes #26796.
2023-09-21 08:38:32 -07:00
David Rosa cf5bc5bd1d help: Fix formatting issue in "Dark theme" page. 2023-09-21 08:38:07 -07:00
David Rosa e60a4c4d01 help: Document `unarchive_stream` management command.
- Adds "Unarchiving archived streams" section to "Archive a stream".
- Adds `./manage.py unarchive_stream` to contributor docs.
2023-09-19 15:04:07 -07:00
David Rosa eb244fdc07 help: Update "Archive a stream".
- Updates page to follow current help center documentation patterns.
2023-09-19 15:03:33 -07:00
Mateusz Mandera 3e15ea3f3f scim: Add supporting for syncing the user role.
This adds support for syncing user role via the newly added "role"
attribute, which can be set to either of
['owner', 'administrator', 'moderator', 'member', 'guest'].

Removes durable=True from the atomic decorator of do_change_user_role,
as django-scim2 runs PATCH operations in an atomic block.
2023-09-15 13:15:45 -07:00
David Rosa d862cae3e4 help: Update "Remove users from a stream".
Updates page to follow current help center documentation patterns,
adding Desktop/web instructions to unsubscribe via stream settings.
2023-09-15 10:24:21 -07:00
Karl Stolley 64d5547f26 help: Match vdots icons to those in use on Zulip. 2023-09-14 17:13:58 -07:00
David Rosa 6505583b7e help: Update user management pages.
- Documents how to access the "Manage user" tab via a user's profile.
2023-09-13 13:06:04 -07:00
Lauryn Menard b4f02a336d demo-orgs: Add section on configuring email address to help article.
Adds a section to the demo organizations help center article about
configuring an email and password for demo organization owners.

For demo organization warning banners about needing to configure
an email, add a link to the new section in the help article.

Also, adds a related articles section to the help center article,
and updates the current draft text for changes in how the demo
organization feature is being implemented.
2023-09-08 15:17:23 -07:00
David Rosa 2174e0a7b7 help: Document "Add subscribers" mobile feature.
- Documents adding users via all streams, and stream settings/info.
2023-09-08 08:08:06 -07:00
David Rosa 5e2e53a350 help: Update "Add or remove users from a stream".
- Updates Desktop/web instructions to follow current help center
  documentation patterns.
- Adds instructions to subscribe users via stream settings.
2023-09-08 08:08:06 -07:00
Ujjawal Modi 9a96d19315 invites: Frontend changes for adding the new realm setting.
This commit does the changes in frontend required
for adding the new setting `Who can create multiuse invite link.`

Fixes #15159.
2023-09-07 14:21:01 -07:00
Ujjawal Modi ec49c3acc8 invites: Rename `can_invite_others_to_realm` local variables.
This commit rename the existing setting `Who can invite users to this
organization` to `Who can send email invitations to new users` and
also renames all the variables related to this setting that do not
require a change to the API.

This was done for better code readability as a new setting
`Who can create invite links` will be added in future commits.
2023-09-07 14:21:01 -07:00
Ujjawal Modi 54c7cbaf1c docs: Change `Create an invitation link` heading.
This commit changes the `Create an invitation link` heading
in help docs to `Create a reusable invitation link`.
2023-09-07 14:21:01 -07:00
David Rosa bfc6282d4f help: Add "Troubleshooting" section to mobile notifications page. 2023-09-07 09:49:28 -07:00
David Rosa 9ff4e8b82b help: Add mobile instructions to "Create a stream". 2023-08-30 15:32:24 -07:00
David Rosa 0635b89415 help: Update "Create a stream".
- Updates Desktop/Web instructions to follow current help center
  documentation patterns.
- Moves instructions to a Markdown include-block.
2023-08-30 15:32:24 -07:00
David Rosa 38a8c3df17 help: Add mobile instructions to "Unsubscribe from a stream".
- Documents unsubscribing via long-press menu, all streams, and
  stream settings menu.
2023-08-30 11:30:53 -07:00
David Rosa 9e9b1562e5 help: Update "Unsubscribe from a stream".
- Updates Desktop/web instructions to follow current help center
  documentation patterns.
- Adds instructions to unsubscribe from a stream via the stream settings
  panel.
2023-08-30 11:30:53 -07:00
David Rosa 54044a1045 help: Document keyboard shortcut for starring messages.
Fixes: #26573.
2023-08-28 08:49:49 -07:00
David Rosa 7b2d5df3dd help: Document keyboard shortcut for viewing message edit history.
Fixes: #26573.
2023-08-28 08:49:49 -07:00
palashb01 5df5f6c125 help: Update message edit history documentation.
Co-authored-by: Tim Abbott <tabbott@zulip.com>
2023-08-24 16:28:06 -07:00
David Rosa 5b898ef216 help: Document "Browse and subscribe to streams" mobile feature. 2023-08-24 10:46:28 -07:00
David Rosa cef3a801c2 help: Update "Browse and subscribe to streams".
Updates Desktop/web instructions to follow current help center
documentation patterns.
2023-08-24 10:46:28 -07:00
David Rosa 1f3c125217 help: Document how notifications work for edited and deleted messages. 2023-08-22 14:50:23 -07:00
David Rosa 0349152f0f help: Rename edit-or-delete-a-message.md and update links. 2023-08-22 14:50:23 -07:00
David Rosa c86dc34eba help: Split "Edit or delete a message".
- Splits page into "Edit a message" and "Delete a message".
2023-08-22 14:50:23 -07:00
Karl Stolley b294cf63ad docs: Update star icons to use Zulip icons. 2023-08-21 17:13:43 -07:00
David Rosa a6e60afdc4 help: Document how to access all direct messages in the mobile app. 2023-08-15 10:10:31 -07:00
David Rosa c5bb8c63a9 help: Fix "Typing notifications" intro paragraph.
- Corrects documentation to reflect that typing notifications also
  work when narrowing to all direct messages in the web/desktop app,
  and disappear under certain conditions.
2023-08-15 10:10:31 -07:00
David Rosa 6aee4bb768 help: Document how to view all direct messages in the desktop/web app. 2023-08-15 10:10:31 -07:00
David Rosa c3a632eb2f help: Document "Copy to clipboard" mobile feature. 2023-08-15 09:55:23 -07:00
David Rosa 15bfe66109 help: Update "View message Markdown source".
- Updates article to follow current help center documentation patterns.
- Documents "Copy and close" widget.
2023-08-15 09:55:23 -07:00
Zixuan James Li 5301060954 linkifiers: Support dragging and reordering linkifiers.
This also removes sorting on the pattern and the URL template, because
it does not make sense anymore as we make linkifiers draggable.

Fixes #23716
2023-08-14 15:21:48 -07:00
David Rosa d205850d54 docs: Update .html links pointing to "Upgrade Zulip" or "Modify Zulip".
Follow-up to #24089.
2023-08-11 16:49:32 -07:00
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