Commit Graph

431 Commits

Author SHA1 Message Date
Kartik Srivastava 342fd72a10 api: Document /users/me/alert_words API endpoint. 2022-08-16 13:37:52 -07:00
Lauryn Menard 76859d4dc3 help-docs: Note automated PMs sent when subscribing users to streams.
Adds a shared note to both help center articles with sections on
subscribing users to streams, documenting that an automated private
message from the notification bot is sent to a user when subscribed
to a stream by another user.

Links to the article on the notification bot, and clarifies text in
that article regarding automated private messages.
2022-08-15 17:31:00 -07:00
Dinesh 48d2783559 read_receipts: Add support for displaying read receipts.
Adds an API endpoint for accessing read receipts for other users, as
well as a modal UI for displaying that information.

Enables the previously merged privacy settings UI for managing whether
a user makes read receipts data available to other users.

Documentation is pending, and we'll likely want to link to the
documentation with help_settings_link once it is complete.

Fixes #3618.

Co-authored-by: Tim Abbott <tabbott@zulip.com>
2022-08-12 13:16:35 -07:00
Kartik Srivastava 887233a8eb api: Document /default_streams API endpoint. 2022-08-09 14:55:27 -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
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 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
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
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
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
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
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
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 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
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 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
Alya Abbott 8a26a7414f help center: Clarify and expand documentation on inviting new users. 2022-06-03 17:40:06 -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
Lauryn Menard 57c8b56902 help-docs: Add mastering the compose box article.
Adds an article for more advanced techniques and workflows for
the compose box and documents the new 'Go to conversation' button.

Also adds cross-links between compose box articles.

Fixes #21959.

Co-authored-by: Alya Abbott <alya@zulip.com>
2022-06-01 14:57:50 -07:00
Sahil Batra ce34b585a5 streams: Add endpoint "GET /streams/{stream_id}" to get stream by id.
Fixes #22082.
2022-05-23 15:14:04 -07:00
Ganesh Pawar 59e810790f user_groups: Convert inline form to modal.
Fixes part of #21298.
2022-05-04 17:46:30 -07:00
Lauryn Menard 44c9b788f9 settings: Add realm setting for Zulip communities directory.
Adds `want_advertise_in_communities_directory` to the realm model
to track organizations that give permission to be listed on such
a site / directory on zulip.com.

Adds a checkbox to the organization profile admin for
organizations to give permission to be advertised in the
Zulip communities directory.

Adds a help center article about the Zulip communities directory
and uses a shared intro documentation file to create sections in
the articles on creating an organization profile and moderating
open organizations.

Co-authored-by: Alya Abbott <alya@zulip.com>
2022-05-04 11:13:28 -07:00
Tim Abbott 627144b0c7 settings: Simplify setting organization default language.
The changes in the last few commits changed the semantics of the
organization default language to no longer be the primary source of
information for a user's language when creating a new account.

Here, we change the settings UI and /help/ documentation to reflect
this.
2022-04-28 15:03:26 -07:00
Aman Agrawal 00fffd1681 help: Rename `web-public-streams` page to `public-access-option`. 2022-04-28 12:09:08 -07:00
Alya Abbott a80228092b help: Introduce "public access option" term for web-public streams. 2022-04-28 12:09:08 -07:00
Lauryn Menard 1292338537 frontend: Add `org_type` to realm settings updates and events.
Adds a drop-down menu for updating the organization type in the
`organization_profile_admin` page. Implements front end for
this setting to work / update like other organization profile,
notification and permissions settings.

One special note about this dropdown is that the listed options
should change once an organization has successfully set a type
other than 'unspecified' in the database. To accomplish this
the initial settings overlay build checks the realm_org_type
value in the page_params to select the correct options list,
and when the dropdown value is reset, either for update events
or for discarding changes, the page_params value is again used
to check for whether the 'unspecified' value should be present
as an option in the dropdown menu.

Adds basic node test for the `server_events_dispatch`.
Also adds a new help center documentation article for this
organization setting that is linked to in the UI.

Fixes #21692.
2022-04-26 16:29:12 -07:00
Sahil Batra 37793434f7 user_groups: Add API endpoint to get subgroups of a user group. 2022-04-25 10:24:03 -07:00
Sahil Batra 1b3c972d9b user_groups: Add API endpoint to get members of a user group.
This commit adds 'GET /user_groups/{user_group_id}/members'
endpoint to get members of a user group. "direct_member_only"
parameter can be passed as True to the endpoint to get only
direct members of the user group and not the members of
subgroup.
2022-04-25 10:24:03 -07:00
Sahil Batra 374d2a66df user_groups: Add endpoint to check whether a user is member of a group.
This commit adds 'GET /user_groups/{id}/members/{id}' endpoint to check
whether a user is member of a group.

This commit also adds for_read parameter to access_user_group_by_id,
which if passed as True will provide access to read user group even
if it a system group or if non-admin acting user is not part of the
group.
2022-04-25 10:24:03 -07:00
Sahil Batra 6f0a7656ac user_groups: Add API endpoint for updating subgroups of a user group. 2022-04-25 10:24:03 -07:00
Alya Abbott b6d548d9f8 docs: Link to chat.zulip.org from /help/web-public streams.
This provides an easy way to preview the feature.
2022-04-13 16:04:07 -07:00
Alya Abbott 0df4d8eb17 docs: Add "View Zulip version" help center page.
Fixes #21756.
2022-04-12 17:22:03 -07:00
Alya Abbott f04fb51ecc help: Rewrite pages on inviting users and related permissions.
Fixes #21520.

Co-authored-by: Lauryn Menard <lauryn@zulip.com>
2022-03-28 17:00:10 -07:00
Lauryn Menard 9ce924a3a6 help_docs: Document auto-notifications for general stream updates.
Adds a note about auto-notification messages that are sent when
these general settings are changed for a stream: name, description,
access and posting permissions, and message retention.
2022-03-25 11:00:28 -07:00
Tim Abbott f3488c540b help: Tweak index to group edit restrictions. 2022-03-24 11:28:01 -07:00
Lauryn Menard e16ede4622 help_docs: Update documentation for editing messages.
Updates various articles related to editing messages (settings,
edit history, etc) for changes in UI, adding undocumented
settings, and cleaning/linking documentation text and headers.
2022-03-24 11:26:45 -07:00
Lauryn Menard 7dd2ed85db help_docs: Update documentation about moving content.
Moves descriptions of notification and subsetting options
when moving content out of the instructions tab blocks
and into descriptive text.

Adds documentation for editing a topic via the message
recipient bar.

Also cleans up a few changes to UI interactions.

Co-authored-by: Alya Abbott <alya@zulip.com>
2022-03-23 23:46:22 -07:00
Alya Abbott 6087f0daf1 help center: Improve organization of left sidebar. 2022-03-22 20:18:25 -07:00