Commit Graph

1391 Commits

Author SHA1 Message Date
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 1b55ff79c9 help_docs: Remove last instance of 'Zulips' in help center docs. 2022-03-28 15:13:08 -07:00
Lauryn Menard 012e2d29a2 help_docs: Clarify header and text for unmuting topics. 2022-03-28 10:33:02 -07:00
Lauryn Menard 8d242f3467 help_docs: Update edit history documentation for messages.
`disable-message-edit-history`: Remove text about EDITED label
and link to `view-a-messages-edit-history` instead.

`edit-or-delete-a-message`: Reformat 'EDITED' and '(deleted)'
to be bold instead of using backticks. Make link to view
edit history clearer.

Note that the text used in the `OpenGraphTest` in
`test_middleware.py` had to be updated for the changes to
`disable-message-edit-history`.
2022-03-25 17:03:53 -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 f9f111f950 message_edit: Only move muted topic records when moving whole topics.
Our original implementation of moving muted topic records when a topic
is moved took a shortcut of treating all change_later usage as
something with intent to move the whole topic.

This works OK when moving the whole topic via this interface, but not
when moving a last off-topic message in the topic.

Address this by changing the rule to match the existing
moved_all_visible_messages variable.
2022-03-24 17:48:52 -07:00
Lauryn Menard bd936a837a help_docs: Update image viewer documentation for changes.
Updates the list of actions and buttons referenced in the help
center documentation for viewing images with lightbox.

Also, makes some minor corrections to the keyboard shortcut note.

Fixes #21527.
2022-03-24 11:48:19 -07:00
Lauryn Menard 182c00248d help_docs: Update various docs related to permissions.
Adds tab for web-public streams in documentation for setting
who can create new streams, as well as some text about why
this is limited to certain roles.

Removes list of actions that can be restricted to full members
due to maintainability concerns for that type of list in the
documentation and replaces it with a short descriptive text
explaining that many settings in Zulip support this restriction.
2022-03-24 11:37:35 -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 b7747e51dd help_docs: Update various help docs for small changes.
- `user-groups`: Add warning for removing yourself.
- `restrict-wildcard-mentions`: Updated setting name to match UI.
- `format-your-message-with-markdown`: In-app help is now an icon.
- `web-public-streams`: Add link to Zulip's Rules of Use.
2022-03-24 10:59:03 -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 c121bec188 help center: Explain details of content moves. 2022-03-22 20:18:25 -07:00
Alya Abbott 6087f0daf1 help center: Improve organization of left sidebar. 2022-03-22 20:18:25 -07:00
Lauryn Menard babe5ed44a help: Update notifications docs for changes.
Adds documentation for unread badge count to help article on
desktop notifications.

Generally, cleans up instructions and article structure for
the help article on pms, mentions and alerts.

Co-authored-by: Alya Abbott <alya@zulip.com>
2022-03-22 15:52:23 -07:00
Lauryn Menard b67288db67 help_docs: Extend options for getting links to Zulip content.
Extends the linking to Zulip documentation to cover:

- Getting URLs to messages via the message timestamp.
- Getting links to topics via the three-dots menu.
- Getting links to streams via right-click context menu.

Creates a new tabbed section for using the browser
address bar to copy URLs.
2022-03-22 12:38:09 -07:00
Lauryn Menard 453cb409cf help_docs: Update button description for archive a stream doc.
In the current UI, the button for archiving a stream is an icon
while previously it was text ('Archive'). Updates documentation
to refer to it as so.
2022-03-22 12:08:14 -07:00
Lauryn Menard ba7695e5de help_docs: Revise `mute-a-topic` help doc.
Generally, revises a number of out of date information in this
help article.
2022-03-22 12:06:24 -07:00
Lauryn Menard b70b925716 help_docs: Update `reading-strategies` for changed icon.
Removes reference to icon (previously a magnifying glass) in
text for filtering streams and replaces it with direction
for clicking on the STREAMS header in the left sidebar.
2022-03-21 16:14:07 -07:00
Lauryn Menard ca395227b2 help_docs: Update `mute-a-stream` for menu option text.
Corrects text in instructions for the menu option when
muting and unmuting streams.
2022-03-21 16:12:58 -07:00
Lauryn Menard ddab1d9b07 help_docs: Update `mobile-notifications` to use 'toggle'.
We'd like to use 'toggle' for consistency when referring to
check boxes in the help center documentation.
2022-03-21 16:12:20 -07:00
Lauryn Menard 210268f264 help_docs: Update `manage-inactive-streams` for settings header.
Correct out of date section header in display settings.
2022-03-21 16:12:20 -07:00
Lauryn Menard 1b1c479333 help_docs: Update `invite-new-users` for dropdown option.
Corrects an out of date dropdown option in organizational
settings for enabling email sign-up.
2022-03-21 16:12:20 -07:00
Lauryn Menard 517b2a5e10 help_docs: Update `email-notifications` for setting header.
Updates out of date reference to a Notifications setting header,
and also updates instructions for a check box to use 'toggle'.
2022-03-21 16:12:19 -07:00
Lauryn Menard 4f735aeb0e help_docs: Update `configure-default-view` to use 'toggle'.
We'd like to use 'toggle' for consistency when referring to
check boxes in help center documentation instructions.
2022-03-21 16:11:42 -07:00
Lauryn Menard 1b3e003b53 help_docs: Update `stream-sending-policy` help doc.
Uses new `select-stream-view-general.md` for instructions.

Also, clarifies location of button/icon as well as the
header for the privacy setting in the update modal.

Finally, updates save instruction to use `save-changes.md`.
2022-03-21 12:26:03 -07:00
Lauryn Menard 7c60ff384d help_docs: Update `change-the-privacy-of-a-stream` help doc.
Uses new `select-stream-view-general.md` for instructions.

Also, updates description to include web-public streams with link
to documentation about them, and clarifies location of button/icon
as well as the header for the privacy setting in the update modal.

Finally, updates save instruction to use `save-changes.md` and
renumbers instructions list to only use '1'.
2022-03-21 12:26:03 -07:00
Lauryn Menard 27d669ab62 help_docs: Update `stream-notifications` help doc.
Uses new `select-stream-view-personal` for instructions.

Also, moves one sentence notes to be under header vs tab block,
and updates numbers used in instruction list to all be '1',
and clarifies text about notifications table in general personal
setting.
2022-03-21 12:26:03 -07:00
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