Commit Graph

1411 Commits

Author SHA1 Message Date
Lauryn Menard 78af84f6a1 help_docs: Update `message-retention-policy` help doc.
Uses new `select-stream-view-general.md` for instructions.

Also, updates the text for locating the button/icon.
2022-03-21 12:26:03 -07:00
Lauryn Menard 3989bfe1ff help_docs: Update `rename-a-stream` help doc.
Uses new `select-stream-view-general.md` for instructions.

Also, updates text for locating the button/icon and uses
the `save-changes.md` to correct the final instruction/step.
2022-03-21 12:26:03 -07:00
Lauryn Menard b925c2f3de help_docs: Update `message-a-stream-by-email` help doc.
Uses new `select-stream-view-general.md` for instructions.
2022-03-21 12:26:03 -07:00
Lauryn Menard 7d2abdf56a help_doc: Update `change-the-color-of-a-stream` help doc.
Uses new `select-stream-view-personal.md` for instructions.

Also, clarifies location of setting (header).
2022-03-21 12:26:03 -07:00
Lauryn Menard f0409517b3 help_docs: Update `pin-a-stream` help doc.
Uses new `select-stream-view-personal.md` for instructions.

Also, clarifies where the checkbox is located (header) and
updates instruction to use 'toggle' vs 'click' for checkbox.
2022-03-21 12:26:03 -07:00
Lauryn Menard 2e69b66fec help_docs: Update `change-the-stream-description` help doc.
Uses new `select-stream-view-general.md` in instructions.

Also, moves admin warning to top of the article and updates
description text for clarity (instead of 'apps', specify
which apps have the description in the stream view).
2022-03-21 12:26:03 -07:00
Lauryn Menard f46b231c0c help_docs: Update `add-or-remove-users-from-a-stream` help doc.
Uses new `select-stream-view-subscribers.md` in instructions.

Also, adds a tip to bulk add users to a stream.
2022-03-21 12:26:03 -07:00
Lauryn Menard 9f843b924a help_docs: Add markdown helpers for stream view tabs.
Adds three markdown documents in to be used for help center
articles that have instructions that refer to actions in
the 3 new tabs in the 'Subscribed/All streams' view:

- General: stream name, description and permissions changes.
- Personal: personal stream settings, such as color, changes.
- Subscribers: adding or removing users from streams.
2022-03-21 12:26:03 -07:00
Lauryn Menard d3dca4f7de help_docs: Update instructions for change stream color.
Updates instructions for changing a stream's color so that
there are no missing or incorrect steps.
2022-03-18 14:28:20 -07:00
Lauryn Menard 1168258285 help_docs: Update how to access drafts in help center doc.
Small update of how to access drafts due to the removal of the
button at the bottom of the page. Drafts are now accessed through
the left sidebar.
2022-03-17 17:25:28 -07:00
Alya Abbott 6c6aa0cb37 help center: Remove list of roles from create-a-stream.md.
Also adds links to related articles.
2022-03-15 12:52:09 -07:00
Alya Abbott 19c84a1837 help center: Remove unnecessary lists of possible roles for permissions.
Also adds some links to related articles.
2022-03-15 12:52:09 -07:00
Tim Abbott 69ac302aaf help: Remove Zulip 3.0 changes documentation.
This change is now pretty old, and we don't have a practice of
detailing UI changes in the Help Center for other transitions.
2022-03-15 12:35:48 -07:00
Lauryn Menard 6cc818b672 help_docs: Document user management via user profile modal.
Adds documentation for admins to manage users via the user profile
modal for these actions:
- Deactivating a user
- Changing a user's role
- Changing a user's name

Creates two new tab sections because we still want to document
the ability to do these actions through the users section in
the organizational settings modal.

Also cleans up some text in the help center article for changing
a user's role.

Fixes #21318.
Fixes #21415.
2022-03-15 12:35:03 -07:00
Lauryn Menard 4be79dba87 help_docs: Remove 'Restricting' from list of actions.
Cleans up the list of actions that can be restricted via settings
for new members. Previously, there were a number of entries in the
list that began with 'Restricting' and not the action that was
being set.
2022-03-15 12:30:16 -07:00
Lauryn Menard d327ecaa65 help_docs: Include permissions setting info in user groups article.
Adds content on user group permissions / management to the general
help center article for user groups (`/help/user-groups`) and
removes the then redundant `/help/restrict-user-group-management`
article.

