Commit Graph

148 Commits

Author SHA1 Message Date
sahil839 c3d7703369 help: Update the documentation to document edit_topic_policy. 2021-06-16 15:04:42 -07:00
Abhijeet Prasad Bodas 67cd385cec mute user: Add user documentation page.
Also link to it from the API documentation page,
other help pages, and the confirmation dialog for
muting a user.

With substantial edits by tabbott and alya.
2021-05-10 17:10:40 -07:00
Alya Abbott 279f7b1c8d user docs: Create separate "Code blocks" user documentation page.
* Move the extended documentation of code blocks to a separate page.
* Merge "code playgrounds" documentation to be a section of that page.
* Document copy widget on code blocks.
* This commit changes how we refer to "```python" type syntax for code
  blocks. Instead of being called a syntax highlighting label, this is
  now referred to as a "language tag", since it serves both syntax
  highlighting and playgrounds.
* Remap all the links.
* Advertise this new page in various places that previously did not have a link.
2021-05-05 16:11:21 -07:00
Sumanth V Rao a40fe26586 help: Document playgrounds on /help, /features and /for/open-source.
Linked the Help Center document in places like
    - zulip.yaml (/events, /register/, realm/playgrounds,
                  /realm/playgrounds/{playground_id})
    - /help/format-your-message-using-markdown (Linked to make
      users reading the markdown code block style, aware of this
      feature)
    - /templates/settings/playground_settings_admin.hbs (Linked
      as a reference to read more about playgrounds before
      configuring one)

Also showcase the feature on /features and /for/open-source.
2021-05-04 12:19:01 -07:00
Nikhil Maske 04da50a7bb user docs: Move "Create a poll" section in Sending messages.
Fixes #18312.
2021-04-30 09:37:48 -07:00
Mateusz Mandera 8d4ab69a46 docs: Move the /configure-missed-message-emails help page.
configure-message-notification-emails is the correct name now.
2021-04-21 10:10:54 -07:00
Mateusz Mandera 977a2f7fa0 emails: Rename "missed message email" to "message notification email". 2021-04-21 10:10:54 -07:00
majordwarf 4b3290566b docs: Document integration request process.
There was no proper documentation to guide user to request an integration.
The following changes documents the whole process and links it from the
`/integrations/` page making it visible to the end-user.

Fixes #7935
2021-04-13 20:48:34 -07:00
Aman Agrawal 5e83965e80 giphy: Use GIPHY web SDK to allow inserting GIFs in compose box.
We use GIPHY web SDK to create popover containing GIFs in a
grid format. Simply clicking on the GIFs will insert the GIF in the compose
box.

We add GIPHY logo to compose box action icons which opens the GIPHY
picker popover containing GIFs with "Powered by GIPHY"
attribution.
2021-04-05 15:04:49 -07:00
Mateusz Mandera 82b43a8cfe streams: Use "archive stream" phrasing instead of "delete stream".
The previous phrasing was misleading in relation to what the action
actually does.
2021-04-02 22:06:48 -07:00
Abhijeet Prasad Bodas 9223dced3b refactor: Rename filter to linkifier in frontend code and docs.
This only leaves `page_params.realm_filters`, which
will be changed in further commits along with the
API change.
2021-03-15 11:19:59 -07:00
Aman Agrawal e587c029f6 display_settings: Allow user to set default_view.
TextField is used to allow users to set long stream + topic narrow
names in the urls.

We currently restrict users to only set "all_messages" and
"recent_topics" as narrows.

This commit achieves 3 things:
* Removes recent topics as the default view which loads when
  hash is empty.
* Loads default_view when hash is empty.
* Loads default_view on pressing escape key when it is unhandled by
  other present UI elements.

NOTE: After this commit loading zulip with an empty hash will
automatically set hash to default_view.  Ideally, we'd just display
the default view without a hash, but that involves extra complexity.

One exception is when user is trying to load an overlay directly,
i.e. zulip is loaded with an overlay hash. In this case,
we render recent topics is background irrespective of default_view.

