Commit Graph

4397 Commits

Author SHA1 Message Date
Kartik Srivastava 1291e7000b user_topic: Add user_topic event.
We now send a new user_topic event while muting and unmuting topics.
fetch_initial_state_data now returns an additional user_topics array to
the client that will maintain the user-topic relationship data.
This will support any future addition of new features to modify the
relationship between a user-topic pair.

This commit adds the relevent backend code and schema for the new
event.
2022-08-04 17:44:00 -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
Aman Agrawal 06deeb3239 bottom_whitespace: Extract to a dedicated handlebars template.
We'll be supporting changes its content in coming commits.
2022-08-03 16:14:42 -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
Aman Agrawal ca275c4c10 integrations: Convert `integration-main-text` selector to class.
This can now be used in multiple places.
2022-07-28 19:04:43 +00: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
Aman Agrawal 6a7d64dc44 footer: Fix corporate footer being displayed on self-hosted server.
The condition was wrong in #22184.
2022-07-26 14:22:43 -07:00
Aman Agrawal 2e4a525669 plans: Improve design of faq answers. 2022-07-25 16:55:13 -07:00
Alya Abbott f244336271 portico: Move /plans FAQ to help center. 2022-07-25 16:55:13 -07:00
Anders Kaseorg 2039aed821 openapi: Move endpoint URL to generator.
A standard OpenAPI document has no reason to redundantly include this
information in description fields, as standard generators already
display it.

This uniformly moves the URL above the description, which seems fine.

Signed-off-by: Anders Kaseorg <anders@zulip.com>
2022-07-22 16:41:55 -07:00
Anders Kaseorg 946a0565c6 openapi: Fuse generate_api_title with generate_api_description.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2022-07-22 16:41:55 -07:00
Aman Agrawal 768d7630af footer: Reduce links for self-hosted installations on signup pages.
On registration and login pages on self-hosted Zulip servers,
it is not helpful and confusing to show the full navigation footer
for the Zulip website. Instead, we should show a minimal footer.

Fixes #21776
2022-07-22 15:46:42 -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
Lauryn Menard eb2ee5605c api-docs: Update changelog and notes about GitLab authentication.
Updates changelog entry for feature level 1 about GitLab to include
the endpoint with the changes. Also noted that the change updated
a deprecated return value.

Added changes note to the `gitlab` boolean in the
`authentication_methods` return value for the
`/get-server-settings` endpoint.

Part of work on #22102.
2022-07-19 17:45:34 -07:00
Lauryn Menard edeacb63ff api-docs: Update changelog and notes about video call provider None.
Updates the changelog note in feature level 1 about adding None as
a video call provider to include the endpoints where this realm
setting is used.

Updates the OpenAPI doc for the realm setting `video_chat_provider`
to include information about the enum values and meanings.

Part of work on #22102.
2022-07-19 17:45:34 -07:00
Lauryn Menard ddd9cc3ec9 api_docs: Correct Zulip 3.0 feature level 1 changelog and notes.
Corrects omissions or inconsistencies between the api changelog
and the api documentation for Zulip 3.0, feature level 1,
except for the final two bullet points about GitLab authentication
and adding None as a video call provider option.

The final two bullet points will be addressed in separate commits.

Part of work on #22102.
2022-07-19 17:45:34 -07:00
Lauryn Menard c5ebb74280 api-docs: Fix errors found in audit of 3.0 changelog entries.
Initial round of fixes and clean-ups found during audit of
changelog entries for feature levels 1-27, which correspond
to the 3.0 release.

There are a few changes that are not related to those feature
levels, but fit within the context of clean-ups (spelling mistakes
or errors in api documentation formatting/structure/style).

One notable non-3.0 release fix is making all changes notes in
the OpenAPI documentation for 2.x releases use the correct
version numbering-scheme for those releases (e.g. 2.0.0).

Follow-up commits / PRs will address inconsitencies and omissions
for these feature levels found during the audit.
2022-07-19 17:45:34 -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
Anders Kaseorg f53b5274e5 register: Correct jquery-validation library name in comment.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2022-07-14 14:28:05 -07:00
Purushottam Tiwari bd451d134c help: Cross link help center docs for managing stream subscriptions. 2022-07-14 14:23:33 -07:00
Sahil Batra 093a74bd54 models: Remove "role" field from Subscription.
This commit removes "role" field from subscription
objects since we are not moving forward with stream
administrator concept and instead working on new
permssions model as per #19525.
2022-07-13 17:07:44 -07:00
Sahil Batra 83383090f9 realm: Removed WILDCARD_MENTION_POLICY_STREAM_ADMINS option.
This commit removes WILDCARD_MENTION_POLICY_STREAM_ADMINS
option of wildcard_mention_policy since we are not moving
forward with stream administrator concept and instead working
on new permssions model as per #19525.

We also add a migration to change wildcard_mention_policy of
existing realms to WILDCARD_MENTION_POLICY_ADMINS. This change
is fine since we were already treating both the setting values
as same as stream admin concept was not implemented completely.
2022-07-13 17:07:44 -07:00
Alya Abbott d15e9f7721 images: Move /hello images into dedicated directory. 2022-07-13 15:14:19 -07:00
Alya Abbott 07851077d4 images: Move /features images into dedicated features directory. 2022-07-13 15:14:19 -07:00
Alya Abbott 5eccf9743c images: Move /why-zulip images to static/images/landing-page/why-zulip/. 2022-07-13 15:14:19 -07:00
Alya Abbott 7e3388dd9e images: Move /team images into landing-page directory. 2022-07-13 15:14:19 -07:00
Alya Abbott 454c6db177 images: Move /history images into landing-page directory. 2022-07-13 15:14:19 -07:00
Alya Abbott 2f4b73350c images: Move live /features images into landing-page directory. 2022-07-13 15:14:19 -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