Redirects links in help center and api documentation from deleted
article to the new configure user group settings section of
`/help/user-groups`.

Fixes #21383.
2022-03-15 12:30:16 -07:00
Alya Abbott a8381395ce help center: Improve organization of Status and availabilty doc. 2022-03-15 12:26:55 -07:00
Lauryn Menard 523b75986a help_docs: Add documentation for status emoji.
Extends existing documentation about user status to cover
both potential parts of a status: emojis and messages.

Also, adds a link in the `/help/web-public-streams` article
where user status is referenced.

Fixes #21369.
2022-03-15 12:26:55 -07:00
Lauryn Menard 7e00cae8f7 help_docs: Add typing notifications privacy setting to doc.
Adds a section to the typing notifications documentation about
how to disable them in as a personal privacy setting.

Extended by tabbott to explain the setting in more detail.

Fixes #21381.
2022-03-15 12:23:55 -07:00
Lauryn Menard dda02d17e7 help_docs: Update create stream doc for choosing subscribers.
As the different settings are described in the help center doc
for creating a new stream, we need to update the final setting
name from 'People to add' to the new 'Choose subscribers' that
is in the UI.

Also, updates that setting description to include adding users
via user groups or the new add all users option.
2022-03-15 12:03:25 -07:00
Lauryn Menard 75f7426e21 help_docs: Document unsubscribe user from stream via profile.
Extends the documentation on unsubscribing users from streams to
include an alternate method via the user's full profile, which
is useful for cases where admins may need to unsubscribe a single
user from multiple streams.

Fixes #21379.
2022-03-14 17:23:54 -07:00
Aman Agrawal 82837304ec api: Send full message in GET /messages/{message_id} response.
Previously, this URL just returned the `raw_content` field. It seems
cleanest to just make it a single-message variant of GET /messages,
deprecating the only format.
2022-03-11 10:25:22 -08:00
Tim Abbott a8b0762699 help: Document web public streams are not indexed by Google. 2022-03-10 12:42:03 -08:00
Alya Abbott 757cdeefb1 help center: Change web-public streams status to beta.
Also adds references to web-public streams where appropriate.
2022-03-10 12:31:01 -08:00
Steve Howell 87aa318e3a edit streams: Change headings and move filter box.
The new layout is:

    Add Subscribers

        [input pill] [Add]

    Subscribers             [filter]
    <list of subscribers>
2022-03-04 12:01:09 -08:00
Steve Howell 5f95a33fa3 create streams: Remove "Stream permissions" header.
The header was more confusing than helpful, and we
want the create-stream UI to be less cluttered.

We don't really need the help-center text here, since
we already have ? icons next to the relevant headings
for the sub-sections.

We kill off some CSS, but we won't kill off stream-title
until the big upcoming changes for stream pills.
2022-03-04 12:01:09 -08:00
Aman Agrawal 7e365f7ee3 icons: Replace fa-globe icon with a custom globe icon. 2022-03-01 11:36:38 -08:00
Anders Kaseorg 21cd1c10b3 docs: Add missing space in “time zone”.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2022-02-24 14:05:12 -08:00
rht bf5080b9ca
help: Use topic actions for moving topics to other streams.
This appears to have been a typo.

The original discussion can be found in
https://chat.zulip.org/#narrow/stream/137-feedback/topic/change.20topic.20stream.20doc
2022-02-23 10:52:22 -08:00
Tim Abbott 8f698227f2 help: Fix alternatively typo.
This should have been in the previous commit.
2022-02-22 10:19:12 -08:00
Lauryn Menard ae8ab1d831 help_center: Add Markdown auto-link details link doc page.
Adds a section about the Markdown feature to auto-link to
existing streams and topics in a Zulip message.

Also, does a little reformatting of existing text/tabs and
adds a related links section to the page.

Fixes #21085.