We consider this last detail to be a bug not important enough to block
adding this setting.
2021-03-11 18:09:08 -08:00
Aman Agrawal 62d721e859 docs: Remove HipChat migration guide.
As of Feb 15th 2019, Hipchat Cloud and Stride
have reached End Of Life and are no longer
supported by Atlassian. Since it is almost 2 years
now we can remove the migration guides.
2020-12-23 15:43:13 +05:30
sahil839 5d79dff00b docs: Extract help doc for wildcard mention policy.
This commit moves the wildcard mentions documentation to a top-level page.

Edited by tabbott to deduplicate with the existing docs, and add cross-links.
2020-10-29 15:29:52 -07:00
Anders Kaseorg c155403884 docs: Fix various capitalization errors.
Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-08-11 10:25:52 -07:00
Tim Abbott ec9c272165 help: Document process for changing organization URL. 2020-07-24 16:12:56 -07:00
Alex Vandiver b5f7008728 docs: Document how the desktop application handles certificates.
Zulip Desktop version 5.3.0 only supported adding custom certificates
inside the application.  Starting in version 5.4.0, it also supports
reading from the system certificate store; in the next release (likely
5.5.0) the support for the internal store will be removed.

Document the change, and add explicit instructions on how to add
certificates into the system store on each of the operating systems.

Co-authored-by: Manav Mehta <tmanavmehta@gmail.com>
2020-07-17 23:46:38 -07:00
Mateusz Mandera 501e7c44dc docs: Add instructions for SAML with Okta/OneLogin in /help/.
Tweaked by tabbott to shift how this is organized.
2020-05-28 08:14:30 +00:00
Tim Abbott 87ddd73dcb help: Add article for how to get support.
This page isn't polished properly and I'm not sure it's the best
decision tree here, but it's definitely better to have this page than
not, and we can always adjust forward.

Fixes #10033.
2020-05-04 09:38:36 -07:00
Tim Abbott f4489c381c docs: Document message retention policies.
We've completed the production performance testing that had been
blocking us from advertising this feature, so we're declaring the
feature implemented by documenting it.

As of this commit, you need to edit fields using `manage.py shell` to
configure it and manually configure the cron job, but those should be
addressed in the next few days.

Fixes #106.
2020-05-03 23:52:04 -07:00
Siddharth Varshney 3e78b3cdc3 help: Add doc for restricting users to change their profile pic.
Fixes part of #14298.
2020-04-16 20:30:30 -07:00
Siddharth Varshney e03176b272 help: Add doc for setting profile picture back to gravatar. 2020-04-16 20:27:52 -07:00
Siddharth Varshney cacf7bb7d4 help: Add docs for who can create and manage user groups.
Part of addressing #14298.
2020-04-16 20:24:01 -07:00
vaibhavrajsingh2001 2a212b3300 docs: Add documentation for weekly digest emails.
Added documentation explaining the digest emails feature and how to
disable it, along with a link to the /digest.

Resolves: #14136
2020-04-15 15:38:39 -07:00
Ryan Rehman 174b2abcfd settings: Migrate to stream_post_policy structure.
This commit includes a new `stream_post_policy` setting,
by replacing the `is_announcement_only` field from the Stream model,
which is done by mirroring the structure of the existing
`create_stream_policy`.

It includes the necessary schema and database migrations to migrate
the is_announcement_only boolean field to stream_post_policy,
a smallPositiveInteger field similar to many other settings.

This change is done to allow organization administrators to restrict
new members from creating and posting to a stream. However, this does
not affect admins who are new members.

With many tweaks by tabbott to documentation under /help, etc.

Fixes #13616.
2020-02-04 17:08:08 -08:00
Tim Abbott 79f18138f5 realm: Add private_message_policy setting.
This experimental setting disables sending private messages in Zulip
in a crude way (i.e. users get an error when they try to send one).
It makes no effort to adjust the UI to avoid advertising the idea of
sending private messages.

