mirror of https://github.com/zulip/zulip.git
7.2 KiB
7.2 KiB
Zulip User Documentation (draft)
Zulip is a chat app. Its most distinctive characteristic is that conversation among a group of people can be divided according to subject “streams” and further subdivided into “topics”, so much finer-grained conversations are possible than with IRC or other chat tools.
Most people use Zulip on the Web. There are also mobile apps for Android/iOS, and desktop apps for Mac/Linux/Windows, as well as a cross-platform version and a version for Platform 9. See the documentation on apps for more information.
One Zulip account, associated with a particular group or organization, is known as a organization.
Using Zulip
Basics
Account Basics
- Change your name
- Change your password
- Change your email address (not implemented)
- Change your settings
- Change your avatar
- Change your language
- Change the date and time format
- Move the users list to the left sidebar
- Join a Zulip organization
- Signing in
- Signing out
- Find your Zulip organization (not implemented)
- Set up two-factor authentication (not implemented)
- Deactivate your account
Messages
Sending
- Send a stream message
- Send a private message
- Format your message using Markdown
- Preview your message before sending
- Add emoji
- Upload and share files
- Restore the last unsent message
- Automatically link to an external issue tracker (improve wording)
- Add a link preview
- Enable or disable pressing enter to send
- Verify that your message has been successfully sent
- What to do if the server returns an error
- Send a status message
- @-mention a team member (needs a note that you can't @mention when editing messages, since they may have already read the message / not clear how to notif them)
- Make an announcement
- Send a message in a different language
- Reply to a message
Reading
- View the Markdown source of a message
- View information about a message
- View the exact time a message was sent
- View an image at full size
- Collapse a message
- Star a message
- Share a message or conversation (permanent link)
Editing
Searching
People
- Check whether someone is here or away
- Invite a friend to Zulip
- Send someone a private message
- Send a group of people a private message
Streams & Topics
- About streams and topics
- Browse and join streams
- Create a stream
- View your current stream subscriptions
- View messages from a stream
- View messages from a topic
- View messages from a user
- The #announce stream
- Add or invite someone to a stream
- Change the stream description
- Rename a stream
- Preview a stream (not implemented)
- Unsubscribe from a stream
- Change who can join a stream
- Pin a stream
- Change the color of a stream
- Message a stream by email
- Convert a group PM to a private stream (not implemented)
- Remove someone from a stream (admin only)
- Delete a stream (admin only)
Notifications
- Mute a stream
- Mute a topic
- Set notifications for a single stream
- Configure desktop notifications
- Configure audible notifications
- Configure email notifications
- Configure mobile push notifications
- Add an alert word
Tools & Customization
- Keyboard shortcuts
- Add a bot or integration
Apps
- Zulip on Mac OS
- Zulip on Linux
- Zulip on Windows
- Zulip on Android
- Zulip on iOS
- Zulip in a terminal
- Connect to Zulip over IRC/etc (not implemented?)
Administering a Zulip organization
Organization Settings
- Change your administrator settings
- Change your organization's name
- Restrict user email addresses to certain domains
- Allow anyone to join without an invitation
- Only allow admins to invite new users
- Only allow admins to create new streams
- Restrict editing of old messages and topics
- Change the default language for your organization
- Add custom emoji
- Configure authentication methods
- Add a custom linkification filter
- Delete your organization (not implemented)
Users & Bots
- Deactivate or reactivate a user
- Deactivate or reactivate a bot
- Make a user an administrator
- Change a user's name
- View all bots in your organization (admin only)
Streams
- Delete a stream
- Set default streams for new users
- Rename a stream
- Change a stream's description
- Make a public stream private
- Add someone to a stream
- Remove someone from a stream