Co-authored-by: Alya Abbott <alya@zulip.com>
2022-02-22 10:14:19 -08:00
Alya Abbott e93320c40d portico: Add a self-hosting page.
Co-authored-by: Aman Agrawal <amanagr@zulip.com>
2022-02-17 12:43:13 -08:00
Tim Abbott 8e68e98e33 help: Fix incorrect explanation of generic bots.
The previous explanation of generic bots was inaccurate.

This page needs a lot more cleanup, but this at least fixes the
clearest inaccuracies.

Fixes #19978.
2022-02-10 17:31:35 -08:00
jai2201 67625d6c7b message_feed: Remove the parenthesis around edited notices.
They were found to not particularly improve the UI.

Fixes #21043.
2022-02-10 13:52:24 -08:00
Aman Agrawal 7614f2203a pricing: Replace "Zulip Standard" with "Zulip Cloud Standard".
Case sensitive replace.
2022-02-09 11:00:24 -08:00
Alya Abbott 59d84a362e help center: Make it easier to learn that any auth method will work. 2022-02-08 18:04:32 -08:00
Anders Kaseorg e1f42c1ac5 docs: Add missing space to compound verbs “back up”, “log in”, etc.
Noun: backup, login, logout, lookup, setup.

Verb: back up, log in, log out, look up, set up.

Signed-off-by: Anders Kaseorg <anders@zulip.com>
2022-02-07 19:20:54 -08:00
Anders Kaseorg b0ce4f1bce docs: Fix many spelling mistakes.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2022-02-07 18:51:06 -08:00
Tim Abbott 1a46df40c3 resolve topic: Limit unread flag on automated notifications.
Previously, users found it annoying that the automated "Resolve topic"
notifications triggered an unread for everyone in the stream; this
discouraged some users from using the feature on older threads for
fear of being annoying. We change this to a better default, of only
users who participated in the topic (via either messages or reactions)
being eligible for the new message being unread.

We will likely want to create global and stream-level notifications
settings to control this behavior as a follow-up -- some users, like
me, might prefer the simpler "Always unread" behavior in some streams.

Note that the automated notifications that a topic was resolved will
still result in the topic being moved to the top of the left sidebar.
This would be somewhat difficult to change, since the left sidebar
algorithm just looks at the highest message ID in the topic.

Fixes #19709.

Tests added by Aman Agrawal (amanagr@zulip.com).
2022-02-01 11:35:50 -08:00
Anders Kaseorg 90e202cd38 docs: Consistently hyphenate “web-public”.
In English, compound adjectives should essentially always be
hyphenated.  This makes them easier to parse, especially for users who
might not recognize that the words “web public” go together as a
phrase.

Signed-off-by: Anders Kaseorg <anders@zulip.com>
2022-01-28 17:45:45 -08:00
Alex Vandiver 8f6768f721 help: Document that linkifiers use re2.
Fixes #13720.
2021-12-31 11:14:02 -08:00
Eeshan Garg 5aaeb1a432 use_cases: Rename /for/companies to /for/business. 2021-12-09 17:16:52 -08:00
Eeshan Garg 3bab91079f external links: Migrate the rest of /developer-community links.
We recently changed /developer-community to /development-community.
Now that this change is in production, we can also migrate the
external links in our ReadTheDocs documentation.
2021-12-09 12:14:26 -08:00
Jordan Rob Byamugisha 2b7cca96d2 help: Add documentation on resizing the compose box.
Co-authored-by: Alya Abbott <alya@zulip.com>

Fixes #20017.
2021-12-02 16:03:38 -08:00
Alya Abbott 8070b84785 help center: Remove outdated intro from index page. 2021-12-01 17:05:59 -08:00
Eeshan Garg f976bf723e links: Rename developer-community -> development-community. 2021-12-01 13:41:46 -08:00
Tim Abbott 35f9ed6ebe help: Remind users changing subdomains to update SSL certs. 2021-11-28 11:59:44 -08:00
Sahil Batra dcd6da0351 misc: Replace "night" and "day" with "dark" and "light".
This commit replaces "night" and "day" used in the context
of themes with "dark" and "light".
2021-11-26 22:03:29 -08:00
Lauryn Menard 136234a7f8 documentation: Fix ordered list text wrapping in some /help articles.
Minor change to some of the `/help` md files to correct the text
wrapping of ordered lists in the content of the article.
2021-11-23 10:15:14 -08:00
Alya Abbott 3d31bd79be
settings: Rename "public export" to "export of public data". 2021-11-19 17:36:29 -08:00
Alya Abbott 9b63f6eb5d
user docs: Add documentation page for web public streams.
As noted in the /help/ docs, this feature isn't fully implemented yet.
However, it's useful to merge this documentation, which explains how the
feature will work, to help make sure we've thought through all the details
around how this feature should work and be presented to users as we 
plan to final changes to implement it.