Fixes #6617.
2020-01-13 12:20:42 -08:00
Rishi Gupta 495efada4b help: Rename configure-waiting-period-for-full-members. 2019-06-12 17:02:04 -07:00
Rishi Gupta 49f8b9abbe help: Add manage-inactive-streams. 2019-06-06 22:17:03 -07:00
Rishi Gupta 0eeae3b6d0 email visibility: Enable feature and add user documentation. 2019-05-27 23:21:39 -07:00
David Wood e87d468f76 docs/org settings: Use "full member" terminology.
This commit modifies the help documentation and templates to use a "full
member"/"new member" terminology throughout.

With some tweaks by tabbott.
2019-05-21 17:48:46 -07:00
Rishi Gupta 7c9f377db0 help: Add enable-full-width-display.
Tweaked by tabbott to briefly describe the reason for Zulip's default;
this rough description has been satisfying for many people who've
asked in the past on chat.zulip.org.
2019-05-17 11:45:33 -07:00
David Wood 272ed90685 settings: Create an explicit invite_to_stream_policy setting.
This commit creates a new organization setting that determines whether
a user can invite other users to streams. Previously this was linked
to the waiting period threshold, but this was both not documented and
overly limiting.

With significant tweaks by tabbott to change the database model to not
involve two threshhold fields, edit the tests, etc.

This requires follow-up work to make the create stream policy setting
work how this code implies it should.

Fixes #12042.
2019-04-29 17:11:28 -07:00
Rishi Gupta 88903adb39 help: Rename join-zulip-chat-badge to linking-to-zulip. 2019-04-16 17:49:42 -07:00
Vishnu Ks 02c92e55a2 import: Add tool for importing teams from mattermost. 2019-04-05 17:53:03 -07:00
Rishi Gupta 17528e4ee9 help: Add create-a-poll.md. 2019-04-02 23:09:36 -07:00
Rishi Gupta 36fecaef94 help: Add configure-notification-bot.md. 2019-04-02 22:22:46 -07:00
Rishi Gupta 3c65fda41e help: Add disable-welcome-emails. 2019-04-02 22:05:19 -07:00
Rishi Gupta dc98359fcf help: Add switching-between-organizations.
This is in response to a support ticket where the user had a closed left
sidebar, had added an organization, and then couldn't figure out how to
switch organizations. They had googled and found "The desktop app makes it
easy to switch between different organizations" in our help docs, which was
not sufficiently helpful.
2019-04-02 20:54:07 -07:00
Rishi Gupta 78b2b5e053 help: Move add-custom-profile-fields to Users & bots. 2019-04-02 19:57:43 -07:00
Rishi Gupta fcd0e8c809 help: Update Notifications articles to conform to style guide. 2019-04-02 16:45:25 -07:00
Rishi Gupta 37ec3e1eb0 help: Remove organize-the-streams-sidebar.
This article will have more of a role once we add the option for (not)
pushing inactive streams to the bottom.
2019-04-02 16:45:25 -07:00
Rishi Gupta 6f1a754d70 help: Update Streams & topics articles to conform to style guide. 2019-04-02 16:45:25 -07:00
Rishi Gupta b47e6d0d94 help: Add status-and-availability. 2019-03-21 12:56:38 -07:00
Rishi Gupta d40da5269d help: Update view-and-browse-images. 2019-03-21 12:56:38 -07:00
Ben Muschol d526ff00f2 settings: Rename "user avatar" to "profile picture"
This renames references to user avatars, bot avatars, or organization
icons to profile pictures. The string in the UI are updated,
in addition to the help files, comments, and documentation. Actual
variable/function names, changelog entries, routes, and s3 buckets are
left as-is in order to avoid introducing bugs.

