mirror of
https://github.com/zulip/zulip.git
synced 2025-10-23 04:52:12 +00:00
help-beta: Add MDX files to git.
We have not yet removed the help files. We can use this commit as a conversion commit since a lot more help changes will be merged before this PR gets merged. We will need to rebase on top of main, run conversion step in this commit, push those changes and then merge the PR. NOTE: This commit temporarily breaks the astro build since we have renamed the path in the MDX files from starlight_help/ to help/ early. That should be fine since astro build will not break any tests right now. We should squash this commit with the next commit removing help center files when merging into main and remove this NOTE.
This commit is contained in:
committed by
Tim Abbott
parent
8f16f1139e
commit
40f723c75a
1
starlight_help/.gitignore
vendored
1
starlight_help/.gitignore
vendored
@@ -12,7 +12,6 @@ yarn-debug.log*
|
||||
yarn-error.log*
|
||||
pnpm-debug.log*
|
||||
|
||||
*.mdx
|
||||
*.md
|
||||
|
||||
|
||||
|
60
starlight_help/src/content/docs/add-a-bot-or-integration.mdx
Normal file
60
starlight_help/src/content/docs/add-a-bot-or-integration.mdx
Normal file
@@ -0,0 +1,60 @@
|
||||
---
|
||||
title: Add a bot or integration
|
||||
---
|
||||
|
||||
import NavigationSteps from "../../components/NavigationSteps.astro"
|
||||
import ZulipNote from '../../components/ZulipNote.astro';
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
import DownloadIcon from "~icons/fa/download"
|
||||
import { Tabs, TabItem } from '@astrojs/starlight/components'
|
||||
|
||||
By default, anyone other than guests can add a bot to a Zulip organization.
|
||||
A bot that sends content to or from another product is often called an
|
||||
[integration](/help/integrations-overview).
|
||||
|
||||
Organization administrators can also
|
||||
[restrict bot creation](/help/restrict-bot-creation). Any bot that is added
|
||||
is visible and available for anyone to use.
|
||||
|
||||
## Add a bot or integration
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Via personal settings">
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/your-bots" />
|
||||
|
||||
1. Click **Add a new bot**.
|
||||
1. Fill out the fields, and click **Add**.
|
||||
</FlattenedSteps>
|
||||
</TabItem>
|
||||
|
||||
<TabItem label="Via organization settings">
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/bot-list-admin" />
|
||||
|
||||
1. Click **Add a new bot**.
|
||||
1. Fill out the fields, and click **Add**.
|
||||
</FlattenedSteps>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
<ZulipNote>
|
||||
See [bots overview](/help/bots-overview) for more information about
|
||||
the various fields.
|
||||
Nearly all third-party integrations should use **Incoming webhook**
|
||||
as the **bot type**.
|
||||
</ZulipNote>
|
||||
|
||||
Depending on the type of bot you're creating, you may need to download its
|
||||
`zuliprc` configuration file. For that, click the **download**
|
||||
(<DownloadIcon />) icon under the bot's name.
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Bots overview](/help/bots-overview)
|
||||
* [Integrations overview](/help/integrations-overview)
|
||||
* [Manage a bot](/help/manage-a-bot)
|
||||
* [Deactivate or reactivate a bot](/help/deactivate-or-reactivate-a-bot)
|
||||
* [Restrict bot creation](/help/restrict-bot-creation)
|
||||
* [View all bots in your organization](/help/view-all-bots-in-your-organization)
|
||||
* [Generate URL for an integration](/help/generate-integration-url)
|
204
starlight_help/src/content/docs/add-a-custom-linkifier.mdx
Normal file
204
starlight_help/src/content/docs/add-a-custom-linkifier.mdx
Normal file
@@ -0,0 +1,204 @@
|
||||
---
|
||||
title: Add a custom linkifier
|
||||
---
|
||||
|
||||
import NavigationSteps from "../../components/NavigationSteps.astro"
|
||||
import EditIcon from "~icons/zulip-icon/edit"
|
||||
import ZulipTip from '../../components/ZulipTip.astro';
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
import ExternalLinkIcon from "~icons/zulip-icon/external-link"
|
||||
import TrashIcon from "~icons/zulip-icon/trash"
|
||||
import AdminOnly from "./include/_AdminOnly.mdx"
|
||||
|
||||
<AdminOnly />
|
||||
|
||||
Linkifiers make it easy to refer to issues or tickets in third
|
||||
party issue trackers, like GitHub, Salesforce, Zendesk, and others.
|
||||
For instance, you can add a linkifier that automatically turns `#2468`
|
||||
into a link to `https://github.com/zulip/zulip/issues/2468`.
|
||||
|
||||
If the pattern appears in a topic, Zulip adds an
|
||||
**Open** (<ExternalLinkIcon />) button
|
||||
to the right of the topic in the message recipient bar that links to
|
||||
the appropriate URL.
|
||||
|
||||
If you have any trouble creating the linkifiers you want, please [contact Zulip
|
||||
support](/help/contact-support) with details on what you're trying to do.
|
||||
|
||||
## Add a custom linkifier
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/linkifier-settings" />
|
||||
|
||||
1. Under **Add a new linkifier**, enter a **Pattern** and
|
||||
**URL template**.
|
||||
1. Click **Add linkifier**.
|
||||
</FlattenedSteps>
|
||||
|
||||
## Edit a custom linkifier
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/linkifier-settings" />
|
||||
|
||||
1. In the **Actions** column, click the **edit** (<EditIcon />)
|
||||
icon for the linkifier you want to edit.
|
||||
1. Edit linkifier information as desired, and click **Save changes**.
|
||||
</FlattenedSteps>
|
||||
|
||||
## Delete a custom linkifier
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/linkifier-settings" />
|
||||
|
||||
1. In the **Actions** column, click the **delete** (<TrashIcon />) icon for the linkifier you want to delete.
|
||||
1. Approve by clicking **Confirm**.
|
||||
</FlattenedSteps>
|
||||
|
||||
## Reorder linkifiers
|
||||
|
||||
Linkifiers are processed in order, and will not apply to text that
|
||||
is already linkified. You can therefore choose which linkifiers to prioritize
|
||||
when more than one linkifier applies. See the
|
||||
[overlapping patterns section](#overlapping-patterns) for examples.
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/linkifier-settings" />
|
||||
|
||||
1. In the **Pattern** column under **Linkifiers**, click and drag the vertical
|
||||
dots to reorder the list of linkifiers.
|
||||
</FlattenedSteps>
|
||||
|
||||
## Common linkifier patterns
|
||||
|
||||
The following examples cover the most common types of linkifiers, with a focus
|
||||
on linkifiers for issues or tickets.
|
||||
|
||||
### Link to an issue or ticket
|
||||
|
||||
This is a pattern that turns a `#` followed by a number into a link. It is often
|
||||
used to link to issues or tickets in third party issue trackers, like GitHub,
|
||||
Salesforce, Zendesk, and others.
|
||||
|
||||
* Pattern: `#(?P<id>[0-9]+)`
|
||||
* URL template: `https://github.com/zulip/zulip/issues/\{id\}`
|
||||
* Original text: `#2468`
|
||||
* Automatically links to: `https://github.com/zulip/zulip/issues/2468`
|
||||
|
||||
### Link to issues or tickets in multiple projects or apps
|
||||
|
||||
To set up linkifiers for issues or tickets in multiple projects,
|
||||
consider extending the `#2468` format with project-specific
|
||||
variants. For example, the Zulip development community
|
||||
[uses](https://zulip.com/development-community/#linking-to-github-issues-and-pull-requests)
|
||||
`#M2468` for an issue in the repository for the Zulip mobile app,
|
||||
`#D2468` and issue in the desktop app repository, etc.
|
||||
|
||||
* Pattern: `#F(?P<id>[0-9]+)`
|
||||
* URL template: `https://github.com/zulip/zulip-flutter/issues/\{id\}`
|
||||
* Original text: `#F245`
|
||||
* Automatically links to: `https://github.com/zulip/zulip-flutter/issues/245`
|
||||
|
||||
### Link to issues or tickets in multiple repositories
|
||||
|
||||
For organizations that commonly link to multiple GitHub repositories, this
|
||||
linkfier pattern turns `org/repo#ID` into an issue or pull request link.
|
||||
|
||||
* Pattern: `(?P<org>[a-zA-Z0-9_-]+)/(?P<repo>[a-zA-Z0-9_-]+)#(?P<id>[0-9]+)`
|
||||
* URL template: `https://github.com/\{org\}/\{repo\}/issues/\{id\}`
|
||||
* Original text: `zulip/zulip#2468`
|
||||
* Automatically links to: `https://github.com/zulip/zulip/issues/2468`
|
||||
|
||||
### Link to a hexadecimal issue or ticket number
|
||||
|
||||
The following pattern linkfies a string of hexadecimal digits between 7 and 40
|
||||
characters long, such as a Git commit ID.
|
||||
|
||||
* Pattern: `(?P<id>[0-9a-f]\{7,40\})`
|
||||
* URL template: `https://github.com/zulip/zulip/commit/\{id\}`
|
||||
* Original text: `abdc123`
|
||||
* Automatically links to: `https://github.com/zulip/zulip/commit/abcd123`
|
||||
|
||||
## Advanced linkifier patterns
|
||||
|
||||
Linkifiers are a flexible system that can be used to construct rules for a wide
|
||||
variety of situations. Linkifier patterns are regular expressions, using the
|
||||
[re2](https://github.com/google/re2/wiki/Syntax) regular expression
|
||||
engine.
|
||||
|
||||
Linkifiers use [RFC 6570](https://www.rfc-editor.org/rfc/rfc6570.html) compliant
|
||||
URL templates to describe how links should be generated. These templates support
|
||||
several expression types. The default expression type (`\{var\}`) will URL-encode
|
||||
special characters like `/` and `&`; this behavior is desired for the vast
|
||||
majority of linkifiers. Fancier URL template expression types can allow you to
|
||||
get the exact behavior you want in corner cases like optional URL query
|
||||
parameters. For example:
|
||||
|
||||
* Use `\{+var\}` when you want URL delimiter characters to not be URL-encoded.
|
||||
* Use `\{?var\}` and `\{&var\}` for variables in URL query parameters.
|
||||
* Use <code>\{#var}</code> when generating `#` fragments in URLs.
|
||||
|
||||
The URL template specification has [brief
|
||||
examples](https://www.rfc-editor.org/rfc/rfc6570.html#section-1.2) and [detailed
|
||||
examples](https://www.rfc-editor.org/rfc/rfc6570.html#section-3.2) explaining
|
||||
the precise behavior of URL templates.
|
||||
|
||||
### Linking to documentation pages
|
||||
|
||||
This example pattern is a shorthand for linking to pages on Zulip's ReadTheDocs
|
||||
site.
|
||||
|
||||
* Pattern: `RTD/(?P<article>[a-zA-Z0-9_/.#-]+)`
|
||||
* URL template: `https://zulip.readthedocs.io/en/latest/\{+article\}`
|
||||
* Original text: `RTD/overview/changelog.html`
|
||||
* Automatically links to: `https://zulip.readthedocs.io/en/latest/overview/changelog.html`
|
||||
|
||||
<ZulipTip>
|
||||
This pattern uses the `\{+var\}` expression type. With the
|
||||
default expression type (`\{article\}`), the `/` between `overview` and
|
||||
`changelog` would incorrectly be URL-encoded.
|
||||
</ZulipTip>
|
||||
|
||||
### Linking to Google search results
|
||||
|
||||
This example pattern allows linking to Google searches.
|
||||
|
||||
* Pattern: `google:(?P<q>\w+)?`
|
||||
* URL template: `https://google.com/search\{?q\}`
|
||||
* Original text: `google:foo` or `google:`
|
||||
* Automatically links to: `https://google.com/search?q=foo` or `https://google.com/search`
|
||||
|
||||
<ZulipTip>
|
||||
This pattern uses the `\{?var\}` expression type. With the default expression
|
||||
type (`\{q\}`), there would be no way to only include the `?` in the URL
|
||||
if the optional `q` is present.
|
||||
</ZulipTip>
|
||||
|
||||
### Overlapping patterns
|
||||
|
||||
In this example, a general linkifier is configured to make GitHub
|
||||
repository references like `zulip-desktop#123` link to issues in that
|
||||
repository within the `zulip` GitHub organization. A more specific
|
||||
linkifier overrides that linkifier for a specific repository of
|
||||
interest (`django/django`) that is in a different organization.
|
||||
|
||||
* Specific linkifier (ordered before the general linkifier)
|
||||
* Pattern: `django#(?P<id>[0-9]+)`
|
||||
* URL template: `https://github.com/django/django/pull/\{id\}`
|
||||
* General linkifier
|
||||
* Pattern: `(?P<repo>[a-zA-Z0-9_-]+)#(?P<id>[0-9]+)`
|
||||
* URL template: `https://github.com/zulip/\{repo\}/pull/\{id\}`
|
||||
* Example matching both linkifiers; specific linkifier takes precedence:
|
||||
* Original text: `django#123`
|
||||
* Automatically links to: `https://github.com/django/django/pull/123`
|
||||
* Example matching only the general linkifier:
|
||||
* Original text: `zulip-desktop#123`
|
||||
* Automatically links to: `https://github.com/zulip/zulip-desktop/pull/123`
|
||||
|
||||
<ZulipTip>
|
||||
This set of patterns has overlapping regular expressions. Note that
|
||||
the general linkifier pattern would match `lorem#123` too. The specific
|
||||
linkifier will only get prioritized over the general linkifier if it is
|
||||
ordered before the more general pattern. This can be customized by
|
||||
dragging and dropping existing linkifiers into the desired order. New
|
||||
linkifiers will automatically be ordered last.
|
||||
</ZulipTip>
|
21
starlight_help/src/content/docs/analytics.mdx
Normal file
21
starlight_help/src/content/docs/analytics.mdx
Normal file
@@ -0,0 +1,21 @@
|
||||
---
|
||||
title: Usage statistics
|
||||
---
|
||||
|
||||
import NavigationSteps from "../../components/NavigationSteps.astro"
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
|
||||
Zulip provides detailed analytics to help you see how you and your team are
|
||||
using Zulip. The **Organization summary** section of the usage statistics page
|
||||
includes your organization's overall usage information such as the total number
|
||||
of users, guests, messages, and storage in use.
|
||||
|
||||
You will also find interactive graphs that provide a detailed breakdown of
|
||||
your organization's number of active users, messages sent, messages received,
|
||||
and how these statistics have changed over time.
|
||||
|
||||
## View organization statistics
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="relative/gear/stats" />
|
||||
</FlattenedSteps>
|
84
starlight_help/src/content/docs/animated-gifs-from-giphy.mdx
Normal file
84
starlight_help/src/content/docs/animated-gifs-from-giphy.mdx
Normal file
@@ -0,0 +1,84 @@
|
||||
---
|
||||
title: Animated GIFs from GIPHY
|
||||
---
|
||||
|
||||
import NavigationSteps from "../../components/NavigationSteps.astro"
|
||||
import ZulipNote from '../../components/ZulipNote.astro';
|
||||
import ZulipTip from '../../components/ZulipTip.astro';
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
import SaveChanges from "./include/_SaveChanges.mdx"
|
||||
import { Steps } from '@astrojs/starlight/components';
|
||||
import StartComposing from "./include/_StartComposing.mdx"
|
||||
import GifIcon from "~icons/zulip-icon/gif"
|
||||
import { Tabs, TabItem } from '@astrojs/starlight/components'
|
||||
import AdminOnly from "./include/_AdminOnly.mdx"
|
||||
|
||||
<ZulipNote>
|
||||
On self-hosted servers, this feature need to be
|
||||
[configured][configure-giphy] by a server administrator.
|
||||
</ZulipNote>
|
||||
|
||||
Zulip integrates with [GIPHY](https://giphy.com), allowing you to
|
||||
conveniently search for animated GIFs and include them in your
|
||||
messages.
|
||||
|
||||
Organization administrators can [disable previews of linked
|
||||
images](/help/image-video-and-website-previews#configure-whether-image-and-video-previews-are-shown),
|
||||
including GIFs. When previews are enabled, everyone can
|
||||
[customize](/help/image-video-and-website-previews#configure-how-animated-images-are-played)
|
||||
how animated images are played.
|
||||
|
||||
## Insert a GIF
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Desktop/Web">
|
||||
<Steps>
|
||||
1. Click the **add GIF** (<GifIcon />) icon at
|
||||
the bottom of the compose box.
|
||||
1. Find a GIF you'd like to use.
|
||||
1. Click on an image to insert it in the compose box.
|
||||
</Steps>
|
||||
|
||||
<ZulipTip>
|
||||
You can [preview your message](/help/preview-your-message-before-sending)
|
||||
before sending.
|
||||
</ZulipTip>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Restrict maximum rating of GIFs retrieved from GIPHY
|
||||
|
||||
<AdminOnly />
|
||||
|
||||
By default, the GIPHY integration is configured to only retrieve GIFs
|
||||
that GIPHY categorizes as rated G (General audience). You can change
|
||||
this configure or disable GIPHY integration entirely:
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/organization-settings" />
|
||||
|
||||
1. Under **Compose settings**, select a rating for **GIPHY integration**.
|
||||
|
||||
<SaveChanges />
|
||||
</FlattenedSteps>
|
||||
|
||||
## Privacy
|
||||
|
||||
GIPHY is a third-party service owned by Facebook, and any text you
|
||||
enter into Zulip's GIPHY search box will be sent by your browser to
|
||||
GIPHY's servers via the GIPHY API. Because this request is done
|
||||
directly by your browser, GIPHY will be able to see your IP address,
|
||||
and may use that data to track you, similar to if you visited the
|
||||
GIPHY website and typed the same search keywords there.
|
||||
|
||||
Zulip proxies all external images in messages through the server,
|
||||
including those from GIPHY, to prevent images from being used to track
|
||||
recipients of GIFs from GIPHY.
|
||||
|
||||
[configure-giphy]: https://zulip.readthedocs.io/en/stable/production/giphy-gif-integration.html
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Image, video and website previews](/help/image-video-and-website-previews)
|
||||
* [Share and upload files](/help/share-and-upload-files)
|
||||
* [Insert a link](/help/insert-a-link)
|
110
starlight_help/src/content/docs/archive-a-channel.mdx
Normal file
110
starlight_help/src/content/docs/archive-a-channel.mdx
Normal file
@@ -0,0 +1,110 @@
|
||||
---
|
||||
title: Archive a channel
|
||||
---
|
||||
|
||||
import NavigationSteps from "../../components/NavigationSteps.astro"
|
||||
import MoreVerticalIcon from "~icons/zulip-icon/more-vertical"
|
||||
import ArchiveIcon from "~icons/zulip-icon/archive"
|
||||
import ZulipTip from '../../components/ZulipTip.astro';
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
import UnarchiveIcon from "~icons/zulip-icon/unarchive"
|
||||
import SelectChannelViewGeneral from "./include/_SelectChannelViewGeneral.mdx"
|
||||
import { Tabs, TabItem } from '@astrojs/starlight/components'
|
||||
|
||||
You can archive channels you no longer plan to use. Archiving a channel:
|
||||
|
||||
* Removes it from the left sidebar for all users.
|
||||
* Prevents new messages from being sent to the channel.
|
||||
* Prevents messages in the channel from being edited, deleted, or moved.
|
||||
|
||||
Archiving a channel does not unsubscribe users, or change who can access it.
|
||||
Messages in archived channels still appear in [search
|
||||
results](/help/search-for-messages), the [combined feed](/help/combined-feed),
|
||||
and [recent conversations](/help/recent-conversations). If you prefer, you can
|
||||
configure an archived channel to [hide its
|
||||
content](#hide-content-in-an-archived-channel).
|
||||
|
||||
## Archive a channel
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Desktop/Web">
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="relative/channel/all" />
|
||||
|
||||
1. Select a channel.
|
||||
1. Click the **archive** (<ArchiveIcon />) icon
|
||||
in the upper right corner of the channel settings panel.
|
||||
1. Click **Confirm**.
|
||||
</FlattenedSteps>
|
||||
|
||||
<ZulipTip>
|
||||
You can also hover over a channel in the left sidebar, click on the
|
||||
**ellipsis** (<MoreVerticalIcon />), and
|
||||
select **Channel settings** to access settings for the channel.
|
||||
</ZulipTip>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## View archived channels
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Desktop/Web">
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="relative/channel/all" />
|
||||
|
||||
1. Select **Archived channels** from the dropdown next to the **Filter** box
|
||||
above the list of channels.
|
||||
</FlattenedSteps>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Hide content in an archived channel
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Desktop/Web">
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="relative/channel/all" />
|
||||
|
||||
1. Select **Archived channels** from the dropdown next to the **Filter** box
|
||||
above the list of channels.
|
||||
1. Select a channel.
|
||||
1. Select the **Subscribers** tab on the right.
|
||||
1. Remove all subscribers.
|
||||
|
||||
<SelectChannelViewGeneral />
|
||||
|
||||
1. Under **Channel permissions**, [make the channel
|
||||
private](/help/change-the-privacy-of-a-channel).
|
||||
1. Click **Advanced configuration** to view advanced configuration options.
|
||||
1. Under **Subscription permissions**, remove everyone from **Who can subscribe
|
||||
to this channel**, and **Who can subscribe anyone to this channel**. These
|
||||
permissions give users content access to the channel.
|
||||
</FlattenedSteps>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
You can also make these configuration changes prior to archiving a channel.
|
||||
|
||||
## Unarchive a channel
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Desktop/Web">
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="relative/channel/all" />
|
||||
|
||||
1. Select **Archived channels** from the dropdown in the upper left.
|
||||
1. Select a channel.
|
||||
1. Click the **unarchive** (<UnarchiveIcon />)
|
||||
icon in the upper right corner of the channel settings panel.
|
||||
1. Click **Confirm**.
|
||||
</FlattenedSteps>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Edit a message](/help/edit-a-message)
|
||||
* [Delete a message](/help/delete-a-message)
|
||||
* [Delete a topic](/help/delete-a-topic)
|
||||
* [Message retention policy](/help/message-retention-policy)
|
||||
* [Channel permissions](/help/channel-permissions)
|
87
starlight_help/src/content/docs/bots-overview.mdx
Normal file
87
starlight_help/src/content/docs/bots-overview.mdx
Normal file
@@ -0,0 +1,87 @@
|
||||
---
|
||||
title: Bots overview
|
||||
---
|
||||
|
||||
Bots allow you to
|
||||
|
||||
* Send content into and out of Zulip.
|
||||
* Send content to and from another product.
|
||||
* Automate tasks a human user could do.
|
||||
|
||||
A bot that sends content to or from another product is often called an
|
||||
[integration](/help/integrations-overview).
|
||||
|
||||
## Pre-made bots
|
||||
|
||||
Zulip natively supports integrations with over one hundred products, and with
|
||||
almost a thousand more through Zapier and IFTTT. If you're looking to add an
|
||||
integration with an existing product, see our
|
||||
[list of integrations](/integrations/), along with those of
|
||||
[Zapier](https://zapier.com/apps) and [IFTTT](https://ifttt.com/search).
|
||||
|
||||
## Anatomy of a bot
|
||||
|
||||
You can think of a bot as a special kind of user, with limited permissions.
|
||||
Each bot has a **name**, **profile picture**, **email**, **bot type** and **API key**.
|
||||
|
||||
* The **name** and **profile picture** play the same role they do for human users. They
|
||||
are the most visible attributes of a bot.
|
||||
* The **email** is not used for anything, and will likely be removed in a
|
||||
future version of Zulip.
|
||||
* The **bot type** determines what the bot can and can't do (see below).
|
||||
* The **API key** is how the bot identifies itself to Zulip. Anyone with the
|
||||
bot's API key can impersonate the bot.
|
||||
|
||||
## Bot type
|
||||
|
||||
The **bot type** determines what the bot can do.
|
||||
|
||||
Bot type | Permissions | Common uses
|
||||
\---|---|---
|
||||
Generic | Like a normal user account | Automating tasks, bots that listen to all messages on a channel
|
||||
Incoming webhook | Limited to only sending messages into Zulip | Automated notifications into Zulip
|
||||
Outgoing webhook | Generic bot that also receives new messages via HTTP post requests | Third party integrations, most custom bots
|
||||
|
||||
It's generally best to pick the most restricted bot type that is sufficient
|
||||
to do the task at hand. Anyone with the bot's API key can do anything the
|
||||
bot can.
|
||||
|
||||
A few more details:
|
||||
|
||||
* Bots can send messages to any channel that their owner can,
|
||||
inheriting their owner's [sending permissions](/help/channel-posting-policy).
|
||||
* Bots can be subscribed to channels, and their role can be modified if
|
||||
they need to have permission to do administrative actions.
|
||||
* [Channel permissions](/help/channel-permissions) are the same for bots
|
||||
as for other users. Therefore, for private channels with protected
|
||||
history, a bot can only access messages sent after it was subscribed
|
||||
to the channel.
|
||||
* **Generic**: A generic bot is like a normal Zulip user account that
|
||||
cannot log in via a browser. Note that if you truly want to
|
||||
impersonate yourself (e.g., write messages that come from your Zulip
|
||||
account), you'll need to use your **personal API key**.
|
||||
* **Outgoing webhook**: The bot can read direct messages where the bot
|
||||
is a participant, and channel messages where the bot is
|
||||
[mentioned](/help/mention-a-user-or-group). When the bot is DM'd or
|
||||
mentioned, it POSTs the message content to a URL of your choice. The
|
||||
POST request format can be in a Zulip format or a Slack-compatible
|
||||
format. This is the preferred bot type for interactive bots built on
|
||||
top of Zulip Botserver.
|
||||
|
||||
## Adding bots
|
||||
|
||||
By default, anyone other than guests can [add a bot](/help/add-a-bot-or-integration) to a
|
||||
Zulip organization, but administrators can
|
||||
[restrict bot creation](/help/restrict-bot-creation). Any bot that is added
|
||||
is visible and available for anyone to use.
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Integrations overview](/help/integrations-overview)
|
||||
* [Add a bot or integration](/help/add-a-bot-or-integration)
|
||||
* [Manage a bot](/help/manage-a-bot)
|
||||
* [Request an integration](/help/request-an-integration)
|
||||
* [Deactivate or reactivate a bot](/help/deactivate-or-reactivate-a-bot)
|
||||
* [Restrict bot creation](/help/restrict-bot-creation)
|
||||
* [View all bots in your organization](/help/view-all-bots-in-your-organization)
|
||||
* [Generate URL for an integration](/help/generate-integration-url)
|
60
starlight_help/src/content/docs/bulleted-lists.mdx
Normal file
60
starlight_help/src/content/docs/bulleted-lists.mdx
Normal file
@@ -0,0 +1,60 @@
|
||||
---
|
||||
title: Bulleted lists
|
||||
---
|
||||
|
||||
import BulletedListsExamples from "./include/_BulletedListsExamples.mdx"
|
||||
import ZulipTip from '../../components/ZulipTip.astro';
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
import BulletedListsIntro from "./include/_BulletedListsIntro.mdx"
|
||||
import UnorderedListIcon from "~icons/zulip-icon/unordered-list"
|
||||
import StartComposing from "./include/_StartComposing.mdx"
|
||||
import { Tabs, TabItem } from '@astrojs/starlight/components'
|
||||
|
||||
<BulletedListsIntro />
|
||||
|
||||
## Create a bulleted list
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Via compose box button">
|
||||
<FlattenedSteps>
|
||||
<StartComposing />
|
||||
|
||||
1. *(optional)* Select the text you want to format.
|
||||
1. Click the **Bulleted list**
|
||||
(<UnorderedListIcon />) icon at the
|
||||
bottom of the compose box to insert list formatting.
|
||||
1. Press <kbd>Enter</kbd> to automatically add a new bullet to the list.
|
||||
1. When your list is done, press <kbd>Enter</kbd> a second time to remove the
|
||||
bullet.
|
||||
</FlattenedSteps>
|
||||
|
||||
<ZulipTip>
|
||||
You can also use the **Bulleted list**
|
||||
(<UnorderedListIcon />) icon
|
||||
to remove existing list formatting from the current line or selected text.
|
||||
</ZulipTip>
|
||||
</TabItem>
|
||||
|
||||
<TabItem label="Via Markdown">
|
||||
<FlattenedSteps>
|
||||
<StartComposing />
|
||||
|
||||
1. Type `*`, `-`, or `+` followed by a space and some text to start a bulleted
|
||||
list.
|
||||
1. Press <kbd>Enter</kbd> to automatically add a new bullet to the list.
|
||||
1. When your list is done, press <kbd>Enter</kbd> a second time to remove the
|
||||
bullet.
|
||||
</FlattenedSteps>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Examples
|
||||
|
||||
<BulletedListsExamples />
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Message formatting](/help/format-your-message-using-markdown)
|
||||
* [Preview messages before sending](/help/preview-your-message-before-sending)
|
||||
* [Resize the compose box](/help/resize-the-compose-box)
|
||||
* [Numbered lists](/help/numbered-lists)
|
55
starlight_help/src/content/docs/change-a-users-name.mdx
Normal file
55
starlight_help/src/content/docs/change-a-users-name.mdx
Normal file
@@ -0,0 +1,55 @@
|
||||
---
|
||||
title: Change a user's name
|
||||
---
|
||||
|
||||
import NavigationSteps from "../../components/NavigationSteps.astro"
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
import SaveChanges from "./include/_SaveChanges.mdx"
|
||||
import ManageUserTabTip from "./include/_ManageUserTabTip.mdx"
|
||||
import ManageThisUser from "./include/_ManageThisUser.mdx"
|
||||
import UserCogIcon from "~icons/zulip-icon/user-cog"
|
||||
import { Tabs, TabItem } from '@astrojs/starlight/components'
|
||||
import AdminOnly from "./include/_AdminOnly.mdx"
|
||||
|
||||
<AdminOnly />
|
||||
|
||||
By default, users can [change their name](/help/change-your-name), though
|
||||
organization administrators can
|
||||
[restrict name changes](/help/restrict-name-and-email-changes).
|
||||
|
||||
Organization administrators can always change any user's name.
|
||||
|
||||
## Change a user's name
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Via user profile">
|
||||
<FlattenedSteps>
|
||||
<ManageThisUser />
|
||||
|
||||
1. Under **Name**, enter a new name.
|
||||
|
||||
<SaveChanges />
|
||||
</FlattenedSteps>
|
||||
|
||||
<ManageUserTabTip />
|
||||
</TabItem>
|
||||
|
||||
<TabItem label="Via organization settings">
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/users" />
|
||||
|
||||
1. Find the user you would like to manage. Click the
|
||||
**manage user** (<UserCogIcon />) icon
|
||||
to the right of their name.
|
||||
1. Under **Name**, enter a new name.
|
||||
|
||||
<SaveChanges />
|
||||
</FlattenedSteps>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Change a user's role](/help/user-roles#change-a-users-role)
|
||||
* [Deactivate or reactivate a user](/help/deactivate-or-reactivate-a-user)
|
||||
* [Manage a user](/help/manage-a-user)
|
79
starlight_help/src/content/docs/change-organization-url.mdx
Normal file
79
starlight_help/src/content/docs/change-organization-url.mdx
Normal file
@@ -0,0 +1,79 @@
|
||||
---
|
||||
title: Change organization URL
|
||||
---
|
||||
|
||||
import { Steps } from '@astrojs/starlight/components';
|
||||
import CloudPlusOnly from "./include/_CloudPlusOnly.mdx"
|
||||
import ZulipTip from '../../components/ZulipTip.astro';
|
||||
import OwnerOnly from "./include/_OwnerOnly.mdx"
|
||||
|
||||
<OwnerOnly />
|
||||
|
||||
Zulip supports changing the URL for an organization. Users who navigate to the
|
||||
old URL in the browser will see a notice about the organization being moved,
|
||||
prior to being redirected to the new URL. [Links to channels, topics and
|
||||
messages](/help/link-to-a-message-or-conversation) will thus continue to work.
|
||||
|
||||
When you change the URL:
|
||||
|
||||
* All users will be logged out of the web, mobile and desktop apps.
|
||||
* Any [API clients](/api/) or [integrations](/integrations/) will need
|
||||
to be updated to point to the new organization URL.
|
||||
|
||||
<ZulipTip>
|
||||
Consider using a [wildcard
|
||||
mention](/help/mention-a-user-or-group#mention-everyone-on-a-channel)
|
||||
in an announcement channel to let users know about an upcoming change.
|
||||
</ZulipTip>
|
||||
|
||||
## Change your Zulip Cloud subdomain
|
||||
|
||||
Zulip Cloud organizations are generally hosted at `<subdomain>.zulipchat.com`,
|
||||
with the subdomain chosen when the organization was created. Organization
|
||||
[owners](/help/user-roles) can request to change the subdomain.
|
||||
|
||||
Please email [support@zulip.com](mailto:support@zulip.com) with the following
|
||||
information:
|
||||
|
||||
<Steps>
|
||||
1. Your organization's current subdomain.
|
||||
1. The subdomain you would like to move your organization to.
|
||||
1. Whether you want links to the old subdomain to redirect to the new one for an
|
||||
extended period of time. By default, the old subdomain may be freed up for
|
||||
reuse after 3 months.
|
||||
</Steps>
|
||||
|
||||
## Move to a custom URL on Zulip Cloud
|
||||
|
||||
<CloudPlusOnly />
|
||||
|
||||
Because maintaining custom URLs requires effort from our operational team,
|
||||
this feature is available only for organizations with 25+ [Zulip Cloud
|
||||
Plus](https://zulip.com/plans/#cloud) licenses.
|
||||
|
||||
Please email [support@zulip.com](mailto:support@zulip.com) with the following
|
||||
information:
|
||||
|
||||
<Steps>
|
||||
1. Your organization's current URL.
|
||||
1. The URL you would like to move your organization to.
|
||||
</Steps>
|
||||
|
||||
## Change the URL for your self-hosted server
|
||||
|
||||
If you're self-hosting, you can change the root domain of your Zulip
|
||||
server by changing the `EXTERNAL_HOST` [setting][zulip-settings]. If
|
||||
you're [hosting multiple organizations][zulip-multiple-organizations]
|
||||
and want to change the subdomain for one of them, you can do this
|
||||
using the `change_realm_subdomain` [management command][management-commands].
|
||||
|
||||
In addition to configuring Zulip as detailed here, you also need to
|
||||
generate [SSL certificates][ssl-certificates] for your new domain.
|
||||
|
||||
[ssl-certificates]: https://zulip.readthedocs.io/en/stable/production/ssl-certificates.html
|
||||
|
||||
[zulip-settings]: https://zulip.readthedocs.io/en/stable/production/settings.html
|
||||
|
||||
[zulip-multiple-organizations]: https://zulip.readthedocs.io/en/stable/production/multiple-organizations.html
|
||||
|
||||
[management-commands]: https://zulip.readthedocs.io/en/stable/production/management-commands.html#other-useful-manage-py-commands
|
@@ -0,0 +1,70 @@
|
||||
---
|
||||
title: Change a channel's description
|
||||
---
|
||||
|
||||
import NavigationSteps from "../../components/NavigationSteps.astro"
|
||||
import EditIcon from "~icons/zulip-icon/edit"
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
import AutomatedNoticeChannelEvent from "./include/_AutomatedNoticeChannelEvent.mdx"
|
||||
import SaveChanges from "./include/_SaveChanges.mdx"
|
||||
import ChannelSettingsGeneralTabTip from "./include/_ChannelSettingsGeneralTabTip.mdx"
|
||||
import SelectChannelViewGeneral from "./include/_SelectChannelViewGeneral.mdx"
|
||||
import { Tabs, TabItem } from '@astrojs/starlight/components'
|
||||
|
||||
Channel descriptions can be used to explain the purpose of a channel, and link
|
||||
to usage guidelines, resources, or related channels. They appear in the
|
||||
navigation bar at the top of the web and desktop apps when you view the channel.
|
||||
You can hover over long channel descriptions with the mouse to view them in
|
||||
full.
|
||||
|
||||
Channel descriptions support Zulip's standard [Markdown
|
||||
formatting][markdown-formatting], with the exception that image previews are
|
||||
disabled. Use Markdown formatting to include a link to a website, Zulip
|
||||
[message][message-link], or [topic][topic-link] in the channel description:
|
||||
`[link text](URL)`.
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Desktop/Web">
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="relative/channel/all" />
|
||||
|
||||
1. Select a channel.
|
||||
|
||||
<SelectChannelViewGeneral />
|
||||
|
||||
1. Click the **edit channel name and description**
|
||||
(<EditIcon />) icon to the right of the
|
||||
channel name, and enter a new description.
|
||||
|
||||
<SaveChanges />
|
||||
</FlattenedSteps>
|
||||
|
||||
<ChannelSettingsGeneralTabTip />
|
||||
</TabItem>
|
||||
|
||||
<TabItem label="Mobile">
|
||||
Access this feature by following the web app instructions in your
|
||||
mobile device browser.
|
||||
|
||||
Implementation of this feature in the mobile app is tracked [on
|
||||
GitHub](https://github.com/zulip/zulip-flutter/issues/1102). If
|
||||
you're interested in this feature, please react to the issue's
|
||||
description with 👍.
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
<AutomatedNoticeChannelEvent />
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Pin information](/help/pin-information)
|
||||
* [View channel information](/help/view-channel-information)
|
||||
* [Rename a channel](/help/rename-a-channel)
|
||||
* [Markdown formatting][markdown-formatting]
|
||||
* [Channel permissions](/help/channel-permissions)
|
||||
|
||||
[markdown-formatting]: /help/format-your-message-using-markdown
|
||||
|
||||
[message-link]: /help/link-to-a-message-or-conversation#get-a-link-to-a-specific-message
|
||||
|
||||
[topic-link]: /help/link-to-a-message-or-conversation#get-a-link-to-a-specific-topic
|
@@ -0,0 +1,47 @@
|
||||
---
|
||||
title: Change the color of a channel
|
||||
---
|
||||
|
||||
import NavigationSteps from "../../components/NavigationSteps.astro"
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
import SelectChannelViewPersonal from "./include/_SelectChannelViewPersonal.mdx"
|
||||
import ChannelActions from "./include/_ChannelActions.mdx"
|
||||
import { Tabs, TabItem } from '@astrojs/starlight/components'
|
||||
|
||||
Zulip assigns each of your channels a color when you subscribe to the
|
||||
channel. Changing a channel's color does not change it for anyone else.
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Via left sidebar">
|
||||
<FlattenedSteps>
|
||||
<ChannelActions />
|
||||
|
||||
1. Click **Change color**.
|
||||
1. Select a color from the grid, use the color picker, or enter a hex code.
|
||||
1. Click **Confirm** to save and apply the color change.
|
||||
1. Click outside the box to close the menu.
|
||||
</FlattenedSteps>
|
||||
</TabItem>
|
||||
|
||||
<TabItem label="Via channel settings">
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="relative/gear/channel-settings" />
|
||||
|
||||
1. Select a channel.
|
||||
|
||||
<SelectChannelViewPersonal />
|
||||
|
||||
1. Under **Personal settings**, click on the colored square below **Channel color**.
|
||||
1. Select a color from the grid, use the color picker, or enter a hex code.
|
||||
1. Click **Choose** to save and apply the color change.
|
||||
</FlattenedSteps>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Introduction to channels](/help/introduction-to-channels)
|
||||
* [Channel folders](/help/channel-folders)
|
||||
* [Pin a channel](/help/pin-a-channel)
|
||||
* [Mute or unmute a channel](/help/mute-a-channel)
|
||||
* [Hide or reveal inactive channels](/help/manage-inactive-channels)
|
@@ -0,0 +1,64 @@
|
||||
---
|
||||
title: Change the privacy of a channel
|
||||
---
|
||||
|
||||
import NavigationSteps from "../../components/NavigationSteps.astro"
|
||||
import ContentAccessDefinition from "./include/_ContentAccessDefinition.mdx"
|
||||
import ZulipNote from '../../components/ZulipNote.astro';
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
import AutomatedNoticeChannelEvent from "./include/_AutomatedNoticeChannelEvent.mdx"
|
||||
import SaveChanges from "./include/_SaveChanges.mdx"
|
||||
import ChannelSettingsGeneralTabTip from "./include/_ChannelSettingsGeneralTabTip.mdx"
|
||||
import SelectChannelViewGeneral from "./include/_SelectChannelViewGeneral.mdx"
|
||||
import { Tabs, TabItem } from '@astrojs/starlight/components'
|
||||
import ChannelPrivacyTypes from "./include/_ChannelPrivacyTypes.mdx"
|
||||
|
||||
<ChannelPrivacyTypes />
|
||||
|
||||
Organization administrators and [channel
|
||||
administrators](/help/configure-who-can-administer-a-channel) can always make a
|
||||
channel private. However, they can only make a private channel public or
|
||||
web-public if they have content access to it:
|
||||
|
||||
<ContentAccessDefinition />
|
||||
|
||||
<ZulipNote>
|
||||
**Warning**: Be careful making a private channel public. All past messages
|
||||
will become accessible, even if the channel previously had protected history.
|
||||
</ZulipNote>
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Desktop/Web">
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="relative/channel/all" />
|
||||
|
||||
1. Select a channel.
|
||||
|
||||
<SelectChannelViewGeneral />
|
||||
|
||||
1. Under **Channel permissions**, configure **Who can access the channel**.
|
||||
|
||||
<SaveChanges />
|
||||
</FlattenedSteps>
|
||||
|
||||
<ChannelSettingsGeneralTabTip />
|
||||
</TabItem>
|
||||
|
||||
<TabItem label="Mobile">
|
||||
Access this feature by following the web app instructions in your
|
||||
mobile device browser.
|
||||
|
||||
Implementation of this feature in the mobile app is tracked [on
|
||||
GitHub](https://github.com/zulip/zulip-flutter/issues/1102). If
|
||||
you're interested in this feature, please react to the issue's
|
||||
description with 👍.
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
<AutomatedNoticeChannelEvent />
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Channel permissions](/help/channel-permissions)
|
||||
* [Channel posting policy](/help/channel-posting-policy)
|
||||
* [Configure who can administer a channel](/help/configure-who-can-administer-a-channel)
|
18
starlight_help/src/content/docs/change-the-time-format.mdx
Normal file
18
starlight_help/src/content/docs/change-the-time-format.mdx
Normal file
@@ -0,0 +1,18 @@
|
||||
---
|
||||
title: Change the time format
|
||||
---
|
||||
|
||||
import NavigationSteps from "../../components/NavigationSteps.astro"
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
|
||||
Based on your preference, Zulip can display times either in a 12-hour
|
||||
format (e.g., 5:00 PM) or a 24-hour format (e.g., 17:00).
|
||||
|
||||
### Change the time format
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/preferences" />
|
||||
|
||||
1. Under **General**, select your preferred option from the
|
||||
**Time format** dropdown.
|
||||
</FlattenedSteps>
|
@@ -0,0 +1,28 @@
|
||||
---
|
||||
title: Change your email address
|
||||
---
|
||||
|
||||
import NavigationSteps from "../../components/NavigationSteps.astro"
|
||||
import EditIcon from "~icons/zulip-icon/edit"
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
|
||||
By default, anyone can change their email address at any time.
|
||||
|
||||
Organization administrators can
|
||||
[restrict users to certain email domains](/help/restrict-account-creation#configuring-email-domain-restrictions), or
|
||||
[prevent users from changing their email](/help/restrict-name-and-email-changes).
|
||||
|
||||
## Change your email address
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/account-and-privacy" />
|
||||
|
||||
1. Under **Account**, click on the
|
||||
**change your email** (<EditIcon />) icon
|
||||
to the right of your current email. If you do not see the
|
||||
**change your email** (<EditIcon />) icon,
|
||||
you do not have permission to change your email address.
|
||||
1. Enter your new email, and click **Change**.
|
||||
1. You will receive a confirmation email within a few minutes. Open it,
|
||||
and click **Confirm email change**.
|
||||
</FlattenedSteps>
|
62
starlight_help/src/content/docs/change-your-language.mdx
Normal file
62
starlight_help/src/content/docs/change-your-language.mdx
Normal file
@@ -0,0 +1,62 @@
|
||||
---
|
||||
title: Change your language
|
||||
---
|
||||
|
||||
import NavigationSteps from "../../components/NavigationSteps.astro"
|
||||
import TranslationProjectInfo from "./include/_TranslationProjectInfo.mdx"
|
||||
import { Tabs, TabItem } from '@astrojs/starlight/components'
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
|
||||
<TranslationProjectInfo />
|
||||
|
||||
## Change the language of the Zulip app
|
||||
|
||||
Note that this will not change channel names, topic names (other than [*general
|
||||
chat*](/help/general-chat-topic)), or the language of messages you receive.
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Desktop/Web">
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/preferences" />
|
||||
|
||||
1. Under **General**, click the button under **Language**.
|
||||
1. Select a language. Languages are marked as 100% translated only if every
|
||||
string in the web, desktop, and mobile apps is translated, including
|
||||
administrative UI and all error messages that the API can return.
|
||||
1. Click **Reload**.
|
||||
</FlattenedSteps>
|
||||
</TabItem>
|
||||
|
||||
<TabItem label="Mobile">
|
||||
Access this feature by following the web app instructions in your
|
||||
mobile device browser.
|
||||
|
||||
Implementation of this feature in the mobile app is tracked [on
|
||||
GitHub](https://github.com/zulip/zulip-flutter/issues/1139). If
|
||||
you're interested in this feature, please react to the issue's
|
||||
description with 👍.
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Font configuration for unsupported languages
|
||||
|
||||
Zulip uses the Source Sans 3 font, which [supports over 30 languages][adobe-docs].
|
||||
If Source Sans 3 does not support your language, you may need to configure your
|
||||
browser to use a different font or adjust the default font size to properly
|
||||
display all the characters. See the documentation for [Chrome][chrome-docs],
|
||||
[Firefox][firefox-docs], or [Edge][edge-docs] for more information on how to
|
||||
configure your browser's default font.
|
||||
|
||||
[adobe-docs]: https://fonts.adobe.com/fonts/source-sans-3#details-section
|
||||
|
||||
[chrome-docs]: https://support.google.com/chrome/answer/96810
|
||||
|
||||
[firefox-docs]: https://support.mozilla.org/en-US/kb/change-fonts-and-colors-websites-use#w_custom-fonts
|
||||
|
||||
[edge-docs]: https://support.microsoft.com/en-us/microsoft-edge/increase-default-text-size-in-microsoft-edge-c62f80af-381d-0716-25a3-c4856dd3806c
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Configure organization language for automated messages and invitation emails][org-lang]
|
||||
|
||||
[org-lang]: /help/configure-organization-language
|
29
starlight_help/src/content/docs/change-your-name.mdx
Normal file
29
starlight_help/src/content/docs/change-your-name.mdx
Normal file
@@ -0,0 +1,29 @@
|
||||
---
|
||||
title: Change your name
|
||||
---
|
||||
|
||||
import NavigationSteps from "../../components/NavigationSteps.astro"
|
||||
import ZulipNote from '../../components/ZulipNote.astro';
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
|
||||
By default, everyone can change their name in Zulip. You can write your name
|
||||
in any language you'd like.
|
||||
|
||||
Organization administrators can [change anyone's name](/help/change-a-users-name), and
|
||||
[prevent users from changing their names](/help/restrict-name-and-email-changes). This
|
||||
is useful when users' names are managed via LDAP or another data source.
|
||||
|
||||
### Change your name
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/profile" />
|
||||
|
||||
1. Edit the **Name** field.
|
||||
</FlattenedSteps>
|
||||
|
||||
<ZulipNote>
|
||||
**Note:** If you are unable to edit the name field, check
|
||||
that your organization allows name changes. Follow the steps at
|
||||
[prevent users from changing their names](/help/restrict-name-and-email-changes)
|
||||
to view your organization's settings.
|
||||
</ZulipNote>
|
24
starlight_help/src/content/docs/change-your-password.mdx
Normal file
24
starlight_help/src/content/docs/change-your-password.mdx
Normal file
@@ -0,0 +1,24 @@
|
||||
---
|
||||
title: Change your password
|
||||
---
|
||||
|
||||
import NavigationSteps from "../../components/NavigationSteps.astro"
|
||||
import ChangePasswordViaEmailConfirmation from "./include/_ChangePasswordViaEmailConfirmation.mdx"
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
|
||||
You can reset your password at any time, as long as you either know your
|
||||
current password, or have access to the email address associated with your
|
||||
account.
|
||||
|
||||
### If you've forgotten or never had a password
|
||||
|
||||
<ChangePasswordViaEmailConfirmation />
|
||||
|
||||
### If you know your current password
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/account-and-privacy" />
|
||||
|
||||
1. Under **Account**, click on the password field (it should look like `********`).
|
||||
1. Enter your old password and your new password, and click **Change**.
|
||||
</FlattenedSteps>
|
@@ -0,0 +1,36 @@
|
||||
---
|
||||
title: Change your profile picture
|
||||
---
|
||||
|
||||
import NavigationSteps from "../../components/NavigationSteps.astro"
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
|
||||
By default, Zulip uses an image generated by
|
||||
[Gravatar](https://en.gravatar.com/) as your profile picture.
|
||||
If your email address already has a gravatar associated with it, Zulip will
|
||||
use your existing gravatar.
|
||||
|
||||
You can also upload a custom profile picture to Zulip.
|
||||
|
||||
### Change your profile picture
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/profile" />
|
||||
|
||||
1. Under **Profile picture**, click **Upload new profile picture** and choose an image to upload.
|
||||
</FlattenedSteps>
|
||||
|
||||
### Change profile picture back to gravatar
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/profile" />
|
||||
|
||||
1. Under **Profile picture**, click on the **(X)** icon in the top
|
||||
right corner of the profile picture.
|
||||
1. Approve by clicking **Confirm**. This will remove your current
|
||||
profile picture, reverting to the Gravatar default.
|
||||
</FlattenedSteps>
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Restrict profile picture changes](/help/restrict-profile-picture-changes)
|
63
starlight_help/src/content/docs/change-your-timezone.mdx
Normal file
63
starlight_help/src/content/docs/change-your-timezone.mdx
Normal file
@@ -0,0 +1,63 @@
|
||||
---
|
||||
title: Change your time zone
|
||||
---
|
||||
|
||||
import { Steps } from '@astrojs/starlight/components';
|
||||
import NavigationSteps from "../../components/NavigationSteps.astro"
|
||||
import { Tabs, TabItem } from '@astrojs/starlight/components'
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
|
||||
Zulip uses the time zone configured on your computer or mobile device for
|
||||
displaying dates and times, such as when a message was sent.
|
||||
|
||||
You can [configure your **local time**](#configure-your-local-time) as it's
|
||||
shown to other users in your [user card](/help/user-cards) and
|
||||
[profile](/help/view-someones-profile). When your local time doesn't match your
|
||||
computer's time zone, the Zulip web and desktop apps display a banner offering
|
||||
to update it. If you don't want to see this banner, you can [hide
|
||||
it](#hide-banner-when-time-zones-dont-match).
|
||||
|
||||
## Configure your local time
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Desktop/Web">
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/profile" />
|
||||
|
||||
1. Under **Profile**, select a time zone.
|
||||
</FlattenedSteps>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Configure time zone used by Zulip to display dates and times
|
||||
|
||||
<Steps>
|
||||
1. Configure the time zone on your computer or mobile device.
|
||||
1. Reload Zulip.
|
||||
</Steps>
|
||||
|
||||
## Hide banner when time zones don't match
|
||||
|
||||
If you local time in Zulip differs from your device's time zone (for example,
|
||||
you changed your computer's time zone while traveling), you'll see a banner in
|
||||
the web and desktop apps offering to update your local time to match your
|
||||
computer's current time zone.
|
||||
|
||||
You can choose to permanently hide this banner.
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Desktop/Web">
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/profile" />
|
||||
|
||||
1. Under **Profile**, toggle **Offer to update to my computer's
|
||||
time zone**.
|
||||
</FlattenedSteps>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Related articles
|
||||
|
||||
* [User cards](/help/user-cards)
|
||||
* [View someone's profile](/help/view-someones-profile)
|
||||
* [Edit your profile](/help/edit-your-profile)
|
76
starlight_help/src/content/docs/channel-feed.mdx
Normal file
76
starlight_help/src/content/docs/channel-feed.mdx
Normal file
@@ -0,0 +1,76 @@
|
||||
---
|
||||
title: Channel feed
|
||||
---
|
||||
|
||||
import ChannelActions from "./include/_ChannelActions.mdx"
|
||||
import NavigationSteps from "../../components/NavigationSteps.astro"
|
||||
import ZulipTip from '../../components/ZulipTip.astro';
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
import AllMessagesIcon from "~icons/zulip-icon/all-messages"
|
||||
import MobileChannels from "./include/_MobileChannels.mdx"
|
||||
import KeyboardTip from '../../components/KeyboardTip.astro';
|
||||
import ConfigureChannelLinks from "./include/_ConfigureChannelLinks.mdx"
|
||||
import { Tabs, TabItem } from '@astrojs/starlight/components'
|
||||
|
||||
The **Channel feed** is a feed of all the topics that you have not
|
||||
[muted](/help/mute-a-topic) in a particular channel. It's a great way to get a
|
||||
quick overview of recent messages in a channel.
|
||||
|
||||
## Go to channel feed for a subscribed channel
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Desktop/Web">
|
||||
<FlattenedSteps>
|
||||
<ChannelActions />
|
||||
|
||||
1. Click **Go to channel feed**. If you do not see this option, Zulip is
|
||||
[configured](#configure-where-channel-links-in-the-left-sidebar-go) so that
|
||||
clicking on the channel name in the left sidebar will take you directly to
|
||||
the channel feed.
|
||||
</FlattenedSteps>
|
||||
|
||||
<KeyboardTip>
|
||||
Use <kbd>S</kbd> to go from a topic view to the channel feed.
|
||||
</KeyboardTip>
|
||||
</TabItem>
|
||||
|
||||
<TabItem label="Mobile">
|
||||
<FlattenedSteps>
|
||||
<MobileChannels />
|
||||
|
||||
1. Select a channel.
|
||||
</FlattenedSteps>
|
||||
|
||||
<ZulipTip>
|
||||
You can also go to the channel feed from a conversation view or from the
|
||||
[list of topics in a channel](/help/list-of-topics), by tapping the
|
||||
**channel feed** (<AllMessagesIcon />)
|
||||
icon in the upper right corner of the app.
|
||||
</ZulipTip>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Go to channel feed for an unsubscribed channel
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Desktop/Web">
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="relative/channel/not-subscribed" />
|
||||
|
||||
1. Select a channel.
|
||||
1. Click the channel name in the top bar.
|
||||
</FlattenedSteps>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Configure where channel links in the left sidebar go
|
||||
|
||||
<ConfigureChannelLinks />
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Combined feed](/help/combined-feed)
|
||||
* [List of topics in a channel](/help/list-of-topics)
|
||||
* [Left sidebar](/help/left-sidebar)
|
||||
* [Reading strategies](/help/reading-strategies)
|
||||
* [Reading conversations](/help/reading-conversations)
|
47
starlight_help/src/content/docs/channel-folders.mdx
Normal file
47
starlight_help/src/content/docs/channel-folders.mdx
Normal file
@@ -0,0 +1,47 @@
|
||||
---
|
||||
title: Channel folders
|
||||
---
|
||||
|
||||
import NavigationSteps from "../../components/NavigationSteps.astro"
|
||||
import MoveChannelToFolder from "./include/_MoveChannelToFolder.mdx"
|
||||
import MoreVerticalIcon from "~icons/zulip-icon/more-vertical"
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
import { Steps } from '@astrojs/starlight/components';
|
||||
import ChannelFoldersIntro from "./include/_ChannelFoldersIntro.mdx"
|
||||
import { Tabs, TabItem } from '@astrojs/starlight/components'
|
||||
|
||||
<ChannelFoldersIntro />
|
||||
|
||||
## Move a channel to a folder
|
||||
|
||||
<MoveChannelToFolder />
|
||||
|
||||
## Configure whether channels are grouped by folder in the left sidebar
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Via left sidebar">
|
||||
<Steps>
|
||||
1. Click the **ellipsis** (<MoreVerticalIcon />)
|
||||
to the right of the **Filter left sidebar** box in the upper left.
|
||||
1. Click **Group channels by folder** or **Don't group channels by folder**, as
|
||||
desired.
|
||||
</Steps>
|
||||
</TabItem>
|
||||
|
||||
<TabItem label="Via personal settings">
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/preferences" />
|
||||
|
||||
1. Under **Left sidebar**, toggle **Group channels by folder in the left
|
||||
sidebar**.
|
||||
</FlattenedSteps>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Manage channel folders](/help/manage-channel-folders)
|
||||
* [Introduction to channels](/help/introduction-to-channels)
|
||||
* [Pin a channel](/help/pin-a-channel)
|
||||
* [Mute or unmute a channel](/help/mute-a-channel)
|
||||
* [Hide or reveal inactive channels](/help/manage-inactive-channels)
|
101
starlight_help/src/content/docs/channel-notifications.mdx
Normal file
101
starlight_help/src/content/docs/channel-notifications.mdx
Normal file
@@ -0,0 +1,101 @@
|
||||
---
|
||||
title: Channel notifications
|
||||
---
|
||||
|
||||
import ChannelActions from "./include/_ChannelActions.mdx"
|
||||
import NavigationSteps from "../../components/NavigationSteps.astro"
|
||||
import ZulipTip from '../../components/ZulipTip.astro';
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
import SelectChannelViewPersonal from "./include/_SelectChannelViewPersonal.mdx"
|
||||
import ResetIcon from "~icons/zulip-icon/reset"
|
||||
import { Tabs, TabItem } from '@astrojs/starlight/components'
|
||||
|
||||
You can configure desktop, mobile, and email notifications on a channel by
|
||||
channel basis.
|
||||
|
||||
## Configure notifications for a single channel
|
||||
|
||||
These settings will override any default channel notification settings. In [muted
|
||||
channels](/help/mute-a-channel), channel notification settings apply only to
|
||||
[unmuted topics](/help/mute-a-topic).
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Via channel settings">
|
||||
<FlattenedSteps>
|
||||
<ChannelActions />
|
||||
|
||||
1. Click **Channel settings**.
|
||||
|
||||
<SelectChannelViewPersonal />
|
||||
|
||||
1. Under **Notification settings**, toggle your preferred
|
||||
notifications settings for the channel.
|
||||
</FlattenedSteps>
|
||||
</TabItem>
|
||||
|
||||
<TabItem label="Via personal settings">
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/notifications" />
|
||||
|
||||
1. In the **Notification triggers** table, find the name of the channel
|
||||
you want to configure. If the channel is currently set to the default
|
||||
channel notification settings, you can select it from the **Customize
|
||||
another channel** dropdown at the bottom of the table.
|
||||
1. Toggle your preferred notifications settings for the selected
|
||||
channel.
|
||||
</FlattenedSteps>
|
||||
|
||||
<ZulipTip>
|
||||
To reset a channel's notifications to the default settings, hover
|
||||
over its name in the notification triggers table, and click the
|
||||
**reset to default notifications**
|
||||
(<ResetIcon />) icon.
|
||||
</ZulipTip>
|
||||
</TabItem>
|
||||
|
||||
<TabItem label="Mobile">
|
||||
Access this feature by following the web app instructions in your
|
||||
mobile device browser.
|
||||
|
||||
Implementation of this feature in the mobile app is tracked [on
|
||||
GitHub](https://github.com/zulip/zulip-flutter/issues/1223). If
|
||||
you're interested in this feature, please react to the issue's
|
||||
description with 👍.
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Configure default notifications for all channels
|
||||
|
||||
These settings only apply to channels where you have not
|
||||
explicitly set a notification preference.
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Desktop/Web">
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/notifications" />
|
||||
|
||||
1. In the **Notification triggers** table,
|
||||
toggle the settings for **Channels**.
|
||||
</FlattenedSteps>
|
||||
</TabItem>
|
||||
|
||||
<TabItem label="Mobile">
|
||||
Access this feature by following the web app instructions in your
|
||||
mobile device browser.
|
||||
|
||||
Implementation of this feature in the mobile app is tracked [on
|
||||
GitHub](https://github.com/zulip/zulip-flutter/issues/661). If
|
||||
you're interested in this feature, please react to the issue's
|
||||
description with 👍.
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Desktop notifications](/help/desktop-notifications)
|
||||
* [Email notifications](/help/email-notifications)
|
||||
* [Mobile notifications](/help/mobile-notifications)
|
||||
* [Mute or unmute a channel](/help/mute-a-channel)
|
||||
* [Mute or unmute a topic](/help/mute-a-topic)
|
||||
* [DMs, mentions, and alerts](/help/dm-mention-alert-notifications)
|
||||
* [Do not disturb](/help/do-not-disturb)
|
113
starlight_help/src/content/docs/channel-permissions.mdx
Normal file
113
starlight_help/src/content/docs/channel-permissions.mdx
Normal file
@@ -0,0 +1,113 @@
|
||||
---
|
||||
title: Channel permissions
|
||||
---
|
||||
|
||||
import WebPublicChannelsIntro from "./include/_WebPublicChannelsIntro.mdx"
|
||||
import ZulipNote from '../../components/ZulipNote.astro';
|
||||
import HashtagIcon from "~icons/zulip-icon/hashtag"
|
||||
import ChannelAdminPermissions from "./include/_ChannelAdminPermissions.mdx"
|
||||
import ChannelsIntro from "./include/_ChannelsIntro.mdx"
|
||||
import GlobeIcon from "~icons/zulip-icon/globe"
|
||||
import ChannelPrivacyTypes from "./include/_ChannelPrivacyTypes.mdx"
|
||||
import LockIcon from "~icons/zulip-icon/lock"
|
||||
|
||||
<ChannelsIntro />
|
||||
|
||||
<ChannelPrivacyTypes />
|
||||
|
||||
## Configure channel permissions
|
||||
|
||||
You can configure the following permissions for each channel,
|
||||
regardless of its type.
|
||||
|
||||
Subscription permissions:
|
||||
|
||||
* [Who can administer the channel](/help/configure-who-can-administer-a-channel)
|
||||
* [Who can subscribe themselves](/help/configure-who-can-subscribe)
|
||||
* [Who can subscribe anyone](/help/configure-who-can-invite-to-channels#configure-who-can-subscribe-anyone-to-a-specific-channel)
|
||||
* [Who can unsubscribe anyone](/help/configure-who-can-unsubscribe-others)
|
||||
|
||||
Messaging permissions:
|
||||
|
||||
* [Who can send messages](/help/channel-posting-policy)
|
||||
* [Whether topics are required](/help/require-topics)
|
||||
|
||||
Moderation permissions:
|
||||
|
||||
* [Who can move messages](/help/restrict-moving-messages)
|
||||
* [Who can resolve topics](/help/restrict-resolving-topics)
|
||||
* [Who can delete messages](/help/restrict-message-editing-and-deletion)
|
||||
|
||||
For the organization as a whole, you can:
|
||||
|
||||
* [Restrict channel creation](/help/configure-who-can-create-channels)
|
||||
* [Restrict who can subscribe others to channels](/help/configure-who-can-invite-to-channels#configure-who-can-subscribe-others-to-channels-in-general)
|
||||
|
||||
Any permission, including whether a channel is private, public, or web-public,
|
||||
can be modified after the channel is created.
|
||||
|
||||
## Private channels
|
||||
|
||||
[Private channels](#private-channels) (indicated by <LockIcon />) are for conversations that should be visible to users who
|
||||
are specifically granted access. There are two types of private channels in
|
||||
Zulip:
|
||||
|
||||
* In private channels with **shared history**, new subscribers can access the
|
||||
channel's full message history. For example, a newly added team member can get
|
||||
ramped up on a secret project by seeing prior discussions.
|
||||
* In private channels with **protected history**, new subscribers can only see
|
||||
messages sent after they join. For example, a new manager would not be able to
|
||||
see past discussions regarding their own hiring process or performance management.
|
||||
|
||||
<ChannelAdminPermissions />
|
||||
|
||||
Administrators can [export](/help/export-your-organization) messages in private
|
||||
channels only if [granted permission to do
|
||||
so](/help/export-your-organization#configure-whether-administrators-can-export-your-private-data)
|
||||
by a subscriber.
|
||||
|
||||
Users who do not have special permissions (they are not organization
|
||||
administrators, and have not been granted access to channel metadata) cannot
|
||||
easily see which private channels exist. They can find out that a channel exists
|
||||
only by attempting to create a channel with the same name, if they have
|
||||
[permission to create channels](/help/configure-who-can-create-channels). They
|
||||
can't get any other information about private channels they are not subscribed
|
||||
to.
|
||||
|
||||
<ZulipNote>
|
||||
If you create a [bot](/help/bots-overview) that is allowed to read messages
|
||||
in a private channel (e.g., a **generic bot**, *not* an **incoming webhook bot**,
|
||||
which is more limited), an administrator can in theory gain access to messages
|
||||
in the channel by making themselves the bot's owner.
|
||||
</ZulipNote>
|
||||
|
||||
## Public channels
|
||||
|
||||
Public channels (indicated by <HashtagIcon />) are open to all members of your organization other than
|
||||
[guests](/help/guest-users). Anyone who is not a guest can:
|
||||
|
||||
* See information about the channel, including its name, description, permission
|
||||
settings, and subscribers.
|
||||
* Subscribe or unsubscribe themselves to the channel.
|
||||
* See all messages and topics, whether or not they are subscribed.
|
||||
|
||||
You can configure other permissions for public channels, such as [who is allowed
|
||||
to post](/help/channel-posting-policy).
|
||||
|
||||
Guest users can't see public (or private) channels, unless they have been specifically
|
||||
subscribed to the channel.
|
||||
|
||||
## Web-public channels
|
||||
|
||||
<WebPublicChannelsIntro />
|
||||
|
||||
Web-public channels are indicated with a **globe** (<GlobeIcon />) icon.
|
||||
|
||||
## Related articles
|
||||
|
||||
* [User roles](/help/user-roles)
|
||||
* [Guest users](/help/guest-users)
|
||||
* [User groups](/help/user-groups)
|
||||
* [Public access option](/help/public-access-option)
|
||||
* [Restrict channel creation](/help/configure-who-can-create-channels)
|
||||
* [Configure who can administer a channel](/help/configure-who-can-administer-a-channel)
|
35
starlight_help/src/content/docs/channel-posting-policy.mdx
Normal file
35
starlight_help/src/content/docs/channel-posting-policy.mdx
Normal file
@@ -0,0 +1,35 @@
|
||||
---
|
||||
title: Channel posting policy
|
||||
---
|
||||
|
||||
import NavigationSteps from "../../components/NavigationSteps.astro"
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
import AutomatedNoticeChannelEvent from "./include/_AutomatedNoticeChannelEvent.mdx"
|
||||
import SaveChanges from "./include/_SaveChanges.mdx"
|
||||
import SelectChannelViewGeneralAdvanced from "./include/_SelectChannelViewGeneralAdvanced.mdx"
|
||||
|
||||
You can restrict who can send messages to a channel. For example,
|
||||
you can set up an announcement channel where only a specific
|
||||
[group](/help/user-groups) of users can send messages.
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="relative/channel/all" />
|
||||
|
||||
1. Select a channel.
|
||||
|
||||
<SelectChannelViewGeneralAdvanced />
|
||||
|
||||
1. Under **Messaging permissions**, configure **Who can post to this channel**.
|
||||
|
||||
<SaveChanges />
|
||||
</FlattenedSteps>
|
||||
|
||||
<AutomatedNoticeChannelEvent />
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Channel permissions](/help/channel-permissions)
|
||||
* [User roles](/help/user-roles)
|
||||
* [User groups](/help/user-groups)
|
||||
* [Set default channels for new users](/help/set-default-channels-for-new-users)
|
||||
* [Configure who can administer a channel](/help/configure-who-can-administer-a-channel)
|
193
starlight_help/src/content/docs/code-blocks.mdx
Normal file
193
starlight_help/src/content/docs/code-blocks.mdx
Normal file
@@ -0,0 +1,193 @@
|
||||
---
|
||||
title: Code blocks
|
||||
---
|
||||
|
||||
import NavigationSteps from "../../components/NavigationSteps.astro"
|
||||
import CodeBlocksIntro from "./include/_CodeBlocksIntro.mdx"
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
import StartComposing from "./include/_StartComposing.mdx"
|
||||
import ZulipTip from '../../components/ZulipTip.astro';
|
||||
import CodeBlocksExamples from "./include/_CodeBlocksExamples.mdx"
|
||||
import { Tabs, TabItem } from '@astrojs/starlight/components'
|
||||
import CodeIcon from "~icons/zulip-icon/code"
|
||||
import AdminOnly from "./include/_AdminOnly.mdx"
|
||||
|
||||
<CodeBlocksIntro />
|
||||
|
||||
## Insert code formatting
|
||||
|
||||
Zulip's compose box has a smart **Code** (<CodeIcon />) button, which inserts contextually appropriate code
|
||||
formatting:
|
||||
|
||||
* If no text is selected, the button inserts code block (` ``` `) formatting.
|
||||
* If selected text is on one line, the button inserts code span (`` ` ``)
|
||||
formatting.
|
||||
* If selected text is on multiple lines, the button inserts code block (` ``` `)
|
||||
formatting.
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Via compose box button">
|
||||
<FlattenedSteps>
|
||||
<StartComposing />
|
||||
|
||||
1. *(optional)* Select the text you want to format.
|
||||
1. Click the **Code** (<CodeIcon />) icon at the
|
||||
bottom of the compose box to insert code formatting.
|
||||
1. *(optional)* To enable syntax highlighting in a code bock, start typing the
|
||||
name of the desired programming language directly after the initial ` ``` `.
|
||||
Select the language from the auto-complete suggestions.
|
||||
</FlattenedSteps>
|
||||
|
||||
<ZulipTip>
|
||||
You can also use the **Code** (<CodeIcon />)
|
||||
icon to remove existing code formatting from the selected text.
|
||||
</ZulipTip>
|
||||
</TabItem>
|
||||
|
||||
<TabItem label="Via Markdown">
|
||||
<FlattenedSteps>
|
||||
<StartComposing />
|
||||
|
||||
1. To create an inline code span, use single backticks around the text:
|
||||
`text`
|
||||
To create a code block, use triple backticks around the text:
|
||||
```
|
||||
def f(x):
|
||||
return x+1
|
||||
```
|
||||
To enable syntax highlighting, use triple backticks followed by one or more
|
||||
letters, and select the desired programming language from the auto-complete
|
||||
suggestions.
|
||||
```python
|
||||
def fib(n):
|
||||
# TODO: base case
|
||||
return fib(n-1) + fib(n-2)
|
||||
```
|
||||
</FlattenedSteps>
|
||||
|
||||
<ZulipTip>
|
||||
You can also use `~~~` to start code blocks, or just indent the code 4 or more
|
||||
spaces.
|
||||
</ZulipTip>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Examples
|
||||
|
||||
<CodeBlocksExamples />
|
||||
|
||||
## Language tagging
|
||||
|
||||
Tagging a code block with a language enables syntax highlighting and
|
||||
(if configured) [code playgrounds](#code-playgrounds). Zulip supports syntax
|
||||
highlighting for hundreds of languages.
|
||||
|
||||
A code block can be tagged by typing the language name after the fence
|
||||
(` ``` `) that begins a code block, as shown here. Typeahead will
|
||||
help you enter the name for the language. The **Short names** values
|
||||
from the [Pygments lexer documentation][pygments-lexers] are the
|
||||
complete set of values that support syntax highlighting.
|
||||
|
||||
````
|
||||
``` python
|
||||
print("Hello world!")
|
||||
```
|
||||
````
|
||||
|
||||
### Default code block language
|
||||
|
||||
Organization administrators can also configure a default language for code
|
||||
blocks, which will be used whenever the code block has no tag.
|
||||
|
||||
<AdminOnly />
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/organization-settings" />
|
||||
|
||||
1. Under **Message feed settings**, edit **Default language for code blocks**.
|
||||
</FlattenedSteps>
|
||||
|
||||
When a default language is configured, one can use ` ```text ` to display
|
||||
code blocks without any syntax highlighting (e.g., to paste an error message).
|
||||
|
||||
## Code playgrounds
|
||||
|
||||
Code playgrounds are interactive in-browser development environments
|
||||
that are designed to make it convenient to edit
|
||||
and debug code. Code playgrounds can be configured for any programming language.
|
||||
Zulip code blocks that are tagged with the language will have a button visible
|
||||
on hover that allows you to open the code block in the code playground site.
|
||||
|
||||
### Add a custom code playground
|
||||
|
||||
<AdminOnly />
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/playground-settings" />
|
||||
|
||||
1. Under **Add a new code playground**, enter a **Language**, **Name**, and
|
||||
**URL template**.
|
||||
1. Click **Add code playground**.
|
||||
</FlattenedSteps>
|
||||
|
||||
For example, to configure code a playground for Rust, you could specify the
|
||||
language and URL template as `Rust` and `https://play.rust-lang.org/?code=\{code\}`.
|
||||
|
||||
When a code block is labeled as `rust` (either explicitly or by organization
|
||||
default), users would get an on-hover option to open the code block in the
|
||||
specified code playground.
|
||||
|
||||
<ZulipTip>
|
||||
Code playgrounds use [RFC 6570](https://www.rfc-editor.org/rfc/rfc6570.html)
|
||||
compliant URL templates to describe how links should be generated. Zulip's
|
||||
rendering engine will pass the URL-encoded code from the code block as the
|
||||
`code` parameter, denoted as `\{code\}` in this URL template, in order to
|
||||
generate the URL. You can refer to parts of the documentation on URL
|
||||
templates from [adding a custom linkifier](/help/add-a-custom-linkifier).
|
||||
</ZulipTip>
|
||||
|
||||
### Examples of playground URL templates
|
||||
|
||||
Here is a list of playground URL templates you can use for some popular
|
||||
languages:
|
||||
|
||||
* For Java: `https://pythontutor.com/java.html#code=\{code\}` or
|
||||
`https://cscircles.cemc.uwaterloo.ca/java_visualize/#code=\{code\}`
|
||||
* For JavaScript: `https://pythontutor.com/javascript.html#code=\{code\}`
|
||||
* For Python: `https://pythontutor.com/python-compiler.html#code=\{code\}`
|
||||
* For C: `https://pythontutor.com/c.html#code=\{code\}`
|
||||
* For C++: `https://pythontutor.com/cpp.html#code=\{code\}`
|
||||
* For Rust: `https://play.rust-lang.org/?code=\{code\}`
|
||||
|
||||
### Technical details
|
||||
|
||||
* You can configure multiple playgrounds for a given language; if you do that,
|
||||
the user will get to choose which playground to open the code in.
|
||||
* The **Language** field is the human-readable Pygments language name for that
|
||||
programming language. The language tag for a code block is internally mapped
|
||||
to these human-readable Pygments names; e.g., `py3` and `py` are mapped to
|
||||
`Python`. One can use the typeahead (which appears when you type something
|
||||
or just click on the language field) to look up the Pygments name.
|
||||
* The links for opening code playgrounds are always constructed by substituting
|
||||
the URL-encoded contents of the code block into `code` variable in the URL template.
|
||||
The URL template is required to contain exactly one variable named `code`.
|
||||
* Code playground sites do not always clearly document their URL format; often
|
||||
you can just get the prefix from your browser's URL bar.
|
||||
* You can also use a custom language name to implement simple integrations.
|
||||
For example, a code block tagged with the "language" `send_tweet` could be
|
||||
used with a "playground" that sends the content of the code block as a Tweet.
|
||||
|
||||
If you have any trouble setting up a code playground, please [contact
|
||||
us](/help/contact-support) with details on what you're trying to do, and we'll
|
||||
be happy to help you out.
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Message formatting](/help/format-your-message-using-markdown)
|
||||
* [LaTeX](/help/latex)
|
||||
* [Spoilers](/help/spoilers)
|
||||
* [Quote message](/help/quote-or-forward-a-message)
|
||||
|
||||
[pygments-lexers]: https://pygments.org/docs/lexers/
|
||||
|
||||
[get_lexer_by_name]: https://pygments-doc.readthedocs.io/en/latest/lexers/lexers.html#pygments.lexers.get_lexer_by_name
|
100
starlight_help/src/content/docs/collaborative-to-do-lists.mdx
Normal file
100
starlight_help/src/content/docs/collaborative-to-do-lists.mdx
Normal file
@@ -0,0 +1,100 @@
|
||||
---
|
||||
title: Collaborative to-do lists
|
||||
---
|
||||
|
||||
import ToDoListsIntro from "./include/_ToDoListsIntro.mdx"
|
||||
import ZulipNote from '../../components/ZulipNote.astro';
|
||||
import ZulipTip from '../../components/ZulipTip.astro';
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
import PencilIcon from "~icons/fa/pencil"
|
||||
import { Steps } from '@astrojs/starlight/components';
|
||||
import TrashIcon from "~icons/zulip-icon/trash"
|
||||
import CheckIcon from "~icons/fa/check"
|
||||
import GripVerticalIcon from "~icons/zulip-icon/grip-vertical"
|
||||
import StartComposing from "./include/_StartComposing.mdx"
|
||||
import SendIcon from "~icons/zulip-icon/send"
|
||||
import RemoveIcon from "~icons/fa/remove"
|
||||
import TodoListIcon from "~icons/zulip-icon/todo-list"
|
||||
import { Tabs, TabItem } from '@astrojs/starlight/components'
|
||||
import ToDoListsExamples from "./include/_ToDoListsExamples.mdx"
|
||||
|
||||
<ToDoListsIntro />
|
||||
|
||||
## Create a to-do list
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Via compose box button">
|
||||
<FlattenedSteps>
|
||||
<StartComposing />
|
||||
|
||||
1. Make sure the compose box is empty.
|
||||
1. Click the **Add to-do list** (<TodoListIcon />) icon at the bottom of the compose box.
|
||||
1. Fill out todo-list information as desired, and click **Create to-do
|
||||
list** to insert todo-list formatting.
|
||||
1. Click the **Send** (<SendIcon />)
|
||||
button, or use a [keyboard shortcut](/help/configure-send-message-keys)
|
||||
to send your message.
|
||||
</FlattenedSteps>
|
||||
|
||||
<ZulipTip>
|
||||
To reorder the list of todos, click and drag the **vertical dots**
|
||||
(<GripVerticalIcon />) to the left of
|
||||
each option. To delete an option, click the **delete**
|
||||
(<TrashIcon />) icon to the right of it.
|
||||
</ZulipTip>
|
||||
</TabItem>
|
||||
|
||||
<TabItem label="Via Markdown">
|
||||
<FlattenedSteps>
|
||||
<StartComposing />
|
||||
|
||||
1. Make sure the compose box is empty.
|
||||
1. Type `/todo` followed by a space, and the title of the to-do list.
|
||||
1. *(optional)* Type each task on a new line, with its description, if
|
||||
any, after a <kbd>:</kbd> and blank space.
|
||||
1. Click the **Send** (<SendIcon />)
|
||||
button, or use a [keyboard shortcut](/help/configure-send-message-keys)
|
||||
to send your message.
|
||||
</FlattenedSteps>
|
||||
|
||||
<ZulipTip>
|
||||
You will be able to add tasks after the to-do list is created.
|
||||
</ZulipTip>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Add tasks to a to-do list
|
||||
|
||||
<Steps>
|
||||
1. Fill out the **New task** field, and optionally the **Description**
|
||||
field at the bottom of the to-do list.
|
||||
1. Click **Add task** to add the new task to the to-do list.
|
||||
</Steps>
|
||||
|
||||
## Edit the to-do list title
|
||||
|
||||
<ZulipNote>
|
||||
Only the creator of a to-do list can edit the title.
|
||||
</ZulipNote>
|
||||
|
||||
<Steps>
|
||||
1. Click the **pencil** (<PencilIcon />) icon
|
||||
to the right of the title.
|
||||
1. Edit the title as desired.
|
||||
1. Click the **checkmark** (<CheckIcon />) icon or press
|
||||
<kbd>Enter</kbd> to save your changes.
|
||||
</Steps>
|
||||
|
||||
<ZulipTip>
|
||||
You can click the <RemoveIcon /> icon or press
|
||||
<kbd>Esc</kbd> to discard your changes.
|
||||
</ZulipTip>
|
||||
|
||||
## Examples
|
||||
|
||||
<ToDoListsExamples />
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Message formatting](/help/format-your-message-using-markdown)
|
||||
* [Polls](/help/create-a-poll)
|
24
starlight_help/src/content/docs/collapse-a-message.mdx
Normal file
24
starlight_help/src/content/docs/collapse-a-message.mdx
Normal file
@@ -0,0 +1,24 @@
|
||||
---
|
||||
title: Collapse a message
|
||||
---
|
||||
|
||||
import MessageActionsMenu from "./include/_MessageActionsMenu.mdx"
|
||||
import ZulipTip from '../../components/ZulipTip.astro';
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
|
||||
Collapse messages that you don't want to see. Zulip sometimes automatically
|
||||
partially condenses long messages. This feature is different, and will fully
|
||||
remove the message content from view.
|
||||
|
||||
### Collapse a message
|
||||
|
||||
<FlattenedSteps>
|
||||
<MessageActionsMenu />
|
||||
|
||||
1. Click **Collapse message**.
|
||||
</FlattenedSteps>
|
||||
|
||||
<ZulipTip>
|
||||
To expand a message, click **Show more** at the bottom of the collapsed
|
||||
message.
|
||||
</ZulipTip>
|
23
starlight_help/src/content/docs/combined-feed.mdx
Normal file
23
starlight_help/src/content/docs/combined-feed.mdx
Normal file
@@ -0,0 +1,23 @@
|
||||
---
|
||||
title: Combined feed
|
||||
---
|
||||
|
||||
import KeyboardTip from '../../components/KeyboardTip.astro';
|
||||
import CombinedFeed from "./include/_CombinedFeed.mdx"
|
||||
|
||||
<CombinedFeed />
|
||||
|
||||
<KeyboardTip>
|
||||
Use <kbd>S</kbd> (go to channel) or <kbd>Shift</kbd> +
|
||||
<kbd>S</kbd> (go to conversation) to zoom in, and <kbd>A</kbd> to
|
||||
get back to **Combined feed**.
|
||||
</KeyboardTip>
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Reading strategies](/help/reading-strategies)
|
||||
* [Inbox](/help/inbox)
|
||||
* [Recent conversations](/help/recent-conversations)
|
||||
* [Configure home view](/help/configure-home-view)
|
||||
* [Reading conversations](/help/reading-conversations)
|
||||
* [Channel feed](/help/channel-feed)
|
67
starlight_help/src/content/docs/communities-directory.mdx
Normal file
67
starlight_help/src/content/docs/communities-directory.mdx
Normal file
@@ -0,0 +1,67 @@
|
||||
---
|
||||
title: Zulip communities directory
|
||||
---
|
||||
|
||||
import CommunitiesDirectoryIntro from "./include/_CommunitiesDirectoryIntro.mdx"
|
||||
import CommunitiesDirectoryInstructions from "./include/_CommunitiesDirectoryInstructions.mdx"
|
||||
import ZulipTip from '../../components/ZulipTip.astro';
|
||||
import AdminOnly from "./include/_AdminOnly.mdx"
|
||||
|
||||
<CommunitiesDirectoryIntro />
|
||||
|
||||
## Eligibility
|
||||
|
||||
In order to be eligible for listing in the communities directory, an
|
||||
organization must be open to the public. Your organization is eligible
|
||||
if users are allowed to [join without an invitation][join-without-invite]
|
||||
and/or the [public access option](/help/public-access-option) is enabled.
|
||||
|
||||
The directory will be organized by [organization type](/help/organization-type),
|
||||
so it is highly recommended that you make sure the appropriate category
|
||||
is selected.
|
||||
|
||||
To prevent spam, Zulip reserves the right to use editorial discretion.
|
||||
Giving Zulip permission to promote your organization in the communities
|
||||
directory does not guarantee that it will be listed.
|
||||
|
||||
### Self-hosted Zulip communities
|
||||
|
||||
Zulip plans to develop support for self-hosted Zulip communities that
|
||||
have registered their servers with the [Zulip mobile push
|
||||
notification service][push-notifications] to sign-up for the Zulip
|
||||
communities directory.
|
||||
|
||||
Until that feature is developed, if you administer a self-hosted Zulip
|
||||
community and would like to be listed in the directory, please contact
|
||||
[Zulip support](mailto:support@zulip.com). Changing the setting in your
|
||||
Zulip organization will not send any information to the Zulip project
|
||||
at this time, even if you use the Zulip mobile push notifications
|
||||
service.
|
||||
|
||||
[join-without-invite]: /help/restrict-account-creation#set-whether-invitations-are-required-to-join
|
||||
|
||||
[communities-directory-permission]: /help/communities-directory#give-permission-to-be-in-the-zulip-communities-directory
|
||||
|
||||
[push-notifications]: https://zulip.readthedocs.io/en/stable/production/mobile-push-notifications.html
|
||||
|
||||
## Change whether your organization may be listed in the Zulip communities directory
|
||||
|
||||
<AdminOnly />
|
||||
|
||||
<CommunitiesDirectoryInstructions />
|
||||
|
||||
<ZulipTip>
|
||||
Organizations that are not open to the public will not be listed at this time.
|
||||
If you administer a non-public organization, please check the box to request
|
||||
to be listed in the future.
|
||||
</ZulipTip>
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Create your organization profile](/help/create-your-organization-profile)
|
||||
* [Public access option](/help/public-access-option)
|
||||
* [Linking to the Zulip website](/help/linking-to-zulip-website)
|
||||
* [Support the Zulip project](/help/support-zulip-project)
|
||||
* [Restrict account creation](/help/restrict-account-creation)
|
||||
* [Moderating open organizations](/help/moderating-open-organizations)
|
||||
* [Organization type](/help/organization-type)
|
@@ -0,0 +1,71 @@
|
||||
---
|
||||
title: Configure a custom welcome message
|
||||
---
|
||||
|
||||
import NavigationSteps from "../../components/NavigationSteps.astro"
|
||||
import ZulipTip from '../../components/ZulipTip.astro';
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
import SaveChanges from "./include/_SaveChanges.mdx"
|
||||
import InviteUsers from "./include/_InviteUsers.mdx"
|
||||
import AdminOnly from "./include/_AdminOnly.mdx"
|
||||
|
||||
You can configure a custom welcome message to be sent to new users in your
|
||||
organization, along with standard onboarding messages from Welcome Bot. For
|
||||
example, you can describe the purpose of important channels, and link to your
|
||||
organization's guidelines for using Zulip.
|
||||
|
||||
Administrators can also customize the message each time they [create an
|
||||
invitation](/help/invite-new-users). Invitations sent by other users will always
|
||||
use the default custom welcome message configured by your organization's
|
||||
administrators.
|
||||
|
||||
<ZulipTip>
|
||||
You can compose the welcome message in the compose box to benefit from
|
||||
buttons and typeahead suggestions for message formatting, and copy it over.
|
||||
</ZulipTip>
|
||||
|
||||
## Configure a default custom welcome message
|
||||
|
||||
<AdminOnly />
|
||||
|
||||
Users will receive the message that's configured at the time when they accept
|
||||
the invitation, so there's no need to update or revoke invitations when you
|
||||
change the welcome message.
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/organization-settings" />
|
||||
|
||||
1. Under **Onboarding**, enable **Send a custom Welcome Bot message to
|
||||
new users**.
|
||||
1. Under **Message text**, enter a custom welcome message using Zulip's standard
|
||||
[Markdown formatting](/help/format-your-message-using-markdown).
|
||||
1. *(optional)* Click **Send me a test message**, followed by **View message**,
|
||||
to see how the message will look. Follow the instructions above to return to
|
||||
the panel where this setting can be configured.
|
||||
|
||||
<SaveChanges />
|
||||
</FlattenedSteps>
|
||||
|
||||
## Customize the welcome message when sending an invitation
|
||||
|
||||
<AdminOnly />
|
||||
|
||||
<FlattenedSteps>
|
||||
<InviteUsers />
|
||||
|
||||
1. If there is no custom message configured in your organization, enable **Send
|
||||
a custom Welcome Bot message**. Otherwise, disable **Send the default Welcome
|
||||
Bot message configured for this organization**.
|
||||
1. Under **Message text**, enter the welcome message to use for this
|
||||
invitation using Zulip's standard [Markdown
|
||||
formatting](/help/format-your-message-using-markdown).
|
||||
1. Configure other invitation details as desired, and click **Invite** or
|
||||
**Create link**.
|
||||
</FlattenedSteps>
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Invite new users](/help/invite-new-users)
|
||||
* [Set default channels for new users](/help/set-default-channels-for-new-users)
|
||||
* [Configure default new user settings](/help/configure-default-new-user-settings)
|
||||
* [Joining a Zulip organization](/help/join-a-zulip-organization)
|
@@ -0,0 +1,79 @@
|
||||
---
|
||||
title: Configure authentication methods
|
||||
---
|
||||
|
||||
import NavigationSteps from "../../components/NavigationSteps.astro"
|
||||
import ZulipNote from '../../components/ZulipNote.astro';
|
||||
import ZulipTip from '../../components/ZulipTip.astro';
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
import SaveChanges from "./include/_SaveChanges.mdx"
|
||||
import OwnerOnly from "./include/_OwnerOnly.mdx"
|
||||
|
||||
<OwnerOnly />
|
||||
|
||||
You can choose which authentication methods to enable for users to log in to
|
||||
your organization. The following options are available on all
|
||||
[plans](https://zulip.com/plans/):
|
||||
|
||||
* Email and password
|
||||
* Social authentication: Google, GitHub, GitLab, Apple
|
||||
|
||||
The following options are available for organizations on Zulip Cloud Standard,
|
||||
Zulip Cloud Plus, and all self-hosted Zulip servers:
|
||||
|
||||
* Oauth2 with Microsoft Entra ID (AzureAD)
|
||||
|
||||
The following options are available for organizations on Zulip Cloud Plus, and all self-hosted Zulip servers:
|
||||
|
||||
* [SAML authentication](/help/saml-authentication), including Okta, OneLogin, Entra ID (AzureAD), Keycloak, Auth0
|
||||
* [SCIM provisioning](/help/scim)
|
||||
|
||||
The following authentication and identity management options are available for
|
||||
all self-hosted servers. If you are interested in one of these options for a
|
||||
Zulip Cloud organization, contact [support@zulip.com](mailto:support@zulip.com)
|
||||
to inquire.
|
||||
|
||||
* [AD/LDAP user
|
||||
sync](https://zulip.readthedocs.io/en/stable/production/authentication-methods.html#ldap-including-active-directory)
|
||||
* [AD/LDAP group
|
||||
sync](https://zulip.readthedocs.io/en/stable/production/authentication-methods.html#ldap-including-active-directory)
|
||||
* [OpenID
|
||||
Connect](https://zulip.readthedocs.io/en/stable/production/authentication-methods.html#openid-connect)
|
||||
* [Custom authentication
|
||||
options](https://python-social-auth.readthedocs.io/en/latest/backends/index.html#social-backends)
|
||||
with python-social-auth
|
||||
|
||||
### Configure authentication methods
|
||||
|
||||
<ZulipNote>
|
||||
For self-hosted organizations, some authentication options require
|
||||
that you first [configure your
|
||||
server](https://zulip.readthedocs.io/en/stable/production/authentication-methods.html)
|
||||
to support the option.
|
||||
</ZulipNote>
|
||||
|
||||
<ZulipTip>
|
||||
Before disabling an authentication method, test that you can
|
||||
successfully log in with one of the remaining authentication methods.
|
||||
The [`change_auth_backends` management
|
||||
command](https://zulip.readthedocs.io/en/stable/production/management-commands.html)
|
||||
can help if you accidentally lock out all administrators.
|
||||
</ZulipTip>
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/auth-methods" />
|
||||
|
||||
1. To use SAML authentication or SCIM provisioning, Zulip Cloud organizations
|
||||
must upgrade to [Zulip Cloud Plus](https://zulip.com/plans/), and contact
|
||||
[support@zulip.com](mailto:support@zulip.com) to enable these methods.
|
||||
1. Toggle the checkboxes next to the available login options.
|
||||
|
||||
<SaveChanges />
|
||||
</FlattenedSteps>
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Configuring authentication methods](https://zulip.readthedocs.io/en/stable/production/authentication-methods.html)
|
||||
for server administrators (self-hosted only)
|
||||
* [SAML authentication](/help/saml-authentication)
|
||||
* [SCIM provisioning](/help/scim)
|
121
starlight_help/src/content/docs/configure-automated-notices.mdx
Normal file
121
starlight_help/src/content/docs/configure-automated-notices.mdx
Normal file
@@ -0,0 +1,121 @@
|
||||
---
|
||||
title: Configure automated notices
|
||||
---
|
||||
|
||||
import NavigationSteps from "../../components/NavigationSteps.astro"
|
||||
import AdminOnly from "./include/_AdminOnly.mdx"
|
||||
import SaveChanges from "./include/_SaveChanges.mdx"
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
|
||||
The Zulip sends automated notices via Notification Bot to notify users about
|
||||
changes in their organization or account. Some types of notices can be
|
||||
configured, or disabled altogether.
|
||||
|
||||
Notices sent to channels are translated into the language that the organization
|
||||
has configured as the [language for automated messages and invitation
|
||||
emails](/help/configure-organization-language). The topic name is also
|
||||
translated. Notices sent directly to users will use [their preferred
|
||||
language](/help/change-your-language).
|
||||
|
||||
## Notices about channels
|
||||
|
||||
Notices about channel settings changes, such as [name](/help/rename-a-channel),
|
||||
[description](/help/change-the-channel-description),
|
||||
[privacy](/help/change-the-privacy-of-a-channel) and
|
||||
[policy](/help/channel-posting-policy) updates are sent to the
|
||||
“channel events” topic in the channel that was modified.
|
||||
|
||||
### New channel announcements
|
||||
|
||||
<AdminOnly />
|
||||
|
||||
When creating a new [public](/help/channel-permissions#public-channels) or
|
||||
[web-public](/help/channel-permissions#web-public-channels) channel, the channel
|
||||
creator can choose to advertise the new channel via an automated notice. You can
|
||||
configure what channel Zulip uses for these notices, or disable these notices
|
||||
entirely. The topic for these messages is “new channels”.
|
||||
|
||||
New [private](/help/channel-permissions#private-channels) channels are never
|
||||
announced.
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/organization-settings" />
|
||||
|
||||
1. Under **Automated messages and emails**, configure **New channel
|
||||
announcements**.
|
||||
|
||||
<SaveChanges />
|
||||
</FlattenedSteps>
|
||||
|
||||
## Notices about topics
|
||||
|
||||
A notice is sent when a topic is [resolved or
|
||||
unresolved](/help/resolve-a-topic). Users can
|
||||
[configure](/help/marking-messages-as-read#configure-whether-resolved-topic-notices-are-marked-as-read)
|
||||
whether these notices are automatically marked as read.
|
||||
|
||||
Additionally, when moving messages to another
|
||||
[channel](/help/move-content-to-another-channel) or
|
||||
[topic](/help/move-content-to-another-topic), users can decide whether to send
|
||||
automated notices to help others understand how content was moved.
|
||||
|
||||
## Notices about users
|
||||
|
||||
You will be notified if someone [subscribes you to a
|
||||
channel](/help/subscribe-users-to-a-channel), or changes your
|
||||
[group](/help/user-groups) membership.
|
||||
|
||||
### New user announcements
|
||||
|
||||
<AdminOnly />
|
||||
|
||||
You can configure where Notification Bot will post an announcement when new
|
||||
users join your organization, or disable new user announcement messages
|
||||
entirely. The topic for these messages is “signups”.
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/organization-settings" />
|
||||
|
||||
1. Under **Automated messages and emails**, configure **New user
|
||||
announcements**.
|
||||
|
||||
<SaveChanges />
|
||||
</FlattenedSteps>
|
||||
|
||||
## Zulip update announcements
|
||||
|
||||
Zulip announces new features and other important product changes via automated
|
||||
messages. This is designed to help users discover new features they may find
|
||||
useful, including new configuration options.
|
||||
|
||||
These announcements are posted to the “Zulip updates” topic in the
|
||||
channel selected by organization administrators (usually 1-2x a month
|
||||
on Zulip Cloud). You can read update messages whenever it's
|
||||
convenient, or [mute](/help/mute-a-topic) the topic if you are not
|
||||
interested. If you organization does not want to receive these
|
||||
announcements, they can be disabled.
|
||||
|
||||
On self-hosted Zulip servers, announcement messages are shipped with the Zulip
|
||||
server version that includes the new feature or product change. You may thus
|
||||
receive several announcement messages when your server is upgraded.
|
||||
|
||||
Unlike other notices, Zulip update announcements are not translated.
|
||||
|
||||
### Configure Zulip update announcements
|
||||
|
||||
<AdminOnly />
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/organization-settings" />
|
||||
|
||||
1. Under **Automated messages and emails**, configure **Zulip update
|
||||
announcements**.
|
||||
|
||||
<SaveChanges />
|
||||
</FlattenedSteps>
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Organization language for automated messages and invitation emails](/help/configure-organization-language)
|
||||
* [Moderating open organizations](/help/moderating-open-organizations)
|
||||
* [Zulip newsletter](https://zulip.com/help/email-notifications#low-traffic-newsletter)
|
60
starlight_help/src/content/docs/configure-call-provider.mdx
Normal file
60
starlight_help/src/content/docs/configure-call-provider.mdx
Normal file
@@ -0,0 +1,60 @@
|
||||
---
|
||||
title: Configure call provider
|
||||
---
|
||||
|
||||
import NavigationSteps from "../../components/NavigationSteps.astro"
|
||||
import ZulipTip from '../../components/ZulipTip.astro';
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
import SaveChanges from "./include/_SaveChanges.mdx"
|
||||
import AdminOnly from "./include/_AdminOnly.mdx"
|
||||
|
||||
<AdminOnly />
|
||||
|
||||
By default, Zulip integrates with
|
||||
[Jitsi Meet](https://jitsi.org/jitsi-meet/), a fully-encrypted, 100% open
|
||||
source video conferencing solution. Organization administrators can also
|
||||
change the organization's call provider. The call providers
|
||||
supported by Zulip are:
|
||||
|
||||
* [Jitsi Meet](/integrations/doc/jitsi)
|
||||
* [Zoom integration](/integrations/doc/zoom)
|
||||
* [BigBlueButton integration](/integrations/doc/big-blue-button)
|
||||
|
||||
<ZulipTip>
|
||||
You can disable the video and voice call buttons for your organization
|
||||
by setting the **call provider** to "None".
|
||||
</ZulipTip>
|
||||
|
||||
## Configure your organization's call provider
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/organization-settings" />
|
||||
|
||||
1. Under **Compose settings**, select the desired provider from the
|
||||
**Call provider** dropdown.
|
||||
|
||||
<SaveChanges />
|
||||
</FlattenedSteps>
|
||||
|
||||
## Use a self-hosted instance of Jitsi Meet
|
||||
|
||||
Zulip uses the [cloud version of Jitsi Meet](https://meet.jit.si/)
|
||||
as its default call provider. You can also use a self-hosted
|
||||
instance of Jitsi Meet.
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/organization-settings" />
|
||||
|
||||
1. Under **Compose settings**, select **Custom URL** from the
|
||||
**Jitsi server URL** dropdown.
|
||||
1. Enter the URL of your self-hosted Jitsi Meet server.
|
||||
|
||||
<SaveChanges />
|
||||
</FlattenedSteps>
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Start a call](/help/start-a-call)
|
||||
* [Jitsi Meet integration](/integrations/doc/jitsi)
|
||||
* [Zoom integration](/integrations/doc/zoom)
|
||||
* [BigBlueButton integration](/integrations/doc/big-blue-button)
|
@@ -0,0 +1,80 @@
|
||||
---
|
||||
title: Configure default settings for new users
|
||||
---
|
||||
|
||||
import NavigationSteps from "../../components/NavigationSteps.astro"
|
||||
import AdminOnly from "./include/_AdminOnly.mdx"
|
||||
import SaveChanges from "./include/_SaveChanges.mdx"
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
|
||||
<AdminOnly />
|
||||
|
||||
Organization administrators can configure the default values of
|
||||
personal preference settings for new users joining the
|
||||
organization. This can help seamlessly customize the Zulip experience
|
||||
to match how the organization in question is using Zulip.
|
||||
|
||||
Existing users' preferences cannot be modified by administrators, and
|
||||
users will be able to customize their own settings once they
|
||||
join. Administrators can customize defaults for all personal
|
||||
preference settings, including the following:
|
||||
|
||||
* Privacy settings:
|
||||
* Displaying [availability](/help/status-and-availability) to other users
|
||||
* Allowing others to see when the user has [read
|
||||
messages](/help/read-receipts)
|
||||
* Allowing others to see when the user is [typing a
|
||||
message](/help/typing-notifications)
|
||||
* Preferences:
|
||||
* [Language](/help/change-your-language)
|
||||
* [Time format](/help/change-the-time-format)
|
||||
* [Light theme vs. dark theme](/help/dark-theme)
|
||||
* [Font size](/help/font-size)
|
||||
* [Line spacing](/help/line-spacing)
|
||||
* [Emoji theme](/help/emoji-and-emoticons#change-your-emoji-set)
|
||||
* [Home view](/help/configure-home-view)
|
||||
([**Inbox**](/help/inbox) vs.
|
||||
[**Recent conversations**](/help/recent-conversations) vs.
|
||||
[**Combined feed**](/help/reading-strategies#combined-feed))
|
||||
* Notification settings:
|
||||
* What types of messages [trigger notifications][default-notifications]
|
||||
* Which topics users will [automatically follow](/help/follow-a-topic). This
|
||||
minimizes the need to [mention](/help/mention-a-user-or-group) other users
|
||||
to get their attention.
|
||||
|
||||
[default-notifications]: /help/channel-notifications#configure-default-notifications-for-all-channels
|
||||
|
||||
## Configure default settings for new users
|
||||
|
||||
Users will have the initial settings that are configured at the time when they
|
||||
accept the invitation, so there's no need to update or revoke invitations when
|
||||
you change default settings.
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/default-user-settings" />
|
||||
|
||||
1. Review all settings and adjust as needed.
|
||||
</FlattenedSteps>
|
||||
|
||||
## Configure default language for new users
|
||||
|
||||
Your organization's [language](/help/configure-organization-language) will be
|
||||
the default language for new users when Zulip cannot detect their language
|
||||
preferences from their browser, including all users [created via the Zulip
|
||||
API](/api/create-user).
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/organization-settings" />
|
||||
|
||||
1. Under **Automated messages and emails**, change the **Language for
|
||||
automated messages and invitation emails**.
|
||||
|
||||
<SaveChanges />
|
||||
</FlattenedSteps>
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Moving to Zulip](/help/moving-to-zulip)
|
||||
* [Customize settings for new users](/help/customize-settings-for-new-users)
|
||||
* [Set default channels for new users](/help/set-default-channels-for-new-users)
|
||||
* [Invite users to join](/help/invite-users-to-join)
|
@@ -0,0 +1,50 @@
|
||||
---
|
||||
title: Configure email visibility
|
||||
---
|
||||
|
||||
import NavigationSteps from "../../components/NavigationSteps.astro"
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
import { Steps } from '@astrojs/starlight/components';
|
||||
import { Tabs, TabItem } from '@astrojs/starlight/components'
|
||||
import AdminOnly from "./include/_AdminOnly.mdx"
|
||||
|
||||
With privacy in mind, Zulip lets you control which
|
||||
[roles](/help/user-roles) in the organization can view your email
|
||||
address. Administrators can set the default email visibility configuration
|
||||
for new users in the organization.
|
||||
|
||||
## Configure who can access your email address
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="On sign-up">
|
||||
<Steps>
|
||||
1. After confirming your email, click **Change** below your email address.
|
||||
1. Configure **Who can access your email address**.
|
||||
1. Click **Confirm** to apply your changes, and continue the account registration
|
||||
process.
|
||||
</Steps>
|
||||
</TabItem>
|
||||
|
||||
<TabItem label="Desktop/Web">
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/account-and-privacy" />
|
||||
|
||||
1. Under **Privacy**, configure **Who can access your email address**.
|
||||
</FlattenedSteps>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Configure default email visibility for new users
|
||||
|
||||
<AdminOnly />
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/default-user-settings" />
|
||||
|
||||
1. Under **Privacy settings**, configure **Who can access user's email address**.
|
||||
</FlattenedSteps>
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Moderating open organizations](/help/moderating-open-organizations)
|
||||
* [Restrict name and email changes](/help/restrict-name-and-email-changes)
|
@@ -0,0 +1,28 @@
|
||||
---
|
||||
title: Configure emoticon translations
|
||||
---
|
||||
|
||||
import NavigationSteps from "../../components/NavigationSteps.astro"
|
||||
import EmoticonTranslations from '../../components/EmoticonTranslations.astro';
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
|
||||
You can configure whether emoticons like `:)` or `:(` will be automatically
|
||||
translated into emoji equivalents like 🙂 or 🙁 by Zulip.
|
||||
|
||||
## Configure emoticon translations
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/preferences" />
|
||||
|
||||
1. Under **Emoji**, toggle **Convert emoticons before sending**.
|
||||
</FlattenedSteps>
|
||||
|
||||
## List of emoticon translations
|
||||
|
||||
<EmoticonTranslations />
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Emoji and emoticons](/help/emoji-and-emoticons)
|
||||
* [Add custom emoji](/help/custom-emoji)
|
||||
* [Emoji reactions](/help/emoji-reactions)
|
85
starlight_help/src/content/docs/configure-home-view.mdx
Normal file
85
starlight_help/src/content/docs/configure-home-view.mdx
Normal file
@@ -0,0 +1,85 @@
|
||||
---
|
||||
title: Configure home view
|
||||
---
|
||||
|
||||
import NavigationSteps from "../../components/NavigationSteps.astro"
|
||||
import MoreVerticalIcon from "~icons/zulip-icon/more-vertical"
|
||||
import ZulipTip from '../../components/ZulipTip.astro';
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
|
||||
The home view in Zulip is the view you reach after logging in
|
||||
to the Zulip web app. You can also navigate to the home view via
|
||||
keyboard shortcuts.
|
||||
|
||||
The home views available in Zulip are
|
||||
[**Inbox**](/help/inbox),
|
||||
[**Recent conversations**](/help/recent-conversations), and
|
||||
[**Combined feed**](/help/combined-feed). See
|
||||
[Reading strategies](/help/reading-strategies) for recommendations
|
||||
on how to use these views.
|
||||
|
||||
You can configure which view is set as your home view, and whether
|
||||
the <kbd>Esc</kbd> key navigates to the home view. Also, you can
|
||||
always reach the home view by using the
|
||||
<kbd data-mac-key="Ctrl">Ctrl</kbd> + <kbd>\[</kbd> shortcut.
|
||||
|
||||
## Change home view
|
||||
|
||||
Organization administrators can [configure the home view for their
|
||||
organization](/help/configure-default-new-user-settings) to
|
||||
[**Inbox**](/help/inbox),
|
||||
[**Recent conversations**](/help/recent-conversations), or
|
||||
[**Combined feed**](/help/combined-feed).
|
||||
|
||||
* The **Inbox** view works best if you regularly clear all unread messages in
|
||||
channels you follow.
|
||||
* **Recent conversations** works well for getting an overview of recent activity.
|
||||
* **Combined feed** is convenient for low-traffic organizations, or for skimming
|
||||
messages as they come in.
|
||||
|
||||
You can customize your personal home view regardless of
|
||||
organization settings:
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/preferences" />
|
||||
|
||||
1. Under **Navigation**, click on the **Home view** dropdown
|
||||
and select a view.
|
||||
1. To see your changes in action, open a new Zulip tab, or use a keyboard
|
||||
shortcut twice to exit the settings and navigate to your home view
|
||||
(<kbd data-mac-key="Ctrl">Ctrl</kbd> + <kbd>\[</kbd> or <kbd>Esc</kbd>
|
||||
if enabled).
|
||||
</FlattenedSteps>
|
||||
|
||||
<ZulipTip>
|
||||
You can also hover over your desired home view in the left sidebar, and
|
||||
choose the option to **make it your home view** in the **ellipsis**
|
||||
(<MoreVerticalIcon />) menu.
|
||||
</ZulipTip>
|
||||
|
||||
## Configure whether <kbd>Esc</kbd> navigates to the home view
|
||||
|
||||
Zulip has a number of [keyboard shortcuts](/help/keyboard-shortcuts)
|
||||
designed to enhance the user experience in the app.
|
||||
|
||||
By default, the <kbd>Esc</kbd> key shortcut will ultimately navigate to
|
||||
your home view. You can disable this key binding if you would prefer.
|
||||
This will not disable other <kbd>Esc</kbd> key shortcuts used in Zulip,
|
||||
and will not affect the behavior of the
|
||||
<kbd data-mac-key="Ctrl">Ctrl</kbd> + <kbd>\[</kbd> shortcut.
|
||||
|
||||
### Toggle whether <kbd>Esc</kbd> navigates to the home view
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/preferences" />
|
||||
|
||||
1. Under **Navigation**, toggle **Escape key navigates to
|
||||
home view**, as desired.
|
||||
</FlattenedSteps>
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Reading strategies](/help/reading-strategies)
|
||||
* [Recent conversations](/help/recent-conversations)
|
||||
* [Combined feed](/help/combined-feed)
|
||||
* [Keyboard shortcuts](/help/keyboard-shortcuts)
|
26
starlight_help/src/content/docs/configure-how-links-open.mdx
Normal file
26
starlight_help/src/content/docs/configure-how-links-open.mdx
Normal file
@@ -0,0 +1,26 @@
|
||||
---
|
||||
title: Configure how links open in mobile apps
|
||||
---
|
||||
|
||||
import { Tabs, TabItem } from '@astrojs/starlight/components'
|
||||
import MobileSettings from "./include/_MobileSettings.mdx"
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
|
||||
You can configure whether website links will open directly in the Zulip app, or
|
||||
in your device's default browser.
|
||||
|
||||
## Configure whether to open links within the app
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Mobile">
|
||||
<FlattenedSteps>
|
||||
<MobileSettings />
|
||||
|
||||
1. Toggle **Open links with in-app browser**.
|
||||
</FlattenedSteps>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Link to a message or conversation](/help/link-to-a-message-or-conversation)
|
@@ -0,0 +1,23 @@
|
||||
---
|
||||
title: Configure multi-language search
|
||||
---
|
||||
|
||||
Zulip supports [full-text search](/help/search-for-messages), which can be
|
||||
combined arbitrarily with Zulip's full suite of [search
|
||||
filters](/help/search-for-messages#search-filters). By default, Zulip search
|
||||
only supports English text, using [PostgreSQL's built-in full-text search
|
||||
feature](https://www.postgresql.org/docs/current/textsearch.html), with a custom
|
||||
set of English stop words to improve the quality of the search results.
|
||||
|
||||
Self-hosted Zulip organizations can instead set up an experimental
|
||||
[PGroonga](https://pgroonga.github.io/) integration that provides full-text
|
||||
search for all languages simultaneously, including Japanese and Chinese. See
|
||||
[here](https://zulip.readthedocs.io/en/stable/subsystems/full-text-search.html#multi-language-full-text-search)
|
||||
for setup instructions.
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Configure organization language for automated messages and invitation emails][org-lang]
|
||||
* [Searching for messages](/help/search-for-messages)
|
||||
|
||||
[org-lang]: /help/configure-organization-language
|
@@ -0,0 +1,50 @@
|
||||
---
|
||||
title: Organization language for automated messages and invitation emails
|
||||
---
|
||||
|
||||
import NavigationSteps from "../../components/NavigationSteps.astro"
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
import SaveChanges from "./include/_SaveChanges.mdx"
|
||||
import TranslationProjectInfo from "./include/_TranslationProjectInfo.mdx"
|
||||
import AdminOnly from "./include/_AdminOnly.mdx"
|
||||
|
||||
<AdminOnly />
|
||||
|
||||
<TranslationProjectInfo />
|
||||
|
||||
Each user can use Zulip with [their preferred language][user-lang].
|
||||
Additionally, if your organization has a primary language other than
|
||||
American English, you can set the language used for the organization's
|
||||
automated messages and invitation emails. This setting:
|
||||
|
||||
* Determines the language used for [automated
|
||||
notices](/help/configure-automated-notices) that are sent to channels, including
|
||||
both the topic name and message content. (Automated messages sent to a single
|
||||
user will use that user's preferred language).
|
||||
* Determines the language used for outgoing
|
||||
[invitation emails](/help/invite-new-users).
|
||||
* Is used as the default language for new user accounts when Zulip
|
||||
cannot detect their language preferences from their browser,
|
||||
including all users [created via the Zulip API][api-create-user].
|
||||
|
||||
## Configure the organization language
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/organization-settings" />
|
||||
|
||||
1. Under **Automated messages and emails**, change the **Language for
|
||||
automated messages and invitation emails**.
|
||||
|
||||
<SaveChanges />
|
||||
</FlattenedSteps>
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Change your language][user-lang]
|
||||
* [Configure multi-language search](/help/configure-multi-language-search)
|
||||
* [Configure default settings for new users](/help/configure-default-new-user-settings)
|
||||
* [Configure automated notices](/help/configure-automated-notices)
|
||||
|
||||
[api-create-user]: https://zulip.com/api/create-user
|
||||
|
||||
[user-lang]: /help/change-your-language
|
@@ -0,0 +1,52 @@
|
||||
---
|
||||
title: Configure send message keys
|
||||
---
|
||||
|
||||
import NavigationSteps from "../../components/NavigationSteps.astro"
|
||||
import MoreVerticalIcon from "~icons/zulip-icon/more-vertical"
|
||||
import ZulipTip from '../../components/ZulipTip.astro';
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
import StartComposing from "./include/_StartComposing.mdx"
|
||||
import SendIcon from "~icons/zulip-icon/send"
|
||||
import { Tabs, TabItem } from '@astrojs/starlight/components'
|
||||
|
||||
By default, the <kbd>Enter</kbd> key adds a new line to your message,
|
||||
and <kbd>Ctrl</kbd> + <kbd>Enter</kbd> sends your message.
|
||||
|
||||
This is convenient for typing multi-line messages, which are more common in
|
||||
Zulip than in most other chat products. However, you can also configure
|
||||
Zulip so that the <kbd>Enter</kbd> key sends your message.
|
||||
|
||||
<ZulipTip>
|
||||
<kbd>Shift</kbd> + <kbd>Enter</kbd> always adds a new line, regardless
|
||||
of whether **<kbd>Enter</kbd> to send** is enabled.
|
||||
</ZulipTip>
|
||||
|
||||
## Configure send message keys
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Via compose box">
|
||||
<FlattenedSteps>
|
||||
<StartComposing />
|
||||
|
||||
1. Click on the **ellipsis** (<MoreVerticalIcon />)
|
||||
in the bottom right corner of the compose box, next to the **Send**
|
||||
(<SendIcon />) button.
|
||||
1. Toggle your preferred option for **Press ... to send**.
|
||||
</FlattenedSteps>
|
||||
</TabItem>
|
||||
|
||||
<TabItem label="Via personal settings">
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/preferences" />
|
||||
|
||||
1. Under **General**, toggle **<kbd>Enter</kbd> sends when composing a message**.
|
||||
</FlattenedSteps>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Message formatting](/help/format-your-message-using-markdown)
|
||||
* [Preview messages before sending](/help/preview-your-message-before-sending)
|
||||
* [Mastering the compose box](/help/mastering-the-compose-box)
|
@@ -0,0 +1,67 @@
|
||||
---
|
||||
title: Configure unread message counters
|
||||
---
|
||||
|
||||
import NavigationSteps from "../../components/NavigationSteps.astro"
|
||||
import MoreVerticalIcon from "~icons/zulip-icon/more-vertical"
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
import { Steps } from '@astrojs/starlight/components';
|
||||
import { Tabs, TabItem } from '@astrojs/starlight/components'
|
||||
|
||||
To provide information about unread messages, Zulip can show unread message
|
||||
counters next to channel names in the left sidebar. This is likely to be helpful
|
||||
if you generally read (or otherwise [mark as read](/help/marking-messages-as-read))
|
||||
all the messages in a channel, but may otherwise feel unnecessary.
|
||||
|
||||
## Configure unread message counters
|
||||
|
||||
Zulip offers an option to display a dot instead of an unread counter for channels
|
||||
in the left sidebar. You can use a dot for all channels, or just for channels you
|
||||
have [muted](/help/mute-a-channel). You will still be able to see the number of
|
||||
unread messages in a channel by moving your mouse over it in the left sidebar or
|
||||
opening it.
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Desktop/Web">
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/preferences" />
|
||||
|
||||
1. Under **Left sidebar**, select your preferred option from the
|
||||
**Show unread counts for** dropdown.
|
||||
</FlattenedSteps>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Configure unread summary counters
|
||||
|
||||
You can configure whether Zulip displays unread count summaries on your home
|
||||
view in the left sidebar. You will still be able to see the
|
||||
summary counts by moving your mouse over them in the left sidebar. The counter
|
||||
on your home view will also be shown when you're in that view.
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Via left sidebar">
|
||||
<Steps>
|
||||
1. Hover over your configured [home view](/help/configure-home-view) in the
|
||||
**views** section of the left sidebar.
|
||||
1. Click on the **ellipsis** (<MoreVerticalIcon />).
|
||||
1. Click the option to hide or show the unread counter.
|
||||
</Steps>
|
||||
</TabItem>
|
||||
|
||||
<TabItem label="Via personal settings">
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/preferences" />
|
||||
|
||||
1. Under **Left sidebar**, toggle **Show unread count total on home view**.
|
||||
</FlattenedSteps>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Reading strategies](/help/reading-strategies)
|
||||
* [Marking messages as read](/help/marking-messages-as-read)
|
||||
* [Marking messages as unread](/help/marking-messages-as-unread)
|
||||
* [Star a message](/help/star-a-message)
|
||||
* [Desktop notifications](/help/desktop-notifications)
|
44
starlight_help/src/content/docs/configure-where-you-land.mdx
Normal file
44
starlight_help/src/content/docs/configure-where-you-land.mdx
Normal file
@@ -0,0 +1,44 @@
|
||||
---
|
||||
title: Configure where you land in message feeds
|
||||
---
|
||||
|
||||
import { Tabs, TabItem } from '@astrojs/starlight/components'
|
||||
import MobileSettings from "./include/_MobileSettings.mdx"
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
|
||||
When you go to a message feed in the Zulip web or desktop app, you'll generally
|
||||
land at your oldest unread message in that view.
|
||||
[Searches](/help/search-for-messages) and [starred
|
||||
messages](/help/star-a-message) put you at the newest message instead.
|
||||
|
||||
In the mobile app, you can choose where message feeds will open:
|
||||
|
||||
* **First unread message**: Recommended if you like to clear your inbox of
|
||||
unread messages.
|
||||
* **First unread message in conversation views, newest message elsewhere**: In
|
||||
Zulip, a **conversation** is a [direct message](/help/direct-messages) thread
|
||||
(one-on-one or with a group), or a [topic in a
|
||||
channel](/help/introduction-to-topics). This option works well if you have old
|
||||
unread messages, and don't want to navigate there in your [Combined
|
||||
feed](/help/combined-feed) and [channel feeds](/help/channel-feed).
|
||||
* **Newest message**: You may be used to this behavior from other chat
|
||||
applications. To avoid accidentally marking messages as read,
|
||||
consider setting [Mark messages as read on
|
||||
scroll](/help/marking-messages-as-read#configure-whether-messages-are-automatically-marked-as-read)
|
||||
to **Never** when using this setting.
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Mobile">
|
||||
<FlattenedSteps>
|
||||
<MobileSettings />
|
||||
|
||||
1. Tap **Open message feeds at**.
|
||||
1. Select the desired configuration.
|
||||
</FlattenedSteps>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Marking messages as read](/help/marking-messages-as-read)
|
||||
* [Reading strategies](/help/reading-strategies)
|
@@ -0,0 +1,40 @@
|
||||
---
|
||||
title: Configure who can administer a channel
|
||||
---
|
||||
|
||||
import NavigationSteps from "../../components/NavigationSteps.astro"
|
||||
import ZulipNote from '../../components/ZulipNote.astro';
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
import SaveChanges from "./include/_SaveChanges.mdx"
|
||||
import ChannelAdminPermissions from "./include/_ChannelAdminPermissions.mdx"
|
||||
import SelectChannelViewGeneralAdvanced from "./include/_SelectChannelViewGeneralAdvanced.mdx"
|
||||
|
||||
<ZulipNote>
|
||||
Organization administrators can automatically administer all channels.
|
||||
</ZulipNote>
|
||||
|
||||
<ChannelAdminPermissions />
|
||||
|
||||
## Configure who can administer a channel
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="relative/channel/all" />
|
||||
|
||||
1. Select a channel.
|
||||
|
||||
<SelectChannelViewGeneralAdvanced />
|
||||
|
||||
1. Under **Administrative permissions**, configure **Who can administer
|
||||
this channel**.
|
||||
|
||||
<SaveChanges />
|
||||
</FlattenedSteps>
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Channel permissions](/help/channel-permissions)
|
||||
* [User roles](/help/user-roles)
|
||||
* [User groups](/help/user-groups)
|
||||
* [Channel posting policy](/help/channel-posting-policy)
|
||||
* [Configure who can unsubscribe anyone from a channel](/help/configure-who-can-unsubscribe-others)
|
||||
* [Archive a channel](/help/archive-a-channel)
|
@@ -0,0 +1,66 @@
|
||||
---
|
||||
title: Restrict channel creation
|
||||
---
|
||||
|
||||
import NavigationSteps from "../../components/NavigationSteps.astro"
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
import SaveChanges from "./include/_SaveChanges.mdx"
|
||||
import { Tabs, TabItem } from '@astrojs/starlight/components'
|
||||
import AdminOnly from "./include/_AdminOnly.mdx"
|
||||
|
||||
<AdminOnly />
|
||||
|
||||
Zulip allows you to separately control [permissions](/help/manage-permissions)
|
||||
for creating [web-public](/help/public-access-option), public and private
|
||||
channels.
|
||||
|
||||
For corporations and other organizations with controlled access, we
|
||||
recommend keeping channel creation open to make it easy for users to
|
||||
self-organize.
|
||||
|
||||
Only users in trusted roles (moderators and administrators) can be
|
||||
given permission to create web-public channels. This is intended
|
||||
[to help manage abuse](/help/public-access-option#managing-abuse) by
|
||||
making it hard for an attacker to host malicious content in an
|
||||
unadvertised web-public channel in a legitimate organization.
|
||||
|
||||
### Manage who can create channels
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Public channels">
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/organization-permissions" />
|
||||
|
||||
1. Under **Channel permissions**, configure **Who can create public channels**.
|
||||
|
||||
<SaveChanges />
|
||||
</FlattenedSteps>
|
||||
</TabItem>
|
||||
|
||||
<TabItem label="Private channels">
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/organization-permissions" />
|
||||
|
||||
1. Under **Channel permissions**, configure **Who can create private channels**.
|
||||
|
||||
<SaveChanges />
|
||||
</FlattenedSteps>
|
||||
</TabItem>
|
||||
|
||||
<TabItem label="Web-public channels">
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/organization-permissions" />
|
||||
|
||||
1. Under **Channel permissions**, configure **Who can create web-public channels**.
|
||||
|
||||
<SaveChanges />
|
||||
</FlattenedSteps>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Channel permissions](/help/channel-permissions)
|
||||
* [User roles](/help/user-roles)
|
||||
* [Create a channel](/help/create-a-channel)
|
||||
* [Introduction to channels](/help/introduction-to-channels)
|
@@ -0,0 +1,69 @@
|
||||
---
|
||||
title: Configure who can subscribe other users to channels
|
||||
---
|
||||
|
||||
import NavigationSteps from "../../components/NavigationSteps.astro"
|
||||
import ContentAccessDefinition from "./include/_ContentAccessDefinition.mdx"
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
import SaveChanges from "./include/_SaveChanges.mdx"
|
||||
import SelectChannelViewGeneralAdvanced from "./include/_SelectChannelViewGeneralAdvanced.mdx"
|
||||
import AdminOnly from "./include/_AdminOnly.mdx"
|
||||
|
||||
You can configure who can subscribe other users to channels. If you have
|
||||
permission to subscribe users [to a specific
|
||||
channel](#configure-who-can-subscribe-anyone-to-a-specific-channel), you can
|
||||
always do so, whether or not you're subscribed yourself.
|
||||
|
||||
There is also a [general
|
||||
permission](#configure-who-can-subscribe-others-to-channels-in-general), which
|
||||
allows subscribing others to all [public
|
||||
channels](/help/channel-permissions#public-channels). For [private
|
||||
channels](/help/channel-permissions#private-channels), you additionally need to
|
||||
have content access to the channel in order to use this permission. Users have
|
||||
content access if:
|
||||
|
||||
<ContentAccessDefinition />
|
||||
|
||||
[Guests](/help/guest-users) are never permitted to subscribe others.
|
||||
|
||||
## Configure who can subscribe others to channels in general
|
||||
|
||||
<AdminOnly />
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/organization-permissions" />
|
||||
|
||||
1. Under **Channel permissions**, configure **Who can subscribe others to channels**.
|
||||
|
||||
<SaveChanges />
|
||||
</FlattenedSteps>
|
||||
|
||||
## Configure who can subscribe anyone to a specific channel
|
||||
|
||||
If you have permission to administer a public channel, you can configure who can
|
||||
subscribe anyone to it. For [private
|
||||
channels](/help/channel-permissions#private-channels), you additionally need to
|
||||
have content access in order to change this configuration.
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="relative/channel/all" />
|
||||
|
||||
1. Select a channel.
|
||||
|
||||
<SelectChannelViewGeneralAdvanced />
|
||||
|
||||
1. Under **Subscription permissions**, configure **Who can subscribe anyone to
|
||||
this channel**.
|
||||
|
||||
<SaveChanges />
|
||||
</FlattenedSteps>
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Channel permissions](/help/channel-permissions)
|
||||
* [User roles](/help/user-roles)
|
||||
* [User groups](/help/user-groups)
|
||||
* [Configure who can subscribe to a channel](/help/configure-who-can-subscribe)
|
||||
* [Configure who can unsubscribe anyone from a channel](/help/configure-who-can-unsubscribe-others)
|
||||
* [Subscribe users to a channel](/help/subscribe-users-to-a-channel)
|
||||
* [Unsubscribe users from a channel](/help/unsubscribe-users-from-a-channel)
|
@@ -0,0 +1,64 @@
|
||||
---
|
||||
title: Configure who can subscribe to a channel
|
||||
---
|
||||
|
||||
import NavigationSteps from "../../components/NavigationSteps.astro"
|
||||
import ZulipTip from '../../components/ZulipTip.astro';
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
import SaveChanges from "./include/_SaveChanges.mdx"
|
||||
import SelectChannelViewGeneralAdvanced from "./include/_SelectChannelViewGeneralAdvanced.mdx"
|
||||
import { Tabs, TabItem } from '@astrojs/starlight/components'
|
||||
|
||||
You can give users permission to subscribe to a channel. Everyone other than
|
||||
[guests](/help/guest-users) can subscribe to any
|
||||
[public](/help/channel-permissions#public-channels) or
|
||||
[web-public](/help/channel-permissions#web-public-channels) channel, so this
|
||||
feature is intended for use with [private
|
||||
channels](/help/channel-permissions#private-channels). Guests can never
|
||||
subscribe themselves to a channel.
|
||||
|
||||
This permission grants access to channel content: users who are allowed to
|
||||
subscribe to a channel will also be able to read messages in it without
|
||||
subscribing.
|
||||
|
||||
<ZulipTip>
|
||||
For example, you can give your team's [user group](/help/user-groups) permission
|
||||
to subscribe to each of your team's channels. A designer on the team could then
|
||||
follow a [link to a
|
||||
conversation](/help/link-to-a-message-or-conversation#link-to-a-topic-within-zulip)
|
||||
in the private engineering channel, and read it without subscribing. They could
|
||||
subscribe if they need to send a message there, without asking for help.
|
||||
</ZulipTip>
|
||||
|
||||
If you have permission to administer a public channel, you can configure who can
|
||||
subscribe to it. For [private
|
||||
channels](/help/channel-permissions#private-channels), you additionally need to
|
||||
have content access in order to change this configuration.
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Desktop/Web">
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="relative/channel/all" />
|
||||
|
||||
1. Select a channel.
|
||||
|
||||
<SelectChannelViewGeneralAdvanced />
|
||||
|
||||
1. Under **Subscription permissions**, configure **Who can subscribe to this
|
||||
channel**.
|
||||
|
||||
<SaveChanges />
|
||||
</FlattenedSteps>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Subscribe to a channel](/help/introduction-to-channels#browse-and-subscribe-to-channels)
|
||||
* [Channel permissions](/help/channel-permissions)
|
||||
* [User roles](/help/user-roles)
|
||||
* [User groups](/help/user-groups)
|
||||
* [Configure who can subscribe other users to channels](/help/configure-who-can-invite-to-channels)
|
||||
* [Configure who can unsubscribe anyone from a channel](/help/configure-who-can-unsubscribe-others)
|
||||
* [Subscribe users to a channel](/help/subscribe-users-to-a-channel)
|
||||
* [Unsubscribe users from a channel](/help/unsubscribe-users-from-a-channel)
|
@@ -0,0 +1,35 @@
|
||||
---
|
||||
title: Configure who can unsubscribe anyone from a channel
|
||||
---
|
||||
|
||||
import NavigationSteps from "../../components/NavigationSteps.astro"
|
||||
import SaveChanges from "./include/_SaveChanges.mdx"
|
||||
import SelectChannelViewGeneralAdvanced from "./include/_SelectChannelViewGeneralAdvanced.mdx"
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
|
||||
Organization administrators and [channel
|
||||
administrators](/help/configure-who-can-administer-a-channel) can automatically
|
||||
unsubscribe anyone from a channel.
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="relative/channel/all" />
|
||||
|
||||
1. Select a channel.
|
||||
|
||||
<SelectChannelViewGeneralAdvanced />
|
||||
|
||||
1. Under **Subscription permissions**, configure **Who can unsubscribe anyone
|
||||
from this channel**.
|
||||
|
||||
<SaveChanges />
|
||||
</FlattenedSteps>
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Channel permissions](/help/channel-permissions)
|
||||
* [User roles](/help/user-roles)
|
||||
* [User groups](/help/user-groups)
|
||||
* [Configure who can administer a channel](/help/configure-who-can-administer-a-channel)
|
||||
* [Restrict who can subscribe other users to channels](/help/configure-who-can-invite-to-channels)
|
||||
* [Unsubscribe users from a channel](/help/unsubscribe-users-from-a-channel)
|
||||
* [Subscribe users to a channel](/help/subscribe-users-to-a-channel)
|
84
starlight_help/src/content/docs/connect-through-a-proxy.mdx
Normal file
84
starlight_help/src/content/docs/connect-through-a-proxy.mdx
Normal file
@@ -0,0 +1,84 @@
|
||||
---
|
||||
title: Connect through a proxy
|
||||
---
|
||||
|
||||
import DesktopSidebarSettingsMenu from "./include/_DesktopSidebarSettingsMenu.mdx"
|
||||
import { Tabs, TabItem } from '@astrojs/starlight/components'
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
|
||||
Some corporate and university networks may require you to connect to Zulip
|
||||
via a proxy.
|
||||
|
||||
## Web
|
||||
|
||||
Zulip uses your browser's default proxy settings. To set a custom proxy just
|
||||
for Zulip, check your browser's instructions for setting a custom proxy for
|
||||
a single website.
|
||||
|
||||
## Desktop
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="System proxy settings">
|
||||
<FlattenedSteps>
|
||||
<DesktopSidebarSettingsMenu />
|
||||
|
||||
1. Select the **Network** tab.
|
||||
1. Click **Use system proxy settings**.
|
||||
1. Restart the Zulip desktop app.
|
||||
</FlattenedSteps>
|
||||
</TabItem>
|
||||
|
||||
<TabItem label="Custom proxy settings">
|
||||
<FlattenedSteps>
|
||||
<DesktopSidebarSettingsMenu />
|
||||
|
||||
1. Select the **Network** tab.
|
||||
1. Click **Manual proxy configuration**.
|
||||
1. Either enter a URL for **PAC script**, or fill out **Proxy rules** and
|
||||
**Proxy bypass rules**.
|
||||
1. Click **Save changes**.
|
||||
</FlattenedSteps>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Additional tips for custom proxy settings
|
||||
|
||||
In most corporate environments, your network administrator will provide a
|
||||
URL for the **PAC script**.
|
||||
|
||||
The second most common configuration is that your network administrator has
|
||||
set up a proxy server for accessing the public internet, but URLs on the
|
||||
local network must be accessed directly. In that case set **Proxy rules** to
|
||||
the URL of the proxy server (it may look something like
|
||||
`http://proxy.example.edu:port`), and **Proxy bypass rules** to cover local URLs
|
||||
(it may look something like `*.example.edu,10.0.0.0/8`).
|
||||
|
||||
If either of those apply, you can skip the rest of this guide. If not, we
|
||||
document the syntax for **Proxy rules** and **Proxy bypass rules** below.
|
||||
|
||||
### Proxy rules
|
||||
|
||||
A semicolon-separated list of `protocolRule`s.
|
||||
|
||||
```
|
||||
protocolRule -> [<protocol>"="]<URLList>
|
||||
protocol -> "http" | "https" | "ftp" | "socks"
|
||||
URLList -> comma-separated list of URLs, ["direct://"]
|
||||
```
|
||||
|
||||
Some examples:
|
||||
|
||||
* `http=http://foo:80;ftp=http://bar:1080` - Use proxy `http://foo:80`
|
||||
for `http://` URLs, and proxy `http://bar:1080` for `ftp://` URLs.
|
||||
* `http://foo:80` - Use proxy `http://foo:80` for all URLs.
|
||||
* `http://foo:80,socks5://bar,direct://` - Use proxy `http://foo:80` for
|
||||
all URLs, failing over to `socks5://bar` if `http://foo:80` is
|
||||
unavailable, and after that using no proxy.
|
||||
* `http=http://foo;socks5://bar` - Use proxy `http://foo` for `http://` URLs,
|
||||
and use `socks5://bar` for all other URLs.
|
||||
|
||||
### Proxy bypass rules
|
||||
|
||||
A comma-separated list of URIs. The URIs can be hostnames, IP address
|
||||
literals, or IP ranges in CIDR notation. Hostnames can use the `*`
|
||||
wildcard. Use `<local>` to match any of `127.0.0.1`, `::1`, or `localhost`.
|
79
starlight_help/src/content/docs/contact-support.mdx
Normal file
79
starlight_help/src/content/docs/contact-support.mdx
Normal file
@@ -0,0 +1,79 @@
|
||||
---
|
||||
title: Contact support
|
||||
---
|
||||
|
||||
We're here to help! This page will guide you to the best way to reach us.
|
||||
|
||||
## Zulip community
|
||||
|
||||
The primary communication forum for the Zulip community is the Zulip server
|
||||
hosted at chat.zulip.org. Users and administrators of Zulip organizations stop
|
||||
by to ask questions, offer feedback, and participate in product design
|
||||
discussions.
|
||||
|
||||
Everyone is welcome to sign up and participate — we love hearing from our users!
|
||||
Please see the [Zulip development community][development-community] guide for
|
||||
detailed instructions on how to join the community, [community norms][community-norms]
|
||||
and [where][development-community-channels] to ask your questions or give
|
||||
feedback.
|
||||
|
||||
## Support requests
|
||||
|
||||
* For support requests regarding your Zulip Cloud organization, you can request
|
||||
interactive chat support in the [Zulip development
|
||||
community](#zulip-community), or [email Zulip
|
||||
support](mailto:support@zulip.com).
|
||||
* Response time: Usually within 1-3 business days, or within one business
|
||||
day for paid customers.
|
||||
* For support requests regarding your **self-hosted server**:
|
||||
|
||||
* **Business** and **Enterprise** plan customers can request interactive
|
||||
chat support in the [Zulip development community](#zulip-community),
|
||||
or [email Zulip support](mailto:support@zulip.com). Phone support is
|
||||
available for Enterprise customers upon request.
|
||||
* Response time: Usually within one business day.
|
||||
* **Free** and **Community** plan customers can ask for help in the
|
||||
[Zulip development community](#zulip-community). You will usually get a
|
||||
friendly reply within 1-3 business days.
|
||||
|
||||
## Sales, billing, and partnerships
|
||||
|
||||
For **sales**, **billing**, **partnerships**, and **other commercial
|
||||
questions**, contact [sales@zulip.com](mailto:sales@zulip.com). Response time:
|
||||
Usually within one business day.
|
||||
|
||||
## Product feedback
|
||||
|
||||
Your feedback helps us make Zulip better for everyone! Please reach out if you
|
||||
have questions, suggestions, or just want to brainstorm how to make Zulip work
|
||||
for your organization.
|
||||
|
||||
* There are [several
|
||||
ways](https://zulip.readthedocs.io/en/latest/contributing/reporting-bugs.html)
|
||||
to **report possible bugs**.
|
||||
* Response time: Usually within 1-3 business days in the [Zulip development
|
||||
community](#zulip-community) or by email, or within one week [on
|
||||
GitHub](https://github.com/zulip).
|
||||
* You can [**request
|
||||
features**](https://zulip.readthedocs.io/en/latest/contributing/suggesting-features.html)
|
||||
or [**share
|
||||
feedback**](https://zulip.readthedocs.io/en/latest/contributing/suggesting-features.html#evaluation-and-onboarding-feedback).
|
||||
Many improvements to the Zulip app start with a user's suggestion.
|
||||
* Response time: Usually within 1-3 business days in the [Zulip development
|
||||
community](#zulip-community) or by email, or within one week [on
|
||||
GitHub](https://github.com/zulip).
|
||||
* To **report issues or share feedback privately**, contact
|
||||
[feedback@zulip.com](mailto:feedback@zulip.com). This works well if you'd like
|
||||
to include details about your organization that shouldn't be posted in public.
|
||||
* Response time: Usually within 1-3 business days.
|
||||
|
||||
[development-community]: https://zulip.com/development-community/
|
||||
|
||||
[community-norms]: https://zulip.com/development-community/#community-norms
|
||||
|
||||
[development-community-channels]: https://zulip.com/development-community/#channels-for-zulip-users-and-administrators
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Zulip Cloud billing](/help/zulip-cloud-billing)
|
||||
* [View Zulip version](/help/view-zulip-version)
|
21
starlight_help/src/content/docs/create-a-channel.mdx
Normal file
21
starlight_help/src/content/docs/create-a-channel.mdx
Normal file
@@ -0,0 +1,21 @@
|
||||
---
|
||||
title: Create a channel
|
||||
---
|
||||
|
||||
import CreateAChannelInstructions from "./include/_CreateAChannelInstructions.mdx"
|
||||
import DependsOnPermissions from "./include/_DependsOnPermissions.mdx"
|
||||
|
||||
<DependsOnPermissions />
|
||||
|
||||
If you are an administrator setting up channels for the first time, check out our
|
||||
[guide to setting up channels for a new organization](/help/create-channels).
|
||||
|
||||
<CreateAChannelInstructions />
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Create channels for a new organization](/help/create-channels)
|
||||
* [Channel permissions](/help/channel-permissions)
|
||||
* [Set default channels for new users](/help/set-default-channels-for-new-users)
|
||||
* [Introduction to channels](/help/introduction-to-channels)
|
||||
* [Restrict channel creation](/help/configure-who-can-create-channels)
|
105
starlight_help/src/content/docs/create-a-poll.mdx
Normal file
105
starlight_help/src/content/docs/create-a-poll.mdx
Normal file
@@ -0,0 +1,105 @@
|
||||
---
|
||||
title: Polls
|
||||
---
|
||||
|
||||
import ZulipNote from '../../components/ZulipNote.astro';
|
||||
import ZulipTip from '../../components/ZulipTip.astro';
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
import PollsExamples from "./include/_PollsExamples.mdx"
|
||||
import PollsIntro from "./include/_PollsIntro.mdx"
|
||||
import PencilIcon from "~icons/fa/pencil"
|
||||
import { Steps } from '@astrojs/starlight/components';
|
||||
import TrashIcon from "~icons/zulip-icon/trash"
|
||||
import CheckIcon from "~icons/fa/check"
|
||||
import GripVerticalIcon from "~icons/zulip-icon/grip-vertical"
|
||||
import StartComposing from "./include/_StartComposing.mdx"
|
||||
import SendIcon from "~icons/zulip-icon/send"
|
||||
import RemoveIcon from "~icons/fa/remove"
|
||||
import { Tabs, TabItem } from '@astrojs/starlight/components'
|
||||
import PollIcon from "~icons/zulip-icon/poll"
|
||||
|
||||
<PollsIntro />
|
||||
|
||||
## Create a poll
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Via compose box button">
|
||||
<FlattenedSteps>
|
||||
<StartComposing />
|
||||
|
||||
1. Make sure the compose box is empty.
|
||||
1. Click the **Add poll** (<PollIcon />) icon at
|
||||
the bottom of the compose box.
|
||||
1. Fill out poll information as desired, and click **Add poll** to insert poll
|
||||
formatting.
|
||||
1. Click the **Send** (<SendIcon />) button, or
|
||||
use a [keyboard shortcut](/help/configure-send-message-keys) to send your
|
||||
message.
|
||||
</FlattenedSteps>
|
||||
|
||||
<ZulipTip>
|
||||
To reorder the list of options, click and drag the **vertical dots**
|
||||
(<GripVerticalIcon />) to the left of each
|
||||
option. To delete an option, click the **delete**
|
||||
(<TrashIcon />) icon to the right of it.
|
||||
</ZulipTip>
|
||||
</TabItem>
|
||||
|
||||
<TabItem label="Via Markdown">
|
||||
<FlattenedSteps>
|
||||
<StartComposing />
|
||||
|
||||
1. Make sure the compose box is empty.
|
||||
1. Type `/poll` followed by a space, and the question you want to ask.
|
||||
1. *(optional)* Type each option on a new line.
|
||||
1. Click the **Send** (<SendIcon />) button, or
|
||||
use a [keyboard shortcut](/help/configure-send-message-keys) to send your
|
||||
message.
|
||||
</FlattenedSteps>
|
||||
|
||||
<ZulipTip>
|
||||
You will be able to add options after the poll is created.
|
||||
</ZulipTip>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Add options to a poll
|
||||
|
||||
<ZulipNote>
|
||||
To preserve the meaning of votes in the poll, existing poll options cannot
|
||||
be modified.
|
||||
</ZulipNote>
|
||||
|
||||
<Steps>
|
||||
1. Fill out the **New option** field at the bottom of the poll.
|
||||
1. Click **Add option** or press <kbd>Enter</kbd> to add the new option to
|
||||
the poll.
|
||||
</Steps>
|
||||
|
||||
## Edit the question
|
||||
|
||||
<ZulipNote>
|
||||
Only the creator of a poll can edit the question.
|
||||
</ZulipNote>
|
||||
|
||||
<Steps>
|
||||
1. Click the **pencil** (<PencilIcon />) icon
|
||||
to the right of the question.
|
||||
1. Edit the question as desired.
|
||||
1. Click the **checkmark** (<CheckIcon />) icon or press
|
||||
<kbd>Enter</kbd> to save your changes.
|
||||
</Steps>
|
||||
|
||||
<ZulipTip>
|
||||
You can click the <RemoveIcon /> icon or press
|
||||
<kbd>Esc</kbd> to discard your changes.
|
||||
</ZulipTip>
|
||||
|
||||
## Examples
|
||||
|
||||
<PollsExamples />
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Message formatting](/help/format-your-message-using-markdown)
|
||||
* [Collaborative to-do lists](/help/collaborative-to-do-lists)
|
39
starlight_help/src/content/docs/create-channels.mdx
Normal file
39
starlight_help/src/content/docs/create-channels.mdx
Normal file
@@ -0,0 +1,39 @@
|
||||
---
|
||||
title: Create channels
|
||||
---
|
||||
|
||||
import CreateAChannelInstructions from "./include/_CreateAChannelInstructions.mdx"
|
||||
import CreateChannelsIntro from "./include/_CreateChannelsIntro.mdx"
|
||||
|
||||
<CreateChannelsIntro />
|
||||
|
||||
## How to create a channel
|
||||
|
||||
<CreateAChannelInstructions />
|
||||
|
||||
## Tips for creating channels
|
||||
|
||||
* It's often best to start with just a few channels, and add more as
|
||||
needed. For small teams, you can start with the default channels
|
||||
and go from there.
|
||||
* A channel's name can be in any language, and can include spaces, punctuation,
|
||||
and Unicode emoji. For large organizations, we recommend using a consistent naming
|
||||
scheme, like `#marketing/<name>` or `#mk/<name>` for all channels
|
||||
pertaining to the marketing team, `#help/<team name>` for
|
||||
`<team name>`'s internal support channel, etc.
|
||||
* You can [pin reference information](/help/pin-information), such as important
|
||||
messages or topics, and external references, in the
|
||||
[description](/help/view-channel-information#view-channel-description) for a
|
||||
channel.
|
||||
* For open source projects or other volunteer organizations, consider
|
||||
adding default channels 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.
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Moving to Zulip](/help/moving-to-zulip)
|
||||
* [Channel permissions](/help/channel-permissions)
|
||||
* [Set default channels for new users](/help/set-default-channels-for-new-users)
|
||||
* [Getting started with Zulip](/help/getting-started-with-zulip)
|
34
starlight_help/src/content/docs/create-user-groups.mdx
Normal file
34
starlight_help/src/content/docs/create-user-groups.mdx
Normal file
@@ -0,0 +1,34 @@
|
||||
---
|
||||
title: Create user groups
|
||||
---
|
||||
|
||||
import UserGroupsApplications from "./include/_UserGroupsApplications.mdx"
|
||||
import UserGroupsIntro from "./include/_UserGroupsIntro.mdx"
|
||||
import CloudPaidPlansOnly from "./include/_CloudPaidPlansOnly.mdx"
|
||||
import HowToCreateAUserGroup from "./include/_HowToCreateAUserGroup.mdx"
|
||||
import UserSubgroupsIntro from "./include/_UserSubgroupsIntro.mdx"
|
||||
|
||||
<CloudPaidPlansOnly />
|
||||
|
||||
<UserGroupsIntro />
|
||||
|
||||
Many organizations find it helpful to create groups for:
|
||||
|
||||
* Each team, e.g., “mobile”, “design”, or “IT”.
|
||||
* Leadership roles, e.g., “managers”, “engineering-managers”.
|
||||
|
||||
<UserSubgroupsIntro />
|
||||
|
||||
<UserGroupsApplications />
|
||||
|
||||
## How to create a user group
|
||||
|
||||
<HowToCreateAUserGroup />
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Moving to Zulip](/help/moving-to-zulip)
|
||||
* [User groups](/help/user-groups)
|
||||
* [Manage user groups](/help/manage-user-groups)
|
||||
* [Invite users to join](/help/invite-users-to-join)
|
||||
* [Getting started with Zulip](/help/getting-started-with-zulip)
|
@@ -0,0 +1,59 @@
|
||||
---
|
||||
title: Create your organization profile
|
||||
---
|
||||
|
||||
import CommunitiesDirectoryInstructions from "./include/_CommunitiesDirectoryInstructions.mdx"
|
||||
import EditOrganizationProfile from "./include/_EditOrganizationProfile.mdx"
|
||||
import CommunitiesDirectoryIntro from "./include/_CommunitiesDirectoryIntro.mdx"
|
||||
import AddAWideLogo from "./include/_AddAWideLogo.mdx"
|
||||
import AdminOnly from "./include/_AdminOnly.mdx"
|
||||
|
||||
<AdminOnly />
|
||||
|
||||
Your organization's profile includes its **name**,
|
||||
[**type**](/help/organization-type), **description**, **profile picture**, and
|
||||
**logo**. The name, description and profile picture appear on the registration
|
||||
and login pages for your organization, and (optionally) in the [communities
|
||||
directory](/help/communities-directory).
|
||||
|
||||
* The **organization name** also appears in the title of your Zulip browser tab
|
||||
or Desktop app, and in email and desktop notifications. It's best to keep it
|
||||
short.
|
||||
* The **organization type** is used to customize the experience for users
|
||||
in your organization, including initial organization settings and
|
||||
Welcome Bot messages received by new users.
|
||||
* The **organization description** supports [full Markdown
|
||||
formatting](/help/format-your-message-using-markdown), including
|
||||
**bold**/*italic*, links, lists, and more.
|
||||
* The **organization profile picture** is a square image that is also used for
|
||||
[switching between organizations](/help/switching-between-organizations) in
|
||||
the desktop app. It will be displayed at 100×100 pixels, or more on
|
||||
high-resolution displays.
|
||||
* The [**organization logo**](#add-a-wide-logo) replaces the Zulip logo in the
|
||||
upper left corner of the web and desktop apps.
|
||||
|
||||
## Edit organization profile
|
||||
|
||||
<EditOrganizationProfile />
|
||||
|
||||
## Zulip communities directory
|
||||
|
||||
<CommunitiesDirectoryIntro />
|
||||
|
||||
### Change whether your organization may be listed in the Zulip communities directory
|
||||
|
||||
<CommunitiesDirectoryInstructions />
|
||||
|
||||
For more details, see [Communities directory](/help/communities-directory).
|
||||
|
||||
## Add a wide logo
|
||||
|
||||
<AddAWideLogo />
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Moving to Zulip](/help/moving-to-zulip)
|
||||
* [Customize organization settings](/help/customize-organization-settings)
|
||||
* [Create channels](/help/create-channels)
|
||||
* [Communities directory](/help/communities-directory)
|
||||
* [Getting started with Zulip](/help/getting-started-with-zulip)
|
103
starlight_help/src/content/docs/custom-certificates.mdx
Normal file
103
starlight_help/src/content/docs/custom-certificates.mdx
Normal file
@@ -0,0 +1,103 @@
|
||||
---
|
||||
title: Use a custom certificate
|
||||
---
|
||||
|
||||
import { Steps } from '@astrojs/starlight/components';
|
||||
import DesktopSidebarSettingsMenu from "./include/_DesktopSidebarSettingsMenu.mdx"
|
||||
import { Tabs, TabItem } from '@astrojs/starlight/components'
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
|
||||
By default, Zulip generates a signed certificate during the server install
|
||||
process. In some cases, a server administrator may choose not to use that
|
||||
feature, in which case your Zulip server may be using a self-signed
|
||||
certificate. This is most common for Zulip servers not connected to the
|
||||
public internet.
|
||||
|
||||
## Web
|
||||
|
||||
Most browsers will show a warning if you try to connect to a Zulip server
|
||||
with a self-signed certificate.
|
||||
|
||||
If you are absolutely, 100% sure that the Zulip server you are connecting to
|
||||
is supposed to have a self-signed certificate, click through the warnings
|
||||
and follow the instructions on-screen.
|
||||
|
||||
If you are less than 100% sure, contact your server
|
||||
administrator. Accepting a malicious self-signed certificate would
|
||||
give a stranger full access to your Zulip account, including your
|
||||
username and password.
|
||||
|
||||
## Desktop
|
||||
|
||||
### Version 5.4.0 and above
|
||||
|
||||
Zulip Desktop version 5.4.0 and above use the operating system's
|
||||
certificate store, like your web browser.
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="macOS">
|
||||
<Steps>
|
||||
1. Hit `Cmd` + `Space` to bring up Spotlight Search, type **Keychain
|
||||
Access**, and press Enter.
|
||||
1. From the **File** menu, choose **Import Items...**
|
||||
1. Navigate to the certificate file, then click **Open**.
|
||||
1. Right-click the newly-added certificate, and click **Get Info** from
|
||||
the context menu.
|
||||
1. Expand the **Trust** section.
|
||||
1. Select **Always Trust** for the **Secure Sockets Layer (SSL)** option.
|
||||
1. Close the window. You will be prompted for your password to verify
|
||||
the change.
|
||||
1. Restart the Zulip Desktop application.
|
||||
</Steps>
|
||||
</TabItem>
|
||||
|
||||
<TabItem label="Windows">
|
||||
On Windows, Zulip Desktop shares the certificate store with
|
||||
Google Chrome, so you can add certificates to it from inside
|
||||
Chrome.
|
||||
|
||||
<Steps>
|
||||
1. Open Google Chrome.
|
||||
1. From the Chrome menu (⋮) in the top-right, select **Settings**.
|
||||
1. In the **Privacy and Security** section, click **Security**.
|
||||
1. Scroll down to and click **Manage Certificates**.
|
||||
1. Select the **Trusted Root Certification Authorities** tab.
|
||||
1. Select **Import...**
|
||||
1. Navigate to the certificate file, then click **Open**.
|
||||
1. Select **Done**.
|
||||
1. Restart the Zulip Desktop application.
|
||||
</Steps>
|
||||
</TabItem>
|
||||
|
||||
<TabItem label="Linux">
|
||||
The required packages and steps vary by distribution; see the Chromium
|
||||
documentation for [detailed documentation][linux]. On most systems,
|
||||
once the `nss` tools are installed, the command to trust the
|
||||
certificate is:
|
||||
|
||||
```
|
||||
certutil -d sql:$HOME/.pki/nssdb -A -t "P,," -n zulip \
|
||||
-i path/to/certificate.pem
|
||||
```
|
||||
|
||||
You will need to restart the Zulip Desktop application to pick up the
|
||||
new certificate.
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
### Version 5.3.0 and below
|
||||
|
||||
On Zulip Desktop version 5.3.0 and below, we require you to manually
|
||||
enter the certificate details before you can connect to your Zulip
|
||||
server. You'll need to get a certificate file (should end in `.crt` or
|
||||
`.pem`) from your server administrator and add it:
|
||||
|
||||
<FlattenedSteps>
|
||||
<DesktopSidebarSettingsMenu />
|
||||
|
||||
1. Select the **Organizations** tab.
|
||||
1. Under **Add Custom Certificates**, enter your organization URL and add
|
||||
the custom certificate file (it should end in `.crt` or `.pem`).
|
||||
</FlattenedSteps>
|
||||
|
||||
[linux]: https://chromium.googlesource.com/chromium/src.git/+/main/docs/linux/cert_management.md
|
87
starlight_help/src/content/docs/custom-emoji.mdx
Normal file
87
starlight_help/src/content/docs/custom-emoji.mdx
Normal file
@@ -0,0 +1,87 @@
|
||||
---
|
||||
title: Custom emoji
|
||||
---
|
||||
|
||||
import NavigationSteps from "../../components/NavigationSteps.astro"
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
import SaveChanges from "./include/_SaveChanges.mdx"
|
||||
import TrashIcon from "~icons/zulip-icon/trash"
|
||||
import AdminOnly from "./include/_AdminOnly.mdx"
|
||||
|
||||
Custom emoji can be used by all users in an organization (including
|
||||
bots). They are supported everywhere that Zulip supports emoji,
|
||||
including [emoji reactions][emoji-reactions],
|
||||
[messages][emoji-messages], [channel descriptions][emoji-channels] and
|
||||
[user statuses][emoji-status].
|
||||
|
||||
[emoji-reactions]: /help/emoji-reactions
|
||||
|
||||
[emoji-messages]: /help/format-your-message-using-markdown#emoji-and-emoticons
|
||||
|
||||
[emoji-channels]: /help/change-the-channel-description
|
||||
|
||||
[emoji-status]: /help/status-and-availability
|
||||
|
||||
## Add custom emoji
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/emoji-settings" />
|
||||
|
||||
1. Click **Add a new emoji**.
|
||||
1. Click **Upload image or GIF**, and add a file in the PNG, JPG, or
|
||||
GIF file format. Zulip will automatically scale the image down to
|
||||
25x25 pixels.
|
||||
1. Enter an **Emoji name**, and click **Confirm**.
|
||||
</FlattenedSteps>
|
||||
|
||||
**Emoji names** can only contain `a-z`, `0-9`, dashes (`-`), and spaces.
|
||||
Upper and lower case letters are treated the same, and underscores (`_`)
|
||||
are treated the same as spaces.
|
||||
|
||||
### Bulk add emoji
|
||||
|
||||
We expose a [REST API endpoint](/api/upload-custom-emoji) for bulk uploading
|
||||
emoji. Using REST API endpoints requires some technical expertise;
|
||||
[contact us](/help/contact-support) if you get stuck.
|
||||
|
||||
## Replace a default emoji
|
||||
|
||||
You can replace a default emoji by adding a custom emoji of the same
|
||||
name. If an emoji has several names, you must use the emoji's primary name
|
||||
to replace it. You can find the primary name of an emoji by hovering over it
|
||||
in the [emoji picker](/help/emoji-and-emoticons#use-an-emoji-in-your-message),
|
||||
while the search box is empty (you may have to scroll down a bit to find it).
|
||||
|
||||
## Deactivate custom emoji
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/emoji-settings" />
|
||||
|
||||
1. Click the **deactivate** (<TrashIcon />) icon next to the
|
||||
emoji that you would like to deactivate.
|
||||
</FlattenedSteps>
|
||||
|
||||
Deactivating an emoji will not affect any existing messages or emoji
|
||||
reactions. Anyone can deactivate custom emoji they added, and organization
|
||||
administrators can deactivate anyone's custom emoji.
|
||||
|
||||
## Change who can add custom emoji
|
||||
|
||||
<AdminOnly />
|
||||
|
||||
You can configure who can add custom emoji. This permission can be granted to
|
||||
any combination of [roles](/help/user-roles), [groups](/help/user-groups), and
|
||||
individual [users](/help/introduction-to-users).
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/organization-permissions" />
|
||||
|
||||
1. Under **Other permissions**, configure **Who can add custom emoji**.
|
||||
|
||||
<SaveChanges />
|
||||
</FlattenedSteps>
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Emoji and emoticons](/help/emoji-and-emoticons)
|
||||
* [Emoji reactions](/help/emoji-reactions)
|
155
starlight_help/src/content/docs/custom-profile-fields.mdx
Normal file
155
starlight_help/src/content/docs/custom-profile-fields.mdx
Normal file
@@ -0,0 +1,155 @@
|
||||
---
|
||||
title: Custom profile fields
|
||||
---
|
||||
|
||||
import EditIcon from "~icons/zulip-icon/edit"
|
||||
import NavigationSteps from "../../components/NavigationSteps.astro"
|
||||
import ZulipTip from '../../components/ZulipTip.astro';
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
import TrashIcon from "~icons/zulip-icon/trash"
|
||||
import AdminOnly from "./include/_AdminOnly.mdx"
|
||||
|
||||
<AdminOnly />
|
||||
|
||||
[User cards](/help/user-cards) show basic information about a user, and [user
|
||||
profiles](/help/view-someones-profile) provide additional details. You can add
|
||||
custom profile fields to user cards and user profiles, making it easy for users
|
||||
to share information, such as their pronouns, job title, or team.
|
||||
|
||||
Zulip supports many types of profile fields, such as dates, lists of options,
|
||||
GitHub account links, and [more](#profile-field-types). You can choose which
|
||||
custom profile fields to [display](#display-custom-fields-on-user-card) on user
|
||||
cards. Custom profile fields can be optional or
|
||||
[required](#make-a-custom-profile-field-required).
|
||||
|
||||
Zulip supports synchronizing custom profile fields from an external
|
||||
user database such as LDAP or SAML. See the [authentication
|
||||
methods][authentication-production] documentation for details.
|
||||
|
||||
## Add a custom profile field
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/profile-field-settings" />
|
||||
|
||||
1. Click **Add a new profile field**.
|
||||
1. Fill out profile field information as desired, and click **Add**.
|
||||
1. In the **Labels** column, click and drag the vertical dots to reorder the
|
||||
list of custom profile fields.
|
||||
</FlattenedSteps>
|
||||
|
||||
## Edit a custom profile field
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/profile-field-settings" />
|
||||
|
||||
1. In the **Actions** column, click the **edit** (<EditIcon />)
|
||||
icon for the profile field you want to edit.
|
||||
1. Edit profile field information as desired, and click **Save changes**.
|
||||
</FlattenedSteps>
|
||||
|
||||
## Delete a custom profile field
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/profile-field-settings" />
|
||||
|
||||
1. In the **Actions** column, click the **delete** (<TrashIcon />) icon for the profile field you want to delete.
|
||||
1. Approve by clicking **Confirm**.
|
||||
</FlattenedSteps>
|
||||
|
||||
## Reorder custom profile fields
|
||||
|
||||
Users will see custom profile fields in the specified order.
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/profile-field-settings" />
|
||||
|
||||
1. In the **Labels** column, click and drag the vertical dots to reorder the
|
||||
list of custom profile fields.
|
||||
</FlattenedSteps>
|
||||
|
||||
## Display custom fields on user card
|
||||
|
||||
Organizations may find it useful to display additional fields on the
|
||||
user card, such as pronouns, GitHub username, job title, team, etc.
|
||||
|
||||
All field types other than "Long text" or "Person" have a checkbox option
|
||||
that controls whether to display a custom field on the user card.
|
||||
There's a limit to the number of custom profile fields that can be displayed
|
||||
at a time. If the maximum number of fields is already selected, all unselected
|
||||
checkboxes will be disabled.
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/profile-field-settings" />
|
||||
|
||||
1. In the **Actions** column, click the **edit** (<EditIcon />)
|
||||
icon for the profile field you want to edit.
|
||||
1. Toggle **Display on user card**.
|
||||
1. Click **Save changes**.
|
||||
</FlattenedSteps>
|
||||
|
||||
<ZulipTip>
|
||||
You can also choose which custom profile fields will be displayed by toggling
|
||||
the checkboxes in the **Card** column of the **Custom profile fields** table.
|
||||
</ZulipTip>
|
||||
|
||||
## Make a custom profile field required
|
||||
|
||||
If a custom profile field is required, users who have left it blank will see a
|
||||
banner every time they open the Zulip web or desktop app prompting them to fill
|
||||
it out.
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/profile-field-settings" />
|
||||
|
||||
1. In the **Actions** column, click the **edit** (<EditIcon />)
|
||||
icon for the profile field you want to edit.
|
||||
1. Toggle **Required field**.
|
||||
1. Click **Save changes**.
|
||||
</FlattenedSteps>
|
||||
|
||||
<ZulipTip>
|
||||
You can also choose which custom profile fields are required by toggling the
|
||||
checkboxes in the **Required** column of the **Custom profile fields** table.
|
||||
</ZulipTip>
|
||||
|
||||
## Configure whether users can edit custom profile fields
|
||||
|
||||
<AdminOnly />
|
||||
|
||||
You can configure whether users in your organization can edit custom profile
|
||||
fields for their own account. For example, you may want to restrict editing if
|
||||
syncing profile fields from an employee directory.
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/profile-field-settings" />
|
||||
|
||||
1. In the **Actions** column, click the **edit** (<EditIcon />)
|
||||
icon for the profile field you want to configure.
|
||||
1. Toggle **Users can edit this field for their own account**.
|
||||
1. Click **Save changes**.
|
||||
</FlattenedSteps>
|
||||
|
||||
## Profile field types
|
||||
|
||||
Choose the profile field type that's most appropriate for the requested information.
|
||||
|
||||
* **Date**: For dates (e.g., birthdays or work anniversaries).
|
||||
* **Link**: For links to websites, including company-internal pages.
|
||||
* **External account**: For linking to an account on GitHub, X (Twitter), etc.
|
||||
* **List of options**: A dropdown with a list of predefined options (e.g.,
|
||||
office location).
|
||||
* **Pronouns**: What pronouns should people use to refer to the user? Pronouns
|
||||
are displayed in [user mention](/help/mention-a-user-or-group) autocomplete
|
||||
suggestions.
|
||||
* **Text (long)**: For multiline responses (e.g., a user's intro message).
|
||||
* **Text (short)**: For one-line responses up to 50 characters (e.g., team
|
||||
name or role in your organization).
|
||||
* **Users**: For selecting one or more users (e.g., manager or direct reports).
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Edit your profile](/help/edit-your-profile)
|
||||
* [User cards](/help/user-cards)
|
||||
* [View someone's profile](/help/view-someones-profile)
|
||||
|
||||
[authentication-production]: https://zulip.readthedocs.io/en/stable/production/authentication-methods.html
|
@@ -0,0 +1,46 @@
|
||||
---
|
||||
title: Customize organization settings
|
||||
---
|
||||
|
||||
import ReviewOrganizationSettingsInstructions from "./include/_ReviewOrganizationSettingsInstructions.mdx"
|
||||
|
||||
<ReviewOrganizationSettingsInstructions />
|
||||
|
||||
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][message-editing-permissions] and
|
||||
[topic][topic-editing-permissions] editing permissions, you can experience how
|
||||
Zulip works for your organization before deciding what settings are best for
|
||||
you.
|
||||
|
||||
[message-editing-permissions]: /help/restrict-message-editing-and-deletion
|
||||
|
||||
[topic-editing-permissions]: /help/restrict-moving-messages
|
||||
|
||||
[default-code-block-language]: /help/code-blocks#default-code-block-language
|
||||
|
||||
[code-playgrounds]: /help/code-blocks#code-playgrounds
|
||||
|
||||
[email-address-visibility]: /help/configure-email-visibility
|
||||
|
||||
[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
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Moving to Zulip](/help/moving-to-zulip)
|
||||
* [Create your organization profile](/help/create-your-organization-profile)
|
||||
* [Create channels](/help/create-channels)
|
||||
* [Getting started with Zulip](/help/getting-started-with-zulip)
|
@@ -0,0 +1,13 @@
|
||||
---
|
||||
title: Customize settings for new users
|
||||
---
|
||||
|
||||
import CustomizeSettingsForNewUsers from "./include/_CustomizeSettingsForNewUsers.mdx"
|
||||
|
||||
<CustomizeSettingsForNewUsers />
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Moving to Zulip](/help/moving-to-zulip)
|
||||
* [Invite users to join](/help/invite-users-to-join)
|
||||
* [Getting started with Zulip](/help/getting-started-with-zulip)
|
46
starlight_help/src/content/docs/dark-theme.mdx
Normal file
46
starlight_help/src/content/docs/dark-theme.mdx
Normal file
@@ -0,0 +1,46 @@
|
||||
---
|
||||
title: Dark theme
|
||||
---
|
||||
|
||||
import { Tabs, TabItem } from '@astrojs/starlight/components'
|
||||
import MobileSettings from "./include/_MobileSettings.mdx"
|
||||
import PersonalMenu from "./include/_PersonalMenu.mdx"
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
|
||||
Zulip provides both a light theme and a dark theme, which is great
|
||||
for working in a dark space.
|
||||
|
||||
## Manage color theme
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Desktop/Web">
|
||||
<FlattenedSteps>
|
||||
<PersonalMenu />
|
||||
|
||||
1. Select the desired theme using the row of icons in the middle of the menu.
|
||||
</FlattenedSteps>
|
||||
</TabItem>
|
||||
|
||||
<TabItem label="Mobile">
|
||||
<FlattenedSteps>
|
||||
<MobileSettings />
|
||||
|
||||
1. Select the desired theme.
|
||||
</FlattenedSteps>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
The default is **Automatic** (for the desktop and web apps) or **System** (for the
|
||||
mobile apps). This setting detects which theme to use based on the color scheme
|
||||
used by your device's operating system.
|
||||
|
||||
You can also specify **Light** or **Dark** if you'd like Zulip to use the same
|
||||
color scheme regardless of your operating system configuration.
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Set up your account](/help/set-up-your-account)
|
||||
* [Review your settings](/help/review-your-settings)
|
||||
* [Configure default new user settings](/help/configure-default-new-user-settings)
|
||||
* [Font size](/help/font-size)
|
||||
* [Line spacing](/help/line-spacing)
|
63
starlight_help/src/content/docs/deactivate-a-user-group.mdx
Normal file
63
starlight_help/src/content/docs/deactivate-a-user-group.mdx
Normal file
@@ -0,0 +1,63 @@
|
||||
---
|
||||
title: Deactivate a user group
|
||||
---
|
||||
|
||||
import NavigationSteps from "../../components/NavigationSteps.astro"
|
||||
import UserGroupPlusIcon from "~icons/zulip-icon/user-group-plus"
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
import UserGroupXIcon from "~icons/zulip-icon/user-group-x"
|
||||
import { Tabs, TabItem } from '@astrojs/starlight/components'
|
||||
|
||||
You can deactivate groups you no longer plan to use. Deactivated groups cannot be [mentioned](/help/mention-a-user-or-group), or used for any [permissions](/help/manage-permissions).
|
||||
|
||||
## Deactivate a user group
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Desktop/Web">
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="relative/group/all" />
|
||||
|
||||
1. Select a user group.
|
||||
1. Select the **Permissions** tab on the right.
|
||||
1. Remove all permissions.
|
||||
1. Click the **Deactivate group** (<UserGroupXIcon />) button in the
|
||||
upper right corner of the user group settings panel.
|
||||
1. Click **Confirm**.
|
||||
</FlattenedSteps>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## View deactivated user groups
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Desktop/Web">
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="relative/group/all" />
|
||||
|
||||
1. Select **Deactivated groups** from the dropdown next to the **Filter** box
|
||||
above the list of groups.
|
||||
</FlattenedSteps>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Reactivate a user group
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Desktop/Web">
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="relative/group/all" />
|
||||
|
||||
1. Select **Deactivated groups** from the dropdown next to the **Filter** box
|
||||
above the list of groups.
|
||||
1. Select a user group.
|
||||
1. Click the **Reactivate group** (<UserGroupPlusIcon />) button in the
|
||||
upper right corner of the user group settings panel.
|
||||
</FlattenedSteps>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Related articles
|
||||
|
||||
* [User groups](/help/user-groups)
|
||||
* [Create user groups](/help/create-user-groups)
|
||||
* [Manage user groups](/help/manage-user-groups)
|
@@ -0,0 +1,88 @@
|
||||
---
|
||||
title: Deactivate or reactivate a bot
|
||||
---
|
||||
|
||||
import NavigationSteps from "../../components/NavigationSteps.astro"
|
||||
import UserPlusIcon from "~icons/zulip-icon/user-plus"
|
||||
import ZulipTip from '../../components/ZulipTip.astro';
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
import UserXIcon from "~icons/zulip-icon/user-x"
|
||||
import UserCogIcon from "~icons/zulip-icon/user-cog"
|
||||
import { Tabs, TabItem } from '@astrojs/starlight/components'
|
||||
import AdminOnly from "./include/_AdminOnly.mdx"
|
||||
|
||||
By default, users can deactivate and reactivate the bots that they
|
||||
add. Organization admins can prevent users from reactivating bots by
|
||||
[restricting bot creation](/help/restrict-bot-creation).
|
||||
|
||||
Organization administrators can also deactivate or reactivate any existing
|
||||
bot, regardless of who owns them.
|
||||
|
||||
## Deactivate a bot
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Via personal settings">
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/your-bots" />
|
||||
|
||||
1. Click the **deactivate bot** (<UserXIcon />)
|
||||
icon on the profile card for the bot you want to deactivate.
|
||||
1. Approve by clicking **Deactivate**.
|
||||
</FlattenedSteps>
|
||||
|
||||
<ZulipTip>
|
||||
You can also click the **manage bot** (<UserCogIcon />) icon, scroll down to the bottom,
|
||||
and click **Deactivate bot**.
|
||||
</ZulipTip>
|
||||
</TabItem>
|
||||
|
||||
<TabItem label="Via organization settings">
|
||||
<AdminOnly />
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/bot-list-admin" />
|
||||
|
||||
1. In the **Actions** column, click the **deactivate bot** (<UserXIcon />) icon for the bot you want to deactivate.
|
||||
1. Approve by clicking **Deactivate**.
|
||||
</FlattenedSteps>
|
||||
|
||||
<ZulipTip>
|
||||
You can also click the **manage bot** (<UserCogIcon />) icon, scroll down to the bottom,
|
||||
and click **Deactivate bot**.
|
||||
</ZulipTip>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Reactivate a bot
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Via personal settings">
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/your-bots" />
|
||||
|
||||
1. Click the **Inactive bots** tab.
|
||||
1. Click **Reactivate bot** on the profile card for the bot you want to reactivate.
|
||||
1. Approve by clicking **Confirm**.
|
||||
</FlattenedSteps>
|
||||
</TabItem>
|
||||
|
||||
<TabItem label="Via organization settings">
|
||||
<AdminOnly />
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/bot-list-admin" />
|
||||
|
||||
1. In the **Actions** column, click the **reactivate bot** (<UserPlusIcon />) icon for the bot you want to reactivate.
|
||||
1. Approve by clicking **Confirm**.
|
||||
</FlattenedSteps>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Bots overview](/help/bots-overview)
|
||||
* [Integrations overview](/help/integrations-overview)
|
||||
* [Add a bot or integration](/help/add-a-bot-or-integration)
|
||||
* [Manage a bot](/help/manage-a-bot)
|
||||
* [Restrict bot creation](/help/restrict-bot-creation)
|
||||
* [View all bots in your organization](/help/view-all-bots-in-your-organization)
|
@@ -0,0 +1,127 @@
|
||||
---
|
||||
title: Deactivate or reactivate a user
|
||||
---
|
||||
|
||||
import NavigationSteps from "../../components/NavigationSteps.astro"
|
||||
import ZulipNote from '../../components/ZulipNote.astro';
|
||||
import ZulipTip from '../../components/ZulipTip.astro';
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
import UserCircleDeactivatedIcon from "~icons/zulip-icon/user-circle-deactivated"
|
||||
import UserPlusIcon from "~icons/zulip-icon/user-plus"
|
||||
import { Steps } from '@astrojs/starlight/components';
|
||||
import ManageUserTabTip from "./include/_ManageUserTabTip.mdx"
|
||||
import UserXIcon from "~icons/zulip-icon/user-x"
|
||||
import ManageThisUser from "./include/_ManageThisUser.mdx"
|
||||
import { Tabs, TabItem } from '@astrojs/starlight/components'
|
||||
import AdminOnly from "./include/_AdminOnly.mdx"
|
||||
|
||||
## Deactivating a user
|
||||
|
||||
<AdminOnly />
|
||||
|
||||
When you deactivate a user:
|
||||
|
||||
* The user will be immediately logged out of all Zulip sessions, including
|
||||
desktop, web and mobile apps.
|
||||
* The user's credentials for logging in will no longer work, including password
|
||||
login and [any other login options](/help/configure-authentication-methods)
|
||||
enabled in your organization.
|
||||
* The user's [bots](/help/bots-overview) will be deactivated.
|
||||
* [Email invitations and invite links](/help/invite-new-users) created by the
|
||||
user will be disabled.
|
||||
* Other users will be able to see that the user has been deactivated (e.g., on
|
||||
their [user card](/help/user-cards)). In sidebars and elsewhere, a user's
|
||||
[availability](/help/status-and-availability) will be replaced with a
|
||||
deactivated icon
|
||||
(<UserCircleDeactivatedIcon />).
|
||||
* Even if your organization [allows users to join without an
|
||||
invitation](/help/restrict-account-creation#set-whether-invitations-are-required-to-join),
|
||||
this user will not be able to rejoin with the same email account.
|
||||
|
||||
<ZulipNote>
|
||||
You must go through the deactivation process below to fully remove a user's
|
||||
access to your Zulip organization. Changing a user's password or removing
|
||||
their single sign-on account will not log them out of their open Zulip
|
||||
sessions, or disable their API keys.
|
||||
</ZulipNote>
|
||||
|
||||
### Deactivate a user
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Via user profile">
|
||||
<FlattenedSteps>
|
||||
<ManageThisUser />
|
||||
|
||||
1. Click **Deactivate user** at the bottom of the **Manage user** menu.
|
||||
1. *(optional)* Select **Notify this user by email?** if desired, and enter a
|
||||
custom comment to include in the notification email.
|
||||
1. Approve by clicking **Deactivate**.
|
||||
</FlattenedSteps>
|
||||
|
||||
<ManageUserTabTip />
|
||||
</TabItem>
|
||||
|
||||
<TabItem label="Via organization settings">
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/users" />
|
||||
|
||||
1. In the **Actions** column, click the **deactivate user** (<UserXIcon />) icon for the user you want to deactivate.
|
||||
1. *(optional)* Select **Notify this user by email?** if desired, and enter a
|
||||
custom comment to include in the notification email.
|
||||
1. Approve by clicking **Deactivate**.
|
||||
</FlattenedSteps>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
<ZulipTip>
|
||||
Organization administrators cannot deactivate organization owners.
|
||||
</ZulipTip>
|
||||
|
||||
## Reactivating a user
|
||||
|
||||
<AdminOnly />
|
||||
|
||||
A reactivated user will have the same role, channel subscriptions, user group
|
||||
memberships, and other settings and permissions as they did prior to
|
||||
deactivation. They will also have the same API key and bot API keys, but their
|
||||
bots will be deactivated until the user manually
|
||||
[reactivates](deactivate-or-reactivate-a-bot) them again.
|
||||
|
||||
### Reactivate a user
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Via organization settings">
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/deactivated" />
|
||||
|
||||
1. Select the **Deactivated** tab.
|
||||
1. In the **Actions** column, click the **reactivate user** (<UserPlusIcon />) icon for the user you want to reactivate.
|
||||
</FlattenedSteps>
|
||||
</TabItem>
|
||||
|
||||
<TabItem label="Via user profile">
|
||||
<Steps>
|
||||
1. Click on a user's profile picture or name on a message they sent
|
||||
to open their **user card**.
|
||||
1. Click **View profile**.
|
||||
1. Select the **Manage user** tab.
|
||||
1. Click **Reactivate user** at the bottom of the **Manage user** menu.
|
||||
1. Approve by clicking **Confirm**.
|
||||
</Steps>
|
||||
|
||||
<ManageUserTabTip />
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
<ZulipTip>
|
||||
You may want to [review and adjust](/help/manage-user-channel-subscriptions)
|
||||
the reactivated user's channel subscriptions.
|
||||
</ZulipTip>
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Mute a user](/help/mute-a-user)
|
||||
* [Change a user's role](/help/user-roles#change-a-users-role)
|
||||
* [Change a user's name](/help/change-a-users-name)
|
||||
* [Deactivate your account](/help/deactivate-your-account)
|
||||
* [Manage a user](/help/manage-a-user)
|
58
starlight_help/src/content/docs/deactivate-your-account.mdx
Normal file
58
starlight_help/src/content/docs/deactivate-your-account.mdx
Normal file
@@ -0,0 +1,58 @@
|
||||
---
|
||||
title: Deactivate your account
|
||||
---
|
||||
|
||||
import NavigationSteps from "../../components/NavigationSteps.astro"
|
||||
import ZulipNote from '../../components/ZulipNote.astro';
|
||||
import ZulipTip from '../../components/ZulipTip.astro';
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
|
||||
In Zulip, you have a dedicated account for each organization you belong to.
|
||||
Deactivating your Zulip account in one organization will have no effect on any
|
||||
other Zulip accounts you may have.
|
||||
|
||||
Once you deactivate your account, you cannot register in the same organization
|
||||
with the email address you used before. If you are re-joining an organization,
|
||||
ask an organization administrator to
|
||||
[reactivate](/help/deactivate-or-reactivate-a-user#reactivate-a-user) your
|
||||
account.
|
||||
|
||||
<ZulipTip>
|
||||
You can find all the Zulip Cloud accounts associated with your email address
|
||||
with the [**Find your accounts**](https://zulip.com/accounts/find/) tool.
|
||||
If you have forgotten your account password, you can
|
||||
[reset it](/help/change-your-password).
|
||||
</ZulipTip>
|
||||
|
||||
## Deactivate your account
|
||||
|
||||
<ZulipNote>
|
||||
If you are the only owner in the organization, you cannot
|
||||
deactivate your account. You will need to
|
||||
[add another owner](/help/user-roles#change-a-users-role) first.
|
||||
</ZulipNote>
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/account-and-privacy" />
|
||||
|
||||
1. Under **Account**, click **Deactivate account**.
|
||||
1. Approve by clicking **Confirm**.
|
||||
</FlattenedSteps>
|
||||
|
||||
## What happens when you deactivate an account
|
||||
|
||||
* Your [user card](/help/user-cards) will have a notice indicating that your
|
||||
account has been deactivated.
|
||||
* Deactivating your account won't delete messages you've sent or files
|
||||
you've shared. If permitted in your organization, delete content you'd
|
||||
like to remove before deactivating your account.
|
||||
* Any bots that you maintain will be disabled.
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Logging in](/help/logging-in)
|
||||
* [Logging out](/help/logging-out)
|
||||
* [Change your password](/help/change-your-password)
|
||||
* [Switching between organizations](/help/switching-between-organizations)
|
||||
* [Deactivate or reactivate a user](/help/deactivate-or-reactivate-a-user)
|
||||
* [Deactivate your organization](/help/deactivate-your-organization)
|
@@ -0,0 +1,35 @@
|
||||
---
|
||||
title: Deactivate your organization
|
||||
---
|
||||
|
||||
import NavigationSteps from "../../components/NavigationSteps.astro"
|
||||
import {SUPPORT_EMAIL} from "astro:env/client";
|
||||
import OwnerOnly from "./include/_OwnerOnly.mdx"
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
|
||||
If you are no longer using a Zulip organization, you can deactivate it. When you
|
||||
deactivate an organization, you can specify the time period after which the
|
||||
organization's data will be permanently deleted.
|
||||
|
||||
## Deactivate an organization
|
||||
|
||||
<OwnerOnly />
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/organization-profile" />
|
||||
|
||||
1. Under **Deactivate organization**, click **Deactivate organization**.
|
||||
1. Select when the organization's data (users, channels, messages, etc.)
|
||||
should be permanently deleted.
|
||||
1. Approve by clicking **Confirm**.
|
||||
</FlattenedSteps>
|
||||
|
||||
## Restore a deactivated organization
|
||||
|
||||
A deactivated organization can be restored until its data is deleted.
|
||||
If you deactivated your organization by accident, please contact
|
||||
[<>{SUPPORT_EMAIL}</>](mailto:\<>\{SUPPORT_EMAIL}\</>) as soon as possible.
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Deactivate your account](/help/deactivate-your-account)
|
115
starlight_help/src/content/docs/delete-a-message.mdx
Normal file
115
starlight_help/src/content/docs/delete-a-message.mdx
Normal file
@@ -0,0 +1,115 @@
|
||||
---
|
||||
title: Delete a message
|
||||
---
|
||||
|
||||
import EditIcon from "~icons/zulip-icon/edit"
|
||||
import ZulipTip from '../../components/ZulipTip.astro';
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
import MessageLongPressMenu from "./include/_MessageLongPressMenu.mdx"
|
||||
import MessageActions from "./include/_MessageActions.mdx"
|
||||
import MessageActionsMenu from "./include/_MessageActionsMenu.mdx"
|
||||
import { Tabs, TabItem } from '@astrojs/starlight/components'
|
||||
|
||||
Zulip lets you delete the content of your messages or delete messages completely
|
||||
if these actions are allowed in your organization. Only server administrators
|
||||
can restore deleted messages.
|
||||
|
||||
Organization administrators can
|
||||
[configure](/help/restrict-message-editing-and-deletion) who can edit and delete
|
||||
their own messages, and who can delete any message. They can also set time
|
||||
limits on message editing and deletion.
|
||||
|
||||
## Delete message content
|
||||
|
||||
Editing a message to delete its content will cause the message to be displayed
|
||||
as **(deleted)**. The original sender and timestamp of the message will still
|
||||
be displayed, and the original content of the message is still accessible via
|
||||
Zulip's [edit history](/help/view-a-messages-edit-history) feature. This can be
|
||||
the best option for avoiding confusion if other users have already responded to
|
||||
your message.
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Desktop/Web">
|
||||
<FlattenedSteps>
|
||||
<MessageActions />
|
||||
|
||||
1. Click the **pencil** (<EditIcon />) icon. If you do not see
|
||||
the **pencil** (<EditIcon />) icon, you do not have
|
||||
permission to delete the content of this message.
|
||||
1. Delete the content of the message.
|
||||
1. Click **Save**.
|
||||
</FlattenedSteps>
|
||||
</TabItem>
|
||||
|
||||
<TabItem label="Mobile">
|
||||
<FlattenedSteps>
|
||||
<MessageLongPressMenu />
|
||||
|
||||
1. Tap **Edit message**. If you do not see the **Edit message** option,
|
||||
you do not have permission to change the content of this message.
|
||||
1. Delete the content of the message.
|
||||
1. Tap **Save**.
|
||||
</FlattenedSteps>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Delete a message completely
|
||||
|
||||
In some cases, such as when a message accidentally shares secret information, or
|
||||
contains spam or abuse, it makes sense to delete a message completely. Deleted
|
||||
messages will immediately disappear from the UI in all official Zulip clients.
|
||||
|
||||
Any uploaded files referenced only by deleted messages will be immediately
|
||||
inaccessible. Note that an uploaded file shared in multiple messages will be
|
||||
deleted only when *all* of those messages are deleted.
|
||||
|
||||
It's important to understand that anyone who received the message
|
||||
before you deleted it could have made a copy of its content. Even if
|
||||
no one is online when you send the message, users may have received
|
||||
the message via email or mobile notifications. So if you
|
||||
accidentally shared secret information that you can change, like a
|
||||
password, you may want to change that password regardless of whether
|
||||
you also delete the message.
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Desktop/Web">
|
||||
<FlattenedSteps>
|
||||
<MessageActionsMenu />
|
||||
|
||||
1. Select **Delete message**. If you do not see the **Delete message** option,
|
||||
you do not have permission to delete this message completely.
|
||||
1. Approve by clicking **Confirm**.
|
||||
</FlattenedSteps>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
<ZulipTip>
|
||||
You can delete messages sent by [bots that you
|
||||
own](/help/view-your-bots) just like messages you sent yourself.
|
||||
</ZulipTip>
|
||||
|
||||
## Restoring deleted messages
|
||||
|
||||
For protection against accidental or immediately regretted
|
||||
deletions, messages deleted directly or via a [message retention
|
||||
policy](/help/message-retention-policy) are archived for 30 days in a
|
||||
format that can be restored by a server administrator. After that
|
||||
time, they are permanently and irrecoverably deleted from the Zulip
|
||||
server. Server administrators can adjust the archival time using
|
||||
the `ARCHIVED_DATA_VACUUMING_DELAY_DAYS` setting.
|
||||
|
||||
## Message notifications
|
||||
|
||||
If you delete a message soon after sending it, any [pending email
|
||||
notifications](/help/email-notifications#configure-delay-for-message-notification-emails)
|
||||
for that message will be canceled, and
|
||||
[visual desktop notifications](/help/desktop-notifications) will be removed,
|
||||
including [mentions and alerts](/help/dm-mention-alert-notifications).
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Delete a topic](/help/delete-a-topic)
|
||||
* [Archive a channel](/help/archive-a-channel)
|
||||
* [Message retention policy](/help/message-retention-policy)
|
||||
* [Edit a message](/help/edit-a-message)
|
||||
* [Restrict message editing and deletion](/help/restrict-message-editing-and-deletion)
|
58
starlight_help/src/content/docs/delete-a-topic.mdx
Normal file
58
starlight_help/src/content/docs/delete-a-topic.mdx
Normal file
@@ -0,0 +1,58 @@
|
||||
---
|
||||
title: Delete a topic
|
||||
---
|
||||
|
||||
import TopicActions from "./include/_TopicActions.mdx"
|
||||
import AdminOnly from "./include/_AdminOnly.mdx"
|
||||
import { Tabs, TabItem } from '@astrojs/starlight/components'
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
|
||||
<AdminOnly />
|
||||
|
||||
We generally recommend against deleting topics, but there are a few
|
||||
situations in which it can be useful:
|
||||
|
||||
* Clearing out test messages after setting up an organization.
|
||||
* Clearing out messages from an overly enthusiastic bot.
|
||||
* Managing abuse.
|
||||
|
||||
In most other cases, [renaming a topic](/help/rename-a-topic) is often a
|
||||
better idea, or just leaving the topic as is. Deleting a topic can confuse
|
||||
users who come to the topic later via an email notification.
|
||||
|
||||
Note that deleting a topic also deletes every message with that topic,
|
||||
whereas [archiving a channel](/help/archive-a-channel) does not.
|
||||
|
||||
### Delete a topic
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Desktop/Web">
|
||||
<FlattenedSteps>
|
||||
<TopicActions />
|
||||
|
||||
1. Click **Delete topic**.
|
||||
1. Approve by clicking **Confirm**.
|
||||
</FlattenedSteps>
|
||||
</TabItem>
|
||||
|
||||
<TabItem label="Mobile">
|
||||
Access this feature by following the web app instructions in your
|
||||
mobile device browser.
|
||||
|
||||
Implementation of this feature in the mobile app is tracked [on
|
||||
GitHub](https://github.com/zulip/zulip-flutter/issues/1549). If
|
||||
you're interested in this feature, please react to the issue's
|
||||
description with 👍.
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
Note that deleting all of the individual messages within a particular
|
||||
topic also deletes that topic. Structurally, topics are simply an
|
||||
attribute of messages in Zulip.
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Edit a message](/help/edit-a-message)
|
||||
* [Delete a message](/help/delete-a-message)
|
||||
* [Archive a channel](/help/archive-a-channel)
|
||||
* [Message retention policy](/help/message-retention-policy)
|
98
starlight_help/src/content/docs/demo-organizations.mdx
Normal file
98
starlight_help/src/content/docs/demo-organizations.mdx
Normal file
@@ -0,0 +1,98 @@
|
||||
---
|
||||
title: Demo organizations
|
||||
---
|
||||
|
||||
import NavigationSteps from "../../components/NavigationSteps.astro"
|
||||
import ZulipNote from '../../components/ZulipNote.astro';
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
import { Steps } from '@astrojs/starlight/components';
|
||||
import OwnerOnly from "./include/_OwnerOnly.mdx"
|
||||
|
||||
<ZulipNote>
|
||||
**Note:** The ability to create demo organizations is an upcoming
|
||||
feature. It is not available yet.
|
||||
</ZulipNote>
|
||||
|
||||
If you would like to try out Zulip without having to make any
|
||||
decisions (like how to name your organization or whether to import
|
||||
data from an existing chat tool), you can create a Zulip demo
|
||||
organization.
|
||||
|
||||
Demo organizations differ from a regular Zulip organization in a few
|
||||
ways:
|
||||
|
||||
* A demo organization will be automatically deleted 30 days after
|
||||
creation. You can [convert a demo organization into a regular
|
||||
organization](#convert-a-demo-organization-to-a-permanent-organization)
|
||||
if you'd prefer to keep its history.
|
||||
* You do not need to choose a URL or when creating a demo organization;
|
||||
one will be generated automatically for you.
|
||||
* A demo organization cannot be directly upgraded to a paid Zulip
|
||||
Cloud plan without first converting to a regular organization.
|
||||
|
||||
Other than those limitations, they work exactly like a normal Zulip
|
||||
organization; you can invite additional users, connect the mobile
|
||||
apps, etc.
|
||||
|
||||
## Create a demo organization
|
||||
|
||||
<Steps>
|
||||
1. Go to zulip.com and click **New organization** in the top-right corner.
|
||||
</Steps>
|
||||
|
||||
## Configure email for demo organization owner
|
||||
|
||||
To convert a demo organization to a permanent organization, and to access
|
||||
certain features like [inviting other users](/help/invite-new-users) and
|
||||
[configuring authentication methods](/help/configure-authentication-methods),
|
||||
the creator of the demo organization will need to add an email address
|
||||
and set a password for their account.
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/account-and-privacy" />
|
||||
|
||||
1. Under **Account**, click **Add email**.
|
||||
1. Enter your email address.
|
||||
1. *(optional)* If the name on the account is still a placeholder,
|
||||
edit the **Name** field.
|
||||
1. Click **Add**.
|
||||
1. You will receive a confirmation email within a few minutes. Open
|
||||
it and click **Confirm and set password**.
|
||||
</FlattenedSteps>
|
||||
|
||||
## Convert a demo organization to a permanent organization
|
||||
|
||||
<OwnerOnly />
|
||||
|
||||
If you'd like to keep your demo organization user and message history,
|
||||
you can convert it to a permanent Zulip organization. You'll need to
|
||||
choose a new subdomain for your new permanent organization URL.
|
||||
|
||||
Also, as part of the process of converting a demo organization to a
|
||||
permanent organization:
|
||||
|
||||
* Users will be logged out of existing sessions on the web, mobile and
|
||||
desktop apps and need to log in again.
|
||||
* Any [API clients](/api/) or [integrations](/integrations/) will need
|
||||
to be updated to point to the new organization URL.
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/organization-profile" />
|
||||
|
||||
1. Click the **Convert to make it permanent** link at the end of the
|
||||
"This demo organization will be automatically deleted ..." notice.
|
||||
1. Enter the subdomain you would like to use for the new organization
|
||||
URL and click **Convert**.
|
||||
</FlattenedSteps>
|
||||
|
||||
<ZulipNote>
|
||||
**Note:** You will be logged out when the demo organization is
|
||||
successfully converted to a permanent Zulip organization and be
|
||||
redirected to new organization URL log-in page.
|
||||
</ZulipNote>
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Getting started with Zulip](/help/getting-started-with-zulip)
|
||||
* [Moving to Zulip](/help/moving-to-zulip)
|
||||
* [Invite users to join](/help/invite-users-to-join)
|
202
starlight_help/src/content/docs/desktop-app-install-guide.mdx
Normal file
202
starlight_help/src/content/docs/desktop-app-install-guide.mdx
Normal file
@@ -0,0 +1,202 @@
|
||||
---
|
||||
title: Installing the Zulip desktop app
|
||||
---
|
||||
|
||||
import ZulipNote from '../../components/ZulipNote.astro';
|
||||
import ZulipTip from '../../components/ZulipTip.astro';
|
||||
import { Steps } from '@astrojs/starlight/components';
|
||||
import { Tabs, TabItem } from '@astrojs/starlight/components'
|
||||
import AppWillUpdateTip from "./include/_AppWillUpdateTip.mdx"
|
||||
|
||||
The Zulip desktop app comes with native desktop notifications, support for
|
||||
multiple Zulip accounts, and a dedicated tray icon.
|
||||
|
||||
Installing the latest stable release is recommended for most users. For an early
|
||||
look at the newest features, consider the [beta
|
||||
releases](#install-a-beta-release).
|
||||
|
||||
## Install the latest release
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="macOS">
|
||||
<AppWillUpdateTip />
|
||||
|
||||
#### Disk image *(recommended)*
|
||||
|
||||
<Steps>
|
||||
1. Download [Zulip for macOS](https://zulip.com/apps/mac).
|
||||
1. Open the file, and drag the app into the **Applications** folder.
|
||||
</Steps>
|
||||
|
||||
#### Homebrew
|
||||
|
||||
<Steps>
|
||||
1. Run the command `brew install --cask zulip` from a terminal.
|
||||
1. Run Zulip from **Applications**.
|
||||
</Steps>
|
||||
|
||||
You can run the command `brew upgrade zulip` to immediately upgrade the app.
|
||||
</TabItem>
|
||||
|
||||
<TabItem label="Windows">
|
||||
#### Web installer *(recommended)*
|
||||
|
||||
<AppWillUpdateTip />
|
||||
|
||||
<Steps>
|
||||
1. Download and run [Zulip for Windows](https://zulip.com/apps/windows).
|
||||
1. Run Zulip from the **Start** menu.
|
||||
</Steps>
|
||||
|
||||
#### Offline installer *(for isolated networks)*
|
||||
|
||||
<ZulipNote>
|
||||
The app will not update automatically. You can repeat these steps to upgrade
|
||||
to future versions.
|
||||
</ZulipNote>
|
||||
|
||||
<Steps>
|
||||
1. Download [zulip-x.x.x-x64.msi][latest] for 64-bit desktops
|
||||
(common), or [zulip-x.x.x-ia32.msi][latest] for 32-bit (rare).
|
||||
1. Copy the installer file to the machine you want to install the app
|
||||
on, and open it there.
|
||||
1. Run Zulip from the **Start** menu.
|
||||
</Steps>
|
||||
</TabItem>
|
||||
|
||||
<TabItem label="Linux">
|
||||
#### APT *(Ubuntu or Debian)*
|
||||
|
||||
<ZulipTip>
|
||||
The app will be updated automatically to future versions when you do a
|
||||
regular software update on your system, e.g., with
|
||||
`sudo apt update && sudo apt upgrade`.
|
||||
</ZulipTip>
|
||||
|
||||
<Steps>
|
||||
1. Enter the following commands into a terminal:
|
||||
```
|
||||
sudo apt install curl
|
||||
sudo curl -fL -o /etc/apt/trusted.gpg.d/zulip-desktop.asc \
|
||||
https://download.zulip.com/desktop/apt/zulip-desktop.asc
|
||||
echo "deb https://download.zulip.com/desktop/apt stable main" | \
|
||||
sudo tee /etc/apt/sources.list.d/zulip-desktop.list
|
||||
sudo apt update
|
||||
sudo apt install zulip
|
||||
```
|
||||
These commands set up the Zulip Desktop APT repository and its signing
|
||||
key, and then install the Zulip client.
|
||||
1. Run Zulip from your app launcher, or with `zulip` from a terminal.
|
||||
</Steps>
|
||||
|
||||
#### AppImage *(recommended for all other distros)*
|
||||
|
||||
<AppWillUpdateTip />
|
||||
|
||||
<Steps>
|
||||
1. Download [Zulip for Linux](https://zulip.com/apps/linux).
|
||||
1. Make the file executable, with
|
||||
`chmod a+x Zulip-x.x.x-x86_64.AppImage` from a terminal (replace
|
||||
`x.x.x` with the actual app version of the downloaded file).
|
||||
1. Run the file from your app launcher, or from a terminal. This file is the
|
||||
Zulip app, so no installation is required.
|
||||
</Steps>
|
||||
|
||||
#### Snap
|
||||
|
||||
<Steps>
|
||||
1. Make sure [snapd](https://docs.snapcraft.io/core/install) is installed.
|
||||
1. Execute following command to install Zulip:
|
||||
```
|
||||
sudo snap install zulip
|
||||
```
|
||||
1. Run Zulip from your app launcher, or with `zulip` from a terminal.
|
||||
</Steps>
|
||||
|
||||
#### Flathub
|
||||
|
||||
<Steps>
|
||||
1. Make sure you have [Flatpak](https://flathub.org/setup) installed on your
|
||||
system.
|
||||
1. Use the following command from the official
|
||||
[Flathub page](https://flathub.org/apps/org.zulip.Zulip) to install Zulip:
|
||||
```
|
||||
flatpak install flathub org.zulip.Zulip
|
||||
```
|
||||
1. After the installation is complete, you can run Zulip using the following
|
||||
command:
|
||||
```
|
||||
flatpak run org.zulip.Zulip
|
||||
```
|
||||
</Steps>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Install a beta release
|
||||
|
||||
Get a peek at new features before they're released!
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Most systems">
|
||||
<AppWillUpdateTip />
|
||||
|
||||
<Steps>
|
||||
1. Go to the [Zulip releases][release-list] page on GitHub, and find the latest
|
||||
version tagged with the “Pre-release” label.
|
||||
1. If there's a **Pre-release** that's more recent than the [latest release][latest],
|
||||
download the appropriate Zulip beta installer or app for your system.
|
||||
1. To install and run Zulip, refer to the instructions for your operating
|
||||
system in the [Install the latest release](#install-the-latest-release)
|
||||
section above.
|
||||
</Steps>
|
||||
</TabItem>
|
||||
|
||||
<TabItem label="Linux with APT">
|
||||
<ZulipTip>
|
||||
The app will be updated automatically to future versions when you do a
|
||||
regular software update on your system, e.g., with
|
||||
`sudo apt update && sudo apt upgrade`.
|
||||
</ZulipTip>
|
||||
|
||||
#### You don't have the Zulip app installed
|
||||
|
||||
<Steps>
|
||||
1. Enter the following commands into a terminal:
|
||||
```
|
||||
sudo curl -fL -o /etc/apt/trusted.gpg.d/zulip-desktop.asc \
|
||||
https://download.zulip.com/desktop/apt/zulip-desktop.asc
|
||||
echo "deb https://download.zulip.com/desktop/apt beta main" | \
|
||||
sudo tee /etc/apt/sources.list.d/zulip-desktop.list
|
||||
sudo apt update
|
||||
sudo apt install zulip
|
||||
```
|
||||
These commands set up the Zulip Desktop beta APT repository and its signing
|
||||
key, and then install the Zulip beta client.
|
||||
1. Run Zulip from your app launcher, or with `zulip` from a terminal.
|
||||
</Steps>
|
||||
|
||||
#### You already have the Zulip app installed
|
||||
|
||||
<Steps>
|
||||
1. Enter the following commands into a terminal:
|
||||
```
|
||||
sudo sed -i s/stable/beta/ /etc/apt/sources.list.d/zulip-desktop.list
|
||||
sudo apt update
|
||||
sudo apt install zulip
|
||||
```
|
||||
These commands set up the Zulip Desktop beta APT repository, and then
|
||||
install the Zulip beta client.
|
||||
1. Run Zulip from your app launcher, or with `zulip` from a terminal.
|
||||
</Steps>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
[latest]: https://github.com/zulip/zulip-desktop/releases/latest
|
||||
|
||||
[release-list]: https://github.com/zulip/zulip-desktop/releases
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Connect through a proxy](/help/connect-through-a-proxy)
|
||||
* [Use a custom certificate](/help/custom-certificates)
|
||||
* [View Zulip version](/help/view-zulip-version)
|
175
starlight_help/src/content/docs/desktop-notifications.mdx
Normal file
175
starlight_help/src/content/docs/desktop-notifications.mdx
Normal file
@@ -0,0 +1,175 @@
|
||||
---
|
||||
title: Desktop notifications
|
||||
---
|
||||
|
||||
import NavigationSteps from "../../components/NavigationSteps.astro"
|
||||
import ZulipNote from '../../components/ZulipNote.astro';
|
||||
import ZulipTip from '../../components/ZulipTip.astro';
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
import PlayCircleIcon from "~icons/fa/play-circle"
|
||||
import { Steps } from '@astrojs/starlight/components';
|
||||
import { Tabs, TabItem } from '@astrojs/starlight/components'
|
||||
|
||||
Zulip can be configured to send visual and audible desktop notifications for
|
||||
[DMs, mentions, and alerts](/help/dm-mention-alert-notifications), as well as
|
||||
[channel messages](/help/channel-notifications) and [followed
|
||||
topics](/help/follow-a-topic#configure-notifications-for-followed-topics).
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/notifications" />
|
||||
|
||||
1. Toggle the checkboxes in the **Desktop** column of the **Notification
|
||||
triggers** table.
|
||||
</FlattenedSteps>
|
||||
|
||||
## Notification sound
|
||||
|
||||
You can select the sound Zulip uses for audible desktop notifications. Choosing
|
||||
**None** disables all audible desktop notifications.
|
||||
|
||||
### Change notification sound
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/notifications" />
|
||||
|
||||
1. Under **Desktop message notifications**, configure
|
||||
**Notification sound**.
|
||||
</FlattenedSteps>
|
||||
|
||||
<ZulipTip>
|
||||
To hear the selected sound, click the <PlayCircleIcon /> to the right of your selection.
|
||||
</ZulipTip>
|
||||
|
||||
## Unread count badge
|
||||
|
||||
By default, Zulip displays a count of your unmuted unread messages on the
|
||||
[desktop app](https://zulip.com/apps/) sidebar and on the browser tab icon. You
|
||||
can configure the badge to only count [direct messages](/help/direct-messages)
|
||||
and [mentions](/help/mention-a-user-or-group), or to include messages in
|
||||
[followed topics](/help/follow-a-topic) but not other
|
||||
[channel](/help/introduction-to-channels) messages.
|
||||
|
||||
### Configure unread count badge
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/notifications" />
|
||||
|
||||
1. Under **Desktop message notifications**, configure
|
||||
**Unread count badge**.
|
||||
</FlattenedSteps>
|
||||
|
||||
### Disable unread count badge
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/notifications" />
|
||||
|
||||
1. Under **Desktop message notifications**, select **None** from the
|
||||
**Unread count badge** dropdown.
|
||||
</FlattenedSteps>
|
||||
|
||||
## Testing desktop notifications
|
||||
|
||||
<ZulipNote>
|
||||
This does not make an unread count badge appear.
|
||||
</ZulipNote>
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Desktop/Web">
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/notifications" />
|
||||
|
||||
1. Under **Desktop message notifications**, click **Send a test notification**.
|
||||
If notifications are working, you will receive a test notification.
|
||||
</FlattenedSteps>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Troubleshooting desktop notifications
|
||||
|
||||
Desktop notifications are triggered when a message arrives, and Zulip is not
|
||||
in focus or the message is offscreen. You must have Zulip open in a browser
|
||||
tab or in the Zulip desktop app to receive desktop notifications.
|
||||
|
||||
**Visual desktop notifications** appear in the corner of your main monitor.
|
||||
**Audible desktop notifications** make a sound.
|
||||
|
||||
To receive notifications in the desktop app, make sure that [Do Not Disturb
|
||||
mode](/help/do-not-disturb) is turned off.
|
||||
|
||||
### Check notification settings for DMs or channels
|
||||
|
||||
If you have successfully received a [test
|
||||
notification](#testing-desktop-notifications), but you aren't seeing desktop
|
||||
notifications for new messages, check your Zulip notification settings. Make
|
||||
sure you have enabled desktop notifications [for
|
||||
DMs](/help/dm-mention-alert-notifications) or [for the
|
||||
channel](/help/channel-notifications) you are testing. Messages in [muted
|
||||
topics](/help/mute-a-topic) will not trigger notifications.
|
||||
|
||||
### Check platform settings
|
||||
|
||||
The most common issue is that your browser or system settings are blocking
|
||||
notifications from Zulip. Before checking Zulip-specific settings, make sure
|
||||
that **Do Not Disturb mode** is not enabled on your computer.
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Chrome">
|
||||
<Steps>
|
||||
1. Click on the site information menu to the left of the URL for your Zulip
|
||||
organization.
|
||||
1. Toggle **Notifications** and **Sound**. If you don't see those options,
|
||||
click on **Site settings**, and set **Notifications** and **Sound** to
|
||||
**Allow**.
|
||||
</Steps>
|
||||
|
||||
Alternate instructions:
|
||||
|
||||
<Steps>
|
||||
1. Select the Chrome menu at the top right of the browser, and select
|
||||
**Settings**.
|
||||
1. Select **Privacy and security**, **Site Settings**, and then
|
||||
**Notifications**.
|
||||
1. Next to **Allowed to send notifications**, select **Add**.
|
||||
1. Paste the Zulip URL for your organization into the site field, and
|
||||
click **Add**.
|
||||
</Steps>
|
||||
</TabItem>
|
||||
|
||||
<TabItem label="Firefox">
|
||||
<Steps>
|
||||
1. Select the Firefox menu at the top right of the browser, and select
|
||||
**Settings**.
|
||||
1. On the left, select **Privacy & Security**. Scroll to the **Permissions**
|
||||
section and select the **Settings** button next to **Notifications**.
|
||||
1. Find the URL for your Zulip organization, and adjust the **Status**
|
||||
selector to **Allow**.
|
||||
</Steps>
|
||||
</TabItem>
|
||||
|
||||
<TabItem label="Desktop app">
|
||||
**Windows**
|
||||
|
||||
<Steps>
|
||||
1. Click the **Start** button and select **Settings**. Select **System**,
|
||||
and then **Notifications & actions**.
|
||||
1. Select **Zulip** from the list of apps.
|
||||
1. Configure the notification style that you would like Zulip to use.
|
||||
</Steps>
|
||||
|
||||
**macOS**
|
||||
|
||||
<Steps>
|
||||
1. Open your Mac **System Preferences** and select **Notifications**.
|
||||
1. Select **Zulip** from the list of apps.
|
||||
1. Configure the notification style that you would like Zulip to use.
|
||||
</Steps>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Channel notifications](/help/channel-notifications)
|
||||
* [DMs, mentions, and alerts](/help/dm-mention-alert-notifications)
|
||||
* [Email notifications](/help/email-notifications)
|
||||
* [Mobile notifications](/help/mobile-notifications)
|
||||
* [Do not disturb](/help/do-not-disturb)
|
31
starlight_help/src/content/docs/digest-emails.mdx
Normal file
31
starlight_help/src/content/docs/digest-emails.mdx
Normal file
@@ -0,0 +1,31 @@
|
||||
---
|
||||
title: Weekly digest emails
|
||||
---
|
||||
|
||||
import NavigationSteps from "../../components/NavigationSteps.astro"
|
||||
import AdminOnly from "./include/_AdminOnly.mdx"
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
|
||||
<AdminOnly />
|
||||
|
||||
Zulip has a beta feature to send weekly emails to users who haven't
|
||||
been active for 5 or more days. These emails include details on new
|
||||
channels created and highlights of traffic (of subscribed channels) that
|
||||
can intrigue users.
|
||||
|
||||
This feature is disabled by default, but an organization administrator
|
||||
can enable it for their organization. Individual users can opt-out in
|
||||
organizations that have enabled it.
|
||||
|
||||
You can view a sample digest email for your account in HTML and
|
||||
plain-text formats by visiting `https://zulip.example.com/digest/`,
|
||||
if `https://zulip.example.com` is your Zulip server URL.
|
||||
|
||||
## Enable digest emails for an organization
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/organization-settings" />
|
||||
|
||||
1. Under **Automated messages and emails**, toggle
|
||||
**Send weekly digest emails to inactive users**.
|
||||
</FlattenedSteps>
|
115
starlight_help/src/content/docs/direct-messages.mdx
Normal file
115
starlight_help/src/content/docs/direct-messages.mdx
Normal file
@@ -0,0 +1,115 @@
|
||||
---
|
||||
title: Direct messages
|
||||
---
|
||||
|
||||
import DmFeedInstructions from "./include/_DmFeedInstructions.mdx"
|
||||
import MobileDirectMessages from "./include/_MobileDirectMessages.mdx"
|
||||
import SendDm from "./include/_SendDm.mdx"
|
||||
import ZulipTip from '../../components/ZulipTip.astro';
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
import UserListIcon from "~icons/zulip-icon/user-list"
|
||||
import { Steps } from '@astrojs/starlight/components';
|
||||
import ViewDmsLeftSidebar from "./include/_ViewDmsLeftSidebar.mdx"
|
||||
import FindDmConversationLeftSidebar from "./include/_FindDmConversationLeftSidebar.mdx"
|
||||
import SearchIcon from "~icons/zulip-icon/search"
|
||||
import { Tabs, TabItem } from '@astrojs/starlight/components'
|
||||
import ChevronRightIcon from "~icons/zulip-icon/chevron-right"
|
||||
|
||||
**Direct messages (DMs)** are conversations with other users that happen outside
|
||||
of a [channel](/help/introduction-to-channels). They are convenient for 1:1 and
|
||||
small group conversations.
|
||||
|
||||
If you find yourself frequently conversing with the same person or group, it
|
||||
often works best to [create a private channel](/help/create-a-channel) for your
|
||||
conversations. This lets you organize your discussion into topics, and subscribe
|
||||
or unsubscribe people as needed.
|
||||
|
||||
## Send a DM
|
||||
|
||||
<SendDm />
|
||||
|
||||
## View your direct message conversations
|
||||
|
||||
There are a few different ways to view your DM conversations.
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Via left sidebar">
|
||||
<FlattenedSteps>
|
||||
<ViewDmsLeftSidebar />
|
||||
</FlattenedSteps>
|
||||
|
||||
<ZulipTip>
|
||||
To return to the channel list in the left sidebar, click the **back to
|
||||
channels** link above the search box.
|
||||
</ZulipTip>
|
||||
</TabItem>
|
||||
|
||||
<TabItem label="Via right sidebar">
|
||||
<Steps>
|
||||
1. If the [user list](/help/user-list) in the right sidebar is hidden, click the
|
||||
**user list** (<UserListIcon />) icon in
|
||||
the upper right to show it.
|
||||
1. Click on any user to view your 1:1 DM conversation.
|
||||
</Steps>
|
||||
|
||||
<ZulipTip>
|
||||
You can find a user by typing their name in the **Filter users** box at the
|
||||
top of the right sidebar.
|
||||
</ZulipTip>
|
||||
</TabItem>
|
||||
|
||||
<TabItem label="Via compose box">
|
||||
<Steps>
|
||||
1. Click the **New direct message** button at the bottom of the app, or use the
|
||||
<kbd>X</kbd> keyboard shortcut to [open the compose box](/help/open-the-compose-box).
|
||||
1. Start typing a user's name in the recipient bar, and select their name from
|
||||
the list of suggestions. Continue to add users for a group DM conversation.
|
||||
1. Click the highlighted **Go to conversation** (<ChevronRightIcon />) button at the top of the compose box, or use
|
||||
the <kbd>Ctrl</kbd> + <kbd>.</kbd> keyboard shortcut to view that DM
|
||||
conversation.
|
||||
</Steps>
|
||||
</TabItem>
|
||||
|
||||
<TabItem label="Mobile">
|
||||
<FlattenedSteps>
|
||||
<MobileDirectMessages />
|
||||
|
||||
1. Tap a recent DM conversation to view it.
|
||||
</FlattenedSteps>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Find a direct message conversation
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Via left sidebar">
|
||||
<FindDmConversationLeftSidebar />
|
||||
</TabItem>
|
||||
|
||||
<TabItem label="Via search box">
|
||||
<Steps>
|
||||
1. Click the **search** (<SearchIcon />) icon in the top bar to open the [search
|
||||
box](/help/search-for-messages).
|
||||
1. Start typing a user's name. You'll be able to select DMs with that user
|
||||
from the list of suggestions.
|
||||
1. *(optional)* Continue to add users via the search box for a group DM
|
||||
conversation.
|
||||
</Steps>
|
||||
|
||||
<ZulipTip>
|
||||
You can also type `dm-including` in the search box to find all 1:1 and group
|
||||
DM conversations that include a particular user.
|
||||
</ZulipTip>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Go to direct message feed
|
||||
|
||||
You can see all your direct messages in one place.
|
||||
|
||||
<DmFeedInstructions />
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Typing notifications](/help/typing-notifications)
|
||||
* [Open the compose box](/help/open-the-compose-box)
|
25
starlight_help/src/content/docs/disable-welcome-emails.mdx
Normal file
25
starlight_help/src/content/docs/disable-welcome-emails.mdx
Normal file
@@ -0,0 +1,25 @@
|
||||
---
|
||||
title: Disable welcome emails
|
||||
---
|
||||
|
||||
import NavigationSteps from "../../components/NavigationSteps.astro"
|
||||
import AdminOnly from "./include/_AdminOnly.mdx"
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
|
||||
<AdminOnly />
|
||||
|
||||
Zulip sends a handful of emails to new users, introducing them to the Zulip
|
||||
app, when they join an organization. If these emails don't make sense for
|
||||
your organization, you can disable them.
|
||||
|
||||
Note that regardless of this setting, users will receive an initial account
|
||||
email notifying them about their new Zulip account and how to log in.
|
||||
|
||||
## Disable welcome emails
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/organization-settings" />
|
||||
|
||||
1. Under **Onboarding**, toggle
|
||||
**Send emails introducing Zulip to new users**.
|
||||
</FlattenedSteps>
|
@@ -0,0 +1,94 @@
|
||||
---
|
||||
title: DMs, mentions, and alerts
|
||||
---
|
||||
|
||||
import NavigationSteps from "../../components/NavigationSteps.astro"
|
||||
import ZulipTip from '../../components/ZulipTip.astro';
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
import { Steps } from '@astrojs/starlight/components';
|
||||
import TrashIcon from "~icons/zulip-icon/trash"
|
||||
|
||||
You can configure desktop, mobile, and email notifications for
|
||||
[direct messages (DMs)](/help/direct-messages),
|
||||
[mentions](/help/mention-a-user-or-group), and [alert
|
||||
words](#alert-words).
|
||||
|
||||
## Configure notifications
|
||||
|
||||
These settings will affect notifications for direct messages, group
|
||||
direct messages, mentions, and alert words.
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/notifications" />
|
||||
|
||||
1. In the **Notification triggers** table, toggle the settings for **DMs, mentions, and alerts**.
|
||||
</FlattenedSteps>
|
||||
|
||||
You can also hide the content of direct messages (and group direct
|
||||
messages) from desktop notifications.
|
||||
|
||||
<Steps>
|
||||
1. Under **Desktop message notifications**, toggle
|
||||
**Include content of direct messages in desktop notifications**.
|
||||
</Steps>
|
||||
|
||||
## Wildcard mentions
|
||||
|
||||
You can configure which types of notifications you want to receive for wildcard
|
||||
mentions (**@all**, **@everyone**, **@channel**) and **@topic** mentions
|
||||
separately from personal @-mentions.
|
||||
|
||||
<ZulipTip>
|
||||
These mentions don't trigger notifications in muted channels or topics,
|
||||
unlike personal mentions.
|
||||
</ZulipTip>
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/notifications" />
|
||||
|
||||
1. In the **Notification triggers** table, toggle the **@all** checkbox for
|
||||
**Channels** or **Followed topics**.
|
||||
</FlattenedSteps>
|
||||
|
||||
Additionally, you can override this configuration for individual
|
||||
channels in your [Channel settings](/help/channel-notifications), and
|
||||
administrators can [restrict use of wildcard
|
||||
mentions](/help/restrict-wildcard-mentions) in large channels.
|
||||
|
||||
## Alert words
|
||||
|
||||
Zulip lets you to specify **alert words or phrases** that send you a desktop
|
||||
notification whenever the alert word is included in a message. Alert words are
|
||||
case-insensitive.
|
||||
|
||||
<ZulipTip>
|
||||
Alert words in messages you receive while the alert is enabled will be highlighted.
|
||||
</ZulipTip>
|
||||
|
||||
### Add an alert word or phrase
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/alert-words" />
|
||||
|
||||
1. Click **Add alert word**.
|
||||
1. Type a word or phrase, and click **Add**.
|
||||
</FlattenedSteps>
|
||||
|
||||
### Remove an alert word or phrase
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/alert-words" />
|
||||
|
||||
1. Click the **delete** (<TrashIcon />) icon next to the
|
||||
alert word that you would like to remove.
|
||||
</FlattenedSteps>
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Desktop notifications](/help/desktop-notifications)
|
||||
* [Email notifications](/help/email-notifications)
|
||||
* [Mobile notifications](/help/mobile-notifications)
|
||||
* [Restrict wildcard mentions](/help/restrict-wildcard-mentions)
|
||||
* [Channel notifications](/help/channel-notifications)
|
||||
* [View your mentions](/help/view-your-mentions)
|
||||
* [Do not disturb](/help/do-not-disturb)
|
60
starlight_help/src/content/docs/do-not-disturb.mdx
Normal file
60
starlight_help/src/content/docs/do-not-disturb.mdx
Normal file
@@ -0,0 +1,60 @@
|
||||
---
|
||||
title: Do Not Disturb
|
||||
---
|
||||
|
||||
import ZulipNote from '../../components/ZulipNote.astro';
|
||||
import BellIcon from "~icons/fa/bell"
|
||||
import { Steps } from '@astrojs/starlight/components';
|
||||
import DesktopToggleSidebarTip from "./include/_DesktopToggleSidebarTip.mdx"
|
||||
import BellSlashIcon from "~icons/fa/bell-slash"
|
||||
import { Tabs, TabItem } from '@astrojs/starlight/components'
|
||||
|
||||
The Zulip desktop app offers a **Do Not Disturb (DND)** mode. Turning on **Do Not
|
||||
Disturb** mode disables [desktop notifications](/help/desktop-notifications)
|
||||
across all the organizations you have
|
||||
[added](/help/logging-in#log-in-to-a-new-organization) to the Zulip desktop app.
|
||||
This can be convenient for avoiding interruptions during a meeting, or when you need
|
||||
time to focus on your work.
|
||||
|
||||
<ZulipNote>
|
||||
Other types of notifications will not be affected, including [mobile
|
||||
notifications](/help/mobile-notifications), [email
|
||||
notifications](/help/email-notifications), and [desktop
|
||||
notifications](/help/desktop-notifications) in the Zulip web app.
|
||||
</ZulipNote>
|
||||
|
||||
## Toggle Do Not Disturb
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Desktop">
|
||||
<Steps>
|
||||
1. Click the **bell** (<BellIcon />) or **bell with a slash** (<BellSlashIcon />) icon in the **organizations sidebar** on the
|
||||
left. You can also select **Toggle Do Not Disturb** from the **Zulip** menu in
|
||||
the top menu bar.
|
||||
</Steps>
|
||||
|
||||
<DesktopToggleSidebarTip />
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Check whether Do Not Disturb is enabled
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Desktop">
|
||||
<Steps>
|
||||
1. If the **organizations sidebar** on the left shows a **bell** (<BellIcon />) icon, **Do Not Disturb** is disabled. If the **organizations
|
||||
sidebar** on the left shows a **bell with a slash** (<BellSlashIcon />) icon, **Do Not Disturb** is enabled, and you are not
|
||||
receiving desktop notifications.
|
||||
</Steps>
|
||||
|
||||
<DesktopToggleSidebarTip />
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Desktop notifications](/help/desktop-notifications)
|
||||
* [DMs, mentions, and alerts](/help/dm-mention-alert-notifications)
|
||||
* [Channel notifications](/help/channel-notifications)
|
||||
* [Email notifications](/help/email-notifications)
|
||||
* [Mobile notifications](/help/mobile-notifications)
|
77
starlight_help/src/content/docs/edit-a-message.mdx
Normal file
77
starlight_help/src/content/docs/edit-a-message.mdx
Normal file
@@ -0,0 +1,77 @@
|
||||
---
|
||||
title: Edit a message
|
||||
---
|
||||
|
||||
import EditIcon from "~icons/zulip-icon/edit"
|
||||
import ZulipTip from '../../components/ZulipTip.astro';
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
import MessageLongPressMenu from "./include/_MessageLongPressMenu.mdx"
|
||||
import MessageActions from "./include/_MessageActions.mdx"
|
||||
import { Tabs, TabItem } from '@astrojs/starlight/components'
|
||||
|
||||
Zulip makes it possible to edit the content of your messages, letting you fix
|
||||
typos, clarify your thoughts, etc. Organization administrators can
|
||||
[configure](/help/restrict-message-editing-and-deletion) who can edit messages,
|
||||
and set time limits for this action. However, even organization owners cannot
|
||||
edit the content of a message sent by another user.
|
||||
|
||||
<ZulipTip>
|
||||
You can also [edit message topics](/help/rename-a-topic).
|
||||
</ZulipTip>
|
||||
|
||||
## Edit a message
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Desktop/Web">
|
||||
<FlattenedSteps>
|
||||
<MessageActions />
|
||||
|
||||
1. Click the **pencil** (<EditIcon />) icon. If you do not see
|
||||
the **pencil** (<EditIcon />) icon, you do not have
|
||||
permission to edit this message.
|
||||
1. Edit the content of the message.
|
||||
1. Click **Save**.
|
||||
</FlattenedSteps>
|
||||
</TabItem>
|
||||
|
||||
<TabItem label="Mobile">
|
||||
<FlattenedSteps>
|
||||
<MessageLongPressMenu />
|
||||
|
||||
1. Tap **Edit message**. If you do not see the **Edit message** option, you do
|
||||
not have permission to edit this message.
|
||||
1. Edit the content of the message.
|
||||
1. Tap **Save**.
|
||||
</FlattenedSteps>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
<ZulipTip>
|
||||
When you edit a message, everyone will see it labeled as **edited**. You
|
||||
can [view a message's edit history](/help/view-a-messages-edit-history)
|
||||
if it is [allowed](/help/restrict-message-edit-history-access) in your
|
||||
organization.
|
||||
</ZulipTip>
|
||||
|
||||
## Message notifications
|
||||
|
||||
If you edit a message to [mention a user or group](/help/mention-a-user-or-group),
|
||||
the newly mentioned users will receive notifications just as if they had been
|
||||
mentioned in the original message.
|
||||
|
||||
If you edit a message soon after sending it, the edit will be reflected in any
|
||||
[email notifications that have not yet been sent](/help/email-notifications#configure-delay-for-message-notification-emails).
|
||||
This includes canceling notifications for users whose
|
||||
[mention](/help/format-your-message-using-markdown#mention-a-user-or-group) was
|
||||
removed or changed from a regular mention to a
|
||||
[silent mention](/help/mention-a-user-or-group#silently-mention-a-user).
|
||||
|
||||
If you [delete the content of a message](/help/delete-a-message#delete-message-content),
|
||||
any pending email notifications for that message will be canceled, including
|
||||
[mentions and alerts](/help/dm-mention-alert-notifications).
|
||||
|
||||
## Related articles
|
||||
|
||||
* [View, copy, and share message content as Markdown](/help/view-the-markdown-source-of-a-message)
|
||||
* [Restrict message editing and deletion](/help/restrict-message-editing-and-deletion)
|
||||
* [Delete a message](/help/delete-a-message)
|
30
starlight_help/src/content/docs/edit-your-profile.mdx
Normal file
30
starlight_help/src/content/docs/edit-your-profile.mdx
Normal file
@@ -0,0 +1,30 @@
|
||||
---
|
||||
title: Edit your profile
|
||||
---
|
||||
|
||||
import NavigationSteps from "../../components/NavigationSteps.astro"
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
|
||||
By default, your profile includes your name, email, the date you joined, and
|
||||
when you were last active.
|
||||
|
||||
Organization administrators can also
|
||||
[add custom profile fields](/help/custom-profile-fields#add-a-custom-profile-field). Custom profile
|
||||
fields are always optional, and will not appear in your profile unless you
|
||||
fill them out.
|
||||
|
||||
### Edit your profile
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/profile" />
|
||||
|
||||
1. Edit the fields under **Profile**.
|
||||
</FlattenedSteps>
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Set up your account](/help/set-up-your-account)
|
||||
* [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)
|
||||
* [View someone's profile](/help/view-someones-profile)
|
150
starlight_help/src/content/docs/email-notifications.mdx
Normal file
150
starlight_help/src/content/docs/email-notifications.mdx
Normal file
@@ -0,0 +1,150 @@
|
||||
---
|
||||
title: Email notifications
|
||||
---
|
||||
|
||||
import NavigationSteps from "../../components/NavigationSteps.astro"
|
||||
import ZulipNote from '../../components/ZulipNote.astro';
|
||||
import { Tabs, TabItem } from '@astrojs/starlight/components'
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
|
||||
## Message notification emails
|
||||
|
||||
Zulip can be configured to send message notification emails for [DMs, mentions,
|
||||
and alerts](/help/dm-mention-alert-notifications), as well as [channel
|
||||
messages](/help/channel-notifications) and [followed
|
||||
topics](/help/follow-a-topic#configure-notifications-for-followed-topics).
|
||||
|
||||
You will receive email notifications only for messages sent when you were not
|
||||
[active](/help/status-and-availability#availability) on Zulip. Messages sent to
|
||||
the same conversation within a [configurable time
|
||||
period](#configure-delay-for-message-notification-emails) (e.g., a few minutes)
|
||||
will be combined into a single email.
|
||||
|
||||
You can reply to Zulip messages by replying to message notification emails.
|
||||
|
||||
<ZulipNote>
|
||||
To enable replies via email on a self-hosted server, the [incoming email
|
||||
gateway][incoming-email-gateway] must be configured by the system
|
||||
administrator.
|
||||
</ZulipNote>
|
||||
|
||||
### Configure triggers for message notification emails
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/notifications" />
|
||||
|
||||
1. Toggle the checkboxes in the **Email** column of the **Notification
|
||||
triggers** table.
|
||||
</FlattenedSteps>
|
||||
|
||||
[incoming-email-gateway]: https://zulip.readthedocs.io/en/stable/production/email-gateway.html
|
||||
|
||||
### Include organization name in subject line
|
||||
|
||||
You can configure whether the name of your Zulip organization is included in the
|
||||
subject of message notification emails.
|
||||
|
||||
Zulip offers a convenient **Automatic** configuration option, which includes the
|
||||
name of the organization in the subject only if you have accounts in multiple
|
||||
Zulip Cloud organizations, or in multiple organizations on the same Zulip server.
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/notifications" />
|
||||
|
||||
1. Under **Email message notifications**, configure
|
||||
**Include organization name in subject of message notification emails**.
|
||||
</FlattenedSteps>
|
||||
|
||||
### Configure delay for message notification emails
|
||||
|
||||
To reduce the number of emails you receive, Zulip
|
||||
delays sending message notification emails for a configurable period
|
||||
of time. The delay helps in a few ways:
|
||||
|
||||
* No email is sent if you return to Zulip and read the message before
|
||||
the email would go out.
|
||||
* Edits made by the sender soon after sending a message will be
|
||||
reflected in the email.
|
||||
* Multiple messages in the same Zulip [conversation](/help/reading-conversations)
|
||||
are combined into a single email. Different conversations will always be in
|
||||
separate emails, so that you can respond directly from your
|
||||
email.
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/notifications" />
|
||||
|
||||
1. Under **Email message notifications**, select the desired time period from the
|
||||
**Delay before sending message notification emails** dropdown.
|
||||
</FlattenedSteps>
|
||||
|
||||
### Hide message content
|
||||
|
||||
For security or compliance reasons, you may want to hide the content of your
|
||||
Zulip messages from your email. Organization administrators can do this at an
|
||||
[organization-wide level](/help/hide-message-content-in-emails), but you can
|
||||
also do this just for the messages you receive.
|
||||
|
||||
This setting also blocks message topics, channel names, and user names from
|
||||
being sent through your email.
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/notifications" />
|
||||
|
||||
1. Under **Email message notifications**, toggle
|
||||
**Include message content in message notification emails**.
|
||||
</FlattenedSteps>
|
||||
|
||||
## New login emails
|
||||
|
||||
By default, Zulip sends an email whenever you log in to Zulip. These emails
|
||||
help you protect your account; if you see a login email at a time or from a
|
||||
device you don't recognize, you should
|
||||
[change your password](/help/change-your-password) right away.
|
||||
|
||||
In typical usage, these emails are sent infrequently, since all Zulip apps
|
||||
(web, mobile, desktop, and terminal) keep you logged in to any organization
|
||||
you've interacted with in the last 1-2 weeks.
|
||||
|
||||
However, there are situations (usually due to corporate security policy) in
|
||||
which you may have to log in every day, and where getting login emails can
|
||||
feel excessive.
|
||||
|
||||
### Disable new login emails
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/notifications" />
|
||||
|
||||
1. Under **Other emails**, toggle
|
||||
**Send email notifications for new logins to my account**.
|
||||
</FlattenedSteps>
|
||||
|
||||
## Low-traffic newsletter
|
||||
|
||||
<ZulipNote>
|
||||
This feature is only available on Zulip Cloud.
|
||||
</ZulipNote>
|
||||
|
||||
Zulip sends out a low-traffic newsletter (expect 2-4 emails a year)
|
||||
to Zulip Cloud users announcing major changes in Zulip.
|
||||
|
||||
### Managing your newsletter subscription
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Zulip Cloud">
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/notifications" />
|
||||
|
||||
1. Under **Other emails**, toggle
|
||||
**Send me Zulip's low-traffic newsletter (a few emails a year)**.
|
||||
</FlattenedSteps>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Using Zulip via email](/help/using-zulip-via-email)
|
||||
* [Message a channel by email](/help/message-a-channel-by-email)
|
||||
* [DMs mentions, and alerts](/help/dm-mention-alert-notifications)
|
||||
* [Channel notifications](/help/channel-notifications)
|
||||
* [Follow a topic](/help/follow-a-topic)
|
||||
* [Hide message content in emails (for organizations)](/help/hide-message-content-in-emails)
|
167
starlight_help/src/content/docs/emoji-and-emoticons.mdx
Normal file
167
starlight_help/src/content/docs/emoji-and-emoticons.mdx
Normal file
@@ -0,0 +1,167 @@
|
||||
---
|
||||
title: Emoji and emoticons
|
||||
---
|
||||
|
||||
import NavigationSteps from "../../components/NavigationSteps.astro"
|
||||
import ZulipNote from '../../components/ZulipNote.astro';
|
||||
import ZulipTip from '../../components/ZulipTip.astro';
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
import SmileBiggerIcon from "~icons/zulip-icon/smile-bigger"
|
||||
import { Steps } from '@astrojs/starlight/components';
|
||||
import EmojiAndEmoticonsExamples from "./include/_EmojiAndEmoticonsExamples.mdx"
|
||||
import StartComposing from "./include/_StartComposing.mdx"
|
||||
import EmojiAndEmoticonsIntro from "./include/_EmojiAndEmoticonsIntro.mdx"
|
||||
import { Tabs, TabItem } from '@astrojs/starlight/components'
|
||||
|
||||
<EmojiAndEmoticonsIntro />
|
||||
|
||||
<ZulipTip>
|
||||
You can also quickly respond to a message by using [emoji reactions](/help/emoji-reactions).
|
||||
</ZulipTip>
|
||||
|
||||
## Use an emoji in your message
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Via compose box button">
|
||||
<FlattenedSteps>
|
||||
<StartComposing />
|
||||
|
||||
1. Click the **smiley face** (<SmileBiggerIcon />)
|
||||
icon at the bottom of the compose box.
|
||||
1. Select an emoji. You can type to search, use the arrow keys, or click on
|
||||
an emoji with your mouse.
|
||||
</FlattenedSteps>
|
||||
</TabItem>
|
||||
|
||||
<TabItem label="Via Markdown">
|
||||
<FlattenedSteps>
|
||||
<StartComposing />
|
||||
|
||||
1. Type `:`, followed by a few letters from the emoji name, to see autocomplete
|
||||
suggestions. The letters don't have to be at the beginning of the emoji name.
|
||||
For example, `:app` will match both `:apple:` and `:pineapple:`.
|
||||
1. Type the full emoji name followed by `:`, or select an emoji from the list of
|
||||
suggestions.
|
||||
</FlattenedSteps>
|
||||
</TabItem>
|
||||
|
||||
<TabItem label="Via paste">
|
||||
<FlattenedSteps>
|
||||
<StartComposing />
|
||||
|
||||
1. Paste an emoji copied from outside of Zulip directly into the compose box.
|
||||
</FlattenedSteps>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
<ZulipTip>
|
||||
You can hover over an emoji in the emoji picker, a message, or an [emoji
|
||||
reaction](/help/emoji-reactions) to learn its name.
|
||||
</ZulipTip>
|
||||
|
||||
### Use an emoticon
|
||||
|
||||
You can configure Zulip to convert emoticons into emoji, so that, e.g., `:)`
|
||||
will be displayed as 🙂 .
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/preferences" />
|
||||
|
||||
1. Under **Emoji settings**, select **Convert emoticons before sending**.
|
||||
</FlattenedSteps>
|
||||
|
||||
The list of supported emoticons is available
|
||||
[here](/help/configure-emoticon-translations).
|
||||
|
||||
## Examples
|
||||
|
||||
<EmojiAndEmoticonsExamples />
|
||||
|
||||
## Use an emoji in a topic name
|
||||
|
||||
You can use unicode characters in topic names, including unicode
|
||||
emoji. Each platform has a different way to enter unicode
|
||||
emoji. [Custom emoji](/help/custom-emoji) cannot be used in topic
|
||||
names.
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="macOS">
|
||||
<Steps>
|
||||
1. [Start a new topic](/help/introduction-to-topics#how-to-start-a-new-topic).
|
||||
1. Press <kbd>Command ⌘</kbd> + <kbd>Control</kbd> + <kbd>Space</kbd>
|
||||
to open the **Character Viewer**. See the
|
||||
[macOS documentation](https://support.apple.com/guide/mac-help/use-emoji-and-symbols-on-mac-mchlp1560/mac)
|
||||
to learn more.
|
||||
1. Select an emoji. You can type to search, use the arrow keys, or click on
|
||||
an emoji with your mouse.
|
||||
</Steps>
|
||||
</TabItem>
|
||||
|
||||
<TabItem label="Windows">
|
||||
<Steps>
|
||||
1. [Start a new topic](/help/introduction-to-topics#how-to-start-a-new-topic).
|
||||
1. Press <kbd>Windows</kbd> + <kbd>.</kbd>
|
||||
to open the **emoji keyboard**. See the
|
||||
[Windows documentation](https://support.microsoft.com/en-us/windows/windows-keyboard-tips-and-tricks-588e0b72-0fff-6d3f-aeee-6e5116097942)
|
||||
to learn more.
|
||||
1. Select an emoji. You can type to search, use the arrow keys, or click on
|
||||
an emoji with your mouse.
|
||||
</Steps>
|
||||
</TabItem>
|
||||
|
||||
<TabItem label="Linux">
|
||||
<Steps>
|
||||
1. [Start a new topic](/help/introduction-to-topics#how-to-start-a-new-topic).
|
||||
1. Open the [Characters app for GNOME](https://apps.gnome.org/en/Characters/).
|
||||
1. Select an emoji. You can type to search, use the arrow keys, or click on
|
||||
an emoji with your mouse.
|
||||
</Steps>
|
||||
</TabItem>
|
||||
|
||||
<TabItem label="Chrome">
|
||||
<Steps>
|
||||
1. [Start a new topic](/help/introduction-to-topics#how-to-start-a-new-topic).
|
||||
1. Right-click on the text input box.
|
||||
1. Select **Emoji** or **Emoji & Symbols**. You will only see this option if
|
||||
supported by your operating system.
|
||||
1. Select an emoji. You can type to search, use the arrow keys, or click on
|
||||
an emoji with your mouse.
|
||||
</Steps>
|
||||
</TabItem>
|
||||
|
||||
<TabItem label="Via paste">
|
||||
<Steps>
|
||||
1. [Start a new topic](/help/introduction-to-topics#how-to-start-a-new-topic).
|
||||
1. Paste an emoji copied from outside of Zulip directly into the text input box.
|
||||
</Steps>
|
||||
|
||||
<ZulipTip>
|
||||
[https://emojipedia.org/](https://emojipedia.org/) may be a helpful resource.
|
||||
</ZulipTip>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Change your emoji set
|
||||
|
||||
Your emoji set determines how you see emoji. It has no effect on the emoji
|
||||
you send. Zulip emoji are compatible with screen readers and other accessibility tools.
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/preferences" />
|
||||
|
||||
1. Under **Emoji**, select **Google**,
|
||||
**Twitter**, **Plain text**, or **Google blobs** for the emoji theme.
|
||||
</FlattenedSteps>
|
||||
|
||||
<ZulipNote>
|
||||
**Google blobs** is an old style of Google emoji that has not been maintained
|
||||
by Google since 2017, when they switched to a more modern style. Zulip allows
|
||||
you to still use blob emoji, but any new emoji that have been released since
|
||||
2017 will be displayed in the modern **Google** style.
|
||||
</ZulipNote>
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Add custom emoji](/help/custom-emoji)
|
||||
* [Emoji reactions](/help/emoji-reactions)
|
||||
* [Configure emoticon translations](/help/configure-emoticon-translations)
|
132
starlight_help/src/content/docs/emoji-reactions.mdx
Normal file
132
starlight_help/src/content/docs/emoji-reactions.mdx
Normal file
@@ -0,0 +1,132 @@
|
||||
---
|
||||
title: Emoji reactions
|
||||
---
|
||||
|
||||
import NavigationSteps from "../../components/NavigationSteps.astro"
|
||||
import MoreVerticalSpreadIcon from "~icons/zulip-icon/more-vertical-spread"
|
||||
import ZulipTip from '../../components/ZulipTip.astro';
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
import SmileIcon from "~icons/zulip-icon/smile"
|
||||
import MessageLongPressMenu from "./include/_MessageLongPressMenu.mdx"
|
||||
import KeyboardTip from '../../components/KeyboardTip.astro';
|
||||
import { Steps } from '@astrojs/starlight/components';
|
||||
import MessageActions from "./include/_MessageActions.mdx"
|
||||
import { Tabs, TabItem } from '@astrojs/starlight/components'
|
||||
import ChevronRightIcon from "~icons/zulip-icon/chevron-right"
|
||||
import ViewEmojiReactions from "./include/_ViewEmojiReactions.mdx"
|
||||
|
||||
Emoji reactions let you quickly respond to a message. For example, 👍 is
|
||||
commonly used to express agreement or confirm that you've [read the
|
||||
message](/help/read-receipts). Any emoji can be used as a reaction, including
|
||||
[custom emoji](/help/custom-emoji). Reactions appear at the bottom of the
|
||||
message.
|
||||
|
||||
## Add a new reaction
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Desktop/Web">
|
||||
<FlattenedSteps>
|
||||
<MessageActions />
|
||||
|
||||
1. Click the **Add emoji reaction** (<SmileIcon />) icon. On messages that you sent, click on the
|
||||
**ellipsis** (<MoreVerticalSpreadIcon />),
|
||||
then **Add emoji reaction**.
|
||||
1. Select an emoji. Type to search, use the arrow keys, or click on an emoji
|
||||
with your mouse.
|
||||
</FlattenedSteps>
|
||||
|
||||
<ZulipTip>
|
||||
To add multiple reactions without closing the emoji picker, hold the
|
||||
<kbd>Shift</kbd> key while selecting emoji.
|
||||
</ZulipTip>
|
||||
|
||||
<KeyboardTip>
|
||||
Use <kbd>:</kbd> to add any reaction, <kbd>=</kbd> to add the first
|
||||
emoji reaction added by others, or <kbd>+</kbd> to react with 👍.
|
||||
</KeyboardTip>
|
||||
</TabItem>
|
||||
|
||||
<TabItem label="Mobile">
|
||||
<FlattenedSteps>
|
||||
<MessageLongPressMenu />
|
||||
|
||||
1. Select one of the emojis at the top of the menu, or tap **more**
|
||||
(<ChevronRightIcon />).
|
||||
1. Start typing the name of the emoji you want to use, and select an emoji from
|
||||
the list of suggestions.
|
||||
</FlattenedSteps>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Add or remove an existing reaction
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Desktop/Web">
|
||||
<Steps>
|
||||
1. Click on an existing emoji reaction to add or remove your reaction.
|
||||
</Steps>
|
||||
|
||||
<ZulipTip>
|
||||
To make it easy to see which reactions you have added, they are
|
||||
highlighted in a different color.
|
||||
</ZulipTip>
|
||||
|
||||
<KeyboardTip>
|
||||
You can also toggle the first emoji reaction on the selected message by
|
||||
using the <kbd>=</kbd> shortcut.
|
||||
</KeyboardTip>
|
||||
</TabItem>
|
||||
|
||||
<TabItem label="Mobile">
|
||||
<Steps>
|
||||
1. Tap on an existing emoji reaction to add or remove your reaction.
|
||||
</Steps>
|
||||
|
||||
<ZulipTip>
|
||||
To make it easy to see which reactions you have added, they are
|
||||
highlighted in a different color.
|
||||
</ZulipTip>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Viewing who reacted to a message
|
||||
|
||||
For messages where few users have reacted, the names of users who have reacted
|
||||
are displayed directly on the message if the [option to do
|
||||
so](#toggle-whether-names-of-reacting-users-are-displayed) is enabled.
|
||||
|
||||
### View who reacted to a message
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Desktop/Web">
|
||||
<Steps>
|
||||
1. Hover over an emoji reaction to see who reacted with that emoji.
|
||||
</Steps>
|
||||
</TabItem>
|
||||
|
||||
<TabItem label="Mobile">
|
||||
<FlattenedSteps>
|
||||
<MessageLongPressMenu />
|
||||
|
||||
1. Tap **See who reacted**.
|
||||
</FlattenedSteps>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
### Toggle whether names of reacting users are displayed
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/preferences" />
|
||||
|
||||
1. Under **Emoji**, toggle **Display names of reacting users when few users have
|
||||
reacted to a message**.
|
||||
</FlattenedSteps>
|
||||
|
||||
## View your messages with reactions
|
||||
|
||||
<ViewEmojiReactions />
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Add custom emoji](/help/custom-emoji)
|
||||
* [Emoji in messages](/help/emoji-and-emoticons)
|
@@ -0,0 +1,21 @@
|
||||
---
|
||||
title: Enable full width display
|
||||
---
|
||||
|
||||
import NavigationSteps from "../../components/NavigationSteps.astro"
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
|
||||
By default, Zulip limits the width of the center message pane, because it's
|
||||
easier and faster to read paragraphs that don't have long lines. This is
|
||||
also why many news sites, blogs, and social media platforms limit their
|
||||
paragraph width.
|
||||
|
||||
You can instead configure Zulip to use the full width of wide screens.
|
||||
|
||||
### Enable full width display
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/preferences" />
|
||||
|
||||
1. Under **Information**, select **Use full width on wide screens**.
|
||||
</FlattenedSteps>
|
144
starlight_help/src/content/docs/export-your-organization.mdx
Normal file
144
starlight_help/src/content/docs/export-your-organization.mdx
Normal file
@@ -0,0 +1,144 @@
|
||||
---
|
||||
title: Export your organization
|
||||
---
|
||||
|
||||
import NavigationSteps from "../../components/NavigationSteps.astro"
|
||||
import ZulipNote from '../../components/ZulipNote.astro';
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
import ExportWithoutConsentRequirements from "./include/_ExportWithoutConsentRequirements.mdx"
|
||||
import { Steps } from '@astrojs/starlight/components';
|
||||
import NotHumanExportFormat from "./include/_NotHumanExportFormat.mdx"
|
||||
import OwnerOnly from "./include/_OwnerOnly.mdx"
|
||||
import AdminOnly from "./include/_AdminOnly.mdx"
|
||||
|
||||
<ZulipNote>
|
||||
If you're self-hosting Zulip, you may want to check out the
|
||||
documentation on [server export and import][export-and-import] or
|
||||
[server backups][production-backups].
|
||||
</ZulipNote>
|
||||
|
||||
Zulip has high quality export tools that can be used to migrate between the
|
||||
hosted Zulip Cloud service and your own servers. Two types of data exports are
|
||||
available for all Zulip organizations:
|
||||
|
||||
* [**Export of public
|
||||
data**](#export-for-migrating-to-zulip-cloud-or-a-self-hosted-server):
|
||||
Complete data for your organization *other than* [private
|
||||
channel](/help/channel-permissions#private-channels) messages and [direct
|
||||
messages](/help/direct-messages). This export includes user settings and
|
||||
channel subscriptions.
|
||||
* [**Standard
|
||||
export**](#export-for-migrating-to-zulip-cloud-or-a-self-hosted-server):
|
||||
Everything in the export of public data, plus all the [private
|
||||
channel](/help/channel-permissions#private-channels) messages and [direct
|
||||
messages](/help/direct-messages) that members who have
|
||||
[allowed](#configure-whether-administrators-can-export-your-private-data)
|
||||
administrators to export their private data can access.
|
||||
|
||||
Two additional types of data exports are available to **corporate** [Zulip Cloud
|
||||
Standard][plans] and [Zulip Cloud Plus][plans] customers:
|
||||
|
||||
[plans]: https://zulip.com/plans/
|
||||
|
||||
* [**Full export without member consent**](#full-export-without-member-consent):
|
||||
All the data in the organization.
|
||||
* [**Compliance export**](#compliance-export): A targeted, human-readable export
|
||||
of messages matching some combination of criteria (e.g., sender, recipient,
|
||||
message keyword, or timestamp).
|
||||
|
||||
## Export for migrating to Zulip Cloud or a self-hosted server
|
||||
|
||||
<AdminOnly />
|
||||
|
||||
<NotHumanExportFormat />
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/data-exports-admin" />
|
||||
|
||||
1. Click **Start export**.
|
||||
1. Select the desired **Export type**.
|
||||
1. Click **Start export** to begin the export process. After a few minutes,
|
||||
you'll be able to download the exported data from the list of
|
||||
data exports.
|
||||
1. Use [Zulip's logical data import tool][import-only] to import your data into
|
||||
a self-hosted server. For Zulip Cloud imports, contact
|
||||
[support@zulip.com](mailto:support@zulip.com).
|
||||
</FlattenedSteps>
|
||||
|
||||
<ZulipNote>
|
||||
Generating the export can take up to an hour for organizations
|
||||
with a large number of messages or uploaded files.
|
||||
</ZulipNote>
|
||||
|
||||
## Full export without member consent
|
||||
|
||||
<OwnerOnly />
|
||||
|
||||
<NotHumanExportFormat />
|
||||
|
||||
<ExportWithoutConsentRequirements />
|
||||
|
||||
<Steps>
|
||||
1. Email [support@zulip.com](mailto:support@zulip.com) with your
|
||||
organization's `zulipchat.com` URL, asking for a **full export without
|
||||
member consent**. Please send the email from the same address
|
||||
that you use to sign in to Zulip, so that Zulip Support can verify
|
||||
that you are an owner of the organization.
|
||||
1. Once your authority to request the export has been verified, you will receive
|
||||
an archive in the `.tar.gz` format containing all the information for your
|
||||
organization.
|
||||
1. Import the tarball using [Zulip's logical data import tool][import-only].
|
||||
</Steps>
|
||||
|
||||
## Compliance export
|
||||
|
||||
<OwnerOnly />
|
||||
|
||||
This type of export is recommended if you plan to work with the exported data
|
||||
directly (e.g., reading messages or processing them with a script), rather than
|
||||
importing the export into a new Zulip organization.
|
||||
|
||||
<ExportWithoutConsentRequirements />
|
||||
|
||||
<Steps>
|
||||
1. Email [support@zulip.com](mailto:support@zulip.com) asking for a **compliance
|
||||
export**. Please send the email from the same address that you use to sign in
|
||||
to Zulip, so that Zulip Support can verify that you are an owner of the
|
||||
organization. You will need to specify:
|
||||
1. The `zulipchat.com` URL for your organization
|
||||
1. What limits you would like on the export. Currently, compliance
|
||||
exports can apply any combination of the following filters:
|
||||
* Message sender
|
||||
* Message recipient
|
||||
* Message contents, by specific keywords
|
||||
* Sent timestamp before, after, or between dates
|
||||
If you need other limits, please ask.
|
||||
1. Your preferred format for the export: CSV or JSON.
|
||||
1. Whether or not you want to receive copies of all attachments referenced in
|
||||
the exported messages.
|
||||
1. You will receive the requested information once your authority to request the
|
||||
export has been verified.
|
||||
</Steps>
|
||||
|
||||
## Configure whether administrators can export your private data
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/account-and-privacy" />
|
||||
|
||||
1. Under **Privacy**, toggle **Let administrators export my private data**.
|
||||
</FlattenedSteps>
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Change organization URL](/help/change-organization-url)
|
||||
* [Deactivate your organization](/help/deactivate-your-organization)
|
||||
* [Import organization into a self-hosted Zulip server][import-only]
|
||||
* [Compliance exports for self-hosted organizations][compliance-exports-self-hosted]
|
||||
|
||||
[production-backups]: https://zulip.readthedocs.io/en/stable/production/export-and-import.html#backups
|
||||
|
||||
[export-and-import]: https://zulip.readthedocs.io/en/stable/production/export-and-import.html#data-export
|
||||
|
||||
[import-only]: https://zulip.readthedocs.io/en/stable/production/export-and-import.html#import-into-a-new-zulip-server
|
||||
|
||||
[compliance-exports-self-hosted]: https://zulip.readthedocs.io/en/stable/production/export-and-import.html#compliance-exports
|
20
starlight_help/src/content/docs/find-administrators.mdx
Normal file
20
starlight_help/src/content/docs/find-administrators.mdx
Normal file
@@ -0,0 +1,20 @@
|
||||
---
|
||||
title: Find administrators
|
||||
---
|
||||
|
||||
import ViewUsersByRole from "./include/_ViewUsersByRole.mdx"
|
||||
import ZulipTip from '../../components/ZulipTip.astro';
|
||||
|
||||
[Administrators](/help/user-roles) can take actions other users are
|
||||
not permitted to, such as managing your organization's permissions settings.
|
||||
|
||||
<ZulipTip>
|
||||
Organization owners can do anything that an organization administrator can do.
|
||||
</ZulipTip>
|
||||
|
||||
<ViewUsersByRole />
|
||||
|
||||
## Related articles
|
||||
|
||||
* [User roles](/help/user-roles)
|
||||
* [Customize organization settings](/help/customize-organization-settings)
|
@@ -0,0 +1,34 @@
|
||||
---
|
||||
title: Finding a conversation to read
|
||||
---
|
||||
|
||||
import RecentConversations from "./include/_RecentConversations.mdx"
|
||||
import ConversationRecommendation from "./include/_ConversationRecommendation.mdx"
|
||||
import LeftSidebarConversations from "./include/_LeftSidebarConversations.mdx"
|
||||
import InboxInstructions from "./include/_InboxInstructions.mdx"
|
||||
import ConversationDefinition from "./include/_ConversationDefinition.mdx"
|
||||
import InboxIntro from "./include/_InboxIntro.mdx"
|
||||
|
||||
<ConversationDefinition />
|
||||
|
||||
<ConversationRecommendation />
|
||||
|
||||
## From the Inbox view
|
||||
|
||||
<InboxIntro />
|
||||
|
||||
<InboxInstructions />
|
||||
|
||||
## From Recent conversations
|
||||
|
||||
<RecentConversations />
|
||||
|
||||
## From the left sidebar
|
||||
|
||||
<LeftSidebarConversations />
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Getting started with Zulip](/help/getting-started-with-zulip)
|
||||
* [Reading strategies](/help/reading-strategies)
|
||||
* [Reading conversations](/help/reading-conversations)
|
142
starlight_help/src/content/docs/follow-a-topic.mdx
Normal file
142
starlight_help/src/content/docs/follow-a-topic.mdx
Normal file
@@ -0,0 +1,142 @@
|
||||
---
|
||||
title: Follow a topic
|
||||
---
|
||||
|
||||
import TopicLongPressMenu from "./include/_TopicLongPressMenu.mdx"
|
||||
import ManageConfiguredTopicsDesktopWeb from "./include/_ManageConfiguredTopicsDesktopWeb.mdx"
|
||||
import ConfigureTopicNotificationsDesktopWeb from "./include/_ConfigureTopicNotificationsDesktopWeb.mdx"
|
||||
import ZulipTip from '../../components/ZulipTip.astro';
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
import ConfigureNotificationsForFollowedTopics from "./include/_ConfigureNotificationsForFollowedTopics.mdx"
|
||||
import KeyboardTip from '../../components/KeyboardTip.astro';
|
||||
import FollowedTopicWorkflows from "./include/_FollowedTopicWorkflows.mdx"
|
||||
import { Steps } from '@astrojs/starlight/components';
|
||||
import SearchIcon from "~icons/zulip-icon/search"
|
||||
import GoToInbox from "./include/_GoToInbox.mdx"
|
||||
import { Tabs, TabItem } from '@astrojs/starlight/components'
|
||||
import ManageConfiguredTopicsMobile from "./include/_ManageConfiguredTopicsMobile.mdx"
|
||||
import AutomaticallyFollowTopics from "./include/_AutomaticallyFollowTopics.mdx"
|
||||
|
||||
Zulip lets you follow topics you are interested in. You can follow or unfollow
|
||||
any topic. You can also configure Zulip to automatically follow topics you start
|
||||
or participate in. Participating in a topic means sending a message,
|
||||
[reacting](/help/emoji-reactions) with an emoji, or participating in a
|
||||
[poll](/help/create-a-poll). You can also automatically follow topics where you
|
||||
are [mentioned](/help/mention-a-user-or-group).
|
||||
|
||||
It's easy to prioritize catching up on followed topics. You can:
|
||||
|
||||
* [Configure](/help/follow-a-topic#configure-notifications-for-followed-topics)
|
||||
how you get notified about new messages for topics you follow.
|
||||
* Use the <kbd>Shift</kbd> + <kbd>N</kbd> [keyboard
|
||||
shortcut](/help/keyboard-shortcuts) to go to the next unread followed topic.
|
||||
* Filter the [**Inbox**](/help/inbox) and [**Recent
|
||||
conversations**](/help/recent-conversations) views to only show followed
|
||||
topics.
|
||||
* See which topics you are following in the **left sidebar**.
|
||||
|
||||
You can use followed topics for a variety of workflows:
|
||||
|
||||
<FollowedTopicWorkflows />
|
||||
|
||||
## Follow or unfollow a topic
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Desktop/Web">
|
||||
<FlattenedSteps>
|
||||
<ConfigureTopicNotificationsDesktopWeb />
|
||||
</FlattenedSteps>
|
||||
</TabItem>
|
||||
|
||||
<TabItem label="Mobile">
|
||||
<FlattenedSteps>
|
||||
<TopicLongPressMenu />
|
||||
|
||||
1. Tap **Follow topic** or **Unfollow topic**.
|
||||
</FlattenedSteps>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Catch up on followed topics
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Desktop/Web">
|
||||
<FlattenedSteps>
|
||||
<GoToInbox />
|
||||
|
||||
1. Filter the view to the topics you follow by selecting **Followed topics**
|
||||
from the dropdown in the upper left of the **inbox** view.
|
||||
1. Click on a conversation you're interested in to view it. You can also use
|
||||
the arrow keys to select a conversation, and press <kbd>Enter</kbd>.
|
||||
1. Return to **Inbox** when done to select the next conversation. You can use
|
||||
the **back** button in your browser or the desktop app, <kbd>Shift</kbd> +
|
||||
<kbd>I</kbd>, or <kbd>Esc</kbd> if **Inbox** is configured as you [home
|
||||
view](/help/configure-home-view).
|
||||
</FlattenedSteps>
|
||||
|
||||
<KeyboardTip>
|
||||
You can also use <kbd>Shift</kbd> + <kbd>N</kbd> from any location to go
|
||||
to the next unread followed topic.
|
||||
</KeyboardTip>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Search for messages in followed topics
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Desktop/Web">
|
||||
<Steps>
|
||||
1. Click the **search** (<SearchIcon />) icon in the top bar to open the search box.
|
||||
1. Type `is:followed`, or start typing and select **Followed topics** from the
|
||||
typeahead.
|
||||
1. *(optional)* Enter additional search terms or
|
||||
[filters](/help/search-for-messages).
|
||||
1. Press <kbd>Enter</kbd>.
|
||||
</Steps>
|
||||
|
||||
<KeyboardTip>
|
||||
You can also use the <kbd>/</kbd> or <kbd>Ctrl</kbd> + <kbd>K</kbd>
|
||||
keyboard shortcut to start searching messages.
|
||||
</KeyboardTip>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
<ZulipTip>
|
||||
To get a feed of unread messages in all the topics you follow, search for
|
||||
`is:followed is:unread`.
|
||||
</ZulipTip>
|
||||
|
||||
## Configure notifications for followed topics
|
||||
|
||||
You can configure custom notifications for followed topics. You can also
|
||||
[configure the unread count
|
||||
badge](/help/desktop-notifications#unread-count-badge) to include unread
|
||||
messages just in followed topics, without counting other channel messages.
|
||||
|
||||
<ConfigureNotificationsForFollowedTopics />
|
||||
|
||||
## Automatically follow topics
|
||||
|
||||
<AutomaticallyFollowTopics />
|
||||
|
||||
## Manage configured topics
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Desktop/Web">
|
||||
<ManageConfiguredTopicsDesktopWeb />
|
||||
</TabItem>
|
||||
|
||||
<TabItem label="Mobile">
|
||||
<FlattenedSteps>
|
||||
<ManageConfiguredTopicsMobile />
|
||||
</FlattenedSteps>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Reading strategies](/help/reading-strategies)
|
||||
* [Topic notifications](/help/topic-notifications)
|
||||
* [Channel notifications](/help/channel-notifications)
|
||||
* [Mute or unmute a topic](/help/mute-a-topic)
|
||||
* [Mute or unmute a channel](/help/mute-a-channel)
|
55
starlight_help/src/content/docs/font-size.mdx
Normal file
55
starlight_help/src/content/docs/font-size.mdx
Normal file
@@ -0,0 +1,55 @@
|
||||
---
|
||||
title: Font size
|
||||
---
|
||||
|
||||
import ZulipTip from '../../components/ZulipTip.astro';
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
import { Steps } from '@astrojs/starlight/components';
|
||||
import TypeBigIcon from "~icons/zulip-icon/type-big"
|
||||
import PlusIcon from "~icons/zulip-icon/plus"
|
||||
import PersonalMenu from "./include/_PersonalMenu.mdx"
|
||||
import { Tabs, TabItem } from '@astrojs/starlight/components'
|
||||
import MinusIcon from "~icons/zulip-icon/minus"
|
||||
|
||||
Zulip offers a range of font size options, from 12 to 20, to make the UI
|
||||
feel comfortable on any screen.
|
||||
|
||||
## Change font size
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Desktop/Web">
|
||||
<FlattenedSteps>
|
||||
<PersonalMenu />
|
||||
|
||||
1. Click <PlusIcon /> to increase the font size, <MinusIcon /> to decrease it, and <TypeBigIcon /> to reset to the default.
|
||||
</FlattenedSteps>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Zoom in or out
|
||||
|
||||
You can further adjust the font size by zooming in or out in your browser, or in
|
||||
the Zulip desktop app.
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Desktop/Web">
|
||||
<Steps>
|
||||
1. Use <kbd>Ctrl</kbd> + <kbd>+</kbd> to zoom in, <kbd>Ctrl</kbd> + <kbd>-</kbd>
|
||||
to zoom out, or <kbd>Ctrl</kbd> + <kbd>0</kbd> to reset to default zoom.
|
||||
</Steps>
|
||||
|
||||
<ZulipTip>
|
||||
In the Zulip desktop app and most browsers, you can also open the **View**
|
||||
menu in the top menu bar, and click **Zoom In**, **Zoom Out**, or **Actual
|
||||
Size**.
|
||||
</ZulipTip>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Getting started with Zulip](/help/getting-started-with-zulip)
|
||||
* [Review your settings](/help/review-your-settings)
|
||||
* [Configure default new user settings](/help/configure-default-new-user-settings)
|
||||
* [Line spacing](/help/line-spacing)
|
||||
* [Dark theme](/help/dark-theme)
|
57
starlight_help/src/content/docs/format-a-quote.mdx
Normal file
57
starlight_help/src/content/docs/format-a-quote.mdx
Normal file
@@ -0,0 +1,57 @@
|
||||
---
|
||||
title: Format a quote
|
||||
---
|
||||
|
||||
import ZulipTip from '../../components/ZulipTip.astro';
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
import QuoteIcon from "~icons/zulip-icon/quote"
|
||||
import QuotesIntro from "./include/_QuotesIntro.mdx"
|
||||
import StartComposing from "./include/_StartComposing.mdx"
|
||||
import { Tabs, TabItem } from '@astrojs/starlight/components'
|
||||
import QuotesExamples from "./include/_QuotesExamples.mdx"
|
||||
|
||||
<QuotesIntro />
|
||||
|
||||
## Insert quote formatting
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Via compose box button">
|
||||
<FlattenedSteps>
|
||||
<StartComposing />
|
||||
|
||||
1. *(optional)* Select the text you want to format.
|
||||
1. Click the **Quote** (<QuoteIcon />) icon at the
|
||||
bottom of the compose box to insert quote block formatting.
|
||||
</FlattenedSteps>
|
||||
|
||||
<ZulipTip>
|
||||
You can also use the **Quote** (<QuoteIcon />)
|
||||
icon to remove existing quote formatting from the selected text.
|
||||
</ZulipTip>
|
||||
</TabItem>
|
||||
|
||||
<TabItem label="Via Markdown">
|
||||
<FlattenedSteps>
|
||||
<StartComposing />
|
||||
|
||||
1. To create a multi-line quote, type `>` followed by a space and some text:
|
||||
> a multi-line
|
||||
> quote on two lines
|
||||
> To create a multi-paragraph quote, use triple backticks and the word quote
|
||||
> (\`\`\`\`quote\`) followed by some text and triple backticks at the end:
|
||||
```quote
|
||||
A multi-paragraph
|
||||
quote in two paragraphs
|
||||
```
|
||||
</FlattenedSteps>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Examples
|
||||
|
||||
<QuotesExamples />
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Message formatting](/help/format-your-message-using-markdown)
|
||||
* [Quote message](/help/quote-or-forward-a-message)
|
@@ -0,0 +1,276 @@
|
||||
---
|
||||
title: Message formatting
|
||||
---
|
||||
|
||||
import BulletedListsExamples from "./include/_BulletedListsExamples.mdx"
|
||||
import TimeIcon from "~icons/zulip-icon/time"
|
||||
import ZulipTip from '../../components/ZulipTip.astro';
|
||||
import MathIcon from "~icons/zulip-icon/math"
|
||||
import PollsIntro from "./include/_PollsIntro.mdx"
|
||||
import UnorderedListIcon from "~icons/zulip-icon/unordered-list"
|
||||
import LinksIntro from "./include/_LinksIntro.mdx"
|
||||
import GlobalTimesIntro from "./include/_GlobalTimesIntro.mdx"
|
||||
import SpoilerIcon from "~icons/zulip-icon/spoiler"
|
||||
import ParagraphsAndSectionsIntro from "./include/_ParagraphsAndSectionsIntro.mdx"
|
||||
import TodoListIcon from "~icons/zulip-icon/todo-list"
|
||||
import NavigationSteps from "../../components/NavigationSteps.astro"
|
||||
import ToDoListsIntro from "./include/_ToDoListsIntro.mdx"
|
||||
import NumberedListsIntro from "./include/_NumberedListsIntro.mdx"
|
||||
import MeActionMessagesExamples from "./include/_MeActionMessagesExamples.mdx"
|
||||
import PollIcon from "~icons/zulip-icon/poll"
|
||||
import QuoteIcon from "~icons/zulip-icon/quote"
|
||||
import MeActionMessagesIntro from "./include/_MeActionMessagesIntro.mdx"
|
||||
import OrderedListIcon from "~icons/zulip-icon/ordered-list"
|
||||
import LinkIcon from "~icons/zulip-icon/link"
|
||||
import MentionsIntro from "./include/_MentionsIntro.mdx"
|
||||
import EmojiAndEmoticonsIntro from "./include/_EmojiAndEmoticonsIntro.mdx"
|
||||
import { Tabs, TabItem } from '@astrojs/starlight/components'
|
||||
import TablesExamples from "./include/_TablesExamples.mdx"
|
||||
import ToDoListsExamples from "./include/_ToDoListsExamples.mdx"
|
||||
import TablesIntro from "./include/_TablesIntro.mdx"
|
||||
import NumberedListsExamples from "./include/_NumberedListsExamples.mdx"
|
||||
import QuestionIcon from "~icons/zulip-icon/question"
|
||||
import CodeBlocksIntro from "./include/_CodeBlocksIntro.mdx"
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
import PollsExamples from "./include/_PollsExamples.mdx"
|
||||
import EmphasisExamples from "./include/_EmphasisExamples.mdx"
|
||||
import ParagraphsAndSectionsExamples from "./include/_ParagraphsAndSectionsExamples.mdx"
|
||||
import MentionsExamples from "./include/_MentionsExamples.mdx"
|
||||
import QuotesExamples from "./include/_QuotesExamples.mdx"
|
||||
import BulletedListsIntro from "./include/_BulletedListsIntro.mdx"
|
||||
import SpoilersExamples from "./include/_SpoilersExamples.mdx"
|
||||
import GlobalTimesExamples from "./include/_GlobalTimesExamples.mdx"
|
||||
import SpoilersIntro from "./include/_SpoilersIntro.mdx"
|
||||
import LinksExamples from "./include/_LinksExamples.mdx"
|
||||
import QuotesIntro from "./include/_QuotesIntro.mdx"
|
||||
import EmojiAndEmoticonsExamples from "./include/_EmojiAndEmoticonsExamples.mdx"
|
||||
import LatexExamples from "./include/_LatexExamples.mdx"
|
||||
import CodeBlocksExamples from "./include/_CodeBlocksExamples.mdx"
|
||||
import EmphasisIntro from "./include/_EmphasisIntro.mdx"
|
||||
import LatexIntro from "./include/_LatexIntro.mdx"
|
||||
import CodeIcon from "~icons/zulip-icon/code"
|
||||
|
||||
{/*
|
||||
- All screenshots here require line-height: 22px and font-size: 16px in .message-content.
|
||||
- Requires some additional fiddling for the LaTeX picture, inline code span, and maybe a few others.
|
||||
*/}
|
||||
|
||||
Zulip uses Markdown to allow you to easily format your messages. Even if you've
|
||||
never heard of Markdown, you are probably familiar with basic Markdown
|
||||
formatting, such as using `*` at the start of a line in a bulleted list, or
|
||||
around text to indicate emphasis.
|
||||
|
||||
Formatting buttons in the compose box make it easy to format your message. For
|
||||
those who prefer to type the formatting they need, this page provides an
|
||||
overview of all the formatting available in Zulip. There is a convenient
|
||||
[message formatting reference](#message-formatting-reference) in the Zulip
|
||||
app that you can use whenever you need a reminder of the formatting syntax
|
||||
below.
|
||||
|
||||
* [Text emphasis](#text-emphasis)
|
||||
* [Bulleted lists](#bulleted-lists)
|
||||
* [Numbered lists](#numbered-lists)
|
||||
* [Links](#links)
|
||||
* [Code blocks](#code-blocks)
|
||||
* [LaTeX](#latex)
|
||||
* [Quotes](#quotes)
|
||||
* [Spoilers](#spoilers)
|
||||
* [Emoji and emoticons](#emoji-and-emoticons)
|
||||
* [Mention a user or group](#mention-a-user-or-group)
|
||||
* [/me action messages](#me-action-messages)
|
||||
* [Global times](#global-times)
|
||||
* [Tables](#tables)
|
||||
* [Polls](#polls)
|
||||
* [Collaborative to-do lists](#collaborative-to-do-lists)
|
||||
* [Paragraph and section formatting](#paragraph-and-section-formatting)
|
||||
|
||||
## Text emphasis
|
||||
|
||||
<EmphasisIntro />
|
||||
|
||||
<EmphasisExamples />
|
||||
|
||||
<ZulipTip>
|
||||
You can also use buttons or keyboard shortcuts (<kbd>Ctrl</kbd> +
|
||||
<kbd>B</kbd> or <kbd>Ctrl</kbd> + <kbd>I</kbd>) to make text bold or italic.
|
||||
[Learn more](/help/text-emphasis).
|
||||
</ZulipTip>
|
||||
|
||||
## Bulleted lists
|
||||
|
||||
<BulletedListsIntro />
|
||||
|
||||
<BulletedListsExamples />
|
||||
|
||||
<ZulipTip>
|
||||
You can also use the **Bulleted list**
|
||||
(<UnorderedListIcon />)
|
||||
button in the compose box to insert bulleted list formatting.
|
||||
[Learn more](/help/bulleted-lists).
|
||||
</ZulipTip>
|
||||
|
||||
## Numbered lists
|
||||
|
||||
<NumberedListsIntro />
|
||||
|
||||
<NumberedListsExamples />
|
||||
|
||||
<ZulipTip>
|
||||
You can also use the **Numbered list**
|
||||
(<OrderedListIcon />)
|
||||
button in the compose box to insert numbered list formatting.
|
||||
[Learn more](/help/numbered-lists).
|
||||
</ZulipTip>
|
||||
|
||||
## Links
|
||||
|
||||
<LinksIntro />
|
||||
|
||||
<LinksExamples />
|
||||
|
||||
<ZulipTip>
|
||||
You can also use the **Link**
|
||||
(<LinkIcon />)
|
||||
button or a keyboard shortcut (<kbd>Ctrl</kbd> + <kbd>Shift</kbd> +
|
||||
<kbd>L</kbd>) to insert a link. [Learn more](/help/insert-a-link).
|
||||
</ZulipTip>
|
||||
|
||||
## Code blocks
|
||||
|
||||
<CodeBlocksIntro />
|
||||
|
||||
<CodeBlocksExamples />
|
||||
|
||||
<ZulipTip>
|
||||
You can also use the **Code** (<CodeIcon />)
|
||||
button in the compose box to insert code formatting.
|
||||
[Learn more](/help/code-blocks).
|
||||
</ZulipTip>
|
||||
|
||||
## LaTeX
|
||||
|
||||
<LatexIntro />
|
||||
|
||||
<LatexExamples />
|
||||
|
||||
<ZulipTip>
|
||||
You can also use the **LaTeX** (<MathIcon />)
|
||||
button in the compose box to insert LaTeX formatting.
|
||||
[Learn more](/help/latex).
|
||||
</ZulipTip>
|
||||
|
||||
## Quotes
|
||||
|
||||
<QuotesIntro />
|
||||
|
||||
<QuotesExamples />
|
||||
|
||||
<ZulipTip>
|
||||
There is a handy option to [quote message](/help/quote-or-forward-a-message) to a
|
||||
message in Zulip.
|
||||
You can also use the **Quote** (<QuoteIcon />)
|
||||
button in the compose box to insert quote formatting.
|
||||
[Learn more](/help/format-a-quote).
|
||||
</ZulipTip>
|
||||
|
||||
## Spoilers
|
||||
|
||||
<SpoilersIntro />
|
||||
|
||||
<SpoilersExamples />
|
||||
|
||||
<ZulipTip>
|
||||
You can also use the **Spoiler**
|
||||
(<SpoilerIcon />) button in the compose
|
||||
box to insert spoiler formatting. [Learn more](/help/spoilers).
|
||||
</ZulipTip>
|
||||
|
||||
## Emoji and emoticons
|
||||
|
||||
<EmojiAndEmoticonsIntro />
|
||||
|
||||
<EmojiAndEmoticonsExamples />
|
||||
|
||||
## Mention a user or group
|
||||
|
||||
<MentionsIntro />
|
||||
|
||||
<MentionsExamples />
|
||||
|
||||
## /me action messages
|
||||
|
||||
<MeActionMessagesIntro />
|
||||
|
||||
<MeActionMessagesExamples />
|
||||
|
||||
## Global times
|
||||
|
||||
<GlobalTimesIntro />
|
||||
|
||||
<GlobalTimesExamples />
|
||||
|
||||
<ZulipTip>
|
||||
You can also use the **Add global time**
|
||||
(<TimeIcon />) button in the compose
|
||||
box to select a time from the date picker. [Learn more](/help/global-times).
|
||||
</ZulipTip>
|
||||
|
||||
## Tables
|
||||
|
||||
<TablesIntro />
|
||||
|
||||
<TablesExamples />
|
||||
|
||||
## Polls
|
||||
|
||||
<PollsIntro />
|
||||
|
||||
<PollsExamples />
|
||||
|
||||
<ZulipTip>
|
||||
You can also use the **Add poll** (<PollIcon />) button in the compose box to create a
|
||||
poll. [Learn more](/help/create-a-poll).
|
||||
</ZulipTip>
|
||||
|
||||
## Collaborative to-do lists
|
||||
|
||||
<ToDoListsIntro />
|
||||
|
||||
<ToDoListsExamples />
|
||||
|
||||
<ZulipTip>
|
||||
You can also use the **Add to-do list** (<TodoListIcon />) button in the compose box to create a
|
||||
shared to-do list. [Learn more](/help/collaborative-to-do-lists).
|
||||
</ZulipTip>
|
||||
|
||||
## Paragraph and section formatting
|
||||
|
||||
<ParagraphsAndSectionsIntro />
|
||||
|
||||
<ParagraphsAndSectionsExamples />
|
||||
|
||||
## Message formatting reference
|
||||
|
||||
A summary of the formatting syntax above is available in the Zulip app.
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Desktop/Web">
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="relative/help/message-formatting" />
|
||||
</FlattenedSteps>
|
||||
|
||||
<ZulipTip>
|
||||
You can also [open the compose box](/help/open-the-compose-box), and click
|
||||
the **question mark** (<QuestionIcon />) icon
|
||||
at the bottom of the compose box.
|
||||
</ZulipTip>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Create a poll](/help/create-a-poll)
|
||||
* [Mention a user or group](/help/mention-a-user-or-group)
|
||||
* [Preview messages before sending](/help/preview-your-message-before-sending)
|
||||
* [Resize the compose box](/help/resize-the-compose-box)
|
||||
* [Messaging tips & tricks](/help/messaging-tips)
|
126
starlight_help/src/content/docs/gdpr-compliance.mdx
Normal file
126
starlight_help/src/content/docs/gdpr-compliance.mdx
Normal file
@@ -0,0 +1,126 @@
|
||||
---
|
||||
title: GDPR compliance
|
||||
---
|
||||
|
||||
This page covers how Zulip interacts with the EU's landmark GDPR
|
||||
legislation; you can read the
|
||||
[Zulip Cloud privacy policy](https://zulip.com/policies/privacy) for our
|
||||
general privacy policies.
|
||||
|
||||
## What is GDPR?
|
||||
|
||||
The General Data Protection Regulation (GDPR) is a wide-ranging law designed
|
||||
to protect the privacy of individuals in the European Union (EU) and
|
||||
give them control over how their personal data is collected,
|
||||
processed, and used. The law applies to any company that collects or
|
||||
processes the data of European consumers.
|
||||
|
||||
## How Zulip supports GDPR compliance
|
||||
|
||||
GDPR compliance is supported [for Zulip
|
||||
Cloud](#gdpr-compliance-with-zulip-cloud) and [for self-hosted Zulip
|
||||
installations](#gdpr-compliance-for-self-hosted-installations).
|
||||
|
||||
A [Data Processing Addendum
|
||||
(DPA)](https://zulip.com/static/images/policies/Zulip-Data-Processing-Addendum.pdf)
|
||||
is incorporated into Zulip's [Terms of
|
||||
Service](https://zulip.com/policies/terms).
|
||||
|
||||
## GDPR compliance with Zulip Cloud
|
||||
|
||||
The Zulip Cloud service is operated by Kandra Labs, Inc. To deliver the Zulip
|
||||
Cloud service, Kandra Labs, Inc. acts as a compliant data
|
||||
[processor](#background-on-controllers-and-processors), with each of our
|
||||
customers acting as the data
|
||||
[controller](#background-on-controllers-and-processors). Kandra Labs receives
|
||||
personal data from our customers in the context of providing our Zulip Cloud
|
||||
team chat services to the customer.
|
||||
|
||||
Zulip makes it easy for organizations to comply with GDPR-related requests from
|
||||
users:
|
||||
|
||||
* Zulip users can [edit their profile
|
||||
information](/help/edit-your-profile#edit-your-profile), [configure privacy
|
||||
settings](/help/review-your-settings#review-your-privacy-settings), and
|
||||
[delete their own
|
||||
messages](/help/delete-a-message#delete-a-message-completely) and [uploaded
|
||||
files](/help/manage-your-uploaded-files#delete-a-file), if permissions to do
|
||||
so are enabled by your organization.
|
||||
* Organization administrators can also [edit or remove any user's profile
|
||||
information](/help/manage-a-user), or [deactivate a user](/help/deactivate-or-reactivate-a-user).
|
||||
* You can [export](/help/export-your-organization) all the data related to a
|
||||
Zulip user or organization.
|
||||
* The [Zulip REST API](/api/rest) lets you automate your processes for handling
|
||||
GDPR requests.
|
||||
|
||||
Contact [support@zulip.com](mailto:support@zulip.com) for
|
||||
any assistance with GDPR compliance with Zulip Cloud.
|
||||
|
||||
## GDPR compliance for self-hosted installations
|
||||
|
||||
Compliance is often simpler when running software on-premises, since
|
||||
you can have complete control over how your organization uses the data
|
||||
you collect.
|
||||
|
||||
The Zulip [Mobile Push Notification Service][mobile-push] is operated by Kandra
|
||||
Labs, Inc. Kandra Labs acts as a data processor to deliver the service, which
|
||||
uses the same hosting infrastructure and [terms of
|
||||
service](https://zulip.com/policies/terms) as Zulip Cloud.
|
||||
|
||||
[mobile-push]: https://zulip.readthedocs.io/en/stable/production/mobile-push-notifications.html
|
||||
|
||||
In addition to the features [described
|
||||
above](#gdpr-compliance-with-zulip-cloud), the following tools help self-hosted
|
||||
Zulip installations comply with GDPR-related requests from users:
|
||||
|
||||
* The Zulip server comes with a [command-line tool][management-commands],
|
||||
`manage.py export_single_user`, which is a variant of the main server
|
||||
[export tool][export-and-import-tool], that exports a single Zulip
|
||||
user's account details, preferences, channel subscriptions, and message
|
||||
history in a structured JSON format.
|
||||
* The Django management shell (`manage.py shell`) and database shell
|
||||
(`manage.py dbshell`) allows you to query, access, edit, and delete
|
||||
data directly.
|
||||
|
||||
There's a lot more that goes into GDPR compliance, including securing your
|
||||
server infrastructure responsibly, internal policies around access, logging, and
|
||||
backups, etc. [Zulip Business](https://zulip.com/plans/#self-hosted) and [Zulip
|
||||
Enterprise](https://zulip.com/plans/#self-hosted) customers can contact
|
||||
[support@zulip.com](mailto:support@zulip.com) for assistance with GDPR
|
||||
compliance with Zulip.
|
||||
|
||||
[management-commands]: https://zulip.readthedocs.io/en/stable/production/management-commands.html
|
||||
|
||||
[export-and-import-tool]: https://zulip.readthedocs.io/en/stable/production/export-and-import.html
|
||||
|
||||
## Background on controllers and processors
|
||||
|
||||
There are two key relationships that are defined in the GDPR. As a
|
||||
customer of Zulip Cloud, you operate as the controller when using our
|
||||
products and services. You have the responsibility for ensuring that
|
||||
the personal data you are collecting is being processed in a lawful
|
||||
manner as described above and that you are using processors, such as
|
||||
Zulip Cloud, that are committed to handling the data in a compliant
|
||||
manner.
|
||||
|
||||
Zulip Cloud is considered a **data processor**. We act on the
|
||||
instructions of the controller (you). Similar to controllers,
|
||||
processors are expected to enumerate how they handle personal data,
|
||||
which we have outlined in this document and the legal documents listed
|
||||
below. As a processor, we rely on our customers to ensure that there
|
||||
is a lawful basis for processing.
|
||||
|
||||
Processors may leverage other third-parties in the processing of
|
||||
personal data. These entities are commonly referred to as
|
||||
sub-processors. For example, Kandra Labs leverages cloud service
|
||||
providers like Amazon Web Services and Mailgun to host Zulip Cloud.
|
||||
See [full list of subprocessors for Zulip
|
||||
Cloud](/policies/subprocessors).
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Zulip Cloud privacy policy](https://zulip.com/policies/privacy)
|
||||
* [Terms of Service](https://zulip.com/policies/terms)
|
||||
* [Data Processing Addendum
|
||||
(DPA)](https://zulip.com/static/images/policies/Zulip-Data-Processing-Addendum.pdf)
|
||||
* [Subprocessors for Zulip Cloud](/policies/subprocessors)
|
45
starlight_help/src/content/docs/general-chat-channels.mdx
Normal file
45
starlight_help/src/content/docs/general-chat-channels.mdx
Normal file
@@ -0,0 +1,45 @@
|
||||
---
|
||||
title: “General chat” channels
|
||||
---
|
||||
|
||||
import NavigationSteps from "../../components/NavigationSteps.astro"
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
import SaveChanges from "./include/_SaveChanges.mdx"
|
||||
import SelectChannelViewGeneralAdvanced from "./include/_SelectChannelViewGeneralAdvanced.mdx"
|
||||
import { Tabs, TabItem } from '@astrojs/starlight/components'
|
||||
|
||||
Zulip's [topics](/help/introduction-to-topics) help you keep conversations
|
||||
organized, but you may not need topics in some channels (e.g., a social channel,
|
||||
or one with a narrow purpose).
|
||||
|
||||
If you have permission to administer a channel, you can configure it to only
|
||||
have the special “*general chat*” topic. The name of this topic is shown in
|
||||
italics, and is translated into [your language](/help/change-your-language).
|
||||
|
||||
Users won't need to enter a topic when sending a message to a “*general chat*”
|
||||
channel.
|
||||
|
||||
## Configure a channel to have only the “*general chat*” topic
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Desktop/Web">
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="relative/channel/all" />
|
||||
|
||||
1. Select a channel.
|
||||
|
||||
<SelectChannelViewGeneralAdvanced />
|
||||
|
||||
1. Under **Messaging permissions**, set **Allow posting to the *general chat*
|
||||
topic?** to **Only “general chat” topic allowed**.
|
||||
|
||||
<SaveChanges />
|
||||
</FlattenedSteps>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Introduction to topics](/help/introduction-to-topics)
|
||||
* [“*General chat*” topic](/help/general-chat-topic)
|
||||
* [Require topics in channel messages](/help/require-topics)
|
65
starlight_help/src/content/docs/general-chat-topic.mdx
Normal file
65
starlight_help/src/content/docs/general-chat-topic.mdx
Normal file
@@ -0,0 +1,65 @@
|
||||
---
|
||||
title: “General chat” topic
|
||||
---
|
||||
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
import KeyboardTip from '../../components/KeyboardTip.astro';
|
||||
import GeneralChatIntro from "./include/_GeneralChatIntro.mdx"
|
||||
import ComposeAndSendMessage from "./include/_ComposeAndSendMessage.mdx"
|
||||
import SquarePlusIcon from "~icons/zulip-icon/square-plus"
|
||||
import { Tabs, TabItem } from '@astrojs/starlight/components'
|
||||
|
||||
Zulip's [topics](/help/introduction-to-topics) help you keep conversations
|
||||
organized, but you may sometimes want to send a message without a topic. For
|
||||
example, this could be appropriate for social chatter, or for a one-off request
|
||||
(e.g., “Is anyone around to help me out?”).
|
||||
|
||||
<GeneralChatIntro />
|
||||
|
||||
The “*general chat*” topic can be used only if [allowed](/help/require-topics)
|
||||
by your organization's administrators, and channels can be
|
||||
[configured](/help/general-chat-channels) to only allow the “*general chat*”
|
||||
topic.
|
||||
|
||||
## Sending a message to the “*general chat*” topic
|
||||
|
||||
You can [reply](/help/replying-to-messages) to a message in the “*general chat*”
|
||||
topic, or follow the instructions below.
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Via left sidebar">
|
||||
<FlattenedSteps>
|
||||
1. Click the **new topic** (<SquarePlusIcon />)
|
||||
button next to the name of the channel where you'd like to send a message.
|
||||
|
||||
<ComposeAndSendMessage />
|
||||
</FlattenedSteps>
|
||||
|
||||
<KeyboardTip>
|
||||
You can also use the <kbd>C</kbd> keyboard shortcut to send a message to
|
||||
the channel you're viewing.
|
||||
</KeyboardTip>
|
||||
</TabItem>
|
||||
|
||||
<TabItem label="Via compose box">
|
||||
<FlattenedSteps>
|
||||
1. Click the **Start new conversation** button at the bottom of the app.
|
||||
1. *(optional)* You can change the destination channel for your message using
|
||||
the dropdown in the top left of the compose box. Start typing to filter
|
||||
channels.
|
||||
|
||||
<ComposeAndSendMessage />
|
||||
</FlattenedSteps>
|
||||
|
||||
<KeyboardTip>
|
||||
You can also use the <kbd>C</kbd> keyboard shortcut to send a message to
|
||||
the channel you're viewing.
|
||||
</KeyboardTip>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Introduction to topics](/help/introduction-to-topics)
|
||||
* [“*General chat*” channels](/help/general-chat-channels)
|
||||
* [Require topics in channel messages](/help/require-topics)
|
69
starlight_help/src/content/docs/generate-integration-url.mdx
Normal file
69
starlight_help/src/content/docs/generate-integration-url.mdx
Normal file
@@ -0,0 +1,69 @@
|
||||
---
|
||||
title: Generate URL for an integration
|
||||
---
|
||||
|
||||
import NavigationSteps from "../../components/NavigationSteps.astro"
|
||||
import ZulipTip from '../../components/ZulipTip.astro';
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
import UserCogIcon from "~icons/zulip-icon/user-cog"
|
||||
import LinkIcon from "~icons/fa/link"
|
||||
import { Tabs, TabItem } from '@astrojs/starlight/components'
|
||||
import AdminOnly from "./include/_AdminOnly.mdx"
|
||||
|
||||
Many [Zulip integrations](/integrations/) are webhooks. An incoming webhook
|
||||
integration allows a third-party service, such as an [issue
|
||||
tracker](/integrations/doc/github) or an [alerting
|
||||
tool](/integrations/doc/pagerduty), to post updates to Zulip. To configure
|
||||
where these updates will be posted, you need to generate a special Zulip
|
||||
integration URL.
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Via personal settings">
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/your-bots" />
|
||||
|
||||
1. Click the **link** (<LinkIcon />) icon on the profile card of
|
||||
an **Incoming webhook** bot.
|
||||
1. Select the desired integration from the **Integration** dropdown.
|
||||
1. *(optional)* Select the destination channel from the
|
||||
**Where to send notifications** dropdown.
|
||||
1. *(optional)* Select **Send all notifications to a single topic**, and
|
||||
enter the topic name.
|
||||
1. *(optional)* Select **Filter events that will trigger notifications?**,
|
||||
and select which supported events should trigger notifications.
|
||||
1. Click **Copy URL** to add the URL to your clipboard.
|
||||
</FlattenedSteps>
|
||||
|
||||
<ZulipTip>
|
||||
You can also click the **manage bot** (<UserCogIcon />) icon, scroll down to the bottom, and click
|
||||
**Generate URL for an integration**.
|
||||
</ZulipTip>
|
||||
</TabItem>
|
||||
|
||||
<TabItem label="Via organization settings">
|
||||
<AdminOnly />
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/bot-list-admin" />
|
||||
|
||||
1. In the **Actions** column, click the **manage bot** (<UserCogIcon />) icon for an **Incoming webhook** bot.
|
||||
1. Scroll down to the bottom, and click **Generate URL for an integration**.
|
||||
1. Select the desired integration from the **Integration** dropdown.
|
||||
1. *(optional)* Select the destination channel from the
|
||||
**Where to send notifications** dropdown.
|
||||
1. *(optional)* Select **Send all notifications to a single topic**, and
|
||||
enter the topic name.
|
||||
1. *(optional)* Select **Filter events that will trigger notifications?**,
|
||||
and select which supported events should trigger notifications.
|
||||
1. Click **Copy URL** to add the URL to your clipboard.
|
||||
</FlattenedSteps>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Integrations overview](/help/integrations-overview)
|
||||
* [Bots overview](/help/bots-overview)
|
||||
* [Add a bot or integration](/help/add-a-bot-or-integration)
|
||||
* [View all bots in your organization](/help/view-all-bots-in-your-organization)
|
||||
* [Request an integration](/help/request-an-integration)
|
@@ -0,0 +1,60 @@
|
||||
---
|
||||
title: Getting started with Zulip
|
||||
---
|
||||
|
||||
import SetUpYourAccount from "./include/_SetUpYourAccount.mdx"
|
||||
import WhenToStartANewTopic from "./include/_WhenToStartANewTopic.mdx"
|
||||
import TopicsIntro from "./include/_TopicsIntro.mdx"
|
||||
import MessagingTips from "./include/_MessagingTips.mdx"
|
||||
import ReplyingToMessages from "./include/_ReplyingToMessages.mdx"
|
||||
import HowToStartANewTopic from "./include/_HowToStartANewTopic.mdx"
|
||||
import StartingANewDirectMessage from "./include/_StartingANewDirectMessage.mdx"
|
||||
import ReadingConversations from "./include/_ReadingConversations.mdx"
|
||||
|
||||
Welcome to Zulip! This page guides you through getting started using
|
||||
Zulip. If you are setting up a new organization, you may also want to
|
||||
check out our [guide for moving to Zulip](/help/moving-to-zulip).
|
||||
|
||||
You can learn where to find everything you need to get started with this
|
||||
[2-minute video
|
||||
tour](https://static.zulipchat.com/static/navigation-tour-video/zulip-10.mp4).
|
||||
Mastering Zulip can take a bit of time, but once you get the hang of
|
||||
it, you'll never want to use a different team chat app!
|
||||
|
||||
## Set up your account
|
||||
|
||||
<SetUpYourAccount />
|
||||
|
||||
## Learn about Zulip topics
|
||||
|
||||
<TopicsIntro />
|
||||
|
||||
## Reading your messages
|
||||
|
||||
<ReadingConversations />
|
||||
|
||||
## Sending messages
|
||||
|
||||
### When to start a new topic
|
||||
|
||||
<WhenToStartANewTopic />
|
||||
|
||||
### How to start a new topic
|
||||
|
||||
<HowToStartANewTopic />
|
||||
|
||||
### Starting a new direct message
|
||||
|
||||
<StartingANewDirectMessage />
|
||||
|
||||
### Responding to an existing thread
|
||||
|
||||
<ReplyingToMessages />
|
||||
|
||||
### Messaging tips & tricks
|
||||
|
||||
<MessagingTips />
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Moving to Zulip](/help/moving-to-zulip)
|
50
starlight_help/src/content/docs/global-times.mdx
Normal file
50
starlight_help/src/content/docs/global-times.mdx
Normal file
@@ -0,0 +1,50 @@
|
||||
---
|
||||
title: Global times
|
||||
---
|
||||
|
||||
import TimeIcon from "~icons/zulip-icon/time"
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
import GlobalTimesExamples from "./include/_GlobalTimesExamples.mdx"
|
||||
import GlobalTimesIntro from "./include/_GlobalTimesIntro.mdx"
|
||||
import StartComposing from "./include/_StartComposing.mdx"
|
||||
import { Tabs, TabItem } from '@astrojs/starlight/components'
|
||||
|
||||
<GlobalTimesIntro />
|
||||
|
||||
## Insert a time
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Via compose box button">
|
||||
<FlattenedSteps>
|
||||
<StartComposing />
|
||||
|
||||
1. Click the **Add global time** (<TimeIcon />)
|
||||
icon at the bottom of the compose box to open the date picker.
|
||||
1. Select the desired time by clicking with your mouse, or using the arrow
|
||||
keys + <kbd>Enter</kbd>.
|
||||
1. Click **Confirm** to insert the selected time.
|
||||
</FlattenedSteps>
|
||||
</TabItem>
|
||||
|
||||
<TabItem label="Via Markdown">
|
||||
<FlattenedSteps>
|
||||
<StartComposing />
|
||||
|
||||
1. Type `<time`, and click **Mention a time-zone-aware time**, or press
|
||||
<kbd>Enter</kbd> to open the date picker.
|
||||
1. Select the desired time by clicking with your mouse, or using the arrow
|
||||
keys + <kbd>Enter</kbd>.
|
||||
1. Click **Confirm** to insert the selected time.
|
||||
</FlattenedSteps>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Examples
|
||||
|
||||
<GlobalTimesExamples />
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Message formatting](/help/format-your-message-using-markdown)
|
||||
* [Preview messages before sending](/help/preview-your-message-before-sending)
|
||||
* [Resize the compose box](/help/resize-the-compose-box)
|
132
starlight_help/src/content/docs/guest-users.mdx
Normal file
132
starlight_help/src/content/docs/guest-users.mdx
Normal file
@@ -0,0 +1,132 @@
|
||||
---
|
||||
title: Guest users
|
||||
---
|
||||
|
||||
import NavigationSteps from "../../components/NavigationSteps.astro"
|
||||
import ZulipTip from '../../components/ZulipTip.astro';
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
import SaveChanges from "./include/_SaveChanges.mdx"
|
||||
import CloudPlusOnly from "./include/_CloudPlusOnly.mdx"
|
||||
import { Tabs, TabItem } from '@astrojs/starlight/components'
|
||||
|
||||
You can add users who should have restricted access to your organization as
|
||||
**guests**. For example, this may be a good choice for contractors or customers
|
||||
invited to a company's Zulip chat.
|
||||
|
||||
Guest users **can**:
|
||||
|
||||
* View and send messages in channels they have been subscribed to, including
|
||||
viewing message history in the same way as other channel subscribers.
|
||||
|
||||
Guest users **cannot**:
|
||||
|
||||
* See private or public channels, unless they have been specifically subscribed
|
||||
to the channel.
|
||||
* Create new channels or user groups.
|
||||
* Add or manage bots.
|
||||
* Add custom emoji.
|
||||
* Invite users to join the organization.
|
||||
|
||||
You can also **configure** other permissions for guest users, such as whether they
|
||||
can:
|
||||
|
||||
* [Move](/help/restrict-moving-messages) or
|
||||
[edit](/help/restrict-message-editing-and-deletion) messages.
|
||||
* Notify a large number of users [with a wildcard
|
||||
mention](/help/restrict-wildcard-mentions).
|
||||
|
||||
Zulip Cloud plans have [special discounted
|
||||
pricing](/help/zulip-cloud-billing#temporary-users-and-guests) for guest users.
|
||||
|
||||
## Configure guest indicator
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Desktop/Web">
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/organization-permissions" />
|
||||
|
||||
1. Under **Guests**, toggle **Display “(guest)” after names of guest users**.
|
||||
|
||||
<SaveChanges />
|
||||
</FlattenedSteps>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Configure warning when composing a DM to a guest
|
||||
|
||||
Zulip can display a warning to let users know when recipients for a direct
|
||||
message they are composing are guests in your organization. The warning will be
|
||||
shown as a banner in the compose box on the web and desktop apps.
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Desktop/Web">
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/organization-permissions" />
|
||||
|
||||
1. Under **Guests**, toggle **Warn when composing a DM to a guest**.
|
||||
|
||||
<SaveChanges />
|
||||
</FlattenedSteps>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Configure whether guests can see all other users
|
||||
|
||||
<CloudPlusOnly />
|
||||
|
||||
You can restrict guests' ability to see other users in the organization. If you
|
||||
do so, guests will be able to see information about other users only in the
|
||||
following cases:
|
||||
|
||||
* The user belongs to a [direct message](/help/direct-messages) thread with the
|
||||
guest.
|
||||
* The user is subscribed to one or more [channels](/help/introduction-to-channels) with
|
||||
the guest.
|
||||
|
||||
When a guest cannot see information about a user, the guest's experience will be
|
||||
that:
|
||||
|
||||
* The user does not appear in the right sidebar.
|
||||
* The user does not appear in typeahead suggestions, e.g., in the compose box
|
||||
and search.
|
||||
* Otherwise, such a user will be displayed as an **Unknown user** in the Zulip
|
||||
app. For example, messages and reactions from a former subscriber of a channel
|
||||
will be shown as from an **Unknown user**.
|
||||
* An **Unknown user**'s [user card](/help/user-cards) will not display
|
||||
information about that user. However, the guest can still search from all
|
||||
messages send by a particular **Unknown user** from that user's card.
|
||||
|
||||
In practice, guests should rarely encounter content from an **Unknown user**,
|
||||
unless users in your organization frequently change their channel subscriptions
|
||||
or are [deactivated](/help/deactivate-or-reactivate-a-user).
|
||||
|
||||
The only information guests can access about unknown users via the [API](/api/)
|
||||
is which user IDs exist, and
|
||||
[availability](/help/status-and-availability) updates for each user ID.
|
||||
|
||||
<ZulipTip>
|
||||
Self-hosted organizations can disable API access to availability updates
|
||||
by [configuring](https://zulip.readthedocs.io/en/stable/production/settings.html)
|
||||
`CAN_ACCESS_ALL_USERS_GROUP_LIMITS_PRESENCE = True`. For performance reasons,
|
||||
this is recommended only for organizations with up to ~100 users.
|
||||
</ZulipTip>
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Desktop/Web">
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/organization-permissions" />
|
||||
|
||||
1. Under **Guests**, configure **Who can view all other users in the
|
||||
organization**.
|
||||
|
||||
<SaveChanges />
|
||||
</FlattenedSteps>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Related articles
|
||||
|
||||
* [User roles](/help/user-roles)
|
||||
* [Invite new users](/help/invite-new-users)
|
||||
* [Change a user's role](/help/user-roles#change-a-users-role)
|
||||
* [Zulip Cloud billing](/help/zulip-cloud-billing)
|
@@ -0,0 +1,31 @@
|
||||
---
|
||||
title: Hide message content in emails
|
||||
---
|
||||
|
||||
import NavigationSteps from "../../components/NavigationSteps.astro"
|
||||
import AdminOnly from "./include/_AdminOnly.mdx"
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
|
||||
<AdminOnly />
|
||||
|
||||
For security or compliance reasons, you may want to prevent Zulip message
|
||||
content from being sent through your email system. The only place Zulip
|
||||
currently sends message content is in message notification emails.
|
||||
|
||||
This setting also blocks message topics, channel names, and user names from
|
||||
being sent through the email system.
|
||||
|
||||
### Hide message content in emails
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/organization-settings" />
|
||||
|
||||
1. Under **Notifications security**, toggle
|
||||
**Allow message content in message notification emails**.
|
||||
</FlattenedSteps>
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Hide message content in emails](/help/email-notifications#hide-message-content),
|
||||
as an individual.
|
||||
* [End-to-end encryption (E2EE) for mobile push notifications](/help/mobile-notifications#end-to-end-encryption-e2ee-for-mobile-push-notifications)
|
21
starlight_help/src/content/docs/high-contrast-mode.mdx
Normal file
21
starlight_help/src/content/docs/high-contrast-mode.mdx
Normal file
@@ -0,0 +1,21 @@
|
||||
---
|
||||
title: High contrast mode
|
||||
---
|
||||
|
||||
import NavigationSteps from "../../components/NavigationSteps.astro"
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
|
||||
By default, some visual elements in Zulip (such as date/time stamps, certain
|
||||
buttons, links and unread counts) are intentionally light. **High contrast mode**
|
||||
increases the contrast of these elements to meet the AA level of the
|
||||
W3C's Web Content Accessibility Guidelines.
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/preferences" />
|
||||
|
||||
1. Under **Preferences**, select **High contrast mode**.
|
||||
</FlattenedSteps>
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Accessibility in Zulip](https://zulip.readthedocs.io/en/stable/subsystems/accessibility.html)
|
@@ -0,0 +1,80 @@
|
||||
---
|
||||
title: Image, video and website previews
|
||||
---
|
||||
|
||||
import NavigationSteps from "../../components/NavigationSteps.astro"
|
||||
import ZulipNote from '../../components/ZulipNote.astro';
|
||||
import FlattenedSteps from '../../components/FlattenedSteps.astro';
|
||||
import SaveChanges from "./include/_SaveChanges.mdx"
|
||||
import { Tabs, TabItem } from '@astrojs/starlight/components'
|
||||
import AdminOnly from "./include/_AdminOnly.mdx"
|
||||
|
||||
Zulip displays previews of images, videos and websites in your message feed. To
|
||||
avoid disrupting the flow of conversation, these previews are small. You can
|
||||
configure how animated images are previewed, and organization administrators can
|
||||
also disable previews altogether.
|
||||
|
||||
## Configure how animated images are played
|
||||
|
||||
In the desktop and web apps, you can configure previews of animated images to
|
||||
always show the animation, show it when you hover over the image with your
|
||||
mouse, or not show it at all. For large animated images, only the first part of
|
||||
the animation will be shown in the preview.
|
||||
|
||||
You can always see the full animated image by opening it in the [image
|
||||
viewer](/help/view-images-and-videos).
|
||||
|
||||
<ZulipNote>
|
||||
This configuration applies only to images uploaded since July 21, 2024 on
|
||||
Zulip Cloud, or on Zulip Server [9.0+](/help/view-zulip-version) in
|
||||
self-hosted organizations. Previews of images uploaded earlier are always
|
||||
animated.
|
||||
</ZulipNote>
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Desktop/Web">
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/preferences" />
|
||||
|
||||
1. Under **Information**, select the desired option from the **Play animated
|
||||
images** dropdown.
|
||||
</FlattenedSteps>
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Configure whether image and video previews are shown
|
||||
|
||||
<AdminOnly />
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/organization-settings" />
|
||||
|
||||
1. Under **Message feeed settings**, toggle **Show previews of uploaded and
|
||||
linked images and videos**.
|
||||
|
||||
<SaveChanges />
|
||||
</FlattenedSteps>
|
||||
|
||||
## Configure whether website previews are shown
|
||||
|
||||
<AdminOnly />
|
||||
|
||||
<FlattenedSteps>
|
||||
<NavigationSteps target="settings/organization-settings" />
|
||||
|
||||
1. Under **Message feed settings**, toggle **Show previews of linked websites**.
|
||||
|
||||
<SaveChanges />
|
||||
</FlattenedSteps>
|
||||
|
||||
## Security
|
||||
|
||||
To prevent images from being used to track Zulip users, Zulip proxies all
|
||||
external images in messages through the server.
|
||||
|
||||
## Related articles
|
||||
|
||||
* [Manage your uploaded files](/help/manage-your-uploaded-files)
|
||||
* [Share and upload files](/help/share-and-upload-files)
|
||||
* [View images and videos](/help/view-images-and-videos)
|
||||
* [Animated GIFs](/help/animated-gifs-from-giphy)
|
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user