This commit does not edit other help pages to reflect the existence of
web public streams.

Co-authored-by: Tim Abbott <tabbott@zulip.com>
2021-11-19 16:10:59 -08:00
Sahil Batra f42b8f2fe1 misc: Replace "night theme" with "dark theme". 2021-11-19 11:49:59 -08:00
Sahil Batra 14b91043d2 misc: Replace "Day mode" with "Light theme". 2021-11-19 11:49:59 -08:00
Sahil Batra b72035abfe misc: Replace "Light mode" with "Light theme". 2021-11-19 11:49:59 -08:00
Sahil Batra 5024ba98cd misc: Rename "dark mode" to "dark theme".
Fixes part of #20228.
2021-11-18 16:57:11 -08:00
Sahil Batra cf4f31291c misc: Rename "Night mode" to "Dark theme".
This commit renames "Night mode" to "Dark theme" in the
settings dropdown, help pages and api documentation.

Fixes part of #20228.
2021-11-18 16:55:35 -08:00
Sahil Batra 08404f2824 help: Rename night-mode.md to dark-theme.md.
Fixes part of #20228.
2021-11-18 16:55:35 -08:00
Sahil Batra b61d48d94b settings: Rename "Automatic" option in color scheme dropdown.
This commit renames "Automatic" option in color scheme setting
dropdown to "Sync with compute". We do not change any variables
used in code just the text in the dropdown visible to user.

Fixes part of #20228.
2021-11-18 16:55:35 -08:00
Ankur c578f186b6
docs: Change chat.zulip.org links to zulip.com/developer-community.
This helps increase the probability that folks read the guidelines for how the
chat.zulip.org community works and what streams to use before arriving there.

Fixes #19827.
2021-11-17 22:25:55 -08:00
Tim Abbott 9da1934c8e deletion: Preserve deleted objects for 30 days rather than 7.
We had an incident where someone didn't notice for a week that they'd
accidentally enabled a 30-day message retention policy, and thus we
were unable to restore the deleted the content.

After some review of what other products do (E.g. Dropbox preserves
things in a restoreable state for 30 days) we're adjusting this
setting's default value to be substantially longer, to give more time
for users to notice their mistake and correct it before data is
irrevocably deleted.
2021-11-17 18:03:31 -08:00
Mateusz Mandera 7df5f8e6f5 docs: Update the /help/ instructions for setting up OneLogin SAML.
OneLogin has removed the old app. The new app is nearly identical, just
with some additional configurable settings, that we don't want to touch
anyway as the default are fine - and changing the default Parameters
that are set up, so we also update the screenshot to match how it looks
with the new app.
2021-11-16 14:58:17 -08:00
Manan Rathi aac8ceadf9 user docs: Add documentation for /todo.
Fixes #20141.

Co-authored-by: Alya Abbott <alya@zulip.com>
2021-11-09 10:16:47 -08:00
Eeshan Garg 0cbf22fe9d terminology: Use the term "global time" to refer to time widget. 2021-11-07 09:48:20 -08:00
Mateusz Mandera 1c0e92d343 scim: Add a /help/ page for Okta SCIM. 2021-11-02 14:33:22 -07:00
Priyansh Garg 0c2e4eec20 data_import: Import Rocket.Chat threads as separate topics. 2021-11-01 17:13:35 -07:00
Priyansh Garg 0db9b7287b data_import: Import Rocket.Chat messages from direct discussions.
This commit adds functionality to import messages from the
Discussions having direct channels as their parent. As we don't
have topics in the PMs, the messages are imported in interleaved
form in the imported direct channels/PMs.