Fixes #11824.
2019-03-15 13:29:56 -07:00
Rishi Gupta 48eb0c2358 help: Update start-a-call to include Hangouts and Zoom. 2019-02-28 17:11:27 -08:00
Rishi Gupta 9357e17b93 help: Add private-messages. 2019-02-28 17:11:27 -08:00
Rishi Gupta 812f62c8b3 help: Add user-groups. 2019-02-28 17:11:27 -08:00
Rishi Gupta 1871d00bb2 help: Update at-mention-a-user to include user groups.
Also changes the terminology for this feature from at-mention to
mention.
2019-02-28 17:11:27 -08:00
Rishi Gupta 5692acdf04 help: Update delete-a-topic. 2019-02-28 14:48:07 -08:00
Rishi Gupta dbb4817128 help: Rename make-a-user-an-administrator to include guests. 2019-02-28 14:48:07 -08:00
Rishi Gupta 35af34049b help: Add announcement-only-streams.md. 2019-02-28 14:48:07 -08:00
Rishi Gupta 58829b7646 help: Add start-a-new-topic. 2019-02-28 14:48:07 -08:00
Rishi Gupta 6d51b25fc6 help: Rework docs for joining and inviting. 2019-02-27 09:33:37 -08:00
Rishi Gupta ac6f628c44 help: Rework Navigation and unread counts content. 2019-02-26 22:48:04 -08:00
Rishi Gupta 20d692bbd6 help: Remove compose-and-reply.
This page was too messy and hard to parse. Parent commits already copied
most of the content out into other articles.
2019-02-13 18:03:22 -08:00
Rishi Gupta a2130ca106 help: Separate quote-and-reply into its own article. 2019-02-13 18:03:22 -08:00
Rishi Gupta 2454eff51d help: Rename and update at-mention-a-team-member. 2019-02-13 18:03:22 -08:00
Rishi Gupta 4e33c3a970 help: Make open-the-compose-box a separate article. 2019-02-13 18:03:22 -08:00
Rishi Gupta 64cdac9294 help: Remove zulip-glossary.
I'm torn about this, since there is good content here. But ultimately I think
* This page is a lot of work to write and maintain.
* In most cases, the right thing is for people to find the page that
  explains the full feature. E.g. if you don't know what an "administrator"
  is, the page I hope you find is "Roles and Permissions". For bots, it's
  "Bots and Integrations". Writing a punchy short summary for a glossary
  that does better than that is possible, but not fast.
* People find things via search, e.g. by Googling "What is X in Zulip",
  rather than looking for a glossary.
* This page was written more than 3 years ago, before we had 100+ help
  articles. So it may have served a purpose in the past that no longer
  exists.
