help-docs: Move help center documentation to top level directory.

These files are not Jinja2 templates, so there's no reason that they needed
to be inside `templates/zerver`. Moving them to the top level reflects their
importance and also makes it feel nicer to work on editing the help center content, 
without it being unnecessary buried deep in the codebase.
This commit is contained in:
Lauryn Menard
2023-01-25 23:08:29 +01:00
committed by GitHub
parent 6cf1d9fa20
commit dedea23745
269 changed files with 40 additions and 44 deletions

View File

@@ -0,0 +1,22 @@
{!cloud-standard-only.md!}
You can customize the logo users see in the top left corner
of the Zulip app. For best results:
- The logo should be a wide rectangle image with an 8:1 width to height ratio.
It will be displayed at 200×25 pixels, or more on high-resolution displays.
- Make sure your logo has a transparent background, and trim any bordering
whitespace.
To upload a logo:
{start_tabs}
{settings_tab|organization-profile}
1. Under **Organization logo**, upload a new logo.
{end_tabs}
Make sure to test the logo in both light theme and [dark theme](/help/dark-theme).

View File

@@ -0,0 +1,3 @@
!!! warn ""
This feature is only available to organization owners and administrators.

View File

@@ -0,0 +1,26 @@
* Zulip is [100% open-source software][zulip-github], with no "open core" catch.
When you self-host Zulip, you get the same software as [Zulip Cloud
Standard](https://zulip.com/plans/) customers.
* Retain full control over your data and simplify compliance by self-hosting
Zulip behind your firewall.
* We work hard to make it easy to [install][install-zulip], [back
up][back-up-zulip], and [maintain][maintain-zulip] a self-hosted
Zulip server. Self-host Zulip directly on Ubuntu or Debian Linux, in
<a href="https://github.com/zulip/docker-zulip">Docker</a>, or with
prebuilt images for <a
href="https://marketplace.digitalocean.com/apps/zulip">Digital
Ocean</a> and <a
href="https://render.com/docs/deploy-zulip">Render</a>.
* Customize Zulip for all your needs. It's easy to develop and maintain [custom
integrations](/api/incoming-webhooks-overview) and [features][modify-zulip].
Learn more about [self-hosting Zulip](https://zulip.com/self-hosting/).
[zulip-github]: https://github.com/zulip/zulip#readme
[install-zulip]: https://zulip.readthedocs.io/en/latest/production/install.html
[back-up-zulip]: https://zulip.readthedocs.io/en/stable/production/export-and-import.html#backups
[maintain-zulip]: https://zulip.readthedocs.io/en/stable/production/upgrade-or-modify.html
[modify-zulip]: https://zulip.readthedocs.io/en/latest/production/upgrade-or-modify.html#modifying-zulip

View File

@@ -0,0 +1,6 @@
* Simple managed solution, with no setup or maintenance
overhead. [Sign up](https://zulip.com/new/) with just a few clicks.
* Always updated to the latest version of Zulip.
* Anyone can [start with Zulip Cloud Free](https://zulip.com/new/). [Free or heavily
discounted Zulip Cloud Standard](https://zulip.com/plans/) pricing is available for
most non-business uses.

View File

@@ -0,0 +1,21 @@
The **All messages** view is a feed of all the unmuted messages you have
received, which combines stream messages and private messages. It's a great way
to see new messages as they come in.
You can configure **All messages** to be the [default
view](/help/configure-default-view#configure-default-view) for the Zulip web app.
{start_tabs}
{tab|desktop-web}
1. Open **All messages** from the left sidebar or with the
<kbd>A</kbd> keyboard shortcut.
{tab|mobile}
1. Tap the **All messages**
(<img src="/static/images/help/mobile-globe-icon.svg" alt="globe" class="mobile-icon"/>)
tab in the upper left corner of the app.
{end_tabs}

View File

@@ -0,0 +1,7 @@
!!! warn ""
**Note**: This sends an automated notice from [notification
bot][notification-bot] to the "stream events" topic in the
modified stream.
[notification-bot]: /help/configure-notification-bot

View File

@@ -0,0 +1,6 @@
!!! warn ""
**Note**: Subscribing someone else to a stream sends them an
automated private message from [notification bot][notification-bot].
[notification-bot]: /help/configure-notification-bot

View File

@@ -0,0 +1,15 @@
{start_tabs}
1. If you are logged in, start by [logging out](/help/logging-out).
2. Go to your organization's log in page at `https://<organization-url>/login/`.
3. Click the **Forgot your password?** link below the **Log in** button or
buttons.
4. Enter your email address, and click **Send reset link**.
5. You will receive a confirmation email within a few minutes. Open it and click
**Reset password**.
{end_tabs}

View File

@@ -0,0 +1,4 @@
!!! warn ""
Zulip Cloud customers who wish to use SAML authentication must upgrade to
the Zulip Cloud Plus plan. Contact
[support@zulip.com](mailto:support@zulip.com) for plan benefits and pricing.

View File

@@ -0,0 +1,3 @@
!!! warn ""
This feature is only available to Zulip Cloud Standard and self-hosted organizations.

View File

@@ -0,0 +1,13 @@
{start_tabs}
{settings_tab|organization-profile}
1. To be listed in the appropriate category, under **Organization type**, select
the option that best fits your organization.
1. Toggle **Advertise organization in the Zulip communities
directory**.
{!save-changes.md!}
{end_tabs}

View File

@@ -0,0 +1,14 @@
The [Zulip communities directory](https://zulip.com/communities/) offers
publicly accessible [Zulip Cloud][zulip-cloud] organizations an opportunity to
be listed on the [Zulip website](https://zulip.com). It's a way for [open-source
projects](https://zulip.com/for/open-source/), [research
communities](https://zulip.com/for/research/), and
[others](https://zulip.com/for/communities) to advertise their Zulip community
and support the Zulip project.
The directory will display your community's name, logo, and a link to you Zulip
chat. Other information from your [organization
profile](/help/create-your-organization-profile) and the size of your
organization may be included as well.
[zulip-cloud]: https://zulip.com/plans/

View File

@@ -0,0 +1,7 @@
1. Click on the compose box, or press <kbd>Tab</kbd> to compose your message. You
can [preview your message](/help/preview-your-message-before-sending) before
sending.
1. Click **Send**, or use a [keyboard
shortcut](/help/mastering-the-compose-box#toggle-between-ctrl-enter-and-enter-to-send-a-message)
to send your message.

View File

@@ -0,0 +1,13 @@
In Zulip, streams determine who gets a message. They are similar to
channels in IRC/Slack/Discord, chat rooms, and email lists.
We recommend setting up some streams before inviting other users to
join Zulip, so that you can [automatically subscribe
everyone](/help/set-default-streams-for-new-users) to the right set of
streams.
If you later create additional streams, no worries! You can always add
a group of users or all the members of another stream to a new stream.
!!! tip ""
Add clear descriptions to your streams, especially public streams.

View File

@@ -0,0 +1,30 @@
{!review-organization-settings-instructions.md!}
A few settings to highlight:
* Decide [who can invite new users][who-can-invite], or whether
[anyone can join without an invitation][who-can-join].
* [Set visibility for users' email addresses][email-address-visibility].
* If your organization uses a programming language, set the [default
language for code blocks][default-code-block-language]. Also
consider setting up [code playgrounds][code-playgrounds].
* If your organization uses code repositories, [set up
linkifiers](/help/add-a-custom-linkifier) to make it easy to link to
issues (e.g. just by typing #1234 for issue 1234).
* [Add custom emoji](/help/custom-emoji), including your organization's logo.
For many other settings, e.g. [message and topic editing
permissions][topic-editing-permissions], you can experience how Zulip
works for your organization before deciding what settings are best for
you.
[topic-editing-permissions]: /help/configure-message-editing-and-deletion
[default-code-block-language]: /help/code-blocks#default-code-block-language
[code-playgrounds]: /help/code-blocks#code-playgrounds
[email-address-visibility]: /help/restrict-visibility-of-email-addresses
[who-can-invite]: /help/restrict-account-creation#change-who-can-send-invitations
[who-can-join]: /help/restrict-account-creation#set-whether-invitations-are-required-to-join

View File

@@ -0,0 +1,11 @@
Customize settings for new users to get them off to a great start.
* [Add custom profile fields](/help/custom-profile-fields#add-a-custom-profile-field), such as pronouns
or job title.
* [Configure default new user settings][default-user-settings].
* [Set default streams for new users](/help/set-default-streams-for-new-users).
* [Set organization language for automated messages and invitation emails][org-lang],
if it should be something other than American English.
[org-lang]: /help/configure-organization-language
[default-user-settings]: /help/configure-default-new-user-settings

View File

@@ -0,0 +1 @@
1. Click the **gear** (<i class="fa fa-cog"></i>) icon in the bottom left corner of the app.

View File

@@ -0,0 +1,4 @@
!!! tip ""
To show or hide the **organizations sidebar** on the left, select
**Toggle Sidebar** from the **View** menu in the top menu bar.

View File

@@ -0,0 +1,24 @@
!!! tip ""
The **organization description** supports [full Markdown syntax][markdown-syntax],
including **bold**/*italic*, links, lists, and more.
!!! tip ""
Your **organization profile picture** should be a square image. It will be displayed at
100×100 pixels, or more on high-resolution displays.
{start_tabs}
{settings_tab|organization-profile}
1. Edit your organization **name**, **type**, **description**, and
**profile picture**.
1. *(optional)* Click **Preview organization profile** to see a preview of your
organization's login page in a new browser tab.
{!save-changes.md!}
{end_tabs}
[markdown-syntax]: /help/format-your-message-using-markdown

View File

@@ -0,0 +1,14 @@
{start_tabs}
{settings_tab|user-groups-admin}
1. Click the **Add a new user group** button.
1. Enter a **Name** and **Description**.
1. Click **Save**.
1. Find the group in the list below, and add members. Zulip will notify
everyone who is added.
{end_tabs}

View File

@@ -0,0 +1,29 @@
{start_tabs}
{tab|require-invitations}
1. Configure [allowed authentication
methods](/help/configure-authentication-methods). By default, Zulip allows
logging in via email/password as well as various social authentication
providers like Google, GitHub, GitLab, and Apple. Users can [log in with any
allowed authentication method][logging-in], regardless of how they signed up.
1. Invite users by [sending email invitations][email-invitations] or
sharing a [reusable invite link][invitation-links].
{tab|allow-anyone-to-join}
1. Allow users to [join without an invitation][set-if-invitations-required].
1. Configure the appropriate [email domain restrictions][restrict-email-domain]
for your organization.
1. Share a link to your registration page, which is
https://your-domain.zulipchat.com for Zulip Cloud organizations.
{end_tabs}
[email-invitations]:/help/invite-new-users#send-email-invitations
[invitation-links]: /help/invite-new-users#create-an-invitation-link
[set-if-invitations-required]: /help/restrict-account-creation#set-whether-invitations-are-required-to-join
[restrict-email-domain]: /help/restrict-account-creation#configuring-email-domain-restrictions
[logging-in]: /help/logging-in

View File

@@ -0,0 +1,32 @@
{start_tabs}
{tab|stream}
1. Click the **New topic** button at the bottom of the app, or
use the <kbd>C</kbd> keyboard shortcut.
1. Enter a topic name. Auto-complete will provide suggestions for previously
used topics.
{!compose-and-send-message.md!}
{tab|not-stream}
1. Click the **New topic** button at the bottom of the app, or
use the <kbd>C</kbd> keyboard shortcut.
1. Enter a stream name. Auto-complete will provide suggestions for streams you
can send to.
1. Enter a topic name. Auto-complete will provide suggestions for previously
used topics.
{!compose-and-send-message.md!}
{end_tabs}
!!! warn ""
In Zulip, you can compose a message to a different place than the one you
are viewing. In this situation, the message feed will fade to indicate
what's going on.

View File

@@ -0,0 +1,21 @@
Once the import process is completed, you will need to:
{start_tabs}
1. [Configure the settings for your organization](/help/customize-organization-settings),
which are not exported. This includes settings like [email
visibility](/help/restrict-visibility-of-email-addresses), [message editing
permissions](/help/configure-message-editing-and-deletion#configure-message-editing-and-deletion_1),
and [how users can join your organization](/help/restrict-account-creation).
1. All users from your previous workspace will have accounts in your new Zulip
organization. However, you will need to let users know about their new
accounts, and [decide how they will log
in](/help/import-from-slack#decide-how-users-will-log-in) for the first time.
1. Share the URL for your new Zulip organization, and (recommended) the [Getting
started with Zulip guide](/help/getting-started-with-zulip).
1. Migrate any [integrations](/integrations).
{end_tabs}

View File

@@ -0,0 +1,70 @@
When user accounts are imported, users initially do not have passwords
configured. There are a few options for how users can log in for the first time.
!!! tip ""
For security reasons, passwords are never exported.
### Allow users to log in with non-password authentication
When you create your organization, users will immediately be able to log in with
[authentication methods](/help/configure-authentication-methods) that do not
require a password. Zulip offers a variety of authentication methods, including
Google, GitHub, GitLab, Apple, LDAP and [SAML](/help/saml-authentication).
### Send password reset emails to all users
You can send password reset emails to all users in your organization, which
will allow them to set an initial password.
If you imported your organization into Zulip Cloud, simply e-mail
[support@zulip.com](mailto:support@zulip.com) to request this.
!!! warn ""
To avoid confusion, first make sure that the users in your
organization are aware that their account has been moved to
Zulip, and are expecting to receive a password reset email.
#### Send password reset emails (self-hosted organization)
{start_tabs}
{tab|default-subdomain}
1. To test the process, start by sending yourself a password reset email by
using the following command:
```
./manage.py send_password_reset_email -u username@example.com
```
1. When ready, send password reset emails to all users by
using the following command:
```
./manage.py send_password_reset_email -r '' --all-users
```
{tab|custom-subdomain}
1. To test the process, start by sending yourself a password reset email by
using the following command:
```
./manage.py send_password_reset_email -u username@example.com
```
1. When ready, send password reset emails to all users by
using the following command:
```
./manage.py send_password_reset_email -r <subdomain> --all-users
```
{end_tabs}
### Manual password resets
Alternatively, users can reset their own passwords by following the instructions
on your Zulip organization's login page.

View File

@@ -0,0 +1,18 @@
#### Import into a self-hosted Zulip server
Zulip's import tools are robust, and have been used to import workspaces
with 10,000 members and millions of messages. If you're planning on doing
an import much larger than that, or run into performance issues when
importing, [contact us](/help/contact-support) for help.
1. Follow steps
[1](https://zulip.readthedocs.io/en/stable/production/install.html#step-1-download-the-latest-release)
and
[2](https://zulip.readthedocs.io/en/stable/production/install.html#step-2-install-zulip)
of the guide for [installing a new Zulip
server](https://zulip.readthedocs.io/en/stable/production/install.html).
1. Copy the **exported data** file containing your workspace message
history export onto your Zulip server, and put it in `/tmp/`.
1. Log in to a shell on your Zulip server as the `zulip` user.

View File

@@ -0,0 +1,8 @@
#### Import into a Zulip Cloud organization
{!send-us-info.md!}
1. The subdomain you would like to use for your organization. Your Zulip chat will
be hosted at `<subdomain>.zulipchat.com`.
1. The **exported data** file containing your workspace message history export.

View File

@@ -0,0 +1,22 @@
## Logging in
Once the import completes, all your users will have accounts in your
new Zulip organization, but those accounts won't have passwords yet
(since for very good security reasons, passwords are not exported).
Your users will need to either authenticate using something like
Google auth, or start by resetting their passwords.
You can use the `./manage.py send_password_reset_email` command to
send password reset emails to your users. We
recommend starting with sending one to yourself for testing:
```
./manage.py send_password_reset_email -u username@example.com
```
and then once you're ready, you can email them to everyone using e.g.
```
./manage.py send_password_reset_email -r '' --all-users
```
(replace `''` with your subdomain if you're using one).

View File

@@ -0,0 +1,8 @@
!!! tip ""
* The import could take several minutes to run,
depending on how much data you're importing.
* The server stop/restart commands are only
necessary when importing on a server with minimal
RAM, where an OOM kill might otherwise occur.

View File

@@ -0,0 +1,11 @@
You can import your current workspace into a Zulip organization. It's a great way
to preserve your workspace history when you migrate to Zulip, and to
make the transition easy for the members of your organization.
The import will include your organization's:
* **Name** and **Logo**
* **Message history**, including attachments and emoji reactions
* **Users**, including names, emails, roles, avatars, time zones, and custom profile fields
* **Channels**, including all user subscriptions
* **Custom emoji**

View File

@@ -0,0 +1,10 @@
To start using Zulip, you will need to choose between Zulip Cloud and
self-hosting Zulip. For a simple managed solution, with no setup or maintenance
overhead, you can [sign up](/new/) for Zulip Cloud with just a few clicks.
Alternatively, you can [self-host](/self-hosting/) your Zulip organization. See
[here](/help/zulip-cloud-or-self-hosting) to learn more.
!!! warn ""
**You can only import a workspace as a new Zulip organization.** Your imported
message history cannot be added into an existing Zulip organization.

View File

@@ -0,0 +1,6 @@
!!! warn ""
If the organization already exists, the import process will overwrite all
data that's already there. If needed, we're happy to preserve your
data by moving an organization you've already created to a new
subdomain prior to running the import process.

View File

@@ -0,0 +1,14 @@
In the left sidebar, you can see the streams you are subscribed to, along with
unread message counts for each stream.
{start_tabs}
1. Click on the name of a stream in the left sidebar. You will see a list of the
most recent unread topics in that stream.
1. The initially shown list of topics usually has what you need, but you can
click on **more topics** underneath to see additional topics.
{end_tabs}
!!! tip ""
Older topics disappear from the left sidebar, but you can always find them
by clicking **more topics** or by using [search](/help/search-for-messages).

View File

@@ -0,0 +1,3 @@
{!user-card-three-dot-menu.md!}
1. Click **Manage this user**.

View File

@@ -0,0 +1,3 @@
1. Hover over a message to reveal three icons on the right.
1. Click on the **ellipsis** (<i class="zulip-icon zulip-icon-ellipsis-v-solid"></i>).

View File

@@ -0,0 +1 @@
1. Hover over a message to reveal three icons on the right.

View File

@@ -0,0 +1 @@
1. Press and hold a message until the long-press menu appears.

View File

@@ -0,0 +1,14 @@
- Learn all about [message formatting](/help/format-your-message-using-markdown).
- Use [emoji reactions](/help/emoji-reactions) for lightweight interactions.
- Embed [code blocks](/help/code-blocks) with syntax highlighting for over 250
languages, and integrated [code playgrounds](/help/code-blocks#code-playgrounds).
- [Type LaTeX](/help/format-your-message-using-markdown#latex) directly into
your Zulip message, and see it beautifully rendered.
- [Start a video call](/help/start-a-call) with the click of a button.
- Make plans for later without worrying about time zones using
[global times](/help/format-your-message-using-markdown#global-times).
- Share files or images with [drag-and-drop uploads](/help/share-and-upload-files).
- Enjoy animated GIFs with Zulip's native
[GIPHY integration](/help/animated-gifs-from-giphy).
- [Preview your message](/help/preview-your-message-before-sending) to make sure
it looks just how you want it.

View File

@@ -0,0 +1,10 @@
We have tools for importing your data from other chat tools, including
users, channels, messages, and more.
Note that importing data from another chat app creates a new
Zulip organization containing only imported data.
* [Import from Slack](/help/import-from-slack)
* [Import from Mattermost](/help/import-from-mattermost)
* [Import from Gitter](/help/import-from-gitter)
* [Import from Rocket.Chat](/help/import-from-rocketchat)

View File

@@ -0,0 +1 @@
1. Tap your **profile picture** in the bottom right corner of the app.

View File

@@ -0,0 +1,6 @@
!!! tip ""
If you are viewing a single stream or topic, you can access the
stream settings menu from the information
(<img src="/static/images/help/mobile-info-circle-icon.svg" alt="information" class="mobile-icon"/>)
button in the top right corner of the app.

View File

@@ -0,0 +1,5 @@
The information in your organization profile is displayed on your organization's
registration and login pages, and (optionally) in the [communities
directory](/help/communities-directory). Your **organization profile picture**
is also used for [switching between
organizations](/help/switching-between-organizations) in the Desktop app.

View File

@@ -0,0 +1,3 @@
!!! warn ""
This feature is only available to organization owners.

View File

@@ -0,0 +1,27 @@
{start_tabs}
1. If the **Private messages** section in the left sidebar is collapsed, click
on it to expand it.
1. Click on a conversation under **Private messages**.
1. Read the conversation, scrolling down with the mouse or by pressing
<kbd>PgDn</kbd>.
1. If the conversation is not of interest, you can
[mark all messages as read](/help/marking-messages-as-read) by
jumping to the bottom with the **Scroll to bottom**
(<i class="fa fa-chevron-down"></i>) button or the <kbd>End</kbd> shortcut.
1. Click on the next conversation in the left sidebar, or use the
<kbd>P</kbd> key to go to the next unread conversation.
1. To view all your private message conversations, click the **more
conversations** link at the bottom of the **Private messages** section.
!!! tip ""
You can also find recent PMs in the [**Recent
conversations**](/help/recent-conversations) tab by selecting the **Include PMs** option.
{end_tabs}

View File

@@ -0,0 +1,43 @@
{start_tabs}
{tab|via-recent-conversations}
1. Open **Recent conversations** from the left sidebar or by pressing the
<kbd>Esc</kbd> key.
1. Click on the name of a topic in the **Topic** column.
1. Read the topic, scrolling down with the mouse or by pressing
<kbd>PgDn</kbd>.
1. If the topic is not of interest, you can
[mark all messages as read](/help/marking-messages-as-read) by
jumping to the bottom with the **Scroll to bottom**
(<i class="fa fa-chevron-down"></i>) button or the <kbd>End</kbd> shortcut.
1. You can then click on another topic in the left sidebar, use the
<kbd>N</kbd> key to go to the next unread topic, or go back to the
**Recent conversations** view.
{tab|via-left-sidebar}
1. Click on the name of a stream in the left sidebar. You will see a
list of the most recent unread topics in that stream.
1. Click on a topic in the left sidebar.
1. Read the topic, scrolling down with the mouse or by pressing
<kbd>PgDn</kbd>.
1. If the topic is not of interest, you can
[mark all messages as read](/help/marking-messages-as-read) by
jumping to the bottom with the **Scroll to bottom**
(<i class="fa fa-chevron-down"></i>) button or the <kbd>End</kbd> shortcut.
1. Click on the next topic in the left sidebar, or use the <kbd>N</kbd>
key to go to the next unread topic.
1. To go to older unread topics, use the <kbd>N</kbd> key or click
**more topics** to view.
{end_tabs}

View File

@@ -0,0 +1,18 @@
Use the **Recent conversations** view to get an overview of all the ongoing
conversations. This view is particularly useful for catching up on
messages sent while you were away.
{start_tabs}
1. Open **Recent conversations** from the left sidebar or by pressing the
<kbd>Esc</kbd> key.
1. The filters at the top help you quickly find relevant conversations.
For example, select **Participated** to narrow to the topics you
have sent messages to.
{end_tabs}
!!! tip ""
The **Participants** column shows which users recently sent a message (newest on the left).

View File

@@ -0,0 +1,20 @@
To reply to an existing thread:
{start_tabs}
1. Click the **Message...** button at the bottom of the app.
1. Compose your message. You
can [preview your message](/help/preview-your-message-before-sending) before
sending.
1. Click **Send**, or use a [keyboard
shortcut](/help/mastering-the-compose-box#toggle-between-ctrl-enter-and-enter-to-send-a-message)
to send your message.
!!! tip ""
You can also reply by clicking on a message, or using the <kbd>R</kbd> or
<kbd>Enter</kbd> keyboard shortcuts to reply to the message in the blue box.
{end_tabs}

View File

@@ -0,0 +1,11 @@
Review the settings for your organization to set everything up how you
want it to be.
{start_tabs}
{relative|gear|manage-organization}
1. Click on the **Organization settings** and **Organization
permissions** tabs, as well as any others that are of interest.
{end_tabs}

View File

@@ -0,0 +1,4 @@
1. Hover over a user's name in the right sidebar.
1. Click on the **ellipsis** (<i class="zulip-icon zulip-icon-ellipsis-v-solid"></i>)
to the right of their name to open their **user card**.

View File

@@ -0,0 +1,3 @@
{!right-sidebar-user-card.md!}
1. Click **View profile**.

View File

@@ -0,0 +1,2 @@
1. How you would like the Zulip log in button to be labeled: “Log in with...”
1. *(optional)* An icon to use on the log in button

View File

@@ -0,0 +1 @@
1. Click **Save changes**.

View File

@@ -0,0 +1 @@
1. Select the **General** tab on the right.

View File

@@ -0,0 +1 @@
1. Select the **Personal** tab on the right.

View File

@@ -0,0 +1 @@
1. Select the **Subscribers** tab on the right.

View File

@@ -0,0 +1,4 @@
1. Hover over your name in the right sidebar.
1. Click on the **ellipsis** (<i class="zulip-icon zulip-icon-ellipsis-v-solid"></i>)
to open your **user card**.

View File

@@ -0,0 +1,34 @@
{start_tabs}
{tab|desktop-web}
1. Click the **New private message** button at the bottom of the app, or
use the <kbd>X</kbd> keyboard shortcut.
1. Start typing the name of the person you want to message, and
select their name from the list of suggestions. You can continue
adding as many message recipients as you like.
{!compose-and-send-message.md!}
{tab|mobile}
1. Tap the private messages
( <img src="/static/images/help/mobile-pm-tab-icon.svg" alt="private messages" class="mobile-icon"/> )
tab at the bottom of the app.
2. Tap the **New group PM** button at the top of the app.
3. Start typing the name of the person you want to message, and
select their name from the list of suggestions. You can continue
adding as many message recipients as you like.
4. Approve by tapping the checkmark
(<img src="/static/images/help/mobile-check-circle-icon.svg" alt="checkmark" class="mobile-icon"/>)
button in the bottom right corner of the app.
5. Compose your message, and tap the send
(<img src="/static/images/help/mobile-send-circle-icon.svg" alt="send" class="mobile-icon"/>)
button in the bottom right corner of the app.
{end_tabs}

View File

@@ -0,0 +1,2 @@
If you are using Zulip Cloud, we'll take it from here! Please e-mail
[support@zulip.com](mailto:support@zulip.com) with the following information:

View File

@@ -0,0 +1,13 @@
Zulip integrates directly with dozens of products, and with hundreds
more through [Zapier](/integrations/doc/zapier) and
[IFTTT](/integrations/doc/ifttt). Popular Zulip integrations include
[GitHub](/integrations/doc/github), [Jira](/integrations/doc/jira),
[PagerDuty](/integrations/doc/pagerduty),
[Sentry](/integrations/doc/sentry) and
[Twitter](/integrations/doc/twitter).
* The [integrations page](/integrations) has instructions for
integrating with each product.
* If you don't see an integration you need, you can [request it](/help/request-an-integration).
* You can also [create custom integrations](/api/integrations-overview) using our API.
* Want to learn more? Read about [Zulip bots and integrations](/help/bots-and-integrations).

View File

@@ -0,0 +1,24 @@
!!! tip ""
If this is your first time using Zulip, we recommend starting with the web
or desktop experience to set up your account and get oriented.
- Get the [mobile and desktop apps](/apps). Zulip also works great in a browser.
- [Add a profile picture](/help/change-your-profile-picture) and
[edit your profile information](/help/edit-your-profile) to tell others
about yourself.
- [Review your display settings](/help/review-your-settings#review-your-display-settings).
You can [switch between light and dark theme](/help/dark-theme),
[pick your favorite emoji theme](/help/emoji-and-emoticons#change-your-emoji-set),
[change your language](/help/change-your-language), and make other tweaks to your Zulip experience.
- [Browse and subscribe to streams](/help/browse-and-subscribe-to-streams).
- Decide whether you want <kbd>Enter</kbd> [to send your message
or add a new line](/help/mastering-the-compose-box#toggle-between-ctrl-enter-and-enter-to-send-a-message).
- [Configure your notifications](/#settings/notifications) to work the way
you do. If you're joining a low traffic organization and aren't using the
desktop app, consider sending all messages to email.

View File

@@ -0,0 +1,214 @@
## Guides
* [Getting started with Zulip](/help/getting-started-with-zulip)
* [Setting up your organization](/help/getting-your-organization-started-with-zulip)
* [Moderating open organizations](/help/moderating-open-organizations)
* [Setting up Zulip for a class](/help/setting-up-zulip-for-a-class)
* [Using Zulip for a class](/help/using-zulip-for-a-class)
* [Using Zulip via email](/help/using-zulip-via-email)
## Getting started
* [Joining an organization](/help/join-a-zulip-organization)
* [Set up your account](/help/set-up-your-account)
* [Streams and topics](/help/streams-and-topics)
* [Finding a topic to read](/help/finding-a-topic-to-read)
* [Reading topics](/help/reading-topics)
* [Reading private messages (PMs)](/help/reading-pms)
* [Starting a new topic](/help/starting-a-new-topic)
* [Starting a new private thread](/help/starting-a-new-private-thread)
* [Replying to messages](/help/replying-to-messages)
* [Messaging tips & tricks](/help/messaging-tips)
* [Keyboard shortcuts](/help/keyboard-shortcuts)
## Setting up your organization
* [Trying out Zulip](/help/trying-out-zulip)
* [Zulip Cloud or self-hosting?](/help/zulip-cloud-or-self-hosting)
* [Migrating from other chat tools](/help/migrating-from-other-chat-tools)
* [Create your organization profile](/help/create-your-organization-profile)
* [Customize organization settings](/help/customize-organization-settings)
* [Create streams](/help/create-streams)
* [Customize settings for new users](/help/customize-settings-for-new-users)
* [Invite users to join](/help/invite-users-to-join)
* [Create user groups](/help/create-user-groups)
* [Set up integrations](/help/set-up-integrations)
## Account basics
* [Edit your profile](/help/edit-your-profile)
* [Change your name](/help/change-your-name)
* [Change your email address](/help/change-your-email-address)
* [Change your profile picture](/help/change-your-profile-picture)
* [Change your password](/help/change-your-password)
* [Logging in](/help/logging-in)
* [Logging out](/help/logging-out)
* [Switching between organizations](/help/switching-between-organizations)
* [Import your settings](/help/import-your-settings)
* [Deactivate your account](/help/deactivate-your-account)
## Display settings
* [Review your settings](/help/review-your-settings)
* [Dark theme](/help/dark-theme)
* [Change your language](/help/change-your-language)
* [Change your time zone](/help/change-your-timezone)
* [Use 24-hour time](/help/change-the-time-format)
* [Enable emoticon translations](/help/enable-emoticon-translations)
* [Configure default view](/help/configure-default-view)
* [Enable full width display](/help/enable-full-width-display)
* [Manage your uploaded files](/help/manage-your-uploaded-files)
## Sending messages
* [Open the compose box](/help/open-the-compose-box)
* [Mastering the compose box](/help/mastering-the-compose-box)
* [Resize the compose box](/help/resize-the-compose-box)
* [Message formatting](/help/format-your-message-using-markdown)
* [Mention a user or group](/help/mention-a-user-or-group)
* [Typing notifications](/help/typing-notifications)
* [Preview messages before sending](/help/preview-your-message-before-sending)
* [Verify a message was sent](/help/verify-your-message-was-successfully-sent)
* [Edit or delete a message](/help/edit-or-delete-a-message)
* [Message drafts](/help/view-and-edit-your-message-drafts)
* [Emoji and emoticons](/help/emoji-and-emoticons)
* [Start a video call](/help/start-a-call)
* [Share and upload files](/help/share-and-upload-files)
* [Quote and reply](/help/quote-and-reply)
* [Code blocks](/help/code-blocks)
* [Add GIFs in your message](/help/animated-gifs-from-giphy)
* [Create a poll](/help/create-a-poll)
* [Message a stream by email](/help/message-a-stream-by-email)
## Reading messages
* [Reading strategies](/help/reading-strategies)
* [Recent conversations](/help/recent-conversations)
* [All messages](/help/all-messages)
* [Message actions](/help/message-actions)
* [Marking messages as read](/help/marking-messages-as-read)
* [Marking messages as unread](/help/marking-messages-as-unread)
* [Emoji reactions](/help/emoji-reactions)
* [View your mentions](/help/view-your-mentions)
* [Star a message](/help/star-a-message)
* [View and browse images](/help/view-and-browse-images)
* [View messages sent by a user](/help/view-messages-sent-by-a-user)
* [Link to a message or conversation](/help/link-to-a-message-or-conversation)
* [Searching for messages](/help/search-for-messages)
* [View message Markdown source](/help/view-the-markdown-source-of-a-message)
* [View when message was sent](/help/view-the-exact-time-a-message-was-sent)
* [View a message's edit history](/help/view-a-messages-edit-history)
* [Collapse a message](/help/collapse-a-message)
* [Read receipts](/help/read-receipts)
## People
* [Status and availability](/help/status-and-availability)
* [User cards](/help/user-cards)
* [View someone's profile](/help/view-someones-profile)
* [Private messages](/help/private-messages)
## Streams & topics
* [Streams and topics](/help/streams-and-topics)
* [Browse and subscribe to streams](/help/browse-and-subscribe-to-streams)
* [Unsubscribe from a stream](/help/unsubscribe-from-a-stream)
* [Create a stream](/help/create-a-stream)
* [Add or remove users from a stream](/help/add-or-remove-users-from-a-stream)
* [Pin a stream](/help/pin-a-stream)
* [Change the color of a stream](/help/change-the-color-of-a-stream)
* [Start a new topic](/help/start-a-new-topic)
* [Rename a topic](/help/rename-a-topic)
* [Resolve a topic](/help/resolve-a-topic)
* [Move content to another topic](/help/move-content-to-another-topic)
* [Move content to another stream](/help/move-content-to-another-stream)
* [Delete a topic](/help/delete-a-topic)
* [Manage inactive streams](/help/manage-inactive-streams)
## Notifications
* [Stream notifications](/help/stream-notifications)
* [PMs, mentions, and alerts](/help/pm-mention-alert-notifications)
* [Mute a stream](/help/mute-a-stream)
* [Mute a topic](/help/mute-a-topic)
* [Mute a user](/help/mute-a-user)
* [Email notifications](/help/email-notifications)
* [Desktop notifications](/help/desktop-notifications)
* [Mobile notifications](/help/mobile-notifications)
## Apps
* [Desktop installation guides](/help/desktop-app-install-guide)
* [Zulip in a Terminal](/help/zulip-in-a-terminal)
* [Connect through a proxy](/help/connect-through-a-proxy)
* [Use a custom certificate](/help/custom-certificates)
# Zulip administration
## Organization basics
* [Review your organization's settings](/help/review-your-organization-settings)
* [Organization type](/help/organization-type)
* [Communities directory](/help/communities-directory)
* [Import from Mattermost](/help/import-from-mattermost)
* [Import from Slack](/help/import-from-slack)
* [Import from Gitter](/help/import-from-gitter)
* [Import from Rocket.Chat](/help/import-from-rocketchat)
* [Configure authentication methods](/help/configure-authentication-methods)
* [SAML authentication](/help/saml-authentication)
* [SCIM provisioning](/help/scim)
* [Export your organization](/help/export-your-organization)
* [Change organization URL](/help/change-organization-url)
* [Deactivate your organization](/help/deactivate-your-organization)
* [Usage statistics](/help/analytics)
* [Linking to your organization](/help/linking-to-zulip)
* [GDPR compliance](/help/gdpr-compliance)
## Users
* [Roles and permissions](/help/roles-and-permissions)
* [Invite new users](/help/invite-new-users)
* [Restrict account creation](/help/restrict-account-creation)
* [Deactivate or reactivate a user](/help/deactivate-or-reactivate-a-user)
* [Custom profile fields](/help/custom-profile-fields)
* [Configure default new user settings](/help/configure-default-new-user-settings)
* [Configure organization language](/help/configure-organization-language)
* [User groups](/help/user-groups)
* [Restrict visibility of email addresses](/help/restrict-visibility-of-email-addresses)
* [Change a user's role](/help/change-a-users-role)
* [Change a user's name](/help/change-a-users-name)
* [Manage a user's stream subscriptions](/help/manage-user-stream-subscriptions)
* [Restrict name and email changes](/help/restrict-name-and-email-changes)
* [Restrict profile picture changes](/help/restrict-profile-picture-changes)
* [Restrict permissions of new members](/help/restrict-permissions-of-new-members)
## Stream management
* [Stream permissions](/help/stream-permissions)
* [Public access option](/help/public-access-option)
* [Stream posting policy](/help/stream-sending-policy)
* [Restrict stream creation](/help/configure-who-can-create-streams)
* [Restrict stream invitation](/help/configure-who-can-invite-to-streams)
* [Add or remove users from a stream](/help/add-or-remove-users-from-a-stream)
* [Set default streams for new users](/help/set-default-streams-for-new-users)
* [Rename a stream](/help/rename-a-stream)
* [Change a stream's description](/help/change-the-stream-description)
* [Change the privacy of a stream](/help/change-the-privacy-of-a-stream)
* [Delete or archive a stream](/help/archive-a-stream)
## Organization settings
* [Custom emoji](/help/custom-emoji)
* [Add a custom linkifier](/help/add-a-custom-linkifier)
* [Require topics in stream messages](/help/require-topics)
* [Restrict private messages](/help/restrict-private-messages)
* [Restrict wildcard mentions](/help/restrict-wildcard-mentions)
* [Restrict topic editing](/help/configure-who-can-edit-topics)
* [Restrict message editing](/help/configure-message-editing-and-deletion)
* [Disable message edit history](/help/disable-message-edit-history)
* [Block image and link previews](/help/allow-image-link-previews)
* [Hide message content in emails](/help/hide-message-content-in-emails)
* [Message retention policy](/help/message-retention-policy)
* [Weekly digest emails](/help/digest-emails)
* [Disable welcome emails](/help/disable-welcome-emails)
* [Configure notification bot](/help/configure-notification-bot)
* [Configure multi-language search](/help/configure-multi-language-search)
## Bots & integrations
* [Bots and integrations](/help/bots-and-integrations)
* [Add a bot or integration](/help/add-a-bot-or-integration)
* [Edit a bot](/help/edit-a-bot)
* [Deactivate or reactivate a bot](/help/deactivate-or-reactivate-a-bot)
* [Request an integration](/help/request-an-integration)
* [Restrict bot creation](/help/restrict-bot-creation)
* [View all bots in your organization](/help/view-all-bots-in-your-organization)
## Support
* [View Zulip version](/help/view-zulip-version)
* [Zulip Cloud billing](/help/zulip-cloud-billing)
* [Contact support](/help/contact-support)

View File

@@ -0,0 +1 @@
1. [Open the compose box](/help/open-the-compose-box).

View File

@@ -0,0 +1,6 @@
{!send-group-pm.md!}
!!! tip ""
Rather than kicking off a group thread, consider starting the
conversation in a new topic to make it easier to browse later on.

View File

@@ -0,0 +1,3 @@
1. Hover over a stream in the left sidebar.
1. Click on the **ellipsis** (<i class="zulip-icon zulip-icon-ellipsis-v-solid"></i>).

View File

@@ -0,0 +1,4 @@
!!! tip ""
If you are viewing a single stream, you can access the long-press
menu from the bar at the top of the app.

View File

@@ -0,0 +1 @@
1. Press and hold a stream until the long-press menu appears.

View File

@@ -0,0 +1,20 @@
In Zulip, streams determine who gets a message. Topics tell you what the
message is about.
Topics are light-weight subjects, very similar to the subject line of an email.
Like in email or a forum, messages about the same topic are shown together as a
conversational thread. Here is what it looks like in Zulip.
![Streams and topics](/static/images/help/streams-and-topics.png)
Topics are one of the most wonderful aspects of using Zulip:
* Lots of conversations can happen in the same stream at the same time, each in
its own topic. You never have to worry about interrupting — each
conversation has its own space.
* Conversations can last many hours or days, letting everyone respond in their
own time. Don't worry about replying long after a message is sent —
everyone will see your reply in context.
Check out [Why Zulip](/why-zulip/) to learn more about how Zulip's topic model
helps transform how your organization communicates.

View File

@@ -0,0 +1,24 @@
{start_tabs}
{tab|web}
You can log in to multiple Zulip organizations by opening multiple tabs, and
logging into one Zulip organization in each tab. To switch Zulip organizations,
just switch tabs.
{tab|desktop}
1. Click on a logo in the **organizations sidebar** on the left, or choose
an organization from the **Window** menu in the top menu bar.
{!desktop-toggle-sidebar-tip.md!}
{tab|mobile}
{!mobile-profile-menu.md!}
1. Tap **Switch account**.
1. Tap on the desired Zulip organization.
{end_tabs}

View File

@@ -0,0 +1,17 @@
* It's often best to start with just a few streams, and add more as
needed. For small teams, you can start with the default streams and
go from there.
* For large organizations, we recommend using a consistent naming
scheme, like `#marketing/<name>` or `#mk/<name>` for all streams
pertaining to the marketing team, `#help/<team name>` for
`<team name>`'s internal support stream, etc.
* A `#zulip help` stream can be useful for providing internal Zulip
support and answering questions about Zulip.
* For open source projects or other volunteer organizations, consider
adding default streams like `#announce` for announcements, `#new
members` for new members to introduce themselves and be welcomed,
and `#help` so that there's a clear place users stopping by with
just a single question can post.

View File

@@ -0,0 +1,3 @@
1. Hover over a topic in the left sidebar.
1. Click on the **ellipsis** (<i class="zulip-icon zulip-icon-ellipsis-v-solid"></i>).

View File

@@ -0,0 +1,4 @@
!!! tip ""
If you are viewing a single topic, you can access the long-press
menu from the bar at the top of the app.

View File

@@ -0,0 +1 @@
1. Press and hold a topic until the long-press menu appears.

View File

@@ -0,0 +1,9 @@
Zulip has been translated or partially translated into dozens of
languages by Zulip's amazing community of volunteer translators.
You can see which languages Zulip supports [on Transifex][transifex-zulip].
If you'd like to help by contributing as a translator, see the
[Zulip translation guidelines][translating-zulip] to get started.
[transifex-zulip]: https://www.transifex.com/zulip/zulip/
[translating-zulip]: https://zulip.readthedocs.io/en/latest/translating/translating.html

View File

@@ -0,0 +1,11 @@
You can start by reading about how [Zulips](/hello/) unique
topic-based threading [combines the best of email and
chat](/why-zulip/) to make [remote work](https://zulip.com/for/business/) productive
and delightful.
We also highly recommend trying Zulip for yourself! You can:
* [Create a Zulip Cloud organization](/new/) for free with just a few
clicks.
* [Join the Zulip development community](/development-community/) to see
Zulip in action. Feel free to introduce yourself and ask questions!

View File

@@ -0,0 +1,3 @@
1. Make sure your Zulip Cloud organization is on the Zulip Cloud Plus plan. Contact
[support@zulip.com](mailto:support@zulip.com) to upgrade if needed.

View File

@@ -0,0 +1,3 @@
{!right-sidebar-user-card.md!}
1. Click on the **ellipsis** (<i class="zulip-icon zulip-icon-ellipsis-v-solid"></i>) in the user card.

View File

@@ -0,0 +1,15 @@
The public access option lets administrators configure selected streams to be
**web-public**. Web-public streams can be viewed by anyone on the Internet
without creating an account in your organization.
For example, you can [link to a Zulip
topic](/help/link-to-a-message-or-conversation) in a web-public stream
from a GitHub issue, a social media post, or a forum thread, and
anyone will be able to click the link and view the discussion in the
Zulip web application without needing to create an account.
To see this feature in action, you can [view web-public streams in the Zulip
development community](https://chat.zulip.org/) without logging in.
Users who wish to post content will need to create an account in order
to do so.

View File

@@ -0,0 +1,13 @@
To get the full benefits of Zulip's topic model, when starting a new
conversation, you should start a new topic!
Starting a topic is like a lighter weight version of giving your email a subject.
Topic names should be brief but specific, e.g.:
* **Good topic names:** "question about topics", "welcome Anna Smith!", "issue #1234"
* **Not so good topic names:** "question", "hi", "help", "this topic is about
a question I have about topics"
!!! tip ""
Don't overthink naming your topic. The first 2-3 words that come to mind
are probably fine!