This was completely unsupported earlier and would have resulted in
an error.
2021-11-01 17:09:11 -07:00
Priyansh Garg 5f1e246230 data_import: Import wildcard mention data from Rocket.Chat. 2021-11-01 17:06:15 -07:00
Priyansh Garg 7d3ecc8a0e data_import: Update Rocket.Chat caveats for discussions and uploads.
Uploaded files import implemented in: aed4e48
2021-11-01 17:06:14 -07:00
Lauryn Menard 73710e1cf0 user_settings: Add option to disable escape key navigation to default view.
Add `escape_navigates_to_default_view` as a bool setting in
UserBaseSettings model and implement it as a checkbox that toggles
the hotkey implementation of escape to the default view in the
advanced user display settings.

With /help/ documentation edits from Alya Abbott.

Fixes #20043.
2021-10-29 18:15:30 -07:00
Suyash Vardhan Mathur d2c5067839 openapi: Document remove-attachment endpoint. 2021-10-29 15:01:50 -07:00
Tim Abbott 5dd8fbdf19 help: Clarify descriptions of public/private streams.
Most important is adding the icons to help users understand the
recipients of the stream, but we also use clearer language that better
matches that present in the user interface.
2021-10-26 15:12:38 -07:00
Alya Abbott 7494115b2a user docs: Update documentation following up on #20039. 2021-10-22 13:45:45 -07:00
Lauryn Menard 0d0b4eb9d4 documentation_api: Deduplicate ignored_parameters_unsupported.
Created a schema for the ignored_parameters_unsupported that is
returned by the /settings and /realm/user_settings_defaults endpoints
and removed the duplicated text in the api documentation.

Also cleaned up some small errors in the /realm/user_settings_default
definition and sidebar link /api/update-realm-user-settings-defaults.

Fixes #19674
2021-10-21 10:32:31 -07:00
Mateusz Mandera 068dd6bdae docs: Tweak Keycloak SAML instructions.
Keycloak docs say:

https://www.keycloak.org/getting-started/getting-started-docker
```
By default there is a single realm in Keycloak called master. This is
dedicated to manage Keycloak and should not be used for your own
applications.
```

Thus we should change what we assume the Keycloak realm to be to avoid
assuming as a default a practice
that Keycloak disourages.
2021-10-19 17:00:10 -07:00
rht bb8504d925 lint: Fix typos found by codespell. 2021-10-19 16:51:13 -07:00
Anders Kaseorg 2d45ae58f4 gdpr-compliance: Use real company names.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-10-15 17:31:42 -07:00
Alya Abbott ed3d786c61 user docs: Add a "Setting up Zulip for your class" guide. 2021-10-15 15:30:36 -07:00
Alya Abbott a3af59b52d user docs: Add a helpful tip to the guide for new orgs. 2021-10-15 15:30:36 -07:00
Alya Abbott 84f4deff90 user docs: Add instructions for setting up user groups.
Oops, I have a couple of changes here:
1) Adding a "Create user groups" section to the new org guide.
2) Moving a tip out of how-to-invite-users-to-join.md, so that I
can reuse that section in the Zulip for clases guide I'm working
on without having the tip in it.
2021-10-15 15:30:36 -07:00
Alya Abbott 8045355eee user docs: Document public vs. private stream creation permissions. 2021-10-06 17:33:19 -07:00
sahil839 909a3cde76 realm: Replace allow_message_deleting with delete_own_message_policy.
This commit replaces 'allow_message_deleting' boolean setting
with an integer setting 'delete_own_message_policy'. We have a
separate dropdown now for deciding which user-roles can delete
messages sent by themselves and the time-limit setting droddown
is different.

This new setting has two options - everyone and admins only. Other
options including moderators will be added further.

We also remove the "Never" option from the original time-limit
dropdown, as admins are always allowed to delete message. This
never option resembled the case of only admins being allowed to
delete but this state is now resembled by setting the dropdown
to "admins only" and we also disable the time-limit dropdown in
this case as admins are allowed to delete irrespective of limit.