2019-02-13 18:03:22 -08:00
Rishi Gupta e40af1ca7f help: Update title of change-your-language. 2019-02-13 17:50:39 -08:00
Rishi Gupta e183c316dd help: Rename help/change-your-avatar to help/set-your-avatar. 2019-02-13 17:50:39 -08:00
Rishi Gupta 750fff16ef help: Remove TODOs from sidebar_index.md. 2019-02-13 10:41:29 -08:00
Rishi Gupta e3496830f1 help: Add hide-message-content-in-emails. 2019-02-13 10:41:29 -08:00
Rishi Gupta 7e0e380b5a help: Add change-notification-sound. 2019-02-13 10:41:29 -08:00
Rishi Gupta 458f988262 help: Add configure-missed-message-emails. 2019-02-13 10:41:29 -08:00
Rishi Gupta d20be1dd66 help: Add disable-new-login-emails. 2019-02-13 10:41:29 -08:00
Rishi Gupta 3b9cb9c68c help: Add change-your-timezone. 2019-02-13 10:41:29 -08:00
Rishi Gupta 0119b383a6 help: Update Accounts basics section to conform to new tabbed style. 2019-02-11 12:05:19 -08:00
Rishi Gupta cd0e55cb95 help: Add streams and topics and moderation to Guides. 2019-02-11 12:05:19 -08:00
Rishi Gupta e8251bb758 user docs: Add delete-a-topic. 2019-02-06 22:16:24 -08:00
Rishi Gupta 2d4c0ef292 user docs: Add rename-a-topic. 2019-02-06 22:16:24 -08:00
Rishi Gupta 3e5e4ce561 portico: Add information on billing guests. 2019-02-01 23:34:47 -08:00
Rishi Gupta 78d98168a4 portico: Add stride import to /features and /help. 2019-01-29 13:48:39 -08:00
Rishi Gupta 7956c57448 user docs: Add import-from-hipchat. 2018-10-09 15:23:07 -07:00
Rishi Gupta 0d1907fb71 user docs: Add test-mobile-notifications. 2018-09-28 12:09:33 -07:00
Shubham Dhama 8c6424a4bd user docs: Split and update add-a-bot-or-integration.md. 2018-09-25 20:48:12 -07:00
Rishi Gupta f2b4357d67 user docs: Remove link to #status-messages from left sidebar. 2018-09-18 14:48:17 -07:00
Rishi Gupta 669c2fd752 user docs: Update verify-your-message-was-successfully-sent. 2018-09-18 14:47:33 -07:00
Rishi Gupta 976b5603ce user docs: Update enable-enter-to-send. 2018-09-16 18:03:10 -07:00
Rishi Gupta f56a76b53d user docs: Update manage-your-uploaded-files.
Eventually this should probably just be a document on deleting files.
2018-09-16 18:03:10 -07:00
Rishi Gupta 5b839a90ab user docs: Update upload-and-share-files. 2018-09-16 18:03:09 -07:00
Rishi Gupta 5fcd96b8a1 user docs: Update add-emoji. 2018-09-16 18:03:09 -07:00
Rishi Gupta 0eba0dfdc8 user docs: Remove send-a-message-in-a-different-language.
A valiant effort, but there are too many operating systems to do this
well.
2018-09-16 18:01:18 -07:00
Rishi Gupta e46d3705de user docs: Remove several "send a message" docs.
These are now subsumed by compose-and-reply. Probably we'll want to write a
"PMs and Group PMs" doc at some point so that we have something if people
search for whether Zulip has Group PMs.
2018-09-16 15:04:05 -07:00
Rishi Gupta 02be6c1530 user docs: Add compose-and-reply. 2018-09-16 14:54:42 -07:00
Rishi Gupta 957b4af81f user docs: Remove the-zulip-browser-window.
This is one of the earliest user docs we wrote (Jan 2017), and no longer
fits with our current docs strategy.
2018-09-16 10:33:39 -07:00
Rishi Gupta 91c58987bf user docs: Update change-your-settings. 2018-09-16 10:26:40 -07:00
Rishi Gupta 404f4e3560 user docs: Update emoji-reactions. 2018-09-16 10:13:43 -07:00
Rishi Gupta cd57a8ede4 user docs: Update share-a-message-or-conversation. 2018-09-16 10:13:43 -07:00
Rishi Gupta 7f1e159a45 user docs: Remove a few articles from Reading messages.
This content would be most useful in some sort of guide, perhaps an article
like "navigation and unread counts".
2018-09-16 08:24:28 -07:00
Rishi Gupta bad4a2e8ca user docs: Update invite-a-friend-to-zulip. 2018-09-16 08:24:28 -07:00
Rishi Gupta 29abb80c96 user docs: Remove view your stream subscriptions from the sidebar. 2018-09-15 23:57:22 -07:00
Rishi Gupta 0b77feaf93 user docs: Remove doc for digest emails.
This hasn't been on in production for months.
2018-09-15 18:18:02 -07:00
Rishi Gupta 84f24d2aa6 user docs: Update add-an-alert-word. 2018-09-15 18:18:02 -07:00
Rishi Gupta 253aa95d4c user docs: Update change-your-organization-settings. 2018-09-14 22:07:46 -07:00
Rishi Gupta 7e2f686240 user docs: Add moderating open organizations. 2018-09-14 22:07:46 -07:00
Lyla Fischer 1efcdfdb5c templates: Merge Help and API doc main into documentation_main.
With minor fixes by eeshangarg.
2018-08-27 20:19:24 -02:30