Commit Graph

1460 Commits

Author SHA1 Message Date
Yogesh b8a760b14e compose: Improve tooltip on compose box "x" button.
In compose box, the "x" button tooltip text changed to
"Cancel compose and save draft" except when unsent
message length is short(<3).

Also in help(?) > keyboard shortcuts, text for `Esc`
changed to "Cancel compose and save draft".

The help center page updated with the above changes.

Fixes #21599.
2022-08-06 20:46:46 -07:00
Lauryn Menard f89c251b58 api-docs: Revise areas of documentation re: user presence objects.
Updates documentation to include information about user presence
objects with `aggregated` key (instead of the user's email) where
appropriate.

Also, cleans up spelling, grammar and formatting errors in the
descriptive text for these objects / endpoints.
2022-08-04 16:34:13 -07:00
Kartik Srivastava e2760a2bf2 api: Document /realm/presence API endpoint. 2022-08-04 16:34:13 -07:00
Lauryn Menard d8a490d162 help-docs: Clarify instructions for setting email notifications.
Updates the instruction block to directly reference the section
header (Notifications triggers) for clarity and consistency with
other help center references to this user settings area.
2022-07-28 14:49:10 -07:00
yogesh sirsat f264795770 deactivate_users: Change submit button text of confirmation modal.
Change submit button text of both bot and user deactivation confirm
modal from "Confirm" to "Deactivate".
Calling `launch()` function from `dialog_widget.js` because
`confirm_dialog.js` set submit button text to "Confirm".
2022-07-27 17:09:48 -07:00
David Rosa 268dbd3172 help-docs: Fix instructions for the "Logging out" mobile app feature.
The instructions for logging out are not accurate.

Fixes the instructions and replaces the iOS and Android tabs with
a single Mobile tab.

Adds a Related articles section with links to "Logging in",
"Switching between organizations", and "Deactivate your account".
2022-07-27 13:51:14 -07:00
David Rosa f060d5c870 help-docs: Standardize on "corner of the app" instead of "...screen".
The phrasing "corner of the screen" wouldn't be accurate when the user
is doing a split screen or if the window or app is not taking up the
whole screen. Also, the use of "lower/upper" and "top/bottom" is not
consistent.

This standardizes on "corner of the app" and "bottom/top" when
referring to the location of app features on Desktop, Web, or Mobile.
2022-07-27 13:51:14 -07:00
David Rosa 0f7742ec4d help-docs: Improve "Logging in" and "Switching between organizations".
Improves step-by-step instructions for Desktop users by directing
users to the relevant items in the left sidebar or top menu bar
without using an obscure keyboard shortcut.

Adds tip macro with instructions for toggling the app's left sidebar
via the top menu bar.

Moves the proxy settings and custom certificate info into a warning
block instead of the main instructions flow given they are rarely
needed for Logging in.

Adds a Related Articles section to "Switching between organizations"
so that users can access the information for setting an organization
profile picture from there instead of an oddly placed warning block.

Also adds links to "Logging in", "Logging out", and "Deactivate your
account", and lists them in each other's Related articles sections.
2022-07-27 13:51:14 -07:00
David Rosa 26b51d9393 help-docs: Replace mobile profile menu instructions with macro.
Adds a macro with instructions for accessing the profile menu for
reusability in "Logging out" and "Switching between organizations".

Reorders tabs Web > Desktop > Mobile for consistency.
2022-07-27 13:51:14 -07:00
David Rosa a5eea68cf5 help-docs: Fix cross-links to help center pages about linking to Zulip.
Renames the main heading of "Linking to your organization" to match up
with the sidebar index title and adds a "Related articles" section.

Fixes cross-link title in "Link to a message or conversation".

Fixes: #22590.
2022-07-27 13:44:59 -07:00
David Rosa 6062bad761 help-docs: Document "Pin to top"/"Unpin from top" mobile app feature.
Adds step-by-step instructions for mobile app users.

Adds alternate instructions for accessing the stream settings from
the long-press menu and from the information icon using a new
macro for reusability.

Fixes: #22198.
2022-07-26 17:04:40 -07:00
David Rosa ca22783960 help-docs: Add "Unpin" section to the "Pin a stream" page.
Fixes part of #22198.
2022-07-26 17:04:40 -07:00
Alya Abbott f244336271 portico: Move /plans FAQ to help center. 2022-07-25 16:55:13 -07:00
David Rosa 6e66d63e62 help-docs: Document "Status and availability" mobile features.
Adds step-by-step instructions for mobile app users.
2022-07-22 14:21:21 -07:00
David Rosa a533495399 help-docs: Add macro for self actions menu instructions.
Replaces instructions with macro for reusability.

Adds Desktop/Web tab in preparation for mobile documentation.

Improves wording of a couple of sentences.
2022-07-22 14:21:21 -07:00
Lauryn Menard 6e924125ad api-docs: Remove include links in endpoint descriptions.
Two endpoints had linked markdown files that were used in
their general descriptions to add warning notes with important
information (`/create-user` and `/get-user-groups`).

This moves the warning content to be inline in the endpoint
descriptions so that the important content is in the OpenAPI
documentation and is still formatted to be rendered in a warning
block.

Deletes `can-create-users-only.md` and `api-members-only.md`
since they were only used for these two endpoint descriptions.

Also, cleans up the other instance of a inline warning block in
an endpoint description (`/fetch-api-key`).
2022-07-20 14:36:15 -07:00
Alex Vandiver 7553c7ca4e docs: Document that you need to copy slack-data.zip onto the server. 2022-07-20 09:38:28 -07:00
ritikBhandari 861ddea1cd help-docs: Remove no longer accurate "notifications" terminology.
Updates references / language about organization settings that
were previously labeled as "Notifications", but are now labeled
as "Automated messages and emails".

Fixes #22136.

Co-authored by: Lauryn Menard <lauryn@zulip.com>
2022-07-19 17:32:47 -07:00
Julia Bichler ccbdbe4e3b message-editing: Reword move message menu. 2022-07-19 11:50:28 -07:00
Alya Abbott c074006b78 help center: Update /help/change-your-language. 2022-07-15 14:59:35 -07:00
Lauryn Menard cdb4c8e3d4 help-docs: Update translation general information text.
Adds a shared file with general information about Zulip's
translation project based on the text in web-app's language
picker, and uses that text at the beginning of the help articles
for setting the organization notifications/announcement language
and for the user setting their personal language setting.

Also makes some small edits/updates to the help center article
about the user's personal language setting to align with current
UI and current documentation styles.
2022-07-15 14:59:35 -07:00
Purushottam Tiwari bd451d134c help: Cross link help center docs for managing stream subscriptions. 2022-07-14 14:23:33 -07:00
Lauryn Menard 62c6ab7629 help-docs: Reorganize customize organization settings information.
Allows the 3 articles that use the same instructions for reviewing
the organization settings to share an include file, and also
allows the 2 articles that share the same settings highlight info
to share an include file as well.

Also, fixes mentions of UI features to use bold instead of
quotations.
2022-07-13 14:02:29 -07:00
Lauryn Menard 1c6d2bc6ba help-docs: Fix UI feature references to use bold, not quotes.
Fixes a few help center documentation articles where UI features
were referenced with quotation marks instead of bold text. Also,
updates these articles for other current documentation styles.
2022-07-13 14:02:29 -07:00
David Rosa 82dab51988 help-docs: Rename "Related topics" to "Related articles".
A few help center pages have a "Related topics" section.
This renames it to the terminology we're generally using.
2022-07-12 11:58:30 -07:00
Lauryn Menard 0543f4596c integrations-docs: Update `git-webhook-url-with-branches.md`.
Updates `git-webhook-url-with-branches.md` (and two files that use
that file as an include link) for some of the follow-ups from #22315
to the Markdown parser. With this fix, all integrations docs that
reference this file as an include link should render the url as a
div element with `.codehilite` class.
2022-07-07 17:12:00 -07:00
Lauryn Menard 3edac8feee help-docs: Update button text for enabling `Enter` to send.
Updates help center documentation for enabling `Enter` to send for
the new default button text (`Ctrl` + `Enter` to send).

Also adds backticks to all references to the `Enter` key, so that
they are updated by `adjust_mac_shortcuts` for Mac keyboards;
and removes the table at the end of the article replacing it with
a simple tip for the `Shift` + `Enter` keyboard shortcut.
2022-07-07 15:08:04 -07:00
Lauryn Menard 4eb9e8b9d2 help-docs: Update article about message drafts.
Updates help center article on viewing and editing drafts of
messages for current documentation styles (less use of bold text,
no Mac keys, tabs for Desktop/Web vs subheaders, etc), which also
preps page for mobile app documentation when drafts are supported.
2022-07-07 15:06:08 -07:00
David Rosa 2038eb03c1 help-docs: Document "Delete topic" mobile app feature.
Adds a new tab with instructions for mobile app users.

Fixes: #22195.
2022-07-07 15:05:01 -07:00
David Rosa 7bd8e984e7 help-docs: Replace "Delete topic" instructions with macros.
Fixes part of #22195.
2022-07-07 15:05:01 -07:00
Alya Abbott 6b143f81d9 help center: Add a "Configure multi-language search" page. 2022-07-07 10:44:15 -07:00
Alya Abbott c5508bb8fd help center: Move typing notifications documentation to a separate page. 2022-07-07 10:42:04 -07:00
Alya Abbott 74986765e9 help center: Document reactivating a user in greater detail. 2022-07-07 10:39:55 -07:00
David Rosa a4c3499c11 help-docs: Document "Resolve/Unresolve topic" mobile app feature.
Adds a new tab with the resolve/unresolve topic instructions for
mobile app users.

Makes the instructions a little more explicit so that users know they
won't see the menu unless they press and hold the topic long enough.

Also improves the wording of the instructions to access the
long-press menu so that users are more likely to read it as saying
that the whole area of a given topic, extending the whole width of
the screen, is the region they can press to act on that topic.

Fixes #22144.
2022-06-30 11:27:59 -07:00
David Rosa a2d42ace2f help-docs: Refactor "Resolve/Unresolve topic" instructions.
This consolidates the "message recipient bar" and "left sidebar"
instructions under a "Desktop/Web" tab as proposed in issue #22178.

Rewrites the "message recipient bar" instructions as a Tip block.

This will allow adding a new tab to document the mobile feature.

Fixes part of #22144.
2022-06-30 11:27:59 -07:00
David Rosa 2e2cd3eb49 help-docs: Document "Copy link to stream" mobile app feature.
Adds a new tab with instructions for mobile app users.

Adds new macros with instructions for accessing the long-press menu.

Fixes: #22197.
2022-06-30 11:24:22 -07:00
Lauryn Menard 4ce9799cc2 integrations-docs: Remove `zulip-config.md`.
The content in `zulip-config.md` was moved (in #22315) to
`change-zulip-config.file.md`. This removes the now out-of-date
reference to this macro in the documentation for writing
integrations and removes the file as it is no longer in use.
2022-06-27 17:23:26 -07:00
Lauryn Menard 7c4c01f2e6 help-docs: Fix keyboard shortcuts that use / reference Mac keys.
Fixes help center documentation that use or reference Mac keys
for keyboard shortcuts instead of non-Mac keys since these are
not updated for users with non-Mac keyboards, while the reverse
is true.
2022-06-27 14:57:10 -07:00
Lauryn Menard 57e3f7145f help-docs: Fix keyboard shortcuts with multiple keys.
Fixes existing errors in the help center documentation where a
keyboard shortcut that has multiple keys is all one inline code
tag (e.g. `Ctrl + [`) instead of being separated into individual
inline code tags for each key (e.g. `Ctrl` + `[`).
2022-06-27 14:57:10 -07:00
Anders Kaseorg dc33a0ae67 markdown: Rewrite include plugin without markdown-include.
markdown-include is GPL licensed.

Also, rewrite it as a block processor, so that it works correctly
inside indented blocks.

Signed-off-by: Anders Kaseorg <anders@zulip.com>
2022-06-26 17:36:31 -07:00
David Rosa 483c84da61 help-docs: Update Homebrew instructions for the latest release on macOS.
The command `brew cask` is no longer a `brew` command as of Homebrew
version 3.5.2.

Updates the instruction to use `brew <command> --cask` instead.

Fixes: #22277.
2022-06-23 17:58:30 -07:00
David Rosa 3474567521 help-docs: Document "Copy link to topic" mobile app feature.
Adds a "Mobile" tab with straightforward instructions for accessing
the long-press menu using two new macros.

Knowing where to access the long-press menu is intuitive, except when
the user is in a topic narrow. It's not immediately obvious that the
top bar can be long-pressed so this adds a "Tip block" using a new macro
to clarify things in this scenario.

Also, this combines the instructions for Desktop and Web into a single
tab because the numbered steps work on both platforms. So this documents
the alternate method via the browser's address bar as a "Tip block" to
avoid stacking alternative numbered steps into a single tab.
This updates the stream and message link instructions too.

Fixes: #22147.
2022-06-08 12:24:09 -07:00
David Rosa 52ef574d3e help-docs: Fix minor errors in "Link to a message or conversation".
Removes the ":" which have accidentally ended up in the "Get a link
to a specific topic" and "Get a link to a specific stream" headings.

Renames the "Via browser's address bar" tab to "Web" so that it
stays consistent with other help center articles.

Fixes part of #22147.
2022-06-08 12:20:32 -07:00
Alya Abbott 3e11066f9f docs: Update documentation of max number of thumbnails per message.
This was changed to 10 in https://github.com/zulip/zulip/pull/20789.
2022-06-08 11:24:27 -07:00
Alya Abbott 8a26a7414f help center: Clarify and expand documentation on inviting new users. 2022-06-03 17:40:06 -07:00
Lauryn Menard 1d1a68b3db help-docs: Add information about email invite language.
Adds minimal descriptions for email and general invitation links,
and documents that email invitations are translated into the
organization's notifications language.
2022-06-03 17:40:06 -07:00
Lauryn Menard 214b1a5eba help-docs: Update accessing private messages information.
Removes unnecessary mention of mac keyboard shortcut because the
documentation updates when a mac keyboard is detected.

Also, removes reference to accessing group private messages from
the right sidbar.
2022-06-01 16:38:38 -07:00
Lauryn Menard 7e9b1a13b0 help_docs: Document subscribing a user to stream via mention.
Updates the help center documentation on subscribing users to
streams to include description for doing so via mentioning a
user while composing a message.

Fixes #21796.
2022-06-01 15:15:34 -07:00
Lauryn Menard 8d8bb88bb4 help-docs: Extend notification bot documentation.
Updates the documentation for configuring the notification bot to
include information about the non-configurable messages sent for
stream settings / permissions changes as well as topic resolve
events.

Adds more detailed sections / information about the configurable
aspects of the notification bot, and information about the topics
for the various messages sent by the notification bot.

Fixes #21947.
2022-06-01 15:11:41 -07:00
Lauryn Menard 861da7ced8 help-docs: Add manage a user's stream subscriptions article.
Adds a new help center article focused on managing a single
user's stream subscriptions.

Creates a shared file for instructions to navigate to a user's
full profile via the right sidebar, which is used in three help
center articles.

Fixes #21795.
2022-06-01 15:05:55 -07:00