Note, this setting is only for deleting messages sent by the
deleting user themselves, and only admins are allowed to delete
messages sent by others as before.
2021-09-30 14:59:31 -07:00
Tim Abbott 4368b9d186 ui: Change 'Edit topic' label to 'Move message'. 2021-09-30 13:35:31 -07:00
Alya Abbott 0f9d0f5a86 help_docs: Reorganize notification docs under three umbrella pages.
With minor URL migration work by Eeshan Garg.
2021-09-22 16:46:46 -07:00
Alya Abbott b773048031 user docs: Add documentation for configuring new user defaults.
Also remove a redundant link on customize-settings-for-new-users page.
2021-09-21 16:43:35 -07:00
Tim Abbott 32c2ba8a7b help: Add basic documentation for custom emoji.
We previously didn't actually explain what custom emoji are, just how
to create them (etc.).
2021-09-17 18:08:59 -07:00
Tim Abbott a5dcdebfa7 help: Add basic documentation for stream descriptions. 2021-09-17 18:08:59 -07:00
Alya Abbott 2f3ebb5b16 help: Merge "Change who can add custom emoji" into "Custom emoji" page. 2021-09-17 18:08:59 -07:00
Alya Abbott 302aba035a help: Rename add-custom-emoji -> custom-emoji. 2021-09-17 18:08:59 -07:00
Alya Abbott 1ee482ba9a user docs: Reorder left sidebar links. 2021-09-17 18:08:59 -07:00
Alya Abbott 51cecd25c8 user docs: Rewrite "Setting up your organization" guide.
This change depends on #19783, which hasn't been merged yet, to avoid
some broken rendering.
2021-09-17 18:08:59 -07:00
Tim Abbott bf2071852b help: Fix heading for browsing muted topics.
The previous heading was one size too small, and thus was easily
missed when visually skimming for the information.

Additionally, give it a more natural label.
2021-09-16 15:40:37 -07:00
Alya Abbott 45b7ffb06b user docs: Add a guide on Using Zulip for a class. 2021-09-16 13:36:44 -07:00
Alya Abbott 310b8736af user docs: Add a bunch of "getting started" content. 2021-09-16 11:41:43 -07:00
Mateusz Mandera 05fe62c96c docs: Adjust phrasing of "From your desktop, click on the gear...".
We actually mean the main Zulip UI here, so "from your desktop" sounds
potentially misleading; reodering the phrasing makes the meaning
unambiguous.
2021-09-16 10:47:56 -07:00
Alya Abbott 9df8fbde48 user docs: Document message notification email custom batching.
Also adjust the label slightly for better readability.

Co-authored-by: Tim Abbott <tabbott@zulip.com>
2021-09-15 17:39:51 -07:00
Tim Abbott 39c897a2b0 help: Rename about-streams-and-topics to streams-and-topics.
This better matches the title of the page and more generally our
conventions around naming /help/ articles.  We include a redirect
because this is referenced from Welcome Bot messages, and we
definitely don't want those links to break.
2021-09-15 09:48:36 -07:00
Mateusz Mandera d1d0e484ea docs: Fix Entity ID values in instructions in saml-authentication.md.
The Entity ID for zulipchat.com is `https://zulipchat.com` currently.
Some of these errors happened in the big zulipchat->zulip rename commit
71078adc50, then it was repeated in
10d356d2de and there was also some
confusion when coming up with the instructions for Keycloack in
10d356d2de. Client-ID value in Keycloack
is the expected Issuer for SAMLRequests and thus needs to match our
Entity ID.
2021-09-14 10:23:32 -07:00
Sahil Batra 2bbbcf0f15 help: Update notification related help pages as per new UI.
This commit updates the headings used in notification
related pages as per the updated headings after 14e383ad7a,
60112405ba, and 6651842dc.
2021-09-13 10:07:36 -07:00
Tim Abbott ec380bdb89 help: Fix formatting issues in SAML authentication docs.
Apparently, I failed to squash this before merging the previous commit.
2021-09-10 13:12:00 -07:00
Philipp Seßner a8797b4d9f help: Document how to configure Keycloak as the SAML IdP. 2021-09-10 13:04:04 -07:00