diff --git a/starlight_help/.gitignore b/starlight_help/.gitignore index 762b2c535e..c2defb434b 100644 --- a/starlight_help/.gitignore +++ b/starlight_help/.gitignore @@ -12,7 +12,6 @@ yarn-debug.log* yarn-error.log* pnpm-debug.log* -*.mdx *.md diff --git a/starlight_help/src/content/docs/add-a-bot-or-integration.mdx b/starlight_help/src/content/docs/add-a-bot-or-integration.mdx new file mode 100644 index 0000000000..6dd3b9cda9 --- /dev/null +++ b/starlight_help/src/content/docs/add-a-bot-or-integration.mdx @@ -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 + + + + + + + 1. Click **Add a new bot**. + 1. Fill out the fields, and click **Add**. + + + + + + + + 1. Click **Add a new bot**. + 1. Fill out the fields, and click **Add**. + + + + + + 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**. + + +Depending on the type of bot you're creating, you may need to download its +`zuliprc` configuration file. For that, click the **download** +() 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) diff --git a/starlight_help/src/content/docs/add-a-custom-linkifier.mdx b/starlight_help/src/content/docs/add-a-custom-linkifier.mdx new file mode 100644 index 0000000000..0ec954f106 --- /dev/null +++ b/starlight_help/src/content/docs/add-a-custom-linkifier.mdx @@ -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" + + + +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** () 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 + + + + + 1. Under **Add a new linkifier**, enter a **Pattern** and + **URL template**. + 1. Click **Add linkifier**. + + +## Edit a custom linkifier + + + + + 1. In the **Actions** column, click the **edit** () + icon for the linkifier you want to edit. + 1. Edit linkifier information as desired, and click **Save changes**. + + +## Delete a custom linkifier + + + + + 1. In the **Actions** column, click the **delete** () icon for the linkifier you want to delete. + 1. Approve by clicking **Confirm**. + + +## 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. + + + + + 1. In the **Pattern** column under **Linkifiers**, click and drag the vertical + dots to reorder the list of linkifiers. + + +## 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[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[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[a-zA-Z0-9_-]+)/(?P[a-zA-Z0-9_-]+)#(?P[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[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 \{#var} 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
[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` + + + This pattern uses the `\{+var\}` expression type. With the + default expression type (`\{article\}`), the `/` between `overview` and + `changelog` would incorrectly be URL-encoded. + + +### Linking to Google search results + +This example pattern allows linking to Google searches. + +* Pattern: `google:(?P\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` + + + 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. + + +### 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[0-9]+)` + * URL template: `https://github.com/django/django/pull/\{id\}` +* General linkifier + * Pattern: `(?P[a-zA-Z0-9_-]+)#(?P[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` + + + 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. + diff --git a/starlight_help/src/content/docs/analytics.mdx b/starlight_help/src/content/docs/analytics.mdx new file mode 100644 index 0000000000..c0f17f09a6 --- /dev/null +++ b/starlight_help/src/content/docs/analytics.mdx @@ -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 + + + + diff --git a/starlight_help/src/content/docs/animated-gifs-from-giphy.mdx b/starlight_help/src/content/docs/animated-gifs-from-giphy.mdx new file mode 100644 index 0000000000..665ab714e6 --- /dev/null +++ b/starlight_help/src/content/docs/animated-gifs-from-giphy.mdx @@ -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" + + + On self-hosted servers, this feature need to be + [configured][configure-giphy] by a server administrator. + + +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 + + + + + 1. Click the **add GIF** () 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. + + + + You can [preview your message](/help/preview-your-message-before-sending) + before sending. + + + + +## Restrict maximum rating of GIFs retrieved from GIPHY + + + +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: + + + + + 1. Under **Compose settings**, select a rating for **GIPHY integration**. + + + + +## 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) diff --git a/starlight_help/src/content/docs/archive-a-channel.mdx b/starlight_help/src/content/docs/archive-a-channel.mdx new file mode 100644 index 0000000000..31861233ea --- /dev/null +++ b/starlight_help/src/content/docs/archive-a-channel.mdx @@ -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 + + + + + + + 1. Select a channel. + 1. Click the **archive** () icon + in the upper right corner of the channel settings panel. + 1. Click **Confirm**. + + + + You can also hover over a channel in the left sidebar, click on the + **ellipsis** (), and + select **Channel settings** to access settings for the channel. + + + + +## View archived channels + + + + + + + 1. Select **Archived channels** from the dropdown next to the **Filter** box + above the list of channels. + + + + +## Hide content in an archived channel + + + + + + + 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. + + + + 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. + + + + +You can also make these configuration changes prior to archiving a channel. + +## Unarchive a channel + + + + + + + 1. Select **Archived channels** from the dropdown in the upper left. + 1. Select a channel. + 1. Click the **unarchive** () + icon in the upper right corner of the channel settings panel. + 1. Click **Confirm**. + + + + +## 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) diff --git a/starlight_help/src/content/docs/bots-overview.mdx b/starlight_help/src/content/docs/bots-overview.mdx new file mode 100644 index 0000000000..7823e88ff4 --- /dev/null +++ b/starlight_help/src/content/docs/bots-overview.mdx @@ -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) diff --git a/starlight_help/src/content/docs/bulleted-lists.mdx b/starlight_help/src/content/docs/bulleted-lists.mdx new file mode 100644 index 0000000000..b3aac4ac00 --- /dev/null +++ b/starlight_help/src/content/docs/bulleted-lists.mdx @@ -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' + + + +## Create a bulleted list + + + + + + + 1. *(optional)* Select the text you want to format. + 1. Click the **Bulleted list** + () icon at the + bottom of the compose box to insert list formatting. + 1. Press Enter to automatically add a new bullet to the list. + 1. When your list is done, press Enter a second time to remove the + bullet. + + + + You can also use the **Bulleted list** + () icon + to remove existing list formatting from the current line or selected text. + + + + + + + + 1. Type `*`, `-`, or `+` followed by a space and some text to start a bulleted + list. + 1. Press Enter to automatically add a new bullet to the list. + 1. When your list is done, press Enter a second time to remove the + bullet. + + + + +## Examples + + + +## 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) diff --git a/starlight_help/src/content/docs/change-a-users-name.mdx b/starlight_help/src/content/docs/change-a-users-name.mdx new file mode 100644 index 0000000000..c67f9f4234 --- /dev/null +++ b/starlight_help/src/content/docs/change-a-users-name.mdx @@ -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" + + + +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 + + + + + + + 1. Under **Name**, enter a new name. + + + + + + + + + + + + 1. Find the user you would like to manage. Click the + **manage user** () icon + to the right of their name. + 1. Under **Name**, enter a new name. + + + + + + +## 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) diff --git a/starlight_help/src/content/docs/change-organization-url.mdx b/starlight_help/src/content/docs/change-organization-url.mdx new file mode 100644 index 0000000000..5c07e54c4f --- /dev/null +++ b/starlight_help/src/content/docs/change-organization-url.mdx @@ -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" + + + +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. + + + 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. + + +## Change your Zulip Cloud subdomain + +Zulip Cloud organizations are generally hosted at `.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: + + + 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. + + +## Move to a custom URL on Zulip Cloud + + + +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: + + + 1. Your organization's current URL. + 1. The URL you would like to move your organization to. + + +## 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 diff --git a/starlight_help/src/content/docs/change-the-channel-description.mdx b/starlight_help/src/content/docs/change-the-channel-description.mdx new file mode 100644 index 0000000000..6dfd411447 --- /dev/null +++ b/starlight_help/src/content/docs/change-the-channel-description.mdx @@ -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)`. + + + + + + + 1. Select a channel. + + + + 1. Click the **edit channel name and description** + () icon to the right of the + channel name, and enter a new description. + + + + + + + + + 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 👍. + + + + + +## 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 diff --git a/starlight_help/src/content/docs/change-the-color-of-a-channel.mdx b/starlight_help/src/content/docs/change-the-color-of-a-channel.mdx new file mode 100644 index 0000000000..2ec55a235b --- /dev/null +++ b/starlight_help/src/content/docs/change-the-color-of-a-channel.mdx @@ -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. + + + + + + + 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. + + + + + + + + 1. Select a channel. + + + + 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. + + + + +## 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) diff --git a/starlight_help/src/content/docs/change-the-privacy-of-a-channel.mdx b/starlight_help/src/content/docs/change-the-privacy-of-a-channel.mdx new file mode 100644 index 0000000000..00da5ab660 --- /dev/null +++ b/starlight_help/src/content/docs/change-the-privacy-of-a-channel.mdx @@ -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" + + + +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: + + + + + **Warning**: Be careful making a private channel public. All past messages + will become accessible, even if the channel previously had protected history. + + + + + + + + 1. Select a channel. + + + + 1. Under **Channel permissions**, configure **Who can access the channel**. + + + + + + + + + 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 👍. + + + + + +## 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) diff --git a/starlight_help/src/content/docs/change-the-time-format.mdx b/starlight_help/src/content/docs/change-the-time-format.mdx new file mode 100644 index 0000000000..112bd525f2 --- /dev/null +++ b/starlight_help/src/content/docs/change-the-time-format.mdx @@ -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 + + + + + 1. Under **General**, select your preferred option from the + **Time format** dropdown. + diff --git a/starlight_help/src/content/docs/change-your-email-address.mdx b/starlight_help/src/content/docs/change-your-email-address.mdx new file mode 100644 index 0000000000..3747de29e7 --- /dev/null +++ b/starlight_help/src/content/docs/change-your-email-address.mdx @@ -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 + + + + + 1. Under **Account**, click on the + **change your email** () icon + to the right of your current email. If you do not see the + **change your email** () 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**. + diff --git a/starlight_help/src/content/docs/change-your-language.mdx b/starlight_help/src/content/docs/change-your-language.mdx new file mode 100644 index 0000000000..b6ad312b36 --- /dev/null +++ b/starlight_help/src/content/docs/change-your-language.mdx @@ -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'; + + + +## 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. + + + + + + + 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**. + + + + + 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 👍. + + + +## 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 diff --git a/starlight_help/src/content/docs/change-your-name.mdx b/starlight_help/src/content/docs/change-your-name.mdx new file mode 100644 index 0000000000..c210d2e19c --- /dev/null +++ b/starlight_help/src/content/docs/change-your-name.mdx @@ -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 + + + + + 1. Edit the **Name** field. + + + + **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. + diff --git a/starlight_help/src/content/docs/change-your-password.mdx b/starlight_help/src/content/docs/change-your-password.mdx new file mode 100644 index 0000000000..d96190652f --- /dev/null +++ b/starlight_help/src/content/docs/change-your-password.mdx @@ -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 + + + +### If you know your current password + + + + + 1. Under **Account**, click on the password field (it should look like `********`). + 1. Enter your old password and your new password, and click **Change**. + diff --git a/starlight_help/src/content/docs/change-your-profile-picture.mdx b/starlight_help/src/content/docs/change-your-profile-picture.mdx new file mode 100644 index 0000000000..dd662aa8ed --- /dev/null +++ b/starlight_help/src/content/docs/change-your-profile-picture.mdx @@ -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 + + + + + 1. Under **Profile picture**, click **Upload new profile picture** and choose an image to upload. + + +### Change profile picture back to gravatar + + + + + 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. + + +## Related articles + +* [Restrict profile picture changes](/help/restrict-profile-picture-changes) diff --git a/starlight_help/src/content/docs/change-your-timezone.mdx b/starlight_help/src/content/docs/change-your-timezone.mdx new file mode 100644 index 0000000000..3e17297b7c --- /dev/null +++ b/starlight_help/src/content/docs/change-your-timezone.mdx @@ -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 + + + + + + + 1. Under **Profile**, select a time zone. + + + + +## Configure time zone used by Zulip to display dates and times + + + 1. Configure the time zone on your computer or mobile device. + 1. Reload Zulip. + + +## 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. + + + + + + + 1. Under **Profile**, toggle **Offer to update to my computer's + time zone**. + + + + +## Related articles + +* [User cards](/help/user-cards) +* [View someone's profile](/help/view-someones-profile) +* [Edit your profile](/help/edit-your-profile) diff --git a/starlight_help/src/content/docs/channel-feed.mdx b/starlight_help/src/content/docs/channel-feed.mdx new file mode 100644 index 0000000000..c56f648929 --- /dev/null +++ b/starlight_help/src/content/docs/channel-feed.mdx @@ -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 + + + + + + + 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. + + + + Use S to go from a topic view to the channel feed. + + + + + + + + 1. Select a channel. + + + + 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** () + icon in the upper right corner of the app. + + + + +## Go to channel feed for an unsubscribed channel + + + + + + + 1. Select a channel. + 1. Click the channel name in the top bar. + + + + +## Configure where channel links in the left sidebar go + + + +## 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) diff --git a/starlight_help/src/content/docs/channel-folders.mdx b/starlight_help/src/content/docs/channel-folders.mdx new file mode 100644 index 0000000000..9177a2b8c3 --- /dev/null +++ b/starlight_help/src/content/docs/channel-folders.mdx @@ -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' + + + +## Move a channel to a folder + + + +## Configure whether channels are grouped by folder in the left sidebar + + + + + 1. Click the **ellipsis** () + 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. + + + + + + + + 1. Under **Left sidebar**, toggle **Group channels by folder in the left + sidebar**. + + + + +## 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) diff --git a/starlight_help/src/content/docs/channel-notifications.mdx b/starlight_help/src/content/docs/channel-notifications.mdx new file mode 100644 index 0000000000..f8ec76a031 --- /dev/null +++ b/starlight_help/src/content/docs/channel-notifications.mdx @@ -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). + + + + + + + 1. Click **Channel settings**. + + + + 1. Under **Notification settings**, toggle your preferred + notifications settings for the channel. + + + + + + + + 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. + + + + 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** + () icon. + + + + + 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 👍. + + + +## Configure default notifications for all channels + +These settings only apply to channels where you have not +explicitly set a notification preference. + + + + + + + 1. In the **Notification triggers** table, + toggle the settings for **Channels**. + + + + + 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 👍. + + + +## 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) diff --git a/starlight_help/src/content/docs/channel-permissions.mdx b/starlight_help/src/content/docs/channel-permissions.mdx new file mode 100644 index 0000000000..0b23cf9f1e --- /dev/null +++ b/starlight_help/src/content/docs/channel-permissions.mdx @@ -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" + + + + + +## 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 ) 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. + + + +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. + + + 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. + + +## Public channels + +Public channels (indicated by ) 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 + + + +Web-public channels are indicated with a **globe** () 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) diff --git a/starlight_help/src/content/docs/channel-posting-policy.mdx b/starlight_help/src/content/docs/channel-posting-policy.mdx new file mode 100644 index 0000000000..dc18bdb3f9 --- /dev/null +++ b/starlight_help/src/content/docs/channel-posting-policy.mdx @@ -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. + + + + + 1. Select a channel. + + + + 1. Under **Messaging permissions**, configure **Who can post to this channel**. + + + + + + +## 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) diff --git a/starlight_help/src/content/docs/code-blocks.mdx b/starlight_help/src/content/docs/code-blocks.mdx new file mode 100644 index 0000000000..9953df1350 --- /dev/null +++ b/starlight_help/src/content/docs/code-blocks.mdx @@ -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" + + + +## Insert code formatting + +Zulip's compose box has a smart **Code** () 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. + + + + + + + 1. *(optional)* Select the text you want to format. + 1. Click the **Code** () 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. + + + + You can also use the **Code** () + icon to remove existing code formatting from the selected text. + + + + + + + + 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) + ``` + + + + You can also use `~~~` to start code blocks, or just indent the code 4 or more + spaces. + + + + +## Examples + + + +## 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. + + + + + + + 1. Under **Message feed settings**, edit **Default language for code blocks**. + + +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 + + + + + + + 1. Under **Add a new code playground**, enter a **Language**, **Name**, and + **URL template**. + 1. Click **Add code playground**. + + +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. + + + 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). + + +### 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 diff --git a/starlight_help/src/content/docs/collaborative-to-do-lists.mdx b/starlight_help/src/content/docs/collaborative-to-do-lists.mdx new file mode 100644 index 0000000000..19a174ccaa --- /dev/null +++ b/starlight_help/src/content/docs/collaborative-to-do-lists.mdx @@ -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" + + + +## Create a to-do list + + + + + + + 1. Make sure the compose box is empty. + 1. Click the **Add to-do list** () 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** () + button, or use a [keyboard shortcut](/help/configure-send-message-keys) + to send your message. + + + + To reorder the list of todos, click and drag the **vertical dots** + () to the left of + each option. To delete an option, click the **delete** + () icon to the right of it. + + + + + + + + 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 : and blank space. + 1. Click the **Send** () + button, or use a [keyboard shortcut](/help/configure-send-message-keys) + to send your message. + + + + You will be able to add tasks after the to-do list is created. + + + + +## Add tasks to a to-do list + + + 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. + + +## Edit the to-do list title + + + Only the creator of a to-do list can edit the title. + + + + 1. Click the **pencil** () icon + to the right of the title. + 1. Edit the title as desired. + 1. Click the **checkmark** () icon or press + Enter to save your changes. + + + + You can click the icon or press + Esc to discard your changes. + + +## Examples + + + +## Related articles + +* [Message formatting](/help/format-your-message-using-markdown) +* [Polls](/help/create-a-poll) diff --git a/starlight_help/src/content/docs/collapse-a-message.mdx b/starlight_help/src/content/docs/collapse-a-message.mdx new file mode 100644 index 0000000000..aff462963e --- /dev/null +++ b/starlight_help/src/content/docs/collapse-a-message.mdx @@ -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 + + + + + 1. Click **Collapse message**. + + + + To expand a message, click **Show more** at the bottom of the collapsed + message. + diff --git a/starlight_help/src/content/docs/combined-feed.mdx b/starlight_help/src/content/docs/combined-feed.mdx new file mode 100644 index 0000000000..68ecc2654a --- /dev/null +++ b/starlight_help/src/content/docs/combined-feed.mdx @@ -0,0 +1,23 @@ +--- +title: Combined feed +--- + +import KeyboardTip from '../../components/KeyboardTip.astro'; +import CombinedFeed from "./include/_CombinedFeed.mdx" + + + + + Use S (go to channel) or Shift + + S (go to conversation) to zoom in, and A to + get back to **Combined feed**. + + +## 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) diff --git a/starlight_help/src/content/docs/communities-directory.mdx b/starlight_help/src/content/docs/communities-directory.mdx new file mode 100644 index 0000000000..238827705f --- /dev/null +++ b/starlight_help/src/content/docs/communities-directory.mdx @@ -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" + + + +## 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 + + + + + + + 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. + + +## 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) diff --git a/starlight_help/src/content/docs/configure-a-custom-welcome-message.mdx b/starlight_help/src/content/docs/configure-a-custom-welcome-message.mdx new file mode 100644 index 0000000000..0fbef9ad74 --- /dev/null +++ b/starlight_help/src/content/docs/configure-a-custom-welcome-message.mdx @@ -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. + + + You can compose the welcome message in the compose box to benefit from + buttons and typeahead suggestions for message formatting, and copy it over. + + +## Configure a default custom welcome message + + + +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. + + + + + 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. + + + + +## Customize the welcome message when sending an invitation + + + + + + + 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**. + + +## 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) diff --git a/starlight_help/src/content/docs/configure-authentication-methods.mdx b/starlight_help/src/content/docs/configure-authentication-methods.mdx new file mode 100644 index 0000000000..62d0ee13d6 --- /dev/null +++ b/starlight_help/src/content/docs/configure-authentication-methods.mdx @@ -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" + + + +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 + + + 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. + + + + 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. + + + + + + 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. + + + + +## 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) diff --git a/starlight_help/src/content/docs/configure-automated-notices.mdx b/starlight_help/src/content/docs/configure-automated-notices.mdx new file mode 100644 index 0000000000..d449b3928c --- /dev/null +++ b/starlight_help/src/content/docs/configure-automated-notices.mdx @@ -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 + + + +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. + + + + + 1. Under **Automated messages and emails**, configure **New channel + announcements**. + + + + +## 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 + + + +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”. + + + + + 1. Under **Automated messages and emails**, configure **New user + announcements**. + + + + +## 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 + + + + + + + 1. Under **Automated messages and emails**, configure **Zulip update + announcements**. + + + + +## 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) diff --git a/starlight_help/src/content/docs/configure-call-provider.mdx b/starlight_help/src/content/docs/configure-call-provider.mdx new file mode 100644 index 0000000000..28b6b8f9be --- /dev/null +++ b/starlight_help/src/content/docs/configure-call-provider.mdx @@ -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" + + + +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) + + + You can disable the video and voice call buttons for your organization + by setting the **call provider** to "None". + + +## Configure your organization's call provider + + + + + 1. Under **Compose settings**, select the desired provider from the + **Call provider** dropdown. + + + + +## 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. + + + + + 1. Under **Compose settings**, select **Custom URL** from the + **Jitsi server URL** dropdown. + 1. Enter the URL of your self-hosted Jitsi Meet server. + + + + +## 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) diff --git a/starlight_help/src/content/docs/configure-default-new-user-settings.mdx b/starlight_help/src/content/docs/configure-default-new-user-settings.mdx new file mode 100644 index 0000000000..8273d8083c --- /dev/null +++ b/starlight_help/src/content/docs/configure-default-new-user-settings.mdx @@ -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'; + + + +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. + + + + + 1. Review all settings and adjust as needed. + + +## 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). + + + + + 1. Under **Automated messages and emails**, change the **Language for + automated messages and invitation emails**. + + + + +## 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) diff --git a/starlight_help/src/content/docs/configure-email-visibility.mdx b/starlight_help/src/content/docs/configure-email-visibility.mdx new file mode 100644 index 0000000000..513a1d45f5 --- /dev/null +++ b/starlight_help/src/content/docs/configure-email-visibility.mdx @@ -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 + + + + + 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. + + + + + + + + 1. Under **Privacy**, configure **Who can access your email address**. + + + + +## Configure default email visibility for new users + + + + + + + 1. Under **Privacy settings**, configure **Who can access user's email address**. + + +## Related articles + +* [Moderating open organizations](/help/moderating-open-organizations) +* [Restrict name and email changes](/help/restrict-name-and-email-changes) diff --git a/starlight_help/src/content/docs/configure-emoticon-translations.mdx b/starlight_help/src/content/docs/configure-emoticon-translations.mdx new file mode 100644 index 0000000000..b4b598267e --- /dev/null +++ b/starlight_help/src/content/docs/configure-emoticon-translations.mdx @@ -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 + + + + + 1. Under **Emoji**, toggle **Convert emoticons before sending**. + + +## List of emoticon translations + + + +## Related articles + +* [Emoji and emoticons](/help/emoji-and-emoticons) +* [Add custom emoji](/help/custom-emoji) +* [Emoji reactions](/help/emoji-reactions) diff --git a/starlight_help/src/content/docs/configure-home-view.mdx b/starlight_help/src/content/docs/configure-home-view.mdx new file mode 100644 index 0000000000..496c8becaa --- /dev/null +++ b/starlight_help/src/content/docs/configure-home-view.mdx @@ -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 Esc key navigates to the home view. Also, you can +always reach the home view by using the +Ctrl + \[ 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: + + + + + 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 + (Ctrl + \[ or Esc + if enabled). + + + + 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** + () menu. + + +## Configure whether Esc 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 Esc key shortcut will ultimately navigate to +your home view. You can disable this key binding if you would prefer. +This will not disable other Esc key shortcuts used in Zulip, +and will not affect the behavior of the +Ctrl + \[ shortcut. + +### Toggle whether Esc navigates to the home view + + + + + 1. Under **Navigation**, toggle **Escape key navigates to + home view**, as desired. + + +## Related articles + +* [Reading strategies](/help/reading-strategies) +* [Recent conversations](/help/recent-conversations) +* [Combined feed](/help/combined-feed) +* [Keyboard shortcuts](/help/keyboard-shortcuts) diff --git a/starlight_help/src/content/docs/configure-how-links-open.mdx b/starlight_help/src/content/docs/configure-how-links-open.mdx new file mode 100644 index 0000000000..b9f7ecaa4f --- /dev/null +++ b/starlight_help/src/content/docs/configure-how-links-open.mdx @@ -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 + + + + + + + 1. Toggle **Open links with in-app browser**. + + + + +## Related articles + +* [Link to a message or conversation](/help/link-to-a-message-or-conversation) diff --git a/starlight_help/src/content/docs/configure-multi-language-search.mdx b/starlight_help/src/content/docs/configure-multi-language-search.mdx new file mode 100644 index 0000000000..6b03e733fa --- /dev/null +++ b/starlight_help/src/content/docs/configure-multi-language-search.mdx @@ -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 diff --git a/starlight_help/src/content/docs/configure-organization-language.mdx b/starlight_help/src/content/docs/configure-organization-language.mdx new file mode 100644 index 0000000000..b35a337c40 --- /dev/null +++ b/starlight_help/src/content/docs/configure-organization-language.mdx @@ -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" + + + + + +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 + + + + + 1. Under **Automated messages and emails**, change the **Language for + automated messages and invitation emails**. + + + + +## 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 diff --git a/starlight_help/src/content/docs/configure-send-message-keys.mdx b/starlight_help/src/content/docs/configure-send-message-keys.mdx new file mode 100644 index 0000000000..b5eec3abb4 --- /dev/null +++ b/starlight_help/src/content/docs/configure-send-message-keys.mdx @@ -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 Enter key adds a new line to your message, +and Ctrl + Enter 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 Enter key sends your message. + + + Shift + Enter always adds a new line, regardless + of whether **Enter to send** is enabled. + + +## Configure send message keys + + + + + + + 1. Click on the **ellipsis** () + in the bottom right corner of the compose box, next to the **Send** + () button. + 1. Toggle your preferred option for **Press ... to send**. + + + + + + + + 1. Under **General**, toggle **Enter sends when composing a message**. + + + + +## 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) diff --git a/starlight_help/src/content/docs/configure-unread-message-counters.mdx b/starlight_help/src/content/docs/configure-unread-message-counters.mdx new file mode 100644 index 0000000000..d720829093 --- /dev/null +++ b/starlight_help/src/content/docs/configure-unread-message-counters.mdx @@ -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. + + + + + + + 1. Under **Left sidebar**, select your preferred option from the + **Show unread counts for** dropdown. + + + + +## 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. + + + + + 1. Hover over your configured [home view](/help/configure-home-view) in the + **views** section of the left sidebar. + 1. Click on the **ellipsis** (). + 1. Click the option to hide or show the unread counter. + + + + + + + + 1. Under **Left sidebar**, toggle **Show unread count total on home view**. + + + + +## 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) diff --git a/starlight_help/src/content/docs/configure-where-you-land.mdx b/starlight_help/src/content/docs/configure-where-you-land.mdx new file mode 100644 index 0000000000..18a1032bb0 --- /dev/null +++ b/starlight_help/src/content/docs/configure-where-you-land.mdx @@ -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. + + + + + + + 1. Tap **Open message feeds at**. + 1. Select the desired configuration. + + + + +## Related articles + +* [Marking messages as read](/help/marking-messages-as-read) +* [Reading strategies](/help/reading-strategies) diff --git a/starlight_help/src/content/docs/configure-who-can-administer-a-channel.mdx b/starlight_help/src/content/docs/configure-who-can-administer-a-channel.mdx new file mode 100644 index 0000000000..1dec8ffe05 --- /dev/null +++ b/starlight_help/src/content/docs/configure-who-can-administer-a-channel.mdx @@ -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" + + + Organization administrators can automatically administer all channels. + + + + +## Configure who can administer a channel + + + + + 1. Select a channel. + + + + 1. Under **Administrative permissions**, configure **Who can administer + this channel**. + + + + +## 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) diff --git a/starlight_help/src/content/docs/configure-who-can-create-channels.mdx b/starlight_help/src/content/docs/configure-who-can-create-channels.mdx new file mode 100644 index 0000000000..a75e429f99 --- /dev/null +++ b/starlight_help/src/content/docs/configure-who-can-create-channels.mdx @@ -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" + + + +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 + + + + + + + 1. Under **Channel permissions**, configure **Who can create public channels**. + + + + + + + + + + 1. Under **Channel permissions**, configure **Who can create private channels**. + + + + + + + + + + 1. Under **Channel permissions**, configure **Who can create web-public channels**. + + + + + + +## 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) diff --git a/starlight_help/src/content/docs/configure-who-can-invite-to-channels.mdx b/starlight_help/src/content/docs/configure-who-can-invite-to-channels.mdx new file mode 100644 index 0000000000..78cdff1504 --- /dev/null +++ b/starlight_help/src/content/docs/configure-who-can-invite-to-channels.mdx @@ -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: + + + +[Guests](/help/guest-users) are never permitted to subscribe others. + +## Configure who can subscribe others to channels in general + + + + + + + 1. Under **Channel permissions**, configure **Who can subscribe others to channels**. + + + + +## 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. + + + + + 1. Select a channel. + + + + 1. Under **Subscription permissions**, configure **Who can subscribe anyone to + this channel**. + + + + +## 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) diff --git a/starlight_help/src/content/docs/configure-who-can-subscribe.mdx b/starlight_help/src/content/docs/configure-who-can-subscribe.mdx new file mode 100644 index 0000000000..ea70337969 --- /dev/null +++ b/starlight_help/src/content/docs/configure-who-can-subscribe.mdx @@ -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. + + + 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. + + +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. + + + + + + + 1. Select a channel. + + + + 1. Under **Subscription permissions**, configure **Who can subscribe to this + channel**. + + + + + + +## 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) diff --git a/starlight_help/src/content/docs/configure-who-can-unsubscribe-others.mdx b/starlight_help/src/content/docs/configure-who-can-unsubscribe-others.mdx new file mode 100644 index 0000000000..7f4153d2b8 --- /dev/null +++ b/starlight_help/src/content/docs/configure-who-can-unsubscribe-others.mdx @@ -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. + + + + + 1. Select a channel. + + + + 1. Under **Subscription permissions**, configure **Who can unsubscribe anyone + from this channel**. + + + + +## 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) diff --git a/starlight_help/src/content/docs/connect-through-a-proxy.mdx b/starlight_help/src/content/docs/connect-through-a-proxy.mdx new file mode 100644 index 0000000000..e6dd6b0681 --- /dev/null +++ b/starlight_help/src/content/docs/connect-through-a-proxy.mdx @@ -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 + + + + + + + 1. Select the **Network** tab. + 1. Click **Use system proxy settings**. + 1. Restart the Zulip desktop app. + + + + + + + + 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**. + + + + +## 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 -> "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 `` to match any of `127.0.0.1`, `::1`, or `localhost`. diff --git a/starlight_help/src/content/docs/contact-support.mdx b/starlight_help/src/content/docs/contact-support.mdx new file mode 100644 index 0000000000..0006e1bd44 --- /dev/null +++ b/starlight_help/src/content/docs/contact-support.mdx @@ -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) diff --git a/starlight_help/src/content/docs/create-a-channel.mdx b/starlight_help/src/content/docs/create-a-channel.mdx new file mode 100644 index 0000000000..8f98e84409 --- /dev/null +++ b/starlight_help/src/content/docs/create-a-channel.mdx @@ -0,0 +1,21 @@ +--- +title: Create a channel +--- + +import CreateAChannelInstructions from "./include/_CreateAChannelInstructions.mdx" +import DependsOnPermissions from "./include/_DependsOnPermissions.mdx" + + + +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). + + + +## 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) diff --git a/starlight_help/src/content/docs/create-a-poll.mdx b/starlight_help/src/content/docs/create-a-poll.mdx new file mode 100644 index 0000000000..0fe4666516 --- /dev/null +++ b/starlight_help/src/content/docs/create-a-poll.mdx @@ -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" + + + +## Create a poll + + + + + + + 1. Make sure the compose box is empty. + 1. Click the **Add poll** () 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** () button, or + use a [keyboard shortcut](/help/configure-send-message-keys) to send your + message. + + + + To reorder the list of options, click and drag the **vertical dots** + () to the left of each + option. To delete an option, click the **delete** + () icon to the right of it. + + + + + + + + 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** () button, or + use a [keyboard shortcut](/help/configure-send-message-keys) to send your + message. + + + + You will be able to add options after the poll is created. + + + + +## Add options to a poll + + + To preserve the meaning of votes in the poll, existing poll options cannot + be modified. + + + + 1. Fill out the **New option** field at the bottom of the poll. + 1. Click **Add option** or press Enter to add the new option to + the poll. + + +## Edit the question + + + Only the creator of a poll can edit the question. + + + + 1. Click the **pencil** () icon + to the right of the question. + 1. Edit the question as desired. + 1. Click the **checkmark** () icon or press + Enter to save your changes. + + + + You can click the icon or press + Esc to discard your changes. + + +## Examples + + + +## Related articles + +* [Message formatting](/help/format-your-message-using-markdown) +* [Collaborative to-do lists](/help/collaborative-to-do-lists) diff --git a/starlight_help/src/content/docs/create-channels.mdx b/starlight_help/src/content/docs/create-channels.mdx new file mode 100644 index 0000000000..c00a5d8a2c --- /dev/null +++ b/starlight_help/src/content/docs/create-channels.mdx @@ -0,0 +1,39 @@ +--- +title: Create channels +--- + +import CreateAChannelInstructions from "./include/_CreateAChannelInstructions.mdx" +import CreateChannelsIntro from "./include/_CreateChannelsIntro.mdx" + + + +## How to create a channel + + + +## 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/` or `#mk/` for all channels + pertaining to the marketing team, `#help/` for + ``'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) diff --git a/starlight_help/src/content/docs/create-user-groups.mdx b/starlight_help/src/content/docs/create-user-groups.mdx new file mode 100644 index 0000000000..ff3598b700 --- /dev/null +++ b/starlight_help/src/content/docs/create-user-groups.mdx @@ -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" + + + + + +Many organizations find it helpful to create groups for: + +* Each team, e.g., “mobile”, “design”, or “IT”. +* Leadership roles, e.g., “managers”, “engineering-managers”. + + + + + +## How to create a user group + + + +## 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) diff --git a/starlight_help/src/content/docs/create-your-organization-profile.mdx b/starlight_help/src/content/docs/create-your-organization-profile.mdx new file mode 100644 index 0000000000..dd1e66d9e7 --- /dev/null +++ b/starlight_help/src/content/docs/create-your-organization-profile.mdx @@ -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" + + + +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 + + + +## Zulip communities directory + + + +### Change whether your organization may be listed in the Zulip communities directory + + + +For more details, see [Communities directory](/help/communities-directory). + +## Add a wide logo + + + +## 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) diff --git a/starlight_help/src/content/docs/custom-certificates.mdx b/starlight_help/src/content/docs/custom-certificates.mdx new file mode 100644 index 0000000000..1f17d15ded --- /dev/null +++ b/starlight_help/src/content/docs/custom-certificates.mdx @@ -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. + + + + + 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. + + + + + On Windows, Zulip Desktop shares the certificate store with + Google Chrome, so you can add certificates to it from inside + Chrome. + + + 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. + + + + + 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. + + + +### 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: + + + + + 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`). + + +[linux]: https://chromium.googlesource.com/chromium/src.git/+/main/docs/linux/cert_management.md diff --git a/starlight_help/src/content/docs/custom-emoji.mdx b/starlight_help/src/content/docs/custom-emoji.mdx new file mode 100644 index 0000000000..d8847f3807 --- /dev/null +++ b/starlight_help/src/content/docs/custom-emoji.mdx @@ -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 + + + + + 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**. + + +**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 + + + + + 1. Click the **deactivate** () icon next to the + emoji that you would like to deactivate. + + +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 + + + +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). + + + + + 1. Under **Other permissions**, configure **Who can add custom emoji**. + + + + +## Related articles + +* [Emoji and emoticons](/help/emoji-and-emoticons) +* [Emoji reactions](/help/emoji-reactions) diff --git a/starlight_help/src/content/docs/custom-profile-fields.mdx b/starlight_help/src/content/docs/custom-profile-fields.mdx new file mode 100644 index 0000000000..e5f5b41009 --- /dev/null +++ b/starlight_help/src/content/docs/custom-profile-fields.mdx @@ -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" + + + +[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 + + + + + 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. + + +## Edit a custom profile field + + + + + 1. In the **Actions** column, click the **edit** () + icon for the profile field you want to edit. + 1. Edit profile field information as desired, and click **Save changes**. + + +## Delete a custom profile field + + + + + 1. In the **Actions** column, click the **delete** () icon for the profile field you want to delete. + 1. Approve by clicking **Confirm**. + + +## Reorder custom profile fields + +Users will see custom profile fields in the specified order. + + + + + 1. In the **Labels** column, click and drag the vertical dots to reorder the + list of custom profile fields. + + +## 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. + + + + + 1. In the **Actions** column, click the **edit** () + icon for the profile field you want to edit. + 1. Toggle **Display on user card**. + 1. Click **Save changes**. + + + + 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. + + +## 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. + + + + + 1. In the **Actions** column, click the **edit** () + icon for the profile field you want to edit. + 1. Toggle **Required field**. + 1. Click **Save changes**. + + + + You can also choose which custom profile fields are required by toggling the + checkboxes in the **Required** column of the **Custom profile fields** table. + + +## Configure whether users can edit custom profile fields + + + +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. + + + + + 1. In the **Actions** column, click the **edit** () + icon for the profile field you want to configure. + 1. Toggle **Users can edit this field for their own account**. + 1. Click **Save changes**. + + +## 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 diff --git a/starlight_help/src/content/docs/customize-organization-settings.mdx b/starlight_help/src/content/docs/customize-organization-settings.mdx new file mode 100644 index 0000000000..df6596d086 --- /dev/null +++ b/starlight_help/src/content/docs/customize-organization-settings.mdx @@ -0,0 +1,46 @@ +--- +title: Customize organization settings +--- + +import ReviewOrganizationSettingsInstructions from "./include/_ReviewOrganizationSettingsInstructions.mdx" + + + +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) diff --git a/starlight_help/src/content/docs/customize-settings-for-new-users.mdx b/starlight_help/src/content/docs/customize-settings-for-new-users.mdx new file mode 100644 index 0000000000..6ce228ed41 --- /dev/null +++ b/starlight_help/src/content/docs/customize-settings-for-new-users.mdx @@ -0,0 +1,13 @@ +--- +title: Customize settings for new users +--- + +import CustomizeSettingsForNewUsers from "./include/_CustomizeSettingsForNewUsers.mdx" + + + +## 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) diff --git a/starlight_help/src/content/docs/dark-theme.mdx b/starlight_help/src/content/docs/dark-theme.mdx new file mode 100644 index 0000000000..17368fd3a8 --- /dev/null +++ b/starlight_help/src/content/docs/dark-theme.mdx @@ -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 + + + + + + + 1. Select the desired theme using the row of icons in the middle of the menu. + + + + + + + + 1. Select the desired theme. + + + + +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) diff --git a/starlight_help/src/content/docs/deactivate-a-user-group.mdx b/starlight_help/src/content/docs/deactivate-a-user-group.mdx new file mode 100644 index 0000000000..5f4152aef0 --- /dev/null +++ b/starlight_help/src/content/docs/deactivate-a-user-group.mdx @@ -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 + + + + + + + 1. Select a user group. + 1. Select the **Permissions** tab on the right. + 1. Remove all permissions. + 1. Click the **Deactivate group** () button in the + upper right corner of the user group settings panel. + 1. Click **Confirm**. + + + + +## View deactivated user groups + + + + + + + 1. Select **Deactivated groups** from the dropdown next to the **Filter** box + above the list of groups. + + + + +## Reactivate a user group + + + + + + + 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** () button in the + upper right corner of the user group settings panel. + + + + +## Related articles + +* [User groups](/help/user-groups) +* [Create user groups](/help/create-user-groups) +* [Manage user groups](/help/manage-user-groups) diff --git a/starlight_help/src/content/docs/deactivate-or-reactivate-a-bot.mdx b/starlight_help/src/content/docs/deactivate-or-reactivate-a-bot.mdx new file mode 100644 index 0000000000..79a85c0fe2 --- /dev/null +++ b/starlight_help/src/content/docs/deactivate-or-reactivate-a-bot.mdx @@ -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 + + + + + + + 1. Click the **deactivate bot** () + icon on the profile card for the bot you want to deactivate. + 1. Approve by clicking **Deactivate**. + + + + You can also click the **manage bot** () icon, scroll down to the bottom, + and click **Deactivate bot**. + + + + + + + + + + 1. In the **Actions** column, click the **deactivate bot** () icon for the bot you want to deactivate. + 1. Approve by clicking **Deactivate**. + + + + You can also click the **manage bot** () icon, scroll down to the bottom, + and click **Deactivate bot**. + + + + +## Reactivate a bot + + + + + + + 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**. + + + + + + + + + + 1. In the **Actions** column, click the **reactivate bot** () icon for the bot you want to reactivate. + 1. Approve by clicking **Confirm**. + + + + +## 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) diff --git a/starlight_help/src/content/docs/deactivate-or-reactivate-a-user.mdx b/starlight_help/src/content/docs/deactivate-or-reactivate-a-user.mdx new file mode 100644 index 0000000000..cac38d70f0 --- /dev/null +++ b/starlight_help/src/content/docs/deactivate-or-reactivate-a-user.mdx @@ -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 + + + +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 + (). +* 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. + + + 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. + + +### Deactivate a user + + + + + + + 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**. + + + + + + + + + + 1. In the **Actions** column, click the **deactivate user** () 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**. + + + + + + Organization administrators cannot deactivate organization owners. + + +## Reactivating a user + + + +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 + + + + + + + 1. Select the **Deactivated** tab. + 1. In the **Actions** column, click the **reactivate user** () icon for the user you want to reactivate. + + + + + + 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**. + + + + + + + + You may want to [review and adjust](/help/manage-user-channel-subscriptions) + the reactivated user's channel subscriptions. + + +## 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) diff --git a/starlight_help/src/content/docs/deactivate-your-account.mdx b/starlight_help/src/content/docs/deactivate-your-account.mdx new file mode 100644 index 0000000000..3a643eea25 --- /dev/null +++ b/starlight_help/src/content/docs/deactivate-your-account.mdx @@ -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. + + + 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). + + +## Deactivate your account + + + 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. + + + + + + 1. Under **Account**, click **Deactivate account**. + 1. Approve by clicking **Confirm**. + + +## 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) diff --git a/starlight_help/src/content/docs/deactivate-your-organization.mdx b/starlight_help/src/content/docs/deactivate-your-organization.mdx new file mode 100644 index 0000000000..20ee5218d9 --- /dev/null +++ b/starlight_help/src/content/docs/deactivate-your-organization.mdx @@ -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 + + + + + + + 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**. + + +## 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) diff --git a/starlight_help/src/content/docs/delete-a-message.mdx b/starlight_help/src/content/docs/delete-a-message.mdx new file mode 100644 index 0000000000..0346c751cb --- /dev/null +++ b/starlight_help/src/content/docs/delete-a-message.mdx @@ -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. + + + + + + + 1. Click the **pencil** () icon. If you do not see + the **pencil** () icon, you do not have + permission to delete the content of this message. + 1. Delete the content of the message. + 1. Click **Save**. + + + + + + + + 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**. + + + + +## 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. + + + + + + + 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**. + + + + + + You can delete messages sent by [bots that you + own](/help/view-your-bots) just like messages you sent yourself. + + +## 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) diff --git a/starlight_help/src/content/docs/delete-a-topic.mdx b/starlight_help/src/content/docs/delete-a-topic.mdx new file mode 100644 index 0000000000..a4f1de57cb --- /dev/null +++ b/starlight_help/src/content/docs/delete-a-topic.mdx @@ -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'; + + + +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 + + + + + + + 1. Click **Delete topic**. + 1. Approve by clicking **Confirm**. + + + + + 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 👍. + + + +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) diff --git a/starlight_help/src/content/docs/demo-organizations.mdx b/starlight_help/src/content/docs/demo-organizations.mdx new file mode 100644 index 0000000000..67627dbd3d --- /dev/null +++ b/starlight_help/src/content/docs/demo-organizations.mdx @@ -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" + + + **Note:** The ability to create demo organizations is an upcoming + feature. It is not available yet. + + +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 + + + 1. Go to zulip.com and click **New organization** in the top-right corner. + + +## 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. + + + + + 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**. + + +## Convert a demo organization to a permanent organization + + + +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. + + + + + 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**. + + + + **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. + + +## 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) diff --git a/starlight_help/src/content/docs/desktop-app-install-guide.mdx b/starlight_help/src/content/docs/desktop-app-install-guide.mdx new file mode 100644 index 0000000000..9a68fa9b13 --- /dev/null +++ b/starlight_help/src/content/docs/desktop-app-install-guide.mdx @@ -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 + + + + + + #### Disk image *(recommended)* + + + 1. Download [Zulip for macOS](https://zulip.com/apps/mac). + 1. Open the file, and drag the app into the **Applications** folder. + + + #### Homebrew + + + 1. Run the command `brew install --cask zulip` from a terminal. + 1. Run Zulip from **Applications**. + + + You can run the command `brew upgrade zulip` to immediately upgrade the app. + + + + #### Web installer *(recommended)* + + + + + 1. Download and run [Zulip for Windows](https://zulip.com/apps/windows). + 1. Run Zulip from the **Start** menu. + + + #### Offline installer *(for isolated networks)* + + + The app will not update automatically. You can repeat these steps to upgrade + to future versions. + + + + 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. + + + + + #### APT *(Ubuntu or Debian)* + + + 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`. + + + + 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. + + + #### AppImage *(recommended for all other distros)* + + + + + 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. + + + #### Snap + + + 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. + + + #### Flathub + + + 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 + ``` + + + + +## Install a beta release + +Get a peek at new features before they're released! + + + + + + + 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. + + + + + + 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`. + + + #### You don't have the Zulip app installed + + + 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. + + + #### You already have the Zulip app installed + + + 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. + + + + +[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) diff --git a/starlight_help/src/content/docs/desktop-notifications.mdx b/starlight_help/src/content/docs/desktop-notifications.mdx new file mode 100644 index 0000000000..3c2b9cdfc0 --- /dev/null +++ b/starlight_help/src/content/docs/desktop-notifications.mdx @@ -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). + + + + + 1. Toggle the checkboxes in the **Desktop** column of the **Notification + triggers** table. + + +## Notification sound + +You can select the sound Zulip uses for audible desktop notifications. Choosing +**None** disables all audible desktop notifications. + +### Change notification sound + + + + + 1. Under **Desktop message notifications**, configure + **Notification sound**. + + + + To hear the selected sound, click the to the right of your selection. + + +## 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 + + + + + 1. Under **Desktop message notifications**, configure + **Unread count badge**. + + +### Disable unread count badge + + + + + 1. Under **Desktop message notifications**, select **None** from the + **Unread count badge** dropdown. + + +## Testing desktop notifications + + + This does not make an unread count badge appear. + + + + + + + + 1. Under **Desktop message notifications**, click **Send a test notification**. + If notifications are working, you will receive a test notification. + + + + +## 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. + + + + + 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**. + + + Alternate instructions: + + + 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**. + + + + + + 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**. + + + + + **Windows** + + + 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. + + + **macOS** + + + 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. + + + + +## 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) diff --git a/starlight_help/src/content/docs/digest-emails.mdx b/starlight_help/src/content/docs/digest-emails.mdx new file mode 100644 index 0000000000..a8a5238d47 --- /dev/null +++ b/starlight_help/src/content/docs/digest-emails.mdx @@ -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'; + + + +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 + + + + + 1. Under **Automated messages and emails**, toggle + **Send weekly digest emails to inactive users**. + diff --git a/starlight_help/src/content/docs/direct-messages.mdx b/starlight_help/src/content/docs/direct-messages.mdx new file mode 100644 index 0000000000..9095eee89f --- /dev/null +++ b/starlight_help/src/content/docs/direct-messages.mdx @@ -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 + + + +## View your direct message conversations + +There are a few different ways to view your DM conversations. + + + + + + + + + To return to the channel list in the left sidebar, click the **back to + channels** link above the search box. + + + + + + 1. If the [user list](/help/user-list) in the right sidebar is hidden, click the + **user list** () icon in + the upper right to show it. + 1. Click on any user to view your 1:1 DM conversation. + + + + You can find a user by typing their name in the **Filter users** box at the + top of the right sidebar. + + + + + + 1. Click the **New direct message** button at the bottom of the app, or use the + X 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** () button at the top of the compose box, or use + the Ctrl + . keyboard shortcut to view that DM + conversation. + + + + + + + + 1. Tap a recent DM conversation to view it. + + + + +## Find a direct message conversation + + + + + + + + + 1. Click the **search** () 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. + + + + You can also type `dm-including` in the search box to find all 1:1 and group + DM conversations that include a particular user. + + + + +## Go to direct message feed + +You can see all your direct messages in one place. + + + +## Related articles + +* [Typing notifications](/help/typing-notifications) +* [Open the compose box](/help/open-the-compose-box) diff --git a/starlight_help/src/content/docs/disable-welcome-emails.mdx b/starlight_help/src/content/docs/disable-welcome-emails.mdx new file mode 100644 index 0000000000..8cf72fed79 --- /dev/null +++ b/starlight_help/src/content/docs/disable-welcome-emails.mdx @@ -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'; + + + +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 + + + + + 1. Under **Onboarding**, toggle + **Send emails introducing Zulip to new users**. + diff --git a/starlight_help/src/content/docs/dm-mention-alert-notifications.mdx b/starlight_help/src/content/docs/dm-mention-alert-notifications.mdx new file mode 100644 index 0000000000..40c8d78258 --- /dev/null +++ b/starlight_help/src/content/docs/dm-mention-alert-notifications.mdx @@ -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. + + + + + 1. In the **Notification triggers** table, toggle the settings for **DMs, mentions, and alerts**. + + +You can also hide the content of direct messages (and group direct +messages) from desktop notifications. + + + 1. Under **Desktop message notifications**, toggle + **Include content of direct messages in desktop notifications**. + + +## 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. + + + These mentions don't trigger notifications in muted channels or topics, + unlike personal mentions. + + + + + + 1. In the **Notification triggers** table, toggle the **@all** checkbox for + **Channels** or **Followed topics**. + + +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. + + + Alert words in messages you receive while the alert is enabled will be highlighted. + + +### Add an alert word or phrase + + + + + 1. Click **Add alert word**. + 1. Type a word or phrase, and click **Add**. + + +### Remove an alert word or phrase + + + + + 1. Click the **delete** () icon next to the + alert word that you would like to remove. + + +## 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) diff --git a/starlight_help/src/content/docs/do-not-disturb.mdx b/starlight_help/src/content/docs/do-not-disturb.mdx new file mode 100644 index 0000000000..ce139bc943 --- /dev/null +++ b/starlight_help/src/content/docs/do-not-disturb.mdx @@ -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. + + + 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. + + +## Toggle Do Not Disturb + + + + + 1. Click the **bell** () or **bell with a slash** () 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. + + + + + + +## Check whether Do Not Disturb is enabled + + + + + 1. If the **organizations sidebar** on the left shows a **bell** () icon, **Do Not Disturb** is disabled. If the **organizations + sidebar** on the left shows a **bell with a slash** () icon, **Do Not Disturb** is enabled, and you are not + receiving desktop notifications. + + + + + + +## 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) diff --git a/starlight_help/src/content/docs/edit-a-message.mdx b/starlight_help/src/content/docs/edit-a-message.mdx new file mode 100644 index 0000000000..6fa0193ac7 --- /dev/null +++ b/starlight_help/src/content/docs/edit-a-message.mdx @@ -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. + + + You can also [edit message topics](/help/rename-a-topic). + + +## Edit a message + + + + + + + 1. Click the **pencil** () icon. If you do not see + the **pencil** () icon, you do not have + permission to edit this message. + 1. Edit the content of the message. + 1. Click **Save**. + + + + + + + + 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**. + + + + + + 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. + + +## 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) diff --git a/starlight_help/src/content/docs/edit-your-profile.mdx b/starlight_help/src/content/docs/edit-your-profile.mdx new file mode 100644 index 0000000000..6e96c40a1d --- /dev/null +++ b/starlight_help/src/content/docs/edit-your-profile.mdx @@ -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 + + + + + 1. Edit the fields under **Profile**. + + +## 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) diff --git a/starlight_help/src/content/docs/email-notifications.mdx b/starlight_help/src/content/docs/email-notifications.mdx new file mode 100644 index 0000000000..f4b98257c2 --- /dev/null +++ b/starlight_help/src/content/docs/email-notifications.mdx @@ -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. + + + To enable replies via email on a self-hosted server, the [incoming email + gateway][incoming-email-gateway] must be configured by the system + administrator. + + +### Configure triggers for message notification emails + + + + + 1. Toggle the checkboxes in the **Email** column of the **Notification + triggers** table. + + +[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. + + + + + 1. Under **Email message notifications**, configure + **Include organization name in subject of message notification emails**. + + +### 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. + + + + + 1. Under **Email message notifications**, select the desired time period from the + **Delay before sending message notification emails** dropdown. + + +### 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. + + + + + 1. Under **Email message notifications**, toggle + **Include message content in message notification emails**. + + +## 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 + + + + + 1. Under **Other emails**, toggle + **Send email notifications for new logins to my account**. + + +## Low-traffic newsletter + + + This feature is only available on Zulip Cloud. + + +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 + + + + + + + 1. Under **Other emails**, toggle + **Send me Zulip's low-traffic newsletter (a few emails a year)**. + + + + +## 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) diff --git a/starlight_help/src/content/docs/emoji-and-emoticons.mdx b/starlight_help/src/content/docs/emoji-and-emoticons.mdx new file mode 100644 index 0000000000..5b9a6c0bcc --- /dev/null +++ b/starlight_help/src/content/docs/emoji-and-emoticons.mdx @@ -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' + + + + + You can also quickly respond to a message by using [emoji reactions](/help/emoji-reactions). + + +## Use an emoji in your message + + + + + + + 1. Click the **smiley face** () + 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. + + + + + + + + 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. + + + + + + + + 1. Paste an emoji copied from outside of Zulip directly into the compose box. + + + + + + You can hover over an emoji in the emoji picker, a message, or an [emoji + reaction](/help/emoji-reactions) to learn its name. + + +### Use an emoticon + +You can configure Zulip to convert emoticons into emoji, so that, e.g., `:)` +will be displayed as 🙂 . + + + + + 1. Under **Emoji settings**, select **Convert emoticons before sending**. + + +The list of supported emoticons is available +[here](/help/configure-emoticon-translations). + +## Examples + + + +## 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. + + + + + 1. [Start a new topic](/help/introduction-to-topics#how-to-start-a-new-topic). + 1. Press Command ⌘ + Control + Space + 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. + + + + + + 1. [Start a new topic](/help/introduction-to-topics#how-to-start-a-new-topic). + 1. Press Windows + . + 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. + + + + + + 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. + + + + + + 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. + + + + + + 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. + + + + [https://emojipedia.org/](https://emojipedia.org/) may be a helpful resource. + + + + +## 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. + + + + + 1. Under **Emoji**, select **Google**, + **Twitter**, **Plain text**, or **Google blobs** for the emoji theme. + + + + **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. + + +## Related articles + +* [Add custom emoji](/help/custom-emoji) +* [Emoji reactions](/help/emoji-reactions) +* [Configure emoticon translations](/help/configure-emoticon-translations) diff --git a/starlight_help/src/content/docs/emoji-reactions.mdx b/starlight_help/src/content/docs/emoji-reactions.mdx new file mode 100644 index 0000000000..55faf687ff --- /dev/null +++ b/starlight_help/src/content/docs/emoji-reactions.mdx @@ -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 + + + + + + + 1. Click the **Add emoji reaction** () icon. On messages that you sent, click on the + **ellipsis** (), + then **Add emoji reaction**. + 1. Select an emoji. Type to search, use the arrow keys, or click on an emoji + with your mouse. + + + + To add multiple reactions without closing the emoji picker, hold the + Shift key while selecting emoji. + + + + Use : to add any reaction, = to add the first + emoji reaction added by others, or + to react with 👍. + + + + + + + + 1. Select one of the emojis at the top of the menu, or tap **more** + (). + 1. Start typing the name of the emoji you want to use, and select an emoji from + the list of suggestions. + + + + +## Add or remove an existing reaction + + + + + 1. Click on an existing emoji reaction to add or remove your reaction. + + + + To make it easy to see which reactions you have added, they are + highlighted in a different color. + + + + You can also toggle the first emoji reaction on the selected message by + using the = shortcut. + + + + + + 1. Tap on an existing emoji reaction to add or remove your reaction. + + + + To make it easy to see which reactions you have added, they are + highlighted in a different color. + + + + +## 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 + + + + + 1. Hover over an emoji reaction to see who reacted with that emoji. + + + + + + + + 1. Tap **See who reacted**. + + + + +### Toggle whether names of reacting users are displayed + + + + + 1. Under **Emoji**, toggle **Display names of reacting users when few users have + reacted to a message**. + + +## View your messages with reactions + + + +## Related articles + +* [Add custom emoji](/help/custom-emoji) +* [Emoji in messages](/help/emoji-and-emoticons) diff --git a/starlight_help/src/content/docs/enable-full-width-display.mdx b/starlight_help/src/content/docs/enable-full-width-display.mdx new file mode 100644 index 0000000000..cf48473c5f --- /dev/null +++ b/starlight_help/src/content/docs/enable-full-width-display.mdx @@ -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 + + + + + 1. Under **Information**, select **Use full width on wide screens**. + diff --git a/starlight_help/src/content/docs/export-your-organization.mdx b/starlight_help/src/content/docs/export-your-organization.mdx new file mode 100644 index 0000000000..1a1f94982f --- /dev/null +++ b/starlight_help/src/content/docs/export-your-organization.mdx @@ -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" + + + 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]. + + +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 + + + + + + + + + 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). + + + + Generating the export can take up to an hour for organizations + with a large number of messages or uploaded files. + + +## Full export without member consent + + + + + + + + + 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]. + + +## Compliance export + + + +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. + + + + + 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. + + +## Configure whether administrators can export your private data + + + + + 1. Under **Privacy**, toggle **Let administrators export my private data**. + + +## 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 diff --git a/starlight_help/src/content/docs/find-administrators.mdx b/starlight_help/src/content/docs/find-administrators.mdx new file mode 100644 index 0000000000..02d819f08f --- /dev/null +++ b/starlight_help/src/content/docs/find-administrators.mdx @@ -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. + + + Organization owners can do anything that an organization administrator can do. + + + + +## Related articles + +* [User roles](/help/user-roles) +* [Customize organization settings](/help/customize-organization-settings) diff --git a/starlight_help/src/content/docs/finding-a-conversation-to-read.mdx b/starlight_help/src/content/docs/finding-a-conversation-to-read.mdx new file mode 100644 index 0000000000..f81be2b8b3 --- /dev/null +++ b/starlight_help/src/content/docs/finding-a-conversation-to-read.mdx @@ -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" + + + + + +## From the Inbox view + + + + + +## From Recent conversations + + + +## From the left sidebar + + + +## Related articles + +* [Getting started with Zulip](/help/getting-started-with-zulip) +* [Reading strategies](/help/reading-strategies) +* [Reading conversations](/help/reading-conversations) diff --git a/starlight_help/src/content/docs/follow-a-topic.mdx b/starlight_help/src/content/docs/follow-a-topic.mdx new file mode 100644 index 0000000000..dc5aa4e2b9 --- /dev/null +++ b/starlight_help/src/content/docs/follow-a-topic.mdx @@ -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 Shift + N [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: + + + +## Follow or unfollow a topic + + + + + + + + + + + + + 1. Tap **Follow topic** or **Unfollow topic**. + + + + +## Catch up on followed topics + + + + + + + 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 Enter. + 1. Return to **Inbox** when done to select the next conversation. You can use + the **back** button in your browser or the desktop app, Shift + + I, or Esc if **Inbox** is configured as you [home + view](/help/configure-home-view). + + + + You can also use Shift + N from any location to go + to the next unread followed topic. + + + + +## Search for messages in followed topics + + + + + 1. Click the **search** () 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 Enter. + + + + You can also use the / or Ctrl + K + keyboard shortcut to start searching messages. + + + + + + To get a feed of unread messages in all the topics you follow, search for + `is:followed is:unread`. + + +## 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. + + + +## Automatically follow topics + + + +## Manage configured topics + + + + + + + + + + + + + +## 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) diff --git a/starlight_help/src/content/docs/font-size.mdx b/starlight_help/src/content/docs/font-size.mdx new file mode 100644 index 0000000000..96bfb408c3 --- /dev/null +++ b/starlight_help/src/content/docs/font-size.mdx @@ -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 + + + + + + + 1. Click to increase the font size, to decrease it, and to reset to the default. + + + + +## 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. + + + + + 1. Use Ctrl + + to zoom in, Ctrl + - + to zoom out, or Ctrl + 0 to reset to default zoom. + + + + 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**. + + + + +## 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) diff --git a/starlight_help/src/content/docs/format-a-quote.mdx b/starlight_help/src/content/docs/format-a-quote.mdx new file mode 100644 index 0000000000..a96b56cc12 --- /dev/null +++ b/starlight_help/src/content/docs/format-a-quote.mdx @@ -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" + + + +## Insert quote formatting + + + + + + + 1. *(optional)* Select the text you want to format. + 1. Click the **Quote** () icon at the + bottom of the compose box to insert quote block formatting. + + + + You can also use the **Quote** () + icon to remove existing quote formatting from the selected text. + + + + + + + + 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 + ``` + + + + +## Examples + + + +## Related articles + +* [Message formatting](/help/format-your-message-using-markdown) +* [Quote message](/help/quote-or-forward-a-message) diff --git a/starlight_help/src/content/docs/format-your-message-using-markdown.mdx b/starlight_help/src/content/docs/format-your-message-using-markdown.mdx new file mode 100644 index 0000000000..c99537e45a --- /dev/null +++ b/starlight_help/src/content/docs/format-your-message-using-markdown.mdx @@ -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 + + + + + + + You can also use buttons or keyboard shortcuts (Ctrl + + B or Ctrl + I) to make text bold or italic. + [Learn more](/help/text-emphasis). + + +## Bulleted lists + + + + + + + You can also use the **Bulleted list** + () + button in the compose box to insert bulleted list formatting. + [Learn more](/help/bulleted-lists). + + +## Numbered lists + + + + + + + You can also use the **Numbered list** + () + button in the compose box to insert numbered list formatting. + [Learn more](/help/numbered-lists). + + +## Links + + + + + + + You can also use the **Link** + () + button or a keyboard shortcut (Ctrl + Shift + + L) to insert a link. [Learn more](/help/insert-a-link). + + +## Code blocks + + + + + + + You can also use the **Code** () + button in the compose box to insert code formatting. + [Learn more](/help/code-blocks). + + +## LaTeX + + + + + + + You can also use the **LaTeX** () + button in the compose box to insert LaTeX formatting. + [Learn more](/help/latex). + + +## Quotes + + + + + + + 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** () + button in the compose box to insert quote formatting. + [Learn more](/help/format-a-quote). + + +## Spoilers + + + + + + + You can also use the **Spoiler** + () button in the compose + box to insert spoiler formatting. [Learn more](/help/spoilers). + + +## Emoji and emoticons + + + + + +## Mention a user or group + + + + + +## /me action messages + + + + + +## Global times + + + + + + + You can also use the **Add global time** + () button in the compose + box to select a time from the date picker. [Learn more](/help/global-times). + + +## Tables + + + + + +## Polls + + + + + + + You can also use the **Add poll** () button in the compose box to create a + poll. [Learn more](/help/create-a-poll). + + +## Collaborative to-do lists + + + + + + + You can also use the **Add to-do list** () button in the compose box to create a + shared to-do list. [Learn more](/help/collaborative-to-do-lists). + + +## Paragraph and section formatting + + + + + +## Message formatting reference + +A summary of the formatting syntax above is available in the Zulip app. + + + + + + + + + You can also [open the compose box](/help/open-the-compose-box), and click + the **question mark** () icon + at the bottom of the compose box. + + + + +## 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) diff --git a/starlight_help/src/content/docs/gdpr-compliance.mdx b/starlight_help/src/content/docs/gdpr-compliance.mdx new file mode 100644 index 0000000000..0e73a36bf3 --- /dev/null +++ b/starlight_help/src/content/docs/gdpr-compliance.mdx @@ -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) diff --git a/starlight_help/src/content/docs/general-chat-channels.mdx b/starlight_help/src/content/docs/general-chat-channels.mdx new file mode 100644 index 0000000000..9c916fa425 --- /dev/null +++ b/starlight_help/src/content/docs/general-chat-channels.mdx @@ -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 + + + + + + + 1. Select a channel. + + + + 1. Under **Messaging permissions**, set **Allow posting to the *general chat* + topic?** to **Only “general chat” topic allowed**. + + + + + + +## Related articles + +* [Introduction to topics](/help/introduction-to-topics) +* [“*General chat*” topic](/help/general-chat-topic) +* [Require topics in channel messages](/help/require-topics) diff --git a/starlight_help/src/content/docs/general-chat-topic.mdx b/starlight_help/src/content/docs/general-chat-topic.mdx new file mode 100644 index 0000000000..185e915d69 --- /dev/null +++ b/starlight_help/src/content/docs/general-chat-topic.mdx @@ -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?”). + + + +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. + + + + + 1. Click the **new topic** () + button next to the name of the channel where you'd like to send a message. + + + + + + You can also use the C keyboard shortcut to send a message to + the channel you're viewing. + + + + + + 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. + + + + + + You can also use the C keyboard shortcut to send a message to + the channel you're viewing. + + + + +## Related articles + +* [Introduction to topics](/help/introduction-to-topics) +* [“*General chat*” channels](/help/general-chat-channels) +* [Require topics in channel messages](/help/require-topics) diff --git a/starlight_help/src/content/docs/generate-integration-url.mdx b/starlight_help/src/content/docs/generate-integration-url.mdx new file mode 100644 index 0000000000..060a7d0a3a --- /dev/null +++ b/starlight_help/src/content/docs/generate-integration-url.mdx @@ -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. + + + + + + + 1. Click the **link** () 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. + + + + You can also click the **manage bot** () icon, scroll down to the bottom, and click + **Generate URL for an integration**. + + + + + + + + + + 1. In the **Actions** column, click the **manage bot** () 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. + + + + +## 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) diff --git a/starlight_help/src/content/docs/getting-started-with-zulip.mdx b/starlight_help/src/content/docs/getting-started-with-zulip.mdx new file mode 100644 index 0000000000..08a68718ff --- /dev/null +++ b/starlight_help/src/content/docs/getting-started-with-zulip.mdx @@ -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 + + + +## Learn about Zulip topics + + + +## Reading your messages + + + +## Sending messages + +### When to start a new topic + + + +### How to start a new topic + + + +### Starting a new direct message + + + +### Responding to an existing thread + + + +### Messaging tips & tricks + + + +## Related articles + +* [Moving to Zulip](/help/moving-to-zulip) diff --git a/starlight_help/src/content/docs/global-times.mdx b/starlight_help/src/content/docs/global-times.mdx new file mode 100644 index 0000000000..860a4533c1 --- /dev/null +++ b/starlight_help/src/content/docs/global-times.mdx @@ -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' + + + +## Insert a time + + + + + + + 1. Click the **Add global time** () + 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 + Enter. + 1. Click **Confirm** to insert the selected time. + + + + + + + + 1. Type `Enter to open the date picker. + 1. Select the desired time by clicking with your mouse, or using the arrow + keys + Enter. + 1. Click **Confirm** to insert the selected time. + + + + +## Examples + + + +## 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) diff --git a/starlight_help/src/content/docs/guest-users.mdx b/starlight_help/src/content/docs/guest-users.mdx new file mode 100644 index 0000000000..c9ca054cf8 --- /dev/null +++ b/starlight_help/src/content/docs/guest-users.mdx @@ -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 + + + + + + + 1. Under **Guests**, toggle **Display “(guest)” after names of guest users**. + + + + + + +## 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. + + + + + + + 1. Under **Guests**, toggle **Warn when composing a DM to a guest**. + + + + + + +## Configure whether guests can see all other users + + + +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. + + + 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. + + + + + + + + 1. Under **Guests**, configure **Who can view all other users in the + organization**. + + + + + + +## 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) diff --git a/starlight_help/src/content/docs/hide-message-content-in-emails.mdx b/starlight_help/src/content/docs/hide-message-content-in-emails.mdx new file mode 100644 index 0000000000..cc249b41d3 --- /dev/null +++ b/starlight_help/src/content/docs/hide-message-content-in-emails.mdx @@ -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'; + + + +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 + + + + + 1. Under **Notifications security**, toggle + **Allow message content in message notification emails**. + + +## 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) diff --git a/starlight_help/src/content/docs/high-contrast-mode.mdx b/starlight_help/src/content/docs/high-contrast-mode.mdx new file mode 100644 index 0000000000..5cf2aaaa16 --- /dev/null +++ b/starlight_help/src/content/docs/high-contrast-mode.mdx @@ -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. + + + + + 1. Under **Preferences**, select **High contrast mode**. + + +## Related articles + +* [Accessibility in Zulip](https://zulip.readthedocs.io/en/stable/subsystems/accessibility.html) diff --git a/starlight_help/src/content/docs/image-video-and-website-previews.mdx b/starlight_help/src/content/docs/image-video-and-website-previews.mdx new file mode 100644 index 0000000000..793389b9a0 --- /dev/null +++ b/starlight_help/src/content/docs/image-video-and-website-previews.mdx @@ -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). + + + 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. + + + + + + + + 1. Under **Information**, select the desired option from the **Play animated + images** dropdown. + + + + +## Configure whether image and video previews are shown + + + + + + + 1. Under **Message feeed settings**, toggle **Show previews of uploaded and + linked images and videos**. + + + + +## Configure whether website previews are shown + + + + + + + 1. Under **Message feed settings**, toggle **Show previews of linked websites**. + + + + +## 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) diff --git a/starlight_help/src/content/docs/import-from-mattermost.mdx b/starlight_help/src/content/docs/import-from-mattermost.mdx new file mode 100644 index 0000000000..b83d959865 --- /dev/null +++ b/starlight_help/src/content/docs/import-from-mattermost.mdx @@ -0,0 +1,277 @@ +--- +title: Import from Mattermost +--- + +import ImportIntoAZulipCloudOrganization from "./include/_ImportIntoAZulipCloudOrganization.mdx" +import ImportGetYourOrganizationStarted from "./include/_ImportGetYourOrganizationStarted.mdx" +import FlattenedSteps from '../../components/FlattenedSteps.astro'; +import ImportIntoASelfHostedServerDescription from "./include/_ImportIntoASelfHostedServerDescription.mdx" +import ImportYourDataIntoZulip from "./include/_ImportYourDataIntoZulip.mdx" +import ImportHowUsersWillLogIn from "./include/_ImportHowUsersWillLogIn.mdx" +import ImportSelfHostedServerTips from "./include/_ImportSelfHostedServerTips.mdx" +import { Steps } from '@astrojs/starlight/components'; +import ImportZulipCloudOrganizationWarning from "./include/_ImportZulipCloudOrganizationWarning.mdx" +import ImportIntoASelfHostedServerInstructions from "./include/_ImportIntoASelfHostedServerInstructions.mdx" +import { Tabs, TabItem } from '@astrojs/starlight/components' +import ImportWorkspaceToZulip from "./include/_ImportWorkspaceToZulip.mdx" + + + +## Import process overview + +To import your Mattermost organization into Zulip, you will need to take the +following steps, which are described in more detail below: + + + 1. [Export your Mattermost data](#export-your-mattermost-data). + 1. [Import your Mattermost data into Zulip](#import-your-data-into-zulip). + 1. [Get your organization started with Zulip](#get-your-organization-started-with-zulip)! + + +## Import your organization from Mattermost into Zulip + +### Export your Mattermost data + +Mattermost's [bulk export tool](https://docs.mattermost.com/manage/bulk-export-tool.html) +allows you to export all public and private channel messages. + +The instructions below correspond to various common ways Mattermost is installed; if +yours isn't covered, [contact us](/help/contact-support) and we'll help you out. + +Replace `` and `` with the appropriate values below. + + + + + 1. SSH into your Mattermost production server. + ``` + ssh @ + ``` + 1. Navigate to the directory which contains the Mattermost executable. + On a default install of Mattermost, the directory is `/opt/mattermost/bin`. + ``` + cd /opt/mattermost/bin + ``` + 1. Create an export of all your Mattermost teams, as a tar file. + ``` + sudo ./mattermost export bulk export.json --all-teams --attachments + mkdir -p exported_emoji + tar --transform 's|^|mattermost/|' -czf export.tar.gz \ + data/ exported_emoji/ export.json + ``` + 1. Exit your shell on the Mattermost server. + `exit` + 1. Finally, copy the exported tar file from the server to your local + computer. You may need to replace `/opt/mattermost/bin/` with the + path to your Mattermost installation. + ``` + scp @:/opt/mattermost/bin/export.tar.gz . + ``` + + + + + + 1. Make sure you have [mmctl](https://github.com/mattermost/mmctl) installed - these + instructions assume your version is `7.5.1` or higher. + 1. Log into your Mattermost Cloud instance using your administrator credentials. + ``` + mmctl auth login https://yourdomain.cloud.mattermost.com + ``` + 1. Create a full export of the server, including attached files. + ``` + mmctl export create + ``` + 1. List all of the exports on the server, and copy the name of the + latest one to your clipboard. + ``` + mmctl export list + ``` + 1. Download the export to your local computer, replacing + `latest_export` with the actual file name from the previous step. + ``` + mmctl export download latest_export.zip + ``` + + + + + + 1. SSH into the server hosting your Mattermost docker container. + ``` + ssh @ + ``` + 1. Navigate to the Mattermost docker directory. On most installs, the + directory should be `mattermost-docker`. + ``` + cd mattermost-docker/ + ``` + 1. Create an export of all your Mattermost teams, as a tar file. + ``` + docker exec -it mattermost-docker_app_1 mattermost \ + export bulk data/export.json --all-teams --attachments + cd volumes/app/mattermost/data/ + mkdir -p exported_emoji + tar --transform 's|^|mattermost/|' -czf export.tar.gz \ + data/ exported_emoji/ export.json + ``` + 1. Exit your shell on the Mattermost server. + `exit` + 1. Finally, copy the exported tar file from the server to your local + computer. You may need to replace `mattermost-docker` with the + appropriate path for your installation. + ``` + scp @:mattermost-docker/volumes/app/mattermost/data/export.tar.gz . + ``` + + + + + + 1. SSH into your GitLab Omnibus server. + 1. Create an export of all your Mattermost teams, as a tar file. + ``` + cd /opt/gitlab/embedded/service/mattermost + sudo -u \ + mattermost /opt/gitlab/embedded/bin/mattermost \ + --config=/var/opt/gitlab/mattermost/config.json \ + export bulk export.json --all-teams --attachments + mkdir -p exported_emoji + tar --transform 's|^|mattermost/|' -czf export.tar.gz \ + data/ exported_emoji/ export.json + ``` + 1. Exit your shell on the GitLab Omnibus server. + `exit` + 1. Finally, copy the exported tar file from GitLab Omnibus to your local computer. + ``` + scp @:/opt/gitlab/embedded/bin/mattermost/export.tar.gz . + ``` + + + + +### Import your data into Zulip + + + + + + + + + + + + + + + + + 1. To import into an organization hosted on the root domain + (`EXTERNAL_HOST`) of the Zulip installation, run the following commands, + replacing `` with the name of the Mattermost team you want to import. + + ``` + cd /tmp + tar -xf mattermost_data.tar.gz + cd /home/zulip/deployments/current + ./scripts/stop-server + ./manage.py convert_mattermost_data /tmp/mattermost_data --output /tmp/converted_mattermost_data + ./manage.py import '' /tmp/converted_mattermost_data/ + ./scripts/start-server + ``` + Alternatively, to import into a custom subdomain, run: + ``` + cd /tmp + tar -xf mattermost_data.tar.gz + cd /home/zulip/deployments/current + ./scripts/stop-server + ./manage.py convert_mattermost_data /tmp/mattermost_data --output /tmp/converted_mattermost_data + ./manage.py import /tmp/converted_mattermost_data/ + ./scripts/start-server + ``` + 1. Follow [step 4](https://zulip.readthedocs.io/en/stable/production/install.html#step-4-configure-and-use) + of the guide for [installing a new Zulip + server](https://zulip.readthedocs.io/en/stable/production/install.html). + + + + + + + + + + 1. To import into an organization hosted on the root domain + (`EXTERNAL_HOST`) of the Zulip installation, run the following commands, + replacing `` with the name of the Mattermost team you want to import. + + ``` + unzip latest_export.zip -d /tmp/my_mattermost_export + mv /tmp/my_mattermost_export/import.jsonl /tmp/my_mattermost_export/export.json + cd /home/zulip/deployments/current + ./scripts/stop-server + ./manage.py convert_mattermost_data /tmp/my_mattermost_export --output /tmp/converted_mattermost_data + ./manage.py import '' /tmp/converted_mattermost_data/ + ./scripts/start-server + ``` + Alternatively, to import into a custom subdomain, run: + ``` + unzip latest_export.zip -d /tmp/my_mattermost_export + mv /tmp/my_mattermost_export/import.jsonl /tmp/my_mattermost_export/export.json + cd /home/zulip/deployments/current + ./scripts/stop-server + ./manage.py convert_mattermost_data /tmp/my_mattermost_export --output /tmp/converted_mattermost_data + ./manage.py import /tmp/converted_mattermost_data/ + ./scripts/start-server + ``` + 1. Follow [step 4](https://zulip.readthedocs.io/en/stable/production/install.html#step-4-configure-and-use) + of the guide for [installing a new Zulip + server](https://zulip.readthedocs.io/en/stable/production/install.html). + + + + +#### Import details + +Whether you are using Zulip Cloud or self-hosting Zulip, here are a few notes to +keep in mind about the import process: + +* Mattermost does not export workspace settings, so you will need to [configure + the settings for your Zulip organization](/help/customize-organization-settings). + This includes settings like [email + visibility](/help/configure-email-visibility), + [message editing permissions](/help/restrict-message-editing-and-deletion), + and [how users can join your organization](/help/restrict-account-creation). + +* Mattermost's user roles are mapped to Zulip's [user + roles](/help/user-roles) in the following way: + + | Mattermost role | Zulip role | + |-------------------------|---------------| + | Team administrator | Owner | + | Member | Member | + +* Mattermost's export tool does not support exporting user avatars or message + edit history. + +* Direct messages will only be imported from Mattermost workspaces containing + a single team. This is because Mattermost's data exports do not associate + direct messages with a specific Mattermost team. + +* Messages in threads are imported, but they are not explicitly marked as + being in a thread. + +## Get your organization started with Zulip + + + +## Decide how users will log in + + + +## Related articles + +* [Choosing between Zulip Cloud and self-hosting](/help/zulip-cloud-or-self-hosting) +* [Moving to Zulip](/help/moving-to-zulip) +* [Getting started with Zulip](/help/getting-started-with-zulip) diff --git a/starlight_help/src/content/docs/import-from-rocketchat.mdx b/starlight_help/src/content/docs/import-from-rocketchat.mdx new file mode 100644 index 0000000000..e842715491 --- /dev/null +++ b/starlight_help/src/content/docs/import-from-rocketchat.mdx @@ -0,0 +1,173 @@ +--- +title: Import from Rocket.Chat +--- + +import ImportIntoAZulipCloudOrganization from "./include/_ImportIntoAZulipCloudOrganization.mdx" +import ImportGetYourOrganizationStarted from "./include/_ImportGetYourOrganizationStarted.mdx" +import FlattenedSteps from '../../components/FlattenedSteps.astro'; +import ImportIntoASelfHostedServerDescription from "./include/_ImportIntoASelfHostedServerDescription.mdx" +import ImportYourDataIntoZulip from "./include/_ImportYourDataIntoZulip.mdx" +import ImportHowUsersWillLogIn from "./include/_ImportHowUsersWillLogIn.mdx" +import ImportSelfHostedServerTips from "./include/_ImportSelfHostedServerTips.mdx" +import { Steps } from '@astrojs/starlight/components'; +import ImportZulipCloudOrganizationWarning from "./include/_ImportZulipCloudOrganizationWarning.mdx" +import ImportIntoASelfHostedServerInstructions from "./include/_ImportIntoASelfHostedServerInstructions.mdx" +import { Tabs, TabItem } from '@astrojs/starlight/components' + +You can import your current workspace into a Zulip organization. It's a great +way to preserve your workspace history when you migrate to Zulip, and to make +the transition easy for the members of your organization. + +The import will include your organization's: + +* **Name** +* **Message history**, including attachments and emoji reactions +* **Users**, including names, emails, roles, and teams +* **Channels**, including discussions and all user subscriptions +* **Custom emoji** + +## Import process overview + +To import your Rocket.Chat organization into Zulip, you will need to take the +following steps, which are described in more detail below: + + + 1. [Export your Rocket.Chat data](#export-your-rocketchat-data). + 1. [Import your Rocket.Chat data into Zulip](#import-your-data-into-zulip). + 1. [Get your organization started with Zulip](#get-your-organization-started-with-zulip)! + + +## Import your organization from Rocket.Chat into Zulip + +### Export your Rocket.Chat data + +Rocket.Chat does not provide an official data export feature, so the Zulip +import tool works by importing data from a Rocket.Chat database dump. + +If you're self-hosting your Rocket.Chat instance, you can create a +database dump using the `mongodump` utility. Make sure your Rocket.Chat +server is **NOT** shut down while creating database dump using `mongodump`. + +If your organization is hosted on Rocket.Chat Cloud or another hosting +provider that doesn't provide you with database access, you will need +to request a database dump by contacting their +[support](https://docs.rocket.chat/resources/frequently-asked-questions/cloud-faqs#data-export). + +In either case, you should end up with a directory containing many +`.bson` files. + +### Import your data into Zulip + + + +At this point, you should go to the directory containing all the `.bson` files +from your database dump and rename it to `rocketchat_data`. This directory will +be your **exported data** file in the instructions below. + + + + + + + + + + + + + + + 1. To import into an organization hosted on the root domain + (`EXTERNAL_HOST`) of the Zulip installation, run the following + commands. + + ``` + cd /home/zulip/deployments/current + ./scripts/stop-server + ./manage.py convert_rocketchat_data /tmp/rocketchat_data --output /tmp/converted_rocketchat_data + ./manage.py import '' /tmp/converted_rocketchat_data + ./scripts/start-server + ``` + Alternatively, to import into a custom subdomain, run: + ``` + cd /home/zulip/deployments/current + ./scripts/stop-server + ./manage.py convert_rocketchat_data /tmp/rocketchat_data --output /tmp/converted_rocketchat_data + ./manage.py import /tmp/converted_rocketchat_data + ./scripts/start-server + ``` + 1. Follow [step 4](https://zulip.readthedocs.io/en/stable/production/install.html#step-4-configure-and-use) + of the guide for [installing a new Zulip + server](https://zulip.readthedocs.io/en/stable/production/install.html). + + + + +#### Import details + +Whether you are using Zulip Cloud or self-hosting Zulip, here are a few notes to +keep in mind about the import process: + +* Rocket.Chat does not export workspace settings, so you will need to [configure + the settings for your Zulip organization](/help/customize-organization-settings). + This includes settings like [email + visibility](/help/configure-email-visibility), + [message editing permissions](/help/restrict-message-editing-and-deletion), + and [how users can join your organization](/help/restrict-account-creation). + +* Rocket.Chat does not export user settings, so users in your organization may + want to [customize their account settings](/help/getting-started-with-zulip). + +* Rocket.Chat user roles are mapped to Zulip's [user + roles](/help/user-roles) in the following way: + + | Rocket.Chat role | Zulip role | + |------------------|------------| + | Admin | Owner | + | User | Member | + | Guest | Guest | + +* User avatars are not imported. + +* Default channels for new users are not imported. + +* Starred messages are not imported. + +* Messages longer than Zulip's limit of 10,000 characters are not + imported. + +* Livechat channels/messages are not imported. + +* Messages from Rocket.Chat Discussions are imported as topics + inside the Zulip channel corresponding to the parent channel of the + Rocket.Chat Discussion. + +* Messages from Rocket.Chat Discussions having direct channels + (i.e. direct messages) as their parent are imported as normal + direct messages in Zulip. + +* While Rocket.Chat Threads are in general imported as separate + topics, Rocket.Chat Threads within Rocket.Chat Discussions are + imported as normal messages within the topic containing that + Discussion, and Threads in Direct Messages are imported as normal + Zulip direct messages. + +Additionally, because Rocket.Chat does not provide a documented or +stable data export API, the import tool may require small changes from +time to time to account for changes in the Rocket.Chat database +format. Please [contact us](/help/contact-support) if you encounter +any problems using this tool. + +## Get your organization started with Zulip + + + +## Decide how users will log in + + + +## Related articles + +* [Choosing between Zulip Cloud and self-hosting](/help/zulip-cloud-or-self-hosting) +* [Moving to Zulip](/help/moving-to-zulip) +* [Getting started with Zulip](/help/getting-started-with-zulip) diff --git a/starlight_help/src/content/docs/import-from-slack.mdx b/starlight_help/src/content/docs/import-from-slack.mdx new file mode 100644 index 0000000000..6013d469f7 --- /dev/null +++ b/starlight_help/src/content/docs/import-from-slack.mdx @@ -0,0 +1,202 @@ +--- +title: Import from Slack +--- + +import ImportIntoAZulipCloudOrganization from "./include/_ImportIntoAZulipCloudOrganization.mdx" +import ZulipNote from '../../components/ZulipNote.astro'; +import ImportGetYourOrganizationStarted from "./include/_ImportGetYourOrganizationStarted.mdx" +import ZulipTip from '../../components/ZulipTip.astro'; +import FlattenedSteps from '../../components/FlattenedSteps.astro'; +import ImportIntoASelfHostedServerDescription from "./include/_ImportIntoASelfHostedServerDescription.mdx" +import ImportYourDataIntoZulip from "./include/_ImportYourDataIntoZulip.mdx" +import ImportHowUsersWillLogIn from "./include/_ImportHowUsersWillLogIn.mdx" +import ImportSelfHostedServerTips from "./include/_ImportSelfHostedServerTips.mdx" +import { Steps } from '@astrojs/starlight/components'; +import ImportZulipCloudOrganizationWarning from "./include/_ImportZulipCloudOrganizationWarning.mdx" +import ImportIntoASelfHostedServerInstructions from "./include/_ImportIntoASelfHostedServerInstructions.mdx" +import { Tabs, TabItem } from '@astrojs/starlight/components' +import ImportWorkspaceToZulip from "./include/_ImportWorkspaceToZulip.mdx" + + + +## Import process overview + +To import your Slack organization into Zulip, you will need to take the +following steps, which are described in more detail below: + + + 1. [Export your Slack data](#export-your-slack-data). + 1. [Import your Slack data into Zulip](#import-your-data-into-zulip). + 1. [Clean up](#clean-up-after-the-slack-export) after the Slack export. + 1. [Get your organization started with Zulip](#get-your-organization-started-with-zulip)! + + +## Import your organization from Slack into Zulip + +{/* Update link in slack_import.html when changing title below. */} + +### Export your Slack data + +Slack's [data export +service](https://slack.com/services/export) allows you to +export all public channel messages, **including older messages that may no +longer be searchable** under your Slack plan. + +Unfortunately, Slack [only +allows](https://slack.com/help/articles/201658943-Export-your-workspace-data) +workspaces that are on the **Business+** or **Enterprise Grid** plans +to export private channels and direct messages. Slack's support has +confirmed this policy as of August 2022. + +Owners of **Business+** or **Enterprise Grid** workspaces can [request +special +access](https://slack.com/help/articles/204897248-Guide-to-Slack-import-and-export-tools#options-by-plan) +in order to export direct message data. + +#### Export message history + + + 1. Make sure that you are an owner or admin of your Slack + workspace. If you are one, the Slack web application will display + that in your profile, in a banner covering the bottom of your + avatar. + 1. [Export your Slack message history](https://my.slack.com/services/export). + You should be able to download a `zip` file with your data a few minutes + after you start the export process. + + +#### Export user data and custom emoji + + + 1. Make sure that you are an owner or admin of your Slack + workspace. If you are one, the Slack web application will display + that in your profile, in a banner covering the bottom of your + avatar. + 1. [Create a new Slack app](https://api.slack.com/apps). Choose the "From + scratch" creation option. + 1. [Create a + bot user](https://api.slack.com/authentication/basics#scopes), + following the instructions to add the following OAuth scopes to your bot: + * `emoji:read` + * `users:read` + * `users:read.email` + * `team:read` + 1. [Install your new app](https://api.slack.com/authentication/basics#installing) + to your Slack workspace. + 1. You will immediately see a **Bot User OAuth Token**, which is a long + string of numbers and characters starting with `xoxb-`. Copy this token. It + grants access to download user and emoji data from your Slack workspace. + + + + You may also come across a token starting with `xoxe-`. This token cannot + be used for the Slack export process. + + +### Import your data into Zulip + + + + + + + + + 1. Your Slack **Bot User OAuth Token**, which will be a long + string of numbers and characters starting with `xoxb-`. + + + + + + + + + + + + 1. To import into an organization hosted on the root domain + (`EXTERNAL_HOST`) of the Zulip installation, run the following + commands, replacing `` with your Slack **Bot User OAuth Token**. + + ``` + cd /home/zulip/deployments/current + ./scripts/stop-server + ./manage.py convert_slack_data /tmp/slack_data.zip --token --output /tmp/converted_slack_data + ./manage.py import '' /tmp/converted_slack_data + ./scripts/start-server + ``` + Alternatively, to import into a custom subdomain, run: + ``` + cd /home/zulip/deployments/current + ./scripts/stop-server + ./manage.py convert_slack_data /tmp/slack_data.zip --token --output /tmp/converted_slack_data + ./manage.py import /tmp/converted_slack_data + ./scripts/start-server + ``` + 1. Follow [step 4](https://zulip.readthedocs.io/en/stable/production/install.html#step-4-configure-and-use) + of the guide for [installing a new Zulip + server](https://zulip.readthedocs.io/en/stable/production/install.html). + + + + +#### Import details + +Whether you are using Zulip Cloud or self-hosting Zulip, here are few notes to keep +in mind about the import process: + +* Slack does not export workspace settings, so you will need to [configure + the settings for your Zulip organization](/help/customize-organization-settings). + This includes settings like [email + visibility](/help/configure-email-visibility), + [message editing permissions](/help/restrict-message-editing-and-deletion), + and [how users can join your organization](/help/restrict-account-creation). + +* Slack does not export user settings, so users in your organization may want to + [customize their account settings](/help/getting-started-with-zulip). + +* Slack's user roles are mapped to Zulip's [user + roles](/help/user-roles) in the following way: + + | Slack role | Zulip role | + |-------------------------|---------------| + | Workspace Primary Owner | Owner | + | Workspace Owner | Owner | + | Workspace Admin | Administrator | + | Member | Member | + | Single Channel Guest | Guest | + | Multi Channel Guest | Guest | + | Channel creator | none | + +* Slack threads are imported as topics with names that include snippets of the + original message, such as "2023-05-30 Hi, can anyone reply if you're o…". + +* Message edit history and `@user joined #channel_name` messages are not imported. + +## Clean up after the Slack export + +Once your organization has been successfully imported in to Zulip, you should +delete [the Slack app](https://api.slack.com/apps) that you created in order to +[export your Slack data](#export-your-slack-data). This will prevent the OAuth +token from being used to access your Slack workspace in the future. + +## Get your organization started with Zulip + + + + + Zulip's [Slack-compatible incoming webhook](/integrations/doc/slack_incoming) + makes it easy to migrate integrations. + + +## Decide how users will log in + + + +## Related articles + +* [Choosing between Zulip Cloud and self-hosting](/help/zulip-cloud-or-self-hosting) +* [Moving to Zulip](/help/moving-to-zulip) +* [Slack-compatible incoming webhook](/integrations/doc/slack_incoming) +* [Getting started with Zulip](/help/getting-started-with-zulip) diff --git a/starlight_help/src/content/docs/import-your-settings.mdx b/starlight_help/src/content/docs/import-your-settings.mdx new file mode 100644 index 0000000000..48bb1969be --- /dev/null +++ b/starlight_help/src/content/docs/import-your-settings.mdx @@ -0,0 +1,50 @@ +--- +title: Import your settings +--- + +import { Steps } from '@astrojs/starlight/components'; +import ZulipTip from '../../components/ZulipTip.astro'; + +When you create a Zulip account using an email address already associated with +an account in another Zulip organization, on Zulip Cloud or the same self-hosted +Zulip installation, you can import your user settings from an existing account. +It's a convenient way to preserve the user settings that you've already customized. + + + Settings that may not apply to all organizations, such as custom profile + fields, will not be imported. + + +The import will include your: + +* [Name](/help/change-your-name) and [profile picture](/help/change-your-profile-picture). +* [Preferences](/help/review-your-settings#review-your-preferences), such as the + [theme](/help/dark-theme), [font size](/help/font-size), + [emoji set](/help/emoji-and-emoticons#change-your-emoji-set), and + [language](/help/change-your-language) you have configured. +* [Privacy settings](/help/review-your-settings#review-your-privacy-settings), + which include whether you let others see [when you are typing][send-typing-notifications] + or [if you have read a message][share-read-receipts]. +* [Notification settings](/help/review-your-settings#review-your-notification-settings), + which include [default notifications for channels](/help/channel-notifications), + [notifications for topics you follow](/help/topic-notifications), and + [the sound used for audible desktop notifications](/help/desktop-notifications#notification-sound). + +### Import your settings + + + 1. Follow the instructions for [joining a Zulip organization](/help/join-a-zulip-organization). + 1. From the dropdown list under **Import settings from an existing Zulip account**, + select the account from which you would like to import your settings. + 1. Complete the registration form, and click **Sign up**. + 1. *(recommended)* [Review your settings](/help/review-your-settings). + + +## Related articles + +* [Joining a Zulip organization](/help/join-a-zulip-organization) +* [Review your settings](/help/review-your-settings) + +[send-typing-notifications]: /help/typing-notifications#disable-sending-typing-notifications + +[share-read-receipts]: /help/read-receipts#configure-whether-zulip-lets-others-see-when-youve-read-messages diff --git a/starlight_help/src/content/docs/inbox.mdx b/starlight_help/src/content/docs/inbox.mdx new file mode 100644 index 0000000000..2ed3c989a0 --- /dev/null +++ b/starlight_help/src/content/docs/inbox.mdx @@ -0,0 +1,75 @@ +--- +title: Inbox +--- + +import ZulipTip from '../../components/ZulipTip.astro'; +import FlattenedSteps from '../../components/FlattenedSteps.astro'; +import InboxInstructions from "./include/_InboxInstructions.mdx" +import ConversationDefinition from "./include/_ConversationDefinition.mdx" +import KeyboardTip from '../../components/KeyboardTip.astro'; +import InboxIntro from "./include/_InboxIntro.mdx" +import GoToInbox from "./include/_GoToInbox.mdx" +import { Tabs, TabItem } from '@astrojs/starlight/components' + + + + + +Inbox is a convenient [home view](/help/configure-home-view) if you +regularly clear all unread messages in your subscribed channels. + + + To find recent conversations with no unread messages, use the [recent + conversations](/help/recent-conversations) view instead. + + +## Use your inbox + + + + + The arrow keys and vim navigation keys (J, K, + L, H) can be used to move between elements. + + +## Filter conversations + +### Filter by topic status + +In the web app, you can control whether the **Inbox** includes all topics, just +[unmuted](/help/mute-a-topic) topics, or only topics you +[follow](/help/follow-a-topic). + + + + + + + 1. Select **All topics**, **Standard view**, or **Followed topics** from + the dropdown in the upper left of the **inbox** view. + + + + +### Filter by keyword + + + + + + + 1. Use the **Filter** box at the top to find a conversation. + You can filter by channel, topic, or direct message participants. + + + + +## Related articles + +* [Reading strategies](/help/reading-strategies) +* [Recent conversations](/help/recent-conversations) +* [List of topics in a channel](/help/list-of-topics) +* [Combined feed](/help/combined-feed) +* [Mute or unmute a channel](/help/mute-a-channel) +* [Mute or unmute a topic](/help/mute-a-topic) +* [Introduction to channels](/help/introduction-to-channels) diff --git a/starlight_help/src/content/docs/include/_AddAWideLogo.mdx b/starlight_help/src/content/docs/include/_AddAWideLogo.mdx new file mode 100644 index 0000000000..7e0bacf186 --- /dev/null +++ b/starlight_help/src/content/docs/include/_AddAWideLogo.mdx @@ -0,0 +1,23 @@ +import FlattenedSteps from '../../../components/FlattenedSteps.astro'; +import CloudPaidPlansOnly from "./_CloudPaidPlansOnly.mdx" +import NavigationSteps from "../../../components/NavigationSteps.astro" + + + +You can customize the logo users see in the top left corner +of the Zulip app. For best results: + +* The logo should be a wide rectangle image with an 8:1 width to height ratio. + It will be displayed at 200×25 pixels, or more on high-resolution displays. +* Make sure your logo has a transparent background, and trim any bordering + whitespace. + +To upload a logo: + + + + + 1. Under **Organization logo**, upload a new logo. + + +Make sure to test the logo in both light theme and [dark theme](/help/dark-theme). diff --git a/starlight_help/src/content/docs/include/_AddUsersToAGroup.mdx b/starlight_help/src/content/docs/include/_AddUsersToAGroup.mdx new file mode 100644 index 0000000000..9185d4d445 --- /dev/null +++ b/starlight_help/src/content/docs/include/_AddUsersToAGroup.mdx @@ -0,0 +1,30 @@ +import FlattenedSteps from '../../../components/FlattenedSteps.astro'; +import NavigationSteps from "../../../components/NavigationSteps.astro" +import { Tabs, TabItem } from '@astrojs/starlight/components' +import RightSidebarViewProfile from "./_RightSidebarViewProfile.mdx" + + + + + + + 1. Select a user group. + 1. Select the **Members** tab on the right. + 1. Under **Add members**, enter users you want to add. You can enter a + `#channel` to add all subscribers to the group. + 1. Click **Add**. Zulip will notify everyone who is added to the group. + + + + + + + + 1. Select the **User groups** tab. + 1. Under **Add to groups**, enter the groups you want to add the user to. You + can start typing to filter suggestions. + 1. Click the **Add** button. Zulip will notify the user about the groups they've + been added to. + + + diff --git a/starlight_help/src/content/docs/include/_AdminOnly.mdx b/starlight_help/src/content/docs/include/_AdminOnly.mdx new file mode 100644 index 0000000000..b81b3e7123 --- /dev/null +++ b/starlight_help/src/content/docs/include/_AdminOnly.mdx @@ -0,0 +1,5 @@ +import ZulipNote from '../../../components/ZulipNote.astro'; + + + This feature is only available to organization owners and administrators. + diff --git a/starlight_help/src/content/docs/include/_AdvantagesOfZulipCloud.mdx b/starlight_help/src/content/docs/include/_AdvantagesOfZulipCloud.mdx new file mode 100644 index 0000000000..64c3981b47 --- /dev/null +++ b/starlight_help/src/content/docs/include/_AdvantagesOfZulipCloud.mdx @@ -0,0 +1,14 @@ +* **No setup or maintenance overhead:** Zulip Cloud is a simple SaaS solution, + so you don't need to set up your own server. It only take a minute to [sign + up](https://zulip.com/new/). +* **Always up to date:** Zulip Cloud is updated every couple of weeks with the + latest version of Zulip. In contrast, new features are + [released](https://blog.zulip.com/tag/major-releases/) for self-hosted + installations twice a year (with [maintenance + releases](https://blog.zulip.com/tag/release-announcements/) in between). +* **Operated by experts:** Zulip Cloud is operated by the core team developing + Zulip, with deep expertise in running your mission-critical chat software with + [minimal downtime](https://status.zulip.com/). +* **Free to get started:** [Zulip Cloud Free](https://zulip.com/plans/#cloud) + makes it easy to get started, and has all the features you need for casual + use. diff --git a/starlight_help/src/content/docs/include/_AppWillUpdateTip.mdx b/starlight_help/src/content/docs/include/_AppWillUpdateTip.mdx new file mode 100644 index 0000000000..b8d79f3637 --- /dev/null +++ b/starlight_help/src/content/docs/include/_AppWillUpdateTip.mdx @@ -0,0 +1,5 @@ +import ZulipTip from '../../../components/ZulipTip.astro'; + + + The app will update automatically to future versions. + diff --git a/starlight_help/src/content/docs/include/_AutomatedDmChannelSubscription.mdx b/starlight_help/src/content/docs/include/_AutomatedDmChannelSubscription.mdx new file mode 100644 index 0000000000..57a61fa1bc --- /dev/null +++ b/starlight_help/src/content/docs/include/_AutomatedDmChannelSubscription.mdx @@ -0,0 +1,6 @@ +import ZulipNote from '../../../components/ZulipNote.astro'; + + + **Note**: Subscribing someone else to a channel sends them an + automated direct message from Notification Bot. + diff --git a/starlight_help/src/content/docs/include/_AutomatedNoticeChannelEvent.mdx b/starlight_help/src/content/docs/include/_AutomatedNoticeChannelEvent.mdx new file mode 100644 index 0000000000..53a9ead6ee --- /dev/null +++ b/starlight_help/src/content/docs/include/_AutomatedNoticeChannelEvent.mdx @@ -0,0 +1,6 @@ +import ZulipNote from '../../../components/ZulipNote.astro'; + + + **Note**: This sends an automated notice from Notification Bot + to the "channel events" topic in the modified channel. + diff --git a/starlight_help/src/content/docs/include/_AutomaticBilling.mdx b/starlight_help/src/content/docs/include/_AutomaticBilling.mdx new file mode 100644 index 0000000000..a7d1f1c9c3 --- /dev/null +++ b/starlight_help/src/content/docs/include/_AutomaticBilling.mdx @@ -0,0 +1,26 @@ +import ZulipTip from '../../../components/ZulipTip.astro'; + + + Automatic license management is recommended unless you have a + specific reason to choose manual license management. + + +With automatic license management, you automatically purchase a Zulip +license for each user in your organization at the start of each billing +period (month or year), and whenever you need additional licenses. + +* [Deactivating a user](/help/deactivate-or-reactivate-a-user) frees up + their license for reuse. No refunds are given for unused licenses you + have purchased for the current billing period. For example if you start + an annual billing period with 10 users, and deactivate 4 users halfway + through the year, then you will receive no refund, even if those licenses + are not used in the remaining 6 months of the year. +* If you have no free licenses when a new user joins or an existing user + is reactivated, you will be automatically billed for an additional + license. You will be charged only for the remaining part of the + billing period. For example, if you are on a $8/user/month monthly + plan, you will be billed $4 for a user added halfway through the month. +* If you have an annual billing period, each month, you will see a + single charge for all licenses added the previous month. If you have + a monthly billing period, the charge for licenses added during the + previous month will be combined with your monthly renewal charge. diff --git a/starlight_help/src/content/docs/include/_AutomaticallyFollowTopics.mdx b/starlight_help/src/content/docs/include/_AutomaticallyFollowTopics.mdx new file mode 100644 index 0000000000..289369b7eb --- /dev/null +++ b/starlight_help/src/content/docs/include/_AutomaticallyFollowTopics.mdx @@ -0,0 +1,40 @@ +import FlattenedSteps from '../../../components/FlattenedSteps.astro'; +import NavigationSteps from "../../../components/NavigationSteps.astro" +import { Tabs, TabItem } from '@astrojs/starlight/components' + +### Follow topics you start or participate in + + + + + + + 1. Under **Topic notifications**, select the desired option from the + **Automatically follow topics based on my participation** dropdown. + + + + +### Follow topics where you are mentioned + +You can automatically follow topics where you are personally +[mentioned](/help/mention-a-user-or-group). If this setting is enabled: + +* You will automatically follow topics where you are personally mentioned, but + group mentions and wildcard mentions (**@all**, **@topic**, etc.) will not + affect topic status. +* You will automatically follow topics in [muted channels](/help/mute-a-channel) + when you are mentioned. +* Mentions will *not* cause you to automatically follow topics you have + explicitly [muted](/help/mute-a-topic). + + + + + + + 1. Under **Topic notifications**, toggle **Automatically follow topics where I'm + mentioned**. + + + diff --git a/starlight_help/src/content/docs/include/_AutomaticallyUnmuteTopicsInMutedChannels.mdx b/starlight_help/src/content/docs/include/_AutomaticallyUnmuteTopicsInMutedChannels.mdx new file mode 100644 index 0000000000..7fd84f8dca --- /dev/null +++ b/starlight_help/src/content/docs/include/_AutomaticallyUnmuteTopicsInMutedChannels.mdx @@ -0,0 +1,14 @@ +import FlattenedSteps from '../../../components/FlattenedSteps.astro'; +import NavigationSteps from "../../../components/NavigationSteps.astro" +import { Tabs, TabItem } from '@astrojs/starlight/components' + + + + + + + 1. Under **Topic notifications**, select the desired option from the + **Automatically unmute topics in muted channels** dropdown. + + + diff --git a/starlight_help/src/content/docs/include/_BulletedListsExamples.mdx b/starlight_help/src/content/docs/include/_BulletedListsExamples.mdx new file mode 100644 index 0000000000..40b3a51cda --- /dev/null +++ b/starlight_help/src/content/docs/include/_BulletedListsExamples.mdx @@ -0,0 +1,17 @@ +### What you type + +``` +* bulleted lists + * with sub-bullets too + * sub-bullets start with 2 spaces + * start sub-sub-bullets with 4 spaces +* multi +line +bullet +- dashes and ++ pluses are ok too +``` + +### What it looks like + +![Markdown bullets](../../../../../static/images/help/markdown-bullets.png) diff --git a/starlight_help/src/content/docs/include/_BulletedListsIntro.mdx b/starlight_help/src/content/docs/include/_BulletedListsIntro.mdx new file mode 100644 index 0000000000..330e93a916 --- /dev/null +++ b/starlight_help/src/content/docs/include/_BulletedListsIntro.mdx @@ -0,0 +1,3 @@ +Zulip supports Markdown formatting for bulleted lists. +You can create bulleted lists using `*`, `-`, or `+` at the start of each line. +Add two spaces before the bullet to create a nested list. diff --git a/starlight_help/src/content/docs/include/_ChangePasswordViaEmailConfirmation.mdx b/starlight_help/src/content/docs/include/_ChangePasswordViaEmailConfirmation.mdx new file mode 100644 index 0000000000..36f342ec61 --- /dev/null +++ b/starlight_help/src/content/docs/include/_ChangePasswordViaEmailConfirmation.mdx @@ -0,0 +1,11 @@ +import { Steps } from '@astrojs/starlight/components'; + + + 1. If you are logged in, start by [logging out](/help/logging-out). + 1. Go to your organization's login page at `https:///login/`. + 1. Click the **Forgot your password?** link below the **Log in** button or + buttons. + 1. Enter your email address, and click **Send reset link**. + 1. You will receive a confirmation email within a few minutes. Open it and click + **Reset password**. + diff --git a/starlight_help/src/content/docs/include/_ChannelActions.mdx b/starlight_help/src/content/docs/include/_ChannelActions.mdx new file mode 100644 index 0000000000..4ec053821f --- /dev/null +++ b/starlight_help/src/content/docs/include/_ChannelActions.mdx @@ -0,0 +1,4 @@ +import MoreVerticalIcon from "~icons/zulip-icon/more-vertical" + +1. Hover over a channel in the left sidebar. +1. Click on the **ellipsis** (). diff --git a/starlight_help/src/content/docs/include/_ChannelAdminPermissions.mdx b/starlight_help/src/content/docs/include/_ChannelAdminPermissions.mdx new file mode 100644 index 0000000000..1bb1e304e6 --- /dev/null +++ b/starlight_help/src/content/docs/include/_ChannelAdminPermissions.mdx @@ -0,0 +1,27 @@ +Organization administrators and [channel +administrators](/help/configure-who-can-administer-a-channel) can see and manage +metadata for private channels. However, if they aren't subscribed to a private +channel, they cannot gain access to its content, or grant access to others, +unless specifically permitted to do so. + +This means organization administrators and [channel +administrators](/help/configure-who-can-administer-a-channel) can: + +* See and modify the channel's [name](/help/rename-a-channel) and [description](/help/change-the-channel-description). +* See who is subscribed to the channel, and + [unsubscribe](/help/unsubscribe-users-from-a-channel) them. +* Move the channel to another [folder](/help/channel-folders). +* See the channel's permissions settings, and modify settings that do not affect + content access (e.g., [who can post](/help/channel-posting-policy) or [message + retention policy](/help/message-retention-policy)). +* See how much message traffic the channel gets (but not its contents). +* [Archive](/help/archive-a-channel) the channel. + +However, the following actions require specific permissions. + +* **Seeing messages and topics**: Restricted to channel subscribers, and user + who are allowed to subscribe themselves or any user. +* Subscribing [yourself](/help/configure-who-can-subscribe) or [other + users](/help/configure-who-can-invite-to-channels) +* Modifying settings that affect content access (e.g., making a channel + public, or changing who can add subscribers). diff --git a/starlight_help/src/content/docs/include/_ChannelFoldersIntro.mdx b/starlight_help/src/content/docs/include/_ChannelFoldersIntro.mdx new file mode 100644 index 0000000000..c5c237755e --- /dev/null +++ b/starlight_help/src/content/docs/include/_ChannelFoldersIntro.mdx @@ -0,0 +1,9 @@ +Organizations can sort channels into folders. For example, you can put all the +channels associated with a team into a dedicated folder. Channels will be +grouped into folders in the [**Inbox**](/help/inbox) view, and users can +[decide](/help/channel-folders#configure-whether-channels-are-grouped-by-folder-in-the-left-sidebar) +whether to group them by folder in the [left sidebar](/help/left-sidebar). + +Everyone can [pin channels](/help/pin-a-channel) they personally want to pay +close attention to. Pinned channels appear in a dedicated **pinned channels** +section above channel folders. diff --git a/starlight_help/src/content/docs/include/_ChannelLongPressMenu.mdx b/starlight_help/src/content/docs/include/_ChannelLongPressMenu.mdx new file mode 100644 index 0000000000..cdd24a9bf5 --- /dev/null +++ b/starlight_help/src/content/docs/include/_ChannelLongPressMenu.mdx @@ -0,0 +1 @@ +1. Press and hold a channel until the long-press menu appears. diff --git a/starlight_help/src/content/docs/include/_ChannelLongPressMenuTip.mdx b/starlight_help/src/content/docs/include/_ChannelLongPressMenuTip.mdx new file mode 100644 index 0000000000..33aebbb854 --- /dev/null +++ b/starlight_help/src/content/docs/include/_ChannelLongPressMenuTip.mdx @@ -0,0 +1,6 @@ +import ZulipTip from '../../../components/ZulipTip.astro'; + + + If you are in a channel view, you can access the long-press + menu from the bar at the top of the app. + diff --git a/starlight_help/src/content/docs/include/_ChannelMenuSubscribersTabTip.mdx b/starlight_help/src/content/docs/include/_ChannelMenuSubscribersTabTip.mdx new file mode 100644 index 0000000000..d73af22341 --- /dev/null +++ b/starlight_help/src/content/docs/include/_ChannelMenuSubscribersTabTip.mdx @@ -0,0 +1,8 @@ +import MoreVerticalIcon from "~icons/zulip-icon/more-vertical" +import ZulipTip from '../../../components/ZulipTip.astro'; + + + You can also hover over a channel in the left sidebar, click on the + **ellipsis** (), and + select **Channel settings** to access the **Subscribers** tab. + diff --git a/starlight_help/src/content/docs/include/_ChannelNameLongPressMenu.mdx b/starlight_help/src/content/docs/include/_ChannelNameLongPressMenu.mdx new file mode 100644 index 0000000000..cae3b03a4a --- /dev/null +++ b/starlight_help/src/content/docs/include/_ChannelNameLongPressMenu.mdx @@ -0,0 +1 @@ +1. Press and hold a channel name until the long-press menu appears. diff --git a/starlight_help/src/content/docs/include/_ChannelNameLongPressMenuTip.mdx b/starlight_help/src/content/docs/include/_ChannelNameLongPressMenuTip.mdx new file mode 100644 index 0000000000..0694d91285 --- /dev/null +++ b/starlight_help/src/content/docs/include/_ChannelNameLongPressMenuTip.mdx @@ -0,0 +1,6 @@ +import ZulipTip from '../../../components/ZulipTip.astro'; + + + You can also press and hold the name of a channel in Inbox and channel views + to access the long-press menu. + diff --git a/starlight_help/src/content/docs/include/_ChannelPrivacyTypes.mdx b/starlight_help/src/content/docs/include/_ChannelPrivacyTypes.mdx new file mode 100644 index 0000000000..d4bf53fe19 --- /dev/null +++ b/starlight_help/src/content/docs/include/_ChannelPrivacyTypes.mdx @@ -0,0 +1,17 @@ +import HashtagIcon from "~icons/zulip-icon/hashtag" +import GlobeIcon from "~icons/zulip-icon/globe" +import LockIcon from "~icons/zulip-icon/lock" + +There are three types of channels in Zulip: + +* [Private channels](/help/channel-permissions#private-channels) + (indicated by ), where + joining and viewing messages requires being invited. You can choose + whether new subscribers can see messages sent before they were + subscribed. +* [Public channels](/help/channel-permissions#public-channels) + (indicated by ), which + are open to everyone in your organization other than guests. +* [Web-public channels](/help/channel-permissions#web-public-channels) + (indicated by ), where + anyone on the Internet can see messages without creating an account. diff --git a/starlight_help/src/content/docs/include/_ChannelSettingsGeneralTabTip.mdx b/starlight_help/src/content/docs/include/_ChannelSettingsGeneralTabTip.mdx new file mode 100644 index 0000000000..19dfa85cb1 --- /dev/null +++ b/starlight_help/src/content/docs/include/_ChannelSettingsGeneralTabTip.mdx @@ -0,0 +1,8 @@ +import MoreVerticalIcon from "~icons/zulip-icon/more-vertical" +import ZulipTip from '../../../components/ZulipTip.astro'; + + + You can also hover over a channel in the left sidebar, click on the + **ellipsis** (), and + select **Channel settings** to access the **General** tab. + diff --git a/starlight_help/src/content/docs/include/_ChannelsIntro.mdx b/starlight_help/src/content/docs/include/_ChannelsIntro.mdx new file mode 100644 index 0000000000..867fbb5ba9 --- /dev/null +++ b/starlight_help/src/content/docs/include/_ChannelsIntro.mdx @@ -0,0 +1,5 @@ +Channels organize conversations based on who needs to see them. For example, +it's common to have a channel for each team in an organization. Because Zulip +further organizes messages into conversations labeled with +[topics](/help/introduction-to-topics), there is generally no need to create +dedicated channels for specific projects. diff --git a/starlight_help/src/content/docs/include/_ClearStatus.mdx b/starlight_help/src/content/docs/include/_ClearStatus.mdx new file mode 100644 index 0000000000..50f06dfd21 --- /dev/null +++ b/starlight_help/src/content/docs/include/_ClearStatus.mdx @@ -0,0 +1,4 @@ +import XCircleIcon from "~icons/zulip-icon/x-circle" + +1. Click on the to the + right of your current status. diff --git a/starlight_help/src/content/docs/include/_CloudPaidPlansOnly.mdx b/starlight_help/src/content/docs/include/_CloudPaidPlansOnly.mdx new file mode 100644 index 0000000000..8252aa4748 --- /dev/null +++ b/starlight_help/src/content/docs/include/_CloudPaidPlansOnly.mdx @@ -0,0 +1,7 @@ +import ZulipNote from '../../../components/ZulipNote.astro'; + + + Zulip Cloud customers who wish to use this feature must upgrade to + [Zulip Cloud Standard](https://zulip.com/plans/) or [Zulip Cloud + Plus](https://zulip.com/plans/). + diff --git a/starlight_help/src/content/docs/include/_CloudPlusOnly.mdx b/starlight_help/src/content/docs/include/_CloudPlusOnly.mdx new file mode 100644 index 0000000000..ac198d9f6f --- /dev/null +++ b/starlight_help/src/content/docs/include/_CloudPlusOnly.mdx @@ -0,0 +1,6 @@ +import ZulipNote from '../../../components/ZulipNote.astro'; + + + Zulip Cloud customers who wish to use this feature must upgrade to + the [Zulip Cloud Plus](https://zulip.com/plans/) plan. + diff --git a/starlight_help/src/content/docs/include/_CodeBlocksExamples.mdx b/starlight_help/src/content/docs/include/_CodeBlocksExamples.mdx new file mode 100644 index 0000000000..80540418bd --- /dev/null +++ b/starlight_help/src/content/docs/include/_CodeBlocksExamples.mdx @@ -0,0 +1,34 @@ +import ZulipTip from '../../../components/ZulipTip.astro'; + +### What you type + +```` +Inline code span: `let x = 5` + +Code block: +``` +def f(x): + return x+1 +``` + +Syntax highlighting: +```python +def fib(n): + # TODO: base case + return fib(n-1) + fib(n-2) +``` +```` + + + You can also use `~~~` to start code blocks, or just indent the code 4 or more + spaces. + + +### What it looks like + +![Markdown code](../../../../../static/images/help/markdown-code.png) + + + A widget in the top right corner of code blocks allows you to easily + copy code to your clipboard. + diff --git a/starlight_help/src/content/docs/include/_CodeBlocksIntro.mdx b/starlight_help/src/content/docs/include/_CodeBlocksIntro.mdx new file mode 100644 index 0000000000..c3c83381d5 --- /dev/null +++ b/starlight_help/src/content/docs/include/_CodeBlocksIntro.mdx @@ -0,0 +1,4 @@ +You can write snippets of code, code blocks, and other text in a fixed-width +font using standard Markdown formatting. Zulip also has [syntax +highlighting](/help/code-blocks#language-tagging) and supports configuring +custom [code playgrounds](/help/code-blocks#code-playgrounds). diff --git a/starlight_help/src/content/docs/include/_CombinedFeed.mdx b/starlight_help/src/content/docs/include/_CombinedFeed.mdx new file mode 100644 index 0000000000..62e4356193 --- /dev/null +++ b/starlight_help/src/content/docs/include/_CombinedFeed.mdx @@ -0,0 +1,28 @@ +import AllMessagesIcon from "~icons/zulip-icon/all-messages" +import { Steps } from '@astrojs/starlight/components'; +import GoToCombinedFeed from "./_GoToCombinedFeed.mdx" +import FlattenedSteps from '../../../components/FlattenedSteps.astro'; +import { Tabs, TabItem } from '@astrojs/starlight/components' + +The **Combined feed** view is a feed of all the unmuted messages you have +received, which combines channel messages and direct messages. It's a great way +to see new messages as they come in. + +You can configure **Combined feed** to be the [home +view](/help/configure-home-view#configure-home-view) for the Zulip web app. + + + + + + + + + + + 1. Tap the **Combined feed** + () + tab at the bottom of the app. + + + diff --git a/starlight_help/src/content/docs/include/_CommunitiesDirectoryInstructions.mdx b/starlight_help/src/content/docs/include/_CommunitiesDirectoryInstructions.mdx new file mode 100644 index 0000000000..04027638ef --- /dev/null +++ b/starlight_help/src/content/docs/include/_CommunitiesDirectoryInstructions.mdx @@ -0,0 +1,14 @@ +import FlattenedSteps from '../../../components/FlattenedSteps.astro'; +import NavigationSteps from "../../../components/NavigationSteps.astro" +import SaveChanges from "./_SaveChanges.mdx" + + + + + 1. To be listed in the appropriate category, under **Organization type**, select + the option that best fits your organization. + 1. Toggle **Advertise organization in the Zulip communities + directory**. + + + diff --git a/starlight_help/src/content/docs/include/_CommunitiesDirectoryIntro.mdx b/starlight_help/src/content/docs/include/_CommunitiesDirectoryIntro.mdx new file mode 100644 index 0000000000..6c4f04469a --- /dev/null +++ b/starlight_help/src/content/docs/include/_CommunitiesDirectoryIntro.mdx @@ -0,0 +1,14 @@ +The [Zulip communities directory](https://zulip.com/communities/) offers +publicly accessible [Zulip Cloud][zulip-cloud] organizations an opportunity to +be listed on the [Zulip website](https://zulip.com). It's a way for [open-source +projects](https://zulip.com/for/open-source/), [research +communities](https://zulip.com/for/research/), and +[others](https://zulip.com/for/communities/) to advertise their Zulip community +and support the Zulip project. + +The directory will display your community's name, logo, and a link to you Zulip +chat. Other information from your [organization +profile](/help/create-your-organization-profile) and the size of your +organization may be included as well. + +[zulip-cloud]: https://zulip.com/plans/ diff --git a/starlight_help/src/content/docs/include/_ComposeAndSendMessage.mdx b/starlight_help/src/content/docs/include/_ComposeAndSendMessage.mdx new file mode 100644 index 0000000000..2ace8b9247 --- /dev/null +++ b/starlight_help/src/content/docs/include/_ComposeAndSendMessage.mdx @@ -0,0 +1,8 @@ +import SendIcon from "~icons/zulip-icon/send" + +1. Click on the compose box, or press Tab to compose your message. You + can [preview your message](/help/preview-your-message-before-sending) before + sending. +1. Click the **Send** () button, or + use a [keyboard shortcut](/help/configure-send-message-keys) to send your + message. diff --git a/starlight_help/src/content/docs/include/_ConfigureChannelLinks.mdx b/starlight_help/src/content/docs/include/_ConfigureChannelLinks.mdx new file mode 100644 index 0000000000..6edc2ef93c --- /dev/null +++ b/starlight_help/src/content/docs/include/_ConfigureChannelLinks.mdx @@ -0,0 +1,18 @@ +import FlattenedSteps from '../../../components/FlattenedSteps.astro'; +import NavigationSteps from "../../../components/NavigationSteps.astro" +import { Tabs, TabItem } from '@astrojs/starlight/components' + +You can configure whether channel links in the [left +sidebar](/help/left-sidebar) go to the channel feed, a list of topics in the +channel, the top topic, or the top unread topic. + + + + + + + 1. Under **Navigation**, select your preferred option from the + **Channel links in the left sidebar go to** dropdown. + + + diff --git a/starlight_help/src/content/docs/include/_ConfigureNotificationsForFollowedTopics.mdx b/starlight_help/src/content/docs/include/_ConfigureNotificationsForFollowedTopics.mdx new file mode 100644 index 0000000000..f41544d4f5 --- /dev/null +++ b/starlight_help/src/content/docs/include/_ConfigureNotificationsForFollowedTopics.mdx @@ -0,0 +1,21 @@ +import FlattenedSteps from '../../../components/FlattenedSteps.astro'; +import NavigationSteps from "../../../components/NavigationSteps.astro" +import { Tabs, TabItem } from '@astrojs/starlight/components' +import ZulipTip from '../../../components/ZulipTip.astro'; + + + + + + + 1. In the **Notification triggers** table, + toggle the settings for **Followed topics**. + + + + + + You will receive both followed topics notifications and + [channel notifications](/help/channel-notifications) in + topics you follow. + diff --git a/starlight_help/src/content/docs/include/_ConfigureResolvedNoticesMarkedAsRead.mdx b/starlight_help/src/content/docs/include/_ConfigureResolvedNoticesMarkedAsRead.mdx new file mode 100644 index 0000000000..374b811c36 --- /dev/null +++ b/starlight_help/src/content/docs/include/_ConfigureResolvedNoticesMarkedAsRead.mdx @@ -0,0 +1,18 @@ +import FlattenedSteps from '../../../components/FlattenedSteps.astro'; +import NavigationSteps from "../../../components/NavigationSteps.astro" +import { Tabs, TabItem } from '@astrojs/starlight/components' + +Zulip lets you automatically mark as read Notification Bot notices +indicating that someone [resolved or unresolved](/help/resolve-a-topic) +a topic, or do so just for topics you don't follow. + + + + + + + 1. Under **Topic notifications**, configure **Automatically mark resolved topic + notices as read**. + + + diff --git a/starlight_help/src/content/docs/include/_ConfigureTopicNotificationsDesktopWeb.mdx b/starlight_help/src/content/docs/include/_ConfigureTopicNotificationsDesktopWeb.mdx new file mode 100644 index 0000000000..fbad84ce65 --- /dev/null +++ b/starlight_help/src/content/docs/include/_ConfigureTopicNotificationsDesktopWeb.mdx @@ -0,0 +1,21 @@ +import FollowIcon from "~icons/zulip-icon/follow" +import TopicActions from "./_TopicActions.mdx" +import MuteIcon from "~icons/zulip-icon/mute" +import InheritIcon from "~icons/zulip-icon/inherit" +import UnmuteIcon from "~icons/zulip-icon/unmute" +import ZulipTip from '../../../components/ZulipTip.astro'; +import FlattenedSteps from '../../../components/FlattenedSteps.astro'; + + + + + 1. Configure topic notifications using the row of icons at the top of the menu. + + + + You can also configure notifications by clicking the topic notifications + status icon (, + , + , or + ) wherever it appears. + diff --git a/starlight_help/src/content/docs/include/_ConfigureWhoCanManagePlans.mdx b/starlight_help/src/content/docs/include/_ConfigureWhoCanManagePlans.mdx new file mode 100644 index 0000000000..b8304c3880 --- /dev/null +++ b/starlight_help/src/content/docs/include/_ConfigureWhoCanManagePlans.mdx @@ -0,0 +1,16 @@ +import FlattenedSteps from '../../../components/FlattenedSteps.astro'; +import NavigationSteps from "../../../components/NavigationSteps.astro" +import { Tabs, TabItem } from '@astrojs/starlight/components' +import SaveChanges from "./_SaveChanges.mdx" + + + + + + + 1. Under **Other permissions**, configure **Who can manage plans and billing**. + + + + + diff --git a/starlight_help/src/content/docs/include/_ContentAccessDefinition.mdx b/starlight_help/src/content/docs/include/_ContentAccessDefinition.mdx new file mode 100644 index 0000000000..514c4cd063 --- /dev/null +++ b/starlight_help/src/content/docs/include/_ContentAccessDefinition.mdx @@ -0,0 +1,5 @@ +* They are subscribed to the channel, or +* They have the permission to add subscribers + ([themselves](/help/configure-who-can-subscribe) or + [others](/help/configure-who-can-invite-to-channels#configure-who-can-subscribe-anyone-to-a-specific-channel)) + to the channel. diff --git a/starlight_help/src/content/docs/include/_ConversationDefinition.mdx b/starlight_help/src/content/docs/include/_ConversationDefinition.mdx new file mode 100644 index 0000000000..34726386e9 --- /dev/null +++ b/starlight_help/src/content/docs/include/_ConversationDefinition.mdx @@ -0,0 +1,3 @@ +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). diff --git a/starlight_help/src/content/docs/include/_ConversationRecommendation.mdx b/starlight_help/src/content/docs/include/_ConversationRecommendation.mdx new file mode 100644 index 0000000000..1dcf4ff033 --- /dev/null +++ b/starlight_help/src/content/docs/include/_ConversationRecommendation.mdx @@ -0,0 +1 @@ +It generally works best to read your messages organized by conversation. diff --git a/starlight_help/src/content/docs/include/_CreateAChannelInstructions.mdx b/starlight_help/src/content/docs/include/_CreateAChannelInstructions.mdx new file mode 100644 index 0000000000..7bb7733511 --- /dev/null +++ b/starlight_help/src/content/docs/include/_CreateAChannelInstructions.mdx @@ -0,0 +1,37 @@ +import NavigationSteps from "../../../components/NavigationSteps.astro" +import ZulipNote from '../../../components/ZulipNote.astro'; +import FlattenedSteps from '../../../components/FlattenedSteps.astro'; +import SquarePlusIcon from "~icons/zulip-icon/square-plus" +import { Tabs, TabItem } from '@astrojs/starlight/components' + + + + + + + 1. Click **Create channel** on the right, or click the + **create new channel** () + icon in the upper right. + 1. Fill out the requested information. + 1. *(optional)* Click on **Advanced configuration** to review and update + additional channel settings. + 1. Click **Continue to add subscribers**. + 1. Add users who will be subscribed to the channel, and click **Create**. + + + + **Note**: You will only see the **Create channel** button if you have + permission to create channels. + + + + + 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/1572). If + you're interested in this feature, please react to the issue's + description with 👍. + + diff --git a/starlight_help/src/content/docs/include/_CreateChannelsIntro.mdx b/starlight_help/src/content/docs/include/_CreateChannelsIntro.mdx new file mode 100644 index 0000000000..63295d055c --- /dev/null +++ b/starlight_help/src/content/docs/include/_CreateChannelsIntro.mdx @@ -0,0 +1,16 @@ +import ChannelsIntro from "./_ChannelsIntro.mdx" +import ZulipTip from '../../../components/ZulipTip.astro'; + + + +We recommend setting up some channels before inviting other users to +join Zulip, so that you can [automatically subscribe +everyone](/help/set-default-channels-for-new-users) to the right set of +channels. + +If you later create additional channels, no worries! You can always subscribe +a group of users, or all the subscribers of another channel, to a new channel. + + + Add clear descriptions to your channels, especially public channels. + diff --git a/starlight_help/src/content/docs/include/_CustomizeSettingsForNewUsers.mdx b/starlight_help/src/content/docs/include/_CustomizeSettingsForNewUsers.mdx new file mode 100644 index 0000000000..9aaf5d64cb --- /dev/null +++ b/starlight_help/src/content/docs/include/_CustomizeSettingsForNewUsers.mdx @@ -0,0 +1,12 @@ +Customize settings for new users to get them off to a great start. + +* [Add custom profile fields](/help/custom-profile-fields#add-a-custom-profile-field), such as pronouns + or job title. +* [Configure default new user settings][default-user-settings]. +* [Set default channels for new users](/help/set-default-channels-for-new-users). +* [Set organization language for automated messages and invitation emails][org-lang], + if it should be something other than American English. + +[org-lang]: /help/configure-organization-language + +[default-user-settings]: /help/configure-default-new-user-settings diff --git a/starlight_help/src/content/docs/include/_DependsOnPermissions.mdx b/starlight_help/src/content/docs/include/_DependsOnPermissions.mdx new file mode 100644 index 0000000000..e68853cf89 --- /dev/null +++ b/starlight_help/src/content/docs/include/_DependsOnPermissions.mdx @@ -0,0 +1,6 @@ +import ZulipNote from '../../../components/ZulipNote.astro'; + + + You will see the options described only if you have permission + to take this action. + diff --git a/starlight_help/src/content/docs/include/_DesktopSidebarSettingsMenu.mdx b/starlight_help/src/content/docs/include/_DesktopSidebarSettingsMenu.mdx new file mode 100644 index 0000000000..5299b610df --- /dev/null +++ b/starlight_help/src/content/docs/include/_DesktopSidebarSettingsMenu.mdx @@ -0,0 +1,3 @@ +import CogIcon from "~icons/fa/cog" + +1. Click the **gear** () icon in the bottom left corner of the app. diff --git a/starlight_help/src/content/docs/include/_DesktopToggleSidebarTip.mdx b/starlight_help/src/content/docs/include/_DesktopToggleSidebarTip.mdx new file mode 100644 index 0000000000..de3e9846b0 --- /dev/null +++ b/starlight_help/src/content/docs/include/_DesktopToggleSidebarTip.mdx @@ -0,0 +1,6 @@ +import ZulipTip from '../../../components/ZulipTip.astro'; + + + To show or hide the **organizations sidebar** on the left, select + **Toggle Sidebar** from the **View** menu in the top menu bar. + diff --git a/starlight_help/src/content/docs/include/_DmFeedInstructions.mdx b/starlight_help/src/content/docs/include/_DmFeedInstructions.mdx new file mode 100644 index 0000000000..93afbfacc8 --- /dev/null +++ b/starlight_help/src/content/docs/include/_DmFeedInstructions.mdx @@ -0,0 +1,22 @@ +import { Steps } from '@astrojs/starlight/components'; +import AllMessagesIcon from "~icons/zulip-icon/all-messages" +import { Tabs, TabItem } from '@astrojs/starlight/components' +import ZulipTip from '../../../components/ZulipTip.astro'; + + + + + 1. In the left sidebar, click the **Direct message feed** + () icon to the right of the + **direct messages** heading, or use the Shift + P + keyboard shortcut. + 1. Read your direct messages, starting from your first unread message. You can + scroll using your mouse, the arrow keys, End, or page up/down. + + + + You can click on a conversation in the left sidebar or a message recipient + bar to view that conversation. + + + diff --git a/starlight_help/src/content/docs/include/_EditOrganizationProfile.mdx b/starlight_help/src/content/docs/include/_EditOrganizationProfile.mdx new file mode 100644 index 0000000000..76ad806f99 --- /dev/null +++ b/starlight_help/src/content/docs/include/_EditOrganizationProfile.mdx @@ -0,0 +1,14 @@ +import FlattenedSteps from '../../../components/FlattenedSteps.astro'; +import NavigationSteps from "../../../components/NavigationSteps.astro" +import SaveChanges from "./_SaveChanges.mdx" + + + + + 1. Edit your organization **name**, **type**, **description**, and + **profile picture**. + 1. *(optional)* Click **Preview organization profile** to see a preview of your + organization's login page in a new browser tab. + + + diff --git a/starlight_help/src/content/docs/include/_EmojiAndEmoticonsExamples.mdx b/starlight_help/src/content/docs/include/_EmojiAndEmoticonsExamples.mdx new file mode 100644 index 0000000000..25994105e2 --- /dev/null +++ b/starlight_help/src/content/docs/include/_EmojiAndEmoticonsExamples.mdx @@ -0,0 +1,9 @@ +### What you type + +``` +:octopus: :heart: :zulip: :) +``` + +### What it looks like + +![Markdown emoji](../../../../../static/images/help/markdown-emoji.png) diff --git a/starlight_help/src/content/docs/include/_EmojiAndEmoticonsIntro.mdx b/starlight_help/src/content/docs/include/_EmojiAndEmoticonsIntro.mdx new file mode 100644 index 0000000000..c250da2080 --- /dev/null +++ b/starlight_help/src/content/docs/include/_EmojiAndEmoticonsIntro.mdx @@ -0,0 +1,13 @@ +You can use emoji in Zulip messages and [topics](/help/introduction-to-topics). +There are several ways to use an emoji in your message: + +* [Enter an emoji name](/help/emoji-and-emoticons#use-an-emoji-in-your-message) + surrounded by `:`, with help from autocomplete suggestions. +* [Select an emoji from the emoji + picker](/help/emoji-and-emoticons#use-an-emoji-in-your-message) +* [Use an emoticon](/help/emoji-and-emoticons#use-an-emoticon) +* [Paste an emoji](/help/emoji-and-emoticons#use-an-emoji-in-your-message) + +You can [add custom emoji](/help/custom-emoji) for your organization. Like +default emoji, custom emoji can be entered into the compose box by name, or +selected from the emoji picker. diff --git a/starlight_help/src/content/docs/include/_EmphasisExamples.mdx b/starlight_help/src/content/docs/include/_EmphasisExamples.mdx new file mode 100644 index 0000000000..50a6ca1234 --- /dev/null +++ b/starlight_help/src/content/docs/include/_EmphasisExamples.mdx @@ -0,0 +1,10 @@ +### What you type + +``` +**bold**, *italic*, and ~~strikethrough~~ text +***~~All three at once~~*** +``` + +### What it looks like + +![Markdown emphasis](../../../../../static/images/help/markdown-emphasis.png) diff --git a/starlight_help/src/content/docs/include/_EmphasisIntro.mdx b/starlight_help/src/content/docs/include/_EmphasisIntro.mdx new file mode 100644 index 0000000000..c775410e05 --- /dev/null +++ b/starlight_help/src/content/docs/include/_EmphasisIntro.mdx @@ -0,0 +1 @@ +In Zulip, you can make text bold or italic, or cross it out with strikethrough. diff --git a/starlight_help/src/content/docs/include/_ExportWithoutConsentRequirements.mdx b/starlight_help/src/content/docs/include/_ExportWithoutConsentRequirements.mdx new file mode 100644 index 0000000000..a902d20543 --- /dev/null +++ b/starlight_help/src/content/docs/include/_ExportWithoutConsentRequirements.mdx @@ -0,0 +1,13 @@ +To perform this export, your organization must meet the following requirements: + +* You are a paid [Zulip Cloud Standard](https://zulip.com/plans/) or [Zulip + Cloud Plus](https://zulip.com/plans/) customer. In rare cases, exceptions may + be made in case of due legal process. +* You have authority to read members' [direct messages](/help/direct-messages). + Typically, this will be because your Zulip organization is administered by a + corporation, and you are an official representative of that corporation. + +By requesting and approving this export, you will assume full legal +responsibility that the appropriate employment agreements and corporate policy +for this type of export are in place. Note that many countries have laws that +require employers to notify employees of their use of such an export. diff --git a/starlight_help/src/content/docs/include/_FilterChannels.mdx b/starlight_help/src/content/docs/include/_FilterChannels.mdx new file mode 100644 index 0000000000..368d017806 --- /dev/null +++ b/starlight_help/src/content/docs/include/_FilterChannels.mdx @@ -0,0 +1,19 @@ +import { Steps } from '@astrojs/starlight/components'; +import KeyboardTip from '../../../components/KeyboardTip.astro'; +import { Tabs, TabItem } from '@astrojs/starlight/components' + +Channels in collapsed sections will be included in your search. + + + + + 1. Type the name of the channel you are looking for in the **Filter left + sidebar** box at the top of the left sidebar. + + + + You can also use the Q keyboard shortcut to start searching for + a channel. + + + diff --git a/starlight_help/src/content/docs/include/_FilterResolvedLeftSidebar.mdx b/starlight_help/src/content/docs/include/_FilterResolvedLeftSidebar.mdx new file mode 100644 index 0000000000..8e1c6ce013 --- /dev/null +++ b/starlight_help/src/content/docs/include/_FilterResolvedLeftSidebar.mdx @@ -0,0 +1,15 @@ +import { Steps } from '@astrojs/starlight/components'; +import { Tabs, TabItem } from '@astrojs/starlight/components' + + + + + 1. Click on a channel in the left sidebar. + 1. Click **show all topics** at the bottom of the list of recent topics in the + selected channel. + 1. In the search box at the top of the list of topics, type `is:`. + 1. Choose **Unresolved topics** or **Resolved topics** from the typeahead + suggestions. + + + diff --git a/starlight_help/src/content/docs/include/_FindDmConversationLeftSidebar.mdx b/starlight_help/src/content/docs/include/_FindDmConversationLeftSidebar.mdx new file mode 100644 index 0000000000..fee9af13b2 --- /dev/null +++ b/starlight_help/src/content/docs/include/_FindDmConversationLeftSidebar.mdx @@ -0,0 +1,20 @@ +import { Steps } from '@astrojs/starlight/components'; +import KeyboardTip from '../../../components/KeyboardTip.astro'; +import { Tabs, TabItem } from '@astrojs/starlight/components' + +DM conversations hidden under **more conversations** will be included in your +search. + + + + + 1. Type the name of a participant in the conversation you're looking for in the + **Filter left sidebar** box at the top of the left sidebar. + + + + You can also use the Q keyboard shortcut to start searching for + a conversation. + + + diff --git a/starlight_help/src/content/docs/include/_FollowedTopicWorkflows.mdx b/starlight_help/src/content/docs/include/_FollowedTopicWorkflows.mdx new file mode 100644 index 0000000000..8a7fd4b3ca --- /dev/null +++ b/starlight_help/src/content/docs/include/_FollowedTopicWorkflows.mdx @@ -0,0 +1,18 @@ +* [Catch up](/help/follow-a-topic#catch-up-on-followed-topics) on + followed topics at the start of the day, and whenever you want to + spend a few minutes checking on on the conversations that need + your attention. +* No more stressing about missing a reply to your message in channels + you don't regularly read. You can [automatically + follow](/help/follow-a-topic#automatically-follow-topics) topics you + start or participate in. +* You can also [mute](/help/mute-a-channel) the channels you don't + regularly read, and [automatically follow or + unmute](/help/follow-a-topic#automatically-follow-topics) topics you + start or participate in. In muted channels, topics you follow are + automatically treated as [unmuted](/help/mute-a-topic), so it will + be easy to see when someone responds to your message. +* If you like, follow just the topics where your prompt attention is + needed, and [enable desktop and mobile + notifications](/help/follow-a-topic#configure-notifications-for-followed-topics) + for followed topics. diff --git a/starlight_help/src/content/docs/include/_GeneralChatIntro.mdx b/starlight_help/src/content/docs/include/_GeneralChatIntro.mdx new file mode 100644 index 0000000000..f1f0afd7fd --- /dev/null +++ b/starlight_help/src/content/docs/include/_GeneralChatIntro.mdx @@ -0,0 +1,3 @@ +Messages sent without a topic go to the special “*general chat*” topic. The name +of this topic is shown in italics, and is translated into [your +language](/help/change-your-language). diff --git a/starlight_help/src/content/docs/include/_GlobalTimesExamples.mdx b/starlight_help/src/content/docs/include/_GlobalTimesExamples.mdx new file mode 100644 index 0000000000..3b1a13cbfd --- /dev/null +++ b/starlight_help/src/content/docs/include/_GlobalTimesExamples.mdx @@ -0,0 +1,24 @@ +import ZulipTip from '../../../components/ZulipTip.astro'; + +### What you type + +A date picker will appear once you type `. +``` + + + You can also use other formats such as UNIX timestamps or human readable + dates, for example, ``. + + +### What it looks like + +A person in San Francisco will see: + +![Global time San Francisco example](../../../../../static/images/help/global-time-example-sf.png) + +While someone in London will see: + +![Global time London example](../../../../../static/images/help/global-time-example-london.png) diff --git a/starlight_help/src/content/docs/include/_GlobalTimesIntro.mdx b/starlight_help/src/content/docs/include/_GlobalTimesIntro.mdx new file mode 100644 index 0000000000..7f36fc0b38 --- /dev/null +++ b/starlight_help/src/content/docs/include/_GlobalTimesIntro.mdx @@ -0,0 +1,5 @@ +When collaborating with people in different time zones, you often need to +express a specific time clearly. In Zulip, rather than typing out your time +zone and having everyone translate the time in their heads, you can insert +a time, and it will be displayed to each user in their own time zone (just +like timestamps on Zulip messages). diff --git a/starlight_help/src/content/docs/include/_GoToChannel.mdx b/starlight_help/src/content/docs/include/_GoToChannel.mdx new file mode 100644 index 0000000000..87ce64a7aa --- /dev/null +++ b/starlight_help/src/content/docs/include/_GoToChannel.mdx @@ -0,0 +1,2 @@ +1. Click on a channel in the left sidebar, or otherwise navigate to the channel + you're interested in. diff --git a/starlight_help/src/content/docs/include/_GoToCombinedFeed.mdx b/starlight_help/src/content/docs/include/_GoToCombinedFeed.mdx new file mode 100644 index 0000000000..7da8e27ecf --- /dev/null +++ b/starlight_help/src/content/docs/include/_GoToCombinedFeed.mdx @@ -0,0 +1,6 @@ +import AllMessagesIcon from "~icons/zulip-icon/all-messages" + +1. Click on **Combined feed** + (or if the **views** + section is collapsed) in the left sidebar, + or use the A keyboard shortcut. diff --git a/starlight_help/src/content/docs/include/_GoToDraftMessages.mdx b/starlight_help/src/content/docs/include/_GoToDraftMessages.mdx new file mode 100644 index 0000000000..068e3e892a --- /dev/null +++ b/starlight_help/src/content/docs/include/_GoToDraftMessages.mdx @@ -0,0 +1,7 @@ +import DraftsIcon from "~icons/zulip-icon/drafts" +import MoreVerticalIcon from "~icons/zulip-icon/more-vertical" + +1. Click on **Drafts** + in the left sidebar. If the **views** section is collapsed, click on + the **ellipsis** (), + and select **Drafts**. diff --git a/starlight_help/src/content/docs/include/_GoToInbox.mdx b/starlight_help/src/content/docs/include/_GoToInbox.mdx new file mode 100644 index 0000000000..776500e8c3 --- /dev/null +++ b/starlight_help/src/content/docs/include/_GoToInbox.mdx @@ -0,0 +1,6 @@ +import InboxIcon from "~icons/zulip-icon/inbox" + +1. Click on **Inbox** + (or if the **views** + section is collapsed) in the left sidebar, + or use the Shift + I keyboard shortcut. diff --git a/starlight_help/src/content/docs/include/_GoToRecentConversations.mdx b/starlight_help/src/content/docs/include/_GoToRecentConversations.mdx new file mode 100644 index 0000000000..95dd2c52e4 --- /dev/null +++ b/starlight_help/src/content/docs/include/_GoToRecentConversations.mdx @@ -0,0 +1,6 @@ +import RecentIcon from "~icons/zulip-icon/recent" + +1. Click on **Recent conversations** + (or if the **views** + section is collapsed) in the left sidebar, + or use the T keyboard shortcut. diff --git a/starlight_help/src/content/docs/include/_GoToReminders.mdx b/starlight_help/src/content/docs/include/_GoToReminders.mdx new file mode 100644 index 0000000000..a7d76fa2b7 --- /dev/null +++ b/starlight_help/src/content/docs/include/_GoToReminders.mdx @@ -0,0 +1,7 @@ +import AlarmClockIcon from "~icons/zulip-icon/alarm-clock" +import MoreVerticalIcon from "~icons/zulip-icon/more-vertical" + +1. Click on **Reminders** + in the left sidebar. If the **views** section is collapsed, click on + the **ellipsis** (), and + select **Reminders**. diff --git a/starlight_help/src/content/docs/include/_GoToScheduledMessages.mdx b/starlight_help/src/content/docs/include/_GoToScheduledMessages.mdx new file mode 100644 index 0000000000..5493b8a248 --- /dev/null +++ b/starlight_help/src/content/docs/include/_GoToScheduledMessages.mdx @@ -0,0 +1,7 @@ +import MoreVerticalIcon from "~icons/zulip-icon/more-vertical" +import CalendarDaysIcon from "~icons/zulip-icon/calendar-days" + +1. Click on **Scheduled messages** + in the left sidebar. If the **views** section is collapsed, click on + the **ellipsis** (), and + select **Scheduled messages**. diff --git a/starlight_help/src/content/docs/include/_HowToCreateAUserGroup.mdx b/starlight_help/src/content/docs/include/_HowToCreateAUserGroup.mdx new file mode 100644 index 0000000000..d1ef656768 --- /dev/null +++ b/starlight_help/src/content/docs/include/_HowToCreateAUserGroup.mdx @@ -0,0 +1,27 @@ +import UserGroupPlusIcon from "~icons/zulip-icon/user-group-plus" +import NavigationSteps from "../../../components/NavigationSteps.astro" +import ZulipNote from '../../../components/ZulipNote.astro'; +import FlattenedSteps from '../../../components/FlattenedSteps.astro'; +import { Tabs, TabItem } from '@astrojs/starlight/components' + + + + + + + 1. Click **Create user group** on the right, or click the + **create new user group** () + icon in the upper right. + 1. Fill out the requested information, and click **Continue to add + members**. + 1. Under **Add members**, enter groups and users you want to add. You can enter + a `#channel` to add all subscribers to the group. Click **Add**. + 1. Click **Create** to create the group. + + + + **Note**: You will only see the **Create user group** button if you have + permission to create user groups. + + + diff --git a/starlight_help/src/content/docs/include/_HowToInviteUsersToJoin.mdx b/starlight_help/src/content/docs/include/_HowToInviteUsersToJoin.mdx new file mode 100644 index 0000000000..9727429d7c --- /dev/null +++ b/starlight_help/src/content/docs/include/_HowToInviteUsersToJoin.mdx @@ -0,0 +1,60 @@ +import { Steps } from '@astrojs/starlight/components'; +import { Tabs, TabItem } from '@astrojs/starlight/components' + + + + + 1. [Configure allowed authentication + methods](/help/configure-authentication-methods). Zulip offers a variety of + authentication methods, including email/password, Google, GitHub, GitLab, + Apple, LDAP and [SAML](/help/saml-authentication). Users can [log + in][logging-in] with any allowed authentication method, regardless of how + they signed up. + 1. Invite users by [sending email invitations][email-invitations] or + sharing a [reusable invitation link][invitation-links]. + + + + + + 1. Allow users to [join without an invitation][set-if-invitations-required]. + 1. Configure the appropriate [email domain restrictions][restrict-email-domain] + for your organization. + 1. Share a link to your registration page, which is + https://your-org.zulipchat.com for Zulip Cloud organizations. + + + + + + 1. [Configure allowed authentication + methods](/help/configure-authentication-methods). Zulip offers a variety of + authentication methods, including email/password, Google, GitHub, GitLab, + Apple, LDAP and [SAML](/help/saml-authentication). Users can immediately [log + in][logging-in] with any allowed authentication method that does not require + a password. + 1. Share a link to your Zulip organization, which is + https://your-org.zulipchat.com on Zulip Cloud. + 1. *(optional)* To log in with an email/password, users will need to set their + initial password. You can: + * Automatically send password reset emails to all users in your + organization. If you imported your organization into Zulip Cloud, simply + email [support@zulip.com](mailto:support@zulip.com) to request this. Server + administrators for self-hosted organizations should follow [these + instructions](/help/import-from-slack#send-password-reset-emails-to-all-users). + * Let users know that they can [request a password + reset](/help/change-your-password#if-youve-forgotten-or-never-had-a-password) + on your organization's login page. + + + + +[email-invitations]: /help/invite-new-users#send-email-invitations + +[invitation-links]: /help/invite-new-users#create-a-reusable-invitation-link + +[set-if-invitations-required]: /help/restrict-account-creation#set-whether-invitations-are-required-to-join + +[restrict-email-domain]: /help/restrict-account-creation#configuring-email-domain-restrictions + +[logging-in]: /help/logging-in diff --git a/starlight_help/src/content/docs/include/_HowToReplyIntro.mdx b/starlight_help/src/content/docs/include/_HowToReplyIntro.mdx new file mode 100644 index 0000000000..e666ecc821 --- /dev/null +++ b/starlight_help/src/content/docs/include/_HowToReplyIntro.mdx @@ -0,0 +1,16 @@ +Many chat apps have prominent “reply” or “reply in thread” buttons. These +buttons are necessary, because it's often hard to figure out what conversation +messages belong to if you don't use them. + +When you [start composing](/help/replying-to-messages) a message in Zulip, it +will automatically be addressed to the conversation thread you're reading +(unless you are [starting a new +thread](/help/introduction-to-topics#how-to-start-a-new-topic)). Because +everything is organized into threads, it'll almost always be clear what you're +responding to. This means there is no need to repeat what has already been said +when you reply. + +You can still [quote](/help/quote-or-forward-a-message#quote-a-message) part of +an older message for reference, or +[forward](/help/quote-or-forward-a-message#forward-a-message) a message to +another thread. diff --git a/starlight_help/src/content/docs/include/_HowToStartANewTopic.mdx b/starlight_help/src/content/docs/include/_HowToStartANewTopic.mdx new file mode 100644 index 0000000000..7fddeb719b --- /dev/null +++ b/starlight_help/src/content/docs/include/_HowToStartANewTopic.mdx @@ -0,0 +1,47 @@ +import MobileChannels from "./_MobileChannels.mdx" +import ComposeAndSendMessage from "./_ComposeAndSendMessage.mdx" +import SendIcon from "~icons/zulip-icon/send" +import FlattenedSteps from '../../../components/FlattenedSteps.astro'; +import KeyboardTip from '../../../components/KeyboardTip.astro'; +import { Tabs, TabItem } from '@astrojs/starlight/components' +import StartTopicViaLeftSidebar from "./_StartTopicViaLeftSidebar.mdx" + + + + + + + + + + + 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. + 1. Enter a topic name. Think about finishing the sentence: “Hey, can we chat + about… ?” + + + + + + You can also use the C keyboard shortcut to start a new topic in + the channel you're viewing. + + + + + + + + 1. Tap on the desired channel. + 1. Tap the compose box at the bottom of the app. + 1. Enter a topic name. Auto-complete will provide suggestions for previously + used topics. + 1. Compose your message, and tap the **send** + () button in the + bottom right corner of the app. + + + diff --git a/starlight_help/src/content/docs/include/_ImportGetYourOrganizationStarted.mdx b/starlight_help/src/content/docs/include/_ImportGetYourOrganizationStarted.mdx new file mode 100644 index 0000000000..8350af9ad0 --- /dev/null +++ b/starlight_help/src/content/docs/include/_ImportGetYourOrganizationStarted.mdx @@ -0,0 +1,18 @@ +import { Steps } from '@astrojs/starlight/components'; + +Once the import process is completed, you will need to: + + + 1. [Configure the settings for your organization](/help/customize-organization-settings), + which are not exported. This includes settings like [email + visibility](/help/configure-email-visibility), [message editing + permissions](/help/restrict-message-editing-and-deletion), + and [how users can join your organization](/help/restrict-account-creation). + 1. All users from your previous workspace will have accounts in your new Zulip + organization. However, you will need to let users know about their new + accounts, and [decide how they will log + in](/help/import-from-slack#decide-how-users-will-log-in) for the first time. + 1. Share the URL for your new Zulip organization, and (recommended) the [Getting + started with Zulip guide](/help/getting-started-with-zulip). + 1. Migrate any [integrations](/integrations/). + diff --git a/starlight_help/src/content/docs/include/_ImportHowUsersWillLogIn.mdx b/starlight_help/src/content/docs/include/_ImportHowUsersWillLogIn.mdx new file mode 100644 index 0000000000..b25b73bbd8 --- /dev/null +++ b/starlight_help/src/content/docs/include/_ImportHowUsersWillLogIn.mdx @@ -0,0 +1,76 @@ +import { Steps } from '@astrojs/starlight/components'; +import ZulipNote from '../../../components/ZulipNote.astro'; +import { Tabs, TabItem } from '@astrojs/starlight/components' +import ZulipTip from '../../../components/ZulipTip.astro'; + +When user accounts are imported, users initially do not have passwords +configured. There are a few options for how users can log in for the first time. + + + For security reasons, passwords are never exported. + + +### Allow users to log in with non-password authentication + +When you create your organization, users will immediately be able to log in with +[authentication methods](/help/configure-authentication-methods) that do not +require a password. Zulip offers a variety of authentication methods, including +Google, GitHub, GitLab, Apple, LDAP and [SAML](/help/saml-authentication). + +### Send password reset emails to all users + +You can send password reset emails to all users in your organization, which +will allow them to set an initial password. + +If you imported your organization into Zulip Cloud, simply email +[support@zulip.com](mailto:support@zulip.com) to request this. + + + To avoid confusion, first make sure that the users in your + organization are aware that their account has been moved to + Zulip, and are expecting to receive a password reset email. + + +#### Send password reset emails (self-hosted organization) + + + + + 1. To test the process, start by sending yourself a password reset email by + using the following command: + ``` + ./manage.py send_password_reset_email -u username@example.com + ``` + 1. When ready, send password reset emails to all users by + using the following command: + ``` + ./manage.py send_password_reset_email -r '' --all-users + ``` + + + + + + 1. To test the process, start by sending yourself a password reset email by + using the following command: + ``` + ./manage.py send_password_reset_email -u username@example.com + ``` + 1. When ready, send password reset emails to all users by + using the following command: + ``` + ./manage.py send_password_reset_email -r --all-users + ``` + If you would like to only send emails to users who have not logged in yet, + you can use the following variant instead: + ``` + ./manage.py send_password_reset_email -r --all-users --only-never-logged-in + ``` + + + + +### Manual password resets + +Alternatively, users can reset their own passwords by following the instructions +on your Zulip organization's login page. diff --git a/starlight_help/src/content/docs/include/_ImportIntoASelfHostedServerDescription.mdx b/starlight_help/src/content/docs/include/_ImportIntoASelfHostedServerDescription.mdx new file mode 100644 index 0000000000..16f23851a3 --- /dev/null +++ b/starlight_help/src/content/docs/include/_ImportIntoASelfHostedServerDescription.mdx @@ -0,0 +1,6 @@ +#### Import into a self-hosted Zulip server + +Zulip's import tools are robust, and have been used to import workspaces +with 10,000 members and millions of messages. If you're planning on doing +an import much larger than that, or run into performance issues when +importing, [contact us](/help/contact-support) for help. diff --git a/starlight_help/src/content/docs/include/_ImportIntoASelfHostedServerInstructions.mdx b/starlight_help/src/content/docs/include/_ImportIntoASelfHostedServerInstructions.mdx new file mode 100644 index 0000000000..21b0bf3d6f --- /dev/null +++ b/starlight_help/src/content/docs/include/_ImportIntoASelfHostedServerInstructions.mdx @@ -0,0 +1,9 @@ +1. Follow steps + [1](https://zulip.readthedocs.io/en/stable/production/install.html#step-1-download-the-latest-release) + and + [2](https://zulip.readthedocs.io/en/stable/production/install.html#step-2-install-zulip) + of the guide for [installing a new Zulip + server](https://zulip.readthedocs.io/en/stable/production/install.html). +1. Copy the **exported data** file containing your workspace message + history export onto your Zulip server, and put it in `/tmp/`. +1. Log in to a shell on your Zulip server as the `zulip` user. diff --git a/starlight_help/src/content/docs/include/_ImportIntoAZulipCloudOrganization.mdx b/starlight_help/src/content/docs/include/_ImportIntoAZulipCloudOrganization.mdx new file mode 100644 index 0000000000..d168e95308 --- /dev/null +++ b/starlight_help/src/content/docs/include/_ImportIntoAZulipCloudOrganization.mdx @@ -0,0 +1,12 @@ +import { Steps } from '@astrojs/starlight/components'; +import SendUsInfo from "./_SendUsInfo.mdx" + +#### Import into a Zulip Cloud organization + + + + + 1. The subdomain you would like to use for your organization. Your Zulip chat will + be hosted at `.zulipchat.com`. + 1. The **exported data** file containing your workspace message history export. + diff --git a/starlight_help/src/content/docs/include/_ImportSelfHostedServerTips.mdx b/starlight_help/src/content/docs/include/_ImportSelfHostedServerTips.mdx new file mode 100644 index 0000000000..03aed825a9 --- /dev/null +++ b/starlight_help/src/content/docs/include/_ImportSelfHostedServerTips.mdx @@ -0,0 +1,13 @@ +import ZulipNote from '../../../components/ZulipNote.astro'; +import ZulipTip from '../../../components/ZulipTip.astro'; + + + The import could take several minutes to run, + depending on how much data you're importing. + + + + The server stop/restart commands are only + necessary when importing on a server with minimal + RAM, where an OOM kill might otherwise occur. + diff --git a/starlight_help/src/content/docs/include/_ImportWorkspaceToZulip.mdx b/starlight_help/src/content/docs/include/_ImportWorkspaceToZulip.mdx new file mode 100644 index 0000000000..4624c7fd38 --- /dev/null +++ b/starlight_help/src/content/docs/include/_ImportWorkspaceToZulip.mdx @@ -0,0 +1,11 @@ +You can import your current workspace into a Zulip organization. It's a great way +to preserve your workspace history when you migrate to Zulip, and to +make the transition easy for the members of your organization. + +The import will include your organization's: + +* **Name** and **Logo** +* **Message history**, including attachments and emoji reactions +* **Users**, including names, emails, roles, avatars, time zones, and custom profile fields +* **Channels**, including all user subscriptions +* **Custom emoji** diff --git a/starlight_help/src/content/docs/include/_ImportYourDataIntoZulip.mdx b/starlight_help/src/content/docs/include/_ImportYourDataIntoZulip.mdx new file mode 100644 index 0000000000..c9bf34f6b3 --- /dev/null +++ b/starlight_help/src/content/docs/include/_ImportYourDataIntoZulip.mdx @@ -0,0 +1,12 @@ +import ZulipNote from '../../../components/ZulipNote.astro'; + +To start using Zulip, you will need to choose between Zulip Cloud and +self-hosting Zulip. For a simple managed solution, with no setup or maintenance +overhead, you can [sign up](/new/) for Zulip Cloud with just a few clicks. +Alternatively, you can [self-host](/self-hosting/) your Zulip organization. See +[here](/help/zulip-cloud-or-self-hosting) to learn more. + + + **You can only import a workspace as a new Zulip organization.** Your imported + message history cannot be added into an existing Zulip organization. + diff --git a/starlight_help/src/content/docs/include/_ImportZulipCloudOrganizationWarning.mdx b/starlight_help/src/content/docs/include/_ImportZulipCloudOrganizationWarning.mdx new file mode 100644 index 0000000000..80381830a9 --- /dev/null +++ b/starlight_help/src/content/docs/include/_ImportZulipCloudOrganizationWarning.mdx @@ -0,0 +1,8 @@ +import ZulipNote from '../../../components/ZulipNote.astro'; + + + If the organization already exists, the import process will overwrite all + data that's already there. If needed, we're happy to preserve your + data by moving an organization you've already created to a new + subdomain prior to running the import process. + diff --git a/starlight_help/src/content/docs/include/_InboxInstructions.mdx b/starlight_help/src/content/docs/include/_InboxInstructions.mdx new file mode 100644 index 0000000000..ea94fdb73b --- /dev/null +++ b/starlight_help/src/content/docs/include/_InboxInstructions.mdx @@ -0,0 +1,38 @@ +import ArrowDownIcon from "~icons/zulip-icon/arrow-down" +import InboxIcon from "~icons/zulip-icon/inbox" +import GoToInbox from "./_GoToInbox.mdx" +import { Steps } from '@astrojs/starlight/components'; +import ZulipTip from '../../../components/ZulipTip.astro'; +import FlattenedSteps from '../../../components/FlattenedSteps.astro'; +import { Tabs, TabItem } from '@astrojs/starlight/components' + + + + + + + 1. Click on a conversation you're interested in to view it. You can return to + your **inbox** when done (e.g., by using the **back** button in your browser + or desktop app) to select the next conversation. + + + + + + 1. Tap the **Inbox** () + tab in the bottom left corner of the app. + 1. Tap on a conversation you're interested in to view it. You can return to + your **inbox** when done (e.g., by using the **back** button) to select + the next conversation. + + + + + + You can collapse or expand the list of topics in a channel by clicking the + **collapse** + () + or **expand** + () + icon to the left of a channel name. + diff --git a/starlight_help/src/content/docs/include/_InboxIntro.mdx b/starlight_help/src/content/docs/include/_InboxIntro.mdx new file mode 100644 index 0000000000..51eb7c886a --- /dev/null +++ b/starlight_help/src/content/docs/include/_InboxIntro.mdx @@ -0,0 +1,3 @@ +**Inbox** provides an overview of your conversations with unread messages. +Conversations are shown in the same order as in the left sidebar in the web app, +and you can collapse any channels you are not currently interested in. diff --git a/starlight_help/src/content/docs/include/_InternationalWireTransfers.mdx b/starlight_help/src/content/docs/include/_InternationalWireTransfers.mdx new file mode 100644 index 0000000000..9d3b048378 --- /dev/null +++ b/starlight_help/src/content/docs/include/_InternationalWireTransfers.mdx @@ -0,0 +1,6 @@ +If you choose to pay via a bank transfer from a bank outside of the United +States, your payment will likely incur a transfer charge. When asked which side +will pay the transfer charge, please be sure to **select “OUR”** from the menu +of options. Otherwise, third party banking fees will be deducted from the amount +you transfer, and the resulting total will be insufficient to pay the full +amount of your invoice. diff --git a/starlight_help/src/content/docs/include/_InviteUsers.mdx b/starlight_help/src/content/docs/include/_InviteUsers.mdx new file mode 100644 index 0000000000..e899eaf024 --- /dev/null +++ b/starlight_help/src/content/docs/include/_InviteUsers.mdx @@ -0,0 +1,6 @@ +import UserPlusIcon from "~icons/zulip-icon/user-plus" +import GearIcon from "~icons/zulip-icon/gear" + +1. Click on the **gear** () icon in the upper + right corner of the web or desktop app. +1. Select **Invite users**. diff --git a/starlight_help/src/content/docs/include/_LatexExamples.mdx b/starlight_help/src/content/docs/include/_LatexExamples.mdx new file mode 100644 index 0000000000..957575e845 --- /dev/null +++ b/starlight_help/src/content/docs/include/_LatexExamples.mdx @@ -0,0 +1,14 @@ +### What you type + +```` +Inline: $$O(n^2)$$ + +Displayed: +``` math +\int_a^b f(t)\, dt = F(b) - F(a) +``` +```` + +### What it looks like + +![Markdown LaTeX](../../../../../static/images/help/markdown-latex.png) diff --git a/starlight_help/src/content/docs/include/_LatexIntro.mdx b/starlight_help/src/content/docs/include/_LatexIntro.mdx new file mode 100644 index 0000000000..7cfe0dfa7b --- /dev/null +++ b/starlight_help/src/content/docs/include/_LatexIntro.mdx @@ -0,0 +1,4 @@ +Zulip supports math typesetting powered by [KaTeX](https://katex.org). +Their [support table](https://katex.org/docs/support_table.html) is a +helpful resource for checking what's supported or how to express +something. diff --git a/starlight_help/src/content/docs/include/_LeftSidebarConversations.mdx b/starlight_help/src/content/docs/include/_LeftSidebarConversations.mdx new file mode 100644 index 0000000000..d8e4514441 --- /dev/null +++ b/starlight_help/src/content/docs/include/_LeftSidebarConversations.mdx @@ -0,0 +1,21 @@ +import { Steps } from '@astrojs/starlight/components'; +import { Tabs, TabItem } from '@astrojs/starlight/components' +import ZulipTip from '../../../components/ZulipTip.astro'; + +In the web app, the left sidebar provides quick access to your direct messages, +and the channels you are subscribed to. + + + + + 1. Click on **direct messages** or the name of a channel in the left sidebar. You + will see a list of the most recent unread conversations that you have not [muted](/help/mute-a-topic). + 1. Click on the conversation you are interested in. + + + + To see all conversations, click on **more conversations** (in direct messages) or **show all topics** + (in a channel). + + + diff --git a/starlight_help/src/content/docs/include/_LinksExamples.mdx b/starlight_help/src/content/docs/include/_LinksExamples.mdx new file mode 100644 index 0000000000..bbad1a7665 --- /dev/null +++ b/starlight_help/src/content/docs/include/_LinksExamples.mdx @@ -0,0 +1,14 @@ +### What you type + +``` +Named link: [Zulip homepage](zulip.com) +A URL (links automatically): zulip.com +Channel link: #**channel name** +Topic link: #**channel name>topic name** +Message link: #**channel name>topic name@123** +Custom linkifier: For example, #2468 can automatically link to an issue in your tracker. +``` + +### What it looks like + +![Markdown links](../../../../../static/images/help/markdown-links.png) diff --git a/starlight_help/src/content/docs/include/_LinksIntro.mdx b/starlight_help/src/content/docs/include/_LinksIntro.mdx new file mode 100644 index 0000000000..5390afcc76 --- /dev/null +++ b/starlight_help/src/content/docs/include/_LinksIntro.mdx @@ -0,0 +1,7 @@ +In Zulip, you can insert a named link using Markdown formatting. In addition, Zulip +automatically creates links for you when you enter: + +* A URL +* A reference to a channel, topic, or specific message (see also [Link to a + message or conversation](/help/link-to-a-message-or-conversation)) +* Text that matches a [custom linkifier](/help/add-a-custom-linkifier) set up by your organization diff --git a/starlight_help/src/content/docs/include/_ManageBillingIntro.mdx b/starlight_help/src/content/docs/include/_ManageBillingIntro.mdx new file mode 100644 index 0000000000..ecf3d8c39b --- /dev/null +++ b/starlight_help/src/content/docs/include/_ManageBillingIntro.mdx @@ -0,0 +1,12 @@ +On the billing page for an active paid plan you can: + +* View your past invoices. +* View and update the billing details displayed on invoices and receipts + for future payments. +* If you pay for your plan by credit card, update your card's payment + details. +* Change your billing frequency to be monthly or annual. +* If you opted for [manual license + management](#how-does-manual-license-management-work), you can [update + the number of licenses](#manually-update-number-of-licenses) + for the current billing period or the next billing period. diff --git a/starlight_help/src/content/docs/include/_ManageConfiguredTopicsDesktopWeb.mdx b/starlight_help/src/content/docs/include/_ManageConfiguredTopicsDesktopWeb.mdx new file mode 100644 index 0000000000..7011e3a317 --- /dev/null +++ b/starlight_help/src/content/docs/include/_ManageConfiguredTopicsDesktopWeb.mdx @@ -0,0 +1,9 @@ +import FlattenedSteps from '../../../components/FlattenedSteps.astro'; +import NavigationSteps from "../../../components/NavigationSteps.astro" + + + + + 1. Configure notifications for each topic by selecting the desired option from + the dropdown in the **Status** column. + diff --git a/starlight_help/src/content/docs/include/_ManageConfiguredTopicsMobile.mdx b/starlight_help/src/content/docs/include/_ManageConfiguredTopicsMobile.mdx new file mode 100644 index 0000000000..e267d2e585 --- /dev/null +++ b/starlight_help/src/content/docs/include/_ManageConfiguredTopicsMobile.mdx @@ -0,0 +1,16 @@ +import FlattenedSteps from '../../../components/FlattenedSteps.astro'; +import TopicListIcon from "~icons/zulip-icon/topic-list" +import MobileChannels from "./_MobileChannels.mdx" +import TopicLongPressMenu from "./_TopicLongPressMenu.mdx" + + + + + 1. Select a channel containing topics you want to configure. + 1. Tap **topics** () + in the upper right corner of the app. + + + + 1. Tap **Mute topic**, **Unmute topic**, or **Follow topic**. + diff --git a/starlight_help/src/content/docs/include/_ManageThisUser.mdx b/starlight_help/src/content/docs/include/_ManageThisUser.mdx new file mode 100644 index 0000000000..654465a42d --- /dev/null +++ b/starlight_help/src/content/docs/include/_ManageThisUser.mdx @@ -0,0 +1,8 @@ +import FlattenedSteps from '../../../components/FlattenedSteps.astro'; +import UserCardThreeDotMenu from "./_UserCardThreeDotMenu.mdx" + + + + + 1. Click **Manage this user**. + diff --git a/starlight_help/src/content/docs/include/_ManageThisUserViaUserProfile.mdx b/starlight_help/src/content/docs/include/_ManageThisUserViaUserProfile.mdx new file mode 100644 index 0000000000..6f4ec9bb11 --- /dev/null +++ b/starlight_help/src/content/docs/include/_ManageThisUserViaUserProfile.mdx @@ -0,0 +1,10 @@ +import FlattenedSteps from '../../../components/FlattenedSteps.astro'; +import EditIcon from "~icons/zulip-icon/edit" +import RightSidebarViewProfile from "./_RightSidebarViewProfile.mdx" + + + + + 1. Select the **Manage user** tab, or click the **pencil and paper** + () icon next to the user's name. + diff --git a/starlight_help/src/content/docs/include/_ManageUserTabTip.mdx b/starlight_help/src/content/docs/include/_ManageUserTabTip.mdx new file mode 100644 index 0000000000..3af067ddf7 --- /dev/null +++ b/starlight_help/src/content/docs/include/_ManageUserTabTip.mdx @@ -0,0 +1,8 @@ +import EditIcon from "~icons/zulip-icon/edit" +import ZulipTip from '../../../components/ZulipTip.astro'; + + + You can also access the **Manage user** tab by clicking the **pencil and + paper** () icon at the top of the [user + profile](/help/view-someones-profile). + diff --git a/starlight_help/src/content/docs/include/_ManualAddLicenseInstructions.mdx b/starlight_help/src/content/docs/include/_ManualAddLicenseInstructions.mdx new file mode 100644 index 0000000000..d8016759d8 --- /dev/null +++ b/starlight_help/src/content/docs/include/_ManualAddLicenseInstructions.mdx @@ -0,0 +1,10 @@ +import ZulipTip from '../../../components/ZulipTip.astro'; + +1. Modify **Number of licenses for current billing period** or **Number of + licenses for next billing period**, and click **Update**. + + + Modifying the number of licenses for the current billing period also + automatically updates the number of licenses for the next + billing period. + diff --git a/starlight_help/src/content/docs/include/_MeActionMessagesExamples.mdx b/starlight_help/src/content/docs/include/_MeActionMessagesExamples.mdx new file mode 100644 index 0000000000..dce270a6b4 --- /dev/null +++ b/starlight_help/src/content/docs/include/_MeActionMessagesExamples.mdx @@ -0,0 +1,11 @@ +For example, if you are **Ada Starr**: + +### What you type + +``` +/me is away +``` + +### What it looks like + +![Markdown status](../../../../../static/images/help/markdown-status.png) diff --git a/starlight_help/src/content/docs/include/_MeActionMessagesIntro.mdx b/starlight_help/src/content/docs/include/_MeActionMessagesIntro.mdx new file mode 100644 index 0000000000..2f3ec23f1b --- /dev/null +++ b/starlight_help/src/content/docs/include/_MeActionMessagesIntro.mdx @@ -0,0 +1,4 @@ +You can send messages that display your profile picture and name as the +beginning of the message content by beginning a message with `/me`. You can +use this feature in conversations when you want to describe actions you've +taken or things that are happening around you using a third-person voice. diff --git a/starlight_help/src/content/docs/include/_MentionsExamples.mdx b/starlight_help/src/content/docs/include/_MentionsExamples.mdx new file mode 100644 index 0000000000..a3b93afb24 --- /dev/null +++ b/starlight_help/src/content/docs/include/_MentionsExamples.mdx @@ -0,0 +1,20 @@ +import ZulipTip from '../../../components/ZulipTip.astro'; + +### What you type + +``` +Users: @**Bo Lin** or @**Ariella Drake|26** (two `*`) +User group: @*support team* (one `*`) +Silent mention: @_**Bo Lin** or @_**Ariella Drake|26** (`@_` instead of `@`) +Wildcard mentions: @**all**, @**everyone**, @**channel**, @**topic** (two `*`) +``` + + + A `|` followed by a user ID is inserted automatically when you select a + user from the typeahead suggestions, if there are two users with the same + name in the organization. + + +### What it looks like + +![Markdown mentions](../../../../../static/images/help/markdown-mentions.png) diff --git a/starlight_help/src/content/docs/include/_MentionsIntro.mdx b/starlight_help/src/content/docs/include/_MentionsIntro.mdx new file mode 100644 index 0000000000..df4bfa5a2e --- /dev/null +++ b/starlight_help/src/content/docs/include/_MentionsIntro.mdx @@ -0,0 +1,8 @@ +You can mention a team member or [user group](/help/user-groups) to call their +attention to a message. Mentions follow the same [notification +settings](/help/dm-mention-alert-notifications) as direct messages and alert +words. A [silent mention](/help/mention-a-user-or-group#silently-mention-a-user) +allows you to refer to a user without triggering a notification. A wildcard +mention allows you to +[mention everyone on a channel](/help/mention-a-user-or-group#mention-everyone-on-a-channel), +or [mention all topic participants](/help/mention-a-user-or-group#mention-all-topic-participants). diff --git a/starlight_help/src/content/docs/include/_MessageActions.mdx b/starlight_help/src/content/docs/include/_MessageActions.mdx new file mode 100644 index 0000000000..6ba67b6049 --- /dev/null +++ b/starlight_help/src/content/docs/include/_MessageActions.mdx @@ -0,0 +1 @@ +1. Hover over a message to reveal three icons on the right. diff --git a/starlight_help/src/content/docs/include/_MessageActionsMenu.mdx b/starlight_help/src/content/docs/include/_MessageActionsMenu.mdx new file mode 100644 index 0000000000..759ca06b47 --- /dev/null +++ b/starlight_help/src/content/docs/include/_MessageActionsMenu.mdx @@ -0,0 +1,4 @@ +import MoreVerticalSpreadIcon from "~icons/zulip-icon/more-vertical-spread" + +1. Hover over a message to reveal three icons on the right. +1. Click on the **ellipsis** (). diff --git a/starlight_help/src/content/docs/include/_MessageEditHistoryIntro.mdx b/starlight_help/src/content/docs/include/_MessageEditHistoryIntro.mdx new file mode 100644 index 0000000000..8f5929173d --- /dev/null +++ b/starlight_help/src/content/docs/include/_MessageEditHistoryIntro.mdx @@ -0,0 +1,8 @@ +In Zulip, users who have the appropriate permissions can +[edit](/help/edit-a-message) the content of a message they sent, or move +messages to a different [channel](/help/move-content-to-another-channel) +or [topic](/help/move-content-to-another-topic). + +Modified messages are tagged as **edited** or **moved**, with the **edited** +indicator taking priority. You can view the history of how a message was +edited and moved, if this is allowed in your organization. diff --git a/starlight_help/src/content/docs/include/_MessageLongPressMenu.mdx b/starlight_help/src/content/docs/include/_MessageLongPressMenu.mdx new file mode 100644 index 0000000000..f0c935797e --- /dev/null +++ b/starlight_help/src/content/docs/include/_MessageLongPressMenu.mdx @@ -0,0 +1 @@ +1. Press and hold a message until the long-press menu appears. diff --git a/starlight_help/src/content/docs/include/_MessagingTips.mdx b/starlight_help/src/content/docs/include/_MessagingTips.mdx new file mode 100644 index 0000000000..780bb5d4c5 --- /dev/null +++ b/starlight_help/src/content/docs/include/_MessagingTips.mdx @@ -0,0 +1,14 @@ +* Learn all about [message formatting](/help/format-your-message-using-markdown). +* Use [emoji reactions](/help/emoji-reactions) for lightweight interactions. +* Embed [code blocks](/help/code-blocks) with syntax highlighting for over 250 + languages, and integrated [code playgrounds](/help/code-blocks#code-playgrounds). +* [Type LaTeX](/help/format-your-message-using-markdown#latex) directly into + your Zulip message, and see it beautifully rendered. +* [Start a video call](/help/start-a-call) with the click of a button. +* Make plans for later without worrying about time zones using + [global times](/help/format-your-message-using-markdown#global-times). +* Share files or images with [drag-and-drop uploads](/help/share-and-upload-files). +* Enjoy animated GIFs with Zulip's native + [GIPHY integration](/help/animated-gifs-from-giphy). +* [Preview your message](/help/preview-your-message-before-sending) to make sure + it looks just how you want it. diff --git a/starlight_help/src/content/docs/include/_MobileChannels.mdx b/starlight_help/src/content/docs/include/_MobileChannels.mdx new file mode 100644 index 0000000000..0056dc0840 --- /dev/null +++ b/starlight_help/src/content/docs/include/_MobileChannels.mdx @@ -0,0 +1,4 @@ +import HashIcon from "~icons/zulip-icon/hash" + +1. Tap the **Channels** () + tab at the bottom of the app. diff --git a/starlight_help/src/content/docs/include/_MobileDirectMessages.mdx b/starlight_help/src/content/docs/include/_MobileDirectMessages.mdx new file mode 100644 index 0000000000..ea8b5b1563 --- /dev/null +++ b/starlight_help/src/content/docs/include/_MobileDirectMessages.mdx @@ -0,0 +1,5 @@ +import UserIcon from "~icons/zulip-icon/user" + +1. Tap the **Direct messages** + () tab at the + bottom of the app. diff --git a/starlight_help/src/content/docs/include/_MobileMenu.mdx b/starlight_help/src/content/docs/include/_MobileMenu.mdx new file mode 100644 index 0000000000..c8bdcc9737 --- /dev/null +++ b/starlight_help/src/content/docs/include/_MobileMenu.mdx @@ -0,0 +1,4 @@ +import MobileMenuIcon from "~icons/zulip-icon/mobile-menu" + +1. Tap the **Menu** () + tab in the bottom right corner of the app. diff --git a/starlight_help/src/content/docs/include/_MobileSettings.mdx b/starlight_help/src/content/docs/include/_MobileSettings.mdx new file mode 100644 index 0000000000..8e1a25d5ce --- /dev/null +++ b/starlight_help/src/content/docs/include/_MobileSettings.mdx @@ -0,0 +1,9 @@ +import FlattenedSteps from '../../../components/FlattenedSteps.astro'; +import MobileMenu from "./_MobileMenu.mdx" +import GearIcon from "~icons/zulip-icon/gear" + + + + + 1. Tap **Settings**. + diff --git a/starlight_help/src/content/docs/include/_MobileSwitchAccount.mdx b/starlight_help/src/content/docs/include/_MobileSwitchAccount.mdx new file mode 100644 index 0000000000..8854f6b6da --- /dev/null +++ b/starlight_help/src/content/docs/include/_MobileSwitchAccount.mdx @@ -0,0 +1,10 @@ +import FlattenedSteps from '../../../components/FlattenedSteps.astro'; +import MobileMenu from "./_MobileMenu.mdx" +import MobileArrowLeftRightIcon from "~icons/zulip-icon/mobile-arrow-left-right" + + + + + 1. Tap + **Switch account**. + diff --git a/starlight_help/src/content/docs/include/_ModifyLinkText.mdx b/starlight_help/src/content/docs/include/_ModifyLinkText.mdx new file mode 100644 index 0000000000..1ba0de8e10 --- /dev/null +++ b/starlight_help/src/content/docs/include/_ModifyLinkText.mdx @@ -0,0 +1,2 @@ +1. *(optional)* Modify the link text as desired. Link text will default to the + name of the uploaded file. diff --git a/starlight_help/src/content/docs/include/_MoveChannelToFolder.mdx b/starlight_help/src/content/docs/include/_MoveChannelToFolder.mdx new file mode 100644 index 0000000000..4990048630 --- /dev/null +++ b/starlight_help/src/content/docs/include/_MoveChannelToFolder.mdx @@ -0,0 +1,26 @@ +import NavigationSteps from "../../../components/NavigationSteps.astro" +import SaveChanges from "./_SaveChanges.mdx" +import SelectChannelViewGeneral from "./_SelectChannelViewGeneral.mdx" +import FlattenedSteps from '../../../components/FlattenedSteps.astro'; +import { Tabs, TabItem } from '@astrojs/starlight/components' +import ChannelSettingsGeneralTabTip from "./_ChannelSettingsGeneralTabTip.mdx" + + + + + + + 1. Select a channel. + + + + 1. *(optional)* [Create a new channel folder](/help/manage-channel-folders#create-a-new-channel-folder). + 1. Under **Folders**, select the desired folder from the **Channel folder** + dropdown. + + + + + + + diff --git a/starlight_help/src/content/docs/include/_MuteUnmuteIntro.mdx b/starlight_help/src/content/docs/include/_MuteUnmuteIntro.mdx new file mode 100644 index 0000000000..ed74f9962a --- /dev/null +++ b/starlight_help/src/content/docs/include/_MuteUnmuteIntro.mdx @@ -0,0 +1,30 @@ +import ZulipNote from '../../../components/ZulipNote.astro'; + +Zulip lets you mute topics and channels to avoid receiving notifications for messages +you are not interested in. Muting a channel effectively mutes all topics in +that channel. You can also manually **mute** a topic in an unmuted channel, or +**unmute** a topic in a muted channel. + +Muting has the following effects: + +* Messages in muted topics do not generate notifications (including [alert + word](/help/dm-mention-alert-notifications#alert-words) notifications), unless + you are [mentioned](/help/mention-a-user-or-group). +* Messages in muted topics do not appear in the [**Combined + feed**](/help/combined-feed) view or the mobile **Inbox** view. +* Muted topics appear in the [**Recent conversations**](/help/recent-conversations) + view only if the **Include muted** filter is enabled. +* Unread messages in muted topics do not contribute to channel unread counts. +* Muted topics and channels are grayed out in the left sidebar of the desktop/web + app, and in the mobile app. +* In the desktop/web app, muted topics are sorted to the bottom of their channel, + and muted channels are sorted to the bottom of their channel section. + +You can search muted messages using the `is:muted` [search +filter](/help/search-for-messages#search-by-message-status), or exclude them +from search results with `-is:muted`. + + + **Note**: Some parts of the Zulip experience may start to degrade + if you receive more than a few hundred muted messages a day. + diff --git a/starlight_help/src/content/docs/include/_NotHumanExportFormat.mdx b/starlight_help/src/content/docs/include/_NotHumanExportFormat.mdx new file mode 100644 index 0000000000..e2fb61a225 --- /dev/null +++ b/starlight_help/src/content/docs/include/_NotHumanExportFormat.mdx @@ -0,0 +1,6 @@ +import ZulipNote from '../../../components/ZulipNote.astro'; + + + This export is formatted for importing into Zulip Cloud or a self-hosted + installation of Zulip. It is not designed to be human-readable. + diff --git a/starlight_help/src/content/docs/include/_NumberedListsExamples.mdx b/starlight_help/src/content/docs/include/_NumberedListsExamples.mdx new file mode 100644 index 0000000000..60c5a4d60d --- /dev/null +++ b/starlight_help/src/content/docs/include/_NumberedListsExamples.mdx @@ -0,0 +1,19 @@ +import { Steps } from '@astrojs/starlight/components'; + +### What you type + +``` + +1. numbered lists +1. increment automatically + 1. use nested lists if you like + 3. delete or reorder lines without fixing the numbering +1. one more + 17. lists can start at any number + 18. so you can continue a list after some other text + +``` + +### What it looks like + +![Markdown numbered lists](../../../../../static/images/help/markdown-numbered-lists.png) diff --git a/starlight_help/src/content/docs/include/_NumberedListsIntro.mdx b/starlight_help/src/content/docs/include/_NumberedListsIntro.mdx new file mode 100644 index 0000000000..aa990b2099 --- /dev/null +++ b/starlight_help/src/content/docs/include/_NumberedListsIntro.mdx @@ -0,0 +1,5 @@ +Zulip supports Markdown formatting for numbered lists. +You can create numbered lists by putting a number followed by a `.` at the start +of each line. Lists are numbered automatically, so you can reorder list items +while editing your message without having to update the numbers. Add two spaces +before the number to create a nested list. diff --git a/starlight_help/src/content/docs/include/_OwnerOnly.mdx b/starlight_help/src/content/docs/include/_OwnerOnly.mdx new file mode 100644 index 0000000000..7909c02788 --- /dev/null +++ b/starlight_help/src/content/docs/include/_OwnerOnly.mdx @@ -0,0 +1,5 @@ +import ZulipNote from '../../../components/ZulipNote.astro'; + + + This feature is only available to organization owners. + diff --git a/starlight_help/src/content/docs/include/_ParagraphsAndSectionsExamples.mdx b/starlight_help/src/content/docs/include/_ParagraphsAndSectionsExamples.mdx new file mode 100644 index 0000000000..b51701e163 --- /dev/null +++ b/starlight_help/src/content/docs/include/_ParagraphsAndSectionsExamples.mdx @@ -0,0 +1,19 @@ +### What you type + +``` +One blank space for a new paragraph +New line, same paragraph + +New paragraph + +---, ***, or ___ for a horizontal line +Over the line + +--- + +Under the line +``` + +### What it looks like + +![Markdown paragraph](../../../../../static/images/help/markdown-paragraph.png) diff --git a/starlight_help/src/content/docs/include/_ParagraphsAndSectionsIntro.mdx b/starlight_help/src/content/docs/include/_ParagraphsAndSectionsIntro.mdx new file mode 100644 index 0000000000..41abfc807c --- /dev/null +++ b/starlight_help/src/content/docs/include/_ParagraphsAndSectionsIntro.mdx @@ -0,0 +1,3 @@ +Zulip supports Markdown formatting for paragraphs and visual section breaks, +which you can use to control the layout of your text and to visually separate +different sections of content. diff --git a/starlight_help/src/content/docs/include/_PayByInvoiceSteps.mdx b/starlight_help/src/content/docs/include/_PayByInvoiceSteps.mdx new file mode 100644 index 0000000000..7e34d12b1c --- /dev/null +++ b/starlight_help/src/content/docs/include/_PayByInvoiceSteps.mdx @@ -0,0 +1,18 @@ +import ZulipTip from '../../../components/ZulipTip.astro'; + +1. Select **pay by invoice**. +1. Select your preferred option from the **Payment schedule** dropdown. +1. Select the **Number of licenses** you would like to purchase for your + organization; see details about [manual license + management](#how-does-manual-license-management-work). +1. Click **Update billing information** to enter your billing details, + which will be included on invoices and receipts. +1. Click the **Send invoice** button, and an email with an initial + invoice will be sent to the email address you used to sign in. +1. Your plan will be upgraded when the initial invoice is paid. + + + Until the initial invoice is paid, logging in to manage your billing + will show a page with a link to the outstanding invoice. You'll be able + to manage your plan once your first invoice is paid. + diff --git a/starlight_help/src/content/docs/include/_PayByInvoiceWarning.mdx b/starlight_help/src/content/docs/include/_PayByInvoiceWarning.mdx new file mode 100644 index 0000000000..7ad9605ccb --- /dev/null +++ b/starlight_help/src/content/docs/include/_PayByInvoiceWarning.mdx @@ -0,0 +1,8 @@ +import ZulipNote from '../../../components/ZulipNote.astro'; + + + Only [manual license management](#how-does-manual-license-management-work) is available + when paying by invoice. If you are using a non-US bank, please see + [details](#international-swift-transfers) on making sure your payment covers + the full amount of the invoice. + diff --git a/starlight_help/src/content/docs/include/_PaymentOptions.mdx b/starlight_help/src/content/docs/include/_PaymentOptions.mdx new file mode 100644 index 0000000000..ea77b8f0dc --- /dev/null +++ b/starlight_help/src/content/docs/include/_PaymentOptions.mdx @@ -0,0 +1,6 @@ +You can pay by credit card or by invoice. If you choose to pay by +invoice, your organization will be upgraded to the plan you selected +once the initial invoice is paid. + +Note that automatic license management is only available if you pay by +credit card. Paying by invoice requires manual license management. diff --git a/starlight_help/src/content/docs/include/_PersonalMenu.mdx b/starlight_help/src/content/docs/include/_PersonalMenu.mdx new file mode 100644 index 0000000000..d0e315c826 --- /dev/null +++ b/starlight_help/src/content/docs/include/_PersonalMenu.mdx @@ -0,0 +1,2 @@ +1. Click on your **profile picture** in the upper right + corner of the web or desktop app. diff --git a/starlight_help/src/content/docs/include/_PlanUpgradeSteps.mdx b/starlight_help/src/content/docs/include/_PlanUpgradeSteps.mdx new file mode 100644 index 0000000000..d5a32c82e3 --- /dev/null +++ b/starlight_help/src/content/docs/include/_PlanUpgradeSteps.mdx @@ -0,0 +1,7 @@ +1. Select your preferred option from the **Payment schedule** dropdown. +1. Click **Add card** to enter your payment details. +1. *(optional)* **View and update** billing information included on + receipts so that they are different from the information entered for + the payment method, e.g., in case you would prefer that the company's + name be on receipts instead of the card holder's name. +1. Click the **Purchase** button to complete your purchase. diff --git a/starlight_help/src/content/docs/include/_PollsExamples.mdx b/starlight_help/src/content/docs/include/_PollsExamples.mdx new file mode 100644 index 0000000000..5a1a8950ee --- /dev/null +++ b/starlight_help/src/content/docs/include/_PollsExamples.mdx @@ -0,0 +1,12 @@ +### What you type + +``` +/poll What did you drink this morning? +Milk +Tea +Coffee +``` + +### What it looks like + +![Markdown polls](../../../../../static/images/help/markdown-polls.png) diff --git a/starlight_help/src/content/docs/include/_PollsIntro.mdx b/starlight_help/src/content/docs/include/_PollsIntro.mdx new file mode 100644 index 0000000000..13dcc1474a --- /dev/null +++ b/starlight_help/src/content/docs/include/_PollsIntro.mdx @@ -0,0 +1,3 @@ +Zulip makes it easy to create a poll. Polls in Zulip are collaborative, so +anyone can add new options to a poll. However, only the creator of the poll can +edit the question. diff --git a/starlight_help/src/content/docs/include/_QuotesExamples.mdx b/starlight_help/src/content/docs/include/_QuotesExamples.mdx new file mode 100644 index 0000000000..89e79e9db0 --- /dev/null +++ b/starlight_help/src/content/docs/include/_QuotesExamples.mdx @@ -0,0 +1,18 @@ +### What you type + +```` +> a multi-line +quote on two lines + +normal text + +```quote +A multi-paragraph + +quote in two paragraphs +``` +```` + +### What it looks like + +![Markdown quotes](../../../../../static/images/help/markdown-quotes.png) diff --git a/starlight_help/src/content/docs/include/_QuotesIntro.mdx b/starlight_help/src/content/docs/include/_QuotesIntro.mdx new file mode 100644 index 0000000000..41b6ce62ba --- /dev/null +++ b/starlight_help/src/content/docs/include/_QuotesIntro.mdx @@ -0,0 +1,2 @@ +You can format quotes one line at a time, or create a block of text that will be +formatted as a quote. diff --git a/starlight_help/src/content/docs/include/_ReadingConversations.mdx b/starlight_help/src/content/docs/include/_ReadingConversations.mdx new file mode 100644 index 0000000000..0ca990b244 --- /dev/null +++ b/starlight_help/src/content/docs/include/_ReadingConversations.mdx @@ -0,0 +1,50 @@ +import RecentConversations from "./_RecentConversations.mdx" +import ConversationRecommendation from "./_ConversationRecommendation.mdx" +import ChevronDownIcon from "~icons/fa/chevron-down" +import InboxIntro from "./_InboxIntro.mdx" +import ConversationDefinition from "./_ConversationDefinition.mdx" +import LeftSidebarConversations from "./_LeftSidebarConversations.mdx" +import { Steps } from '@astrojs/starlight/components'; +import InboxInstructions from "./_InboxInstructions.mdx" +import KeyboardTip from '../../../components/KeyboardTip.astro'; +import { Tabs, TabItem } from '@astrojs/starlight/components' + + + + + +### Finding a conversation to read from the Inbox view + + + + + +### Finding a conversation to read from Recent conversations + + + +### Finding a conversation to read from the left sidebar + + + +### Reading conversations + + + + + 1. [Find](/help/finding-a-conversation-to-read) a conversation to read. + 1. Read the conversation, scrolling down with the mouse or by pressing + PgDn. + 1. If the conversation is not of interest, you can + [mark all messages as read](/help/marking-messages-as-read) by + jumping to the bottom with the **Scroll to bottom** + () button or the End shortcut. + + + + Use the N key to go to the next unread topic, or Shift + N + for the next unread [followed](/help/follow-a-topic) topic, or P for the next + unread direct message conversation. + + + diff --git a/starlight_help/src/content/docs/include/_RecentConversations.mdx b/starlight_help/src/content/docs/include/_RecentConversations.mdx new file mode 100644 index 0000000000..d73edeb10b --- /dev/null +++ b/starlight_help/src/content/docs/include/_RecentConversations.mdx @@ -0,0 +1,27 @@ +import FlattenedSteps from '../../../components/FlattenedSteps.astro'; +import { Tabs, TabItem } from '@astrojs/starlight/components' +import GoToRecentConversations from "./_GoToRecentConversations.mdx" +import ZulipTip from '../../../components/ZulipTip.astro'; + +Use the **recent conversations** view to get +an overview of all the ongoing conversations. This view is particularly useful +for catching up on messages sent while you were away. + + + + + + + 1. The filters at the top help you quickly find relevant conversations. + For example, select **Participated** to filter to the conversations you + have sent messages to. + 1. Click on a topic or DM conversation you're interested in to view it. You can + return to **recent conversations** when done (e.g., by using the **back** + button in your browser or desktop app) to select the next conversation. + + + + + + The **Participants** column shows which users recently sent a message (newest on the left). + diff --git a/starlight_help/src/content/docs/include/_ReplyingToMessages.mdx b/starlight_help/src/content/docs/include/_ReplyingToMessages.mdx new file mode 100644 index 0000000000..520b179f71 --- /dev/null +++ b/starlight_help/src/content/docs/include/_ReplyingToMessages.mdx @@ -0,0 +1,39 @@ +import { Steps } from '@astrojs/starlight/components'; +import SendIcon from "~icons/zulip-icon/send" +import { Tabs, TabItem } from '@astrojs/starlight/components' +import ZulipTip from '../../../components/ZulipTip.astro'; + + + + + 1. Click the **Message...** button at the bottom of the app. + 1. Compose your message. You + can [preview your message](/help/preview-your-message-before-sending) before + sending. + 1. Click the **Send** () button, or + use a [keyboard shortcut](/help/configure-send-message-keys) to send your + message. + + + + You can also reply by clicking on a message, or using the R or + Enter keyboard shortcuts to reply to the message in the blue box. + + + + + + 1. Tap the **Message ...** text in the compose box at the bottom of the app. + 1. Compose your message, and tap the **Send** + () button in the + bottom right corner of the app. + + + + If you're reading messages in a [channel feed](/help/channel-feed), + or the [combined feed](/help/combined-feed), navigate to the conversation + view by tapping the message recipient bar of the conversation you want to + reply to. + + + diff --git a/starlight_help/src/content/docs/include/_ReviewOrganizationSettingsInstructions.mdx b/starlight_help/src/content/docs/include/_ReviewOrganizationSettingsInstructions.mdx new file mode 100644 index 0000000000..ddfb75557b --- /dev/null +++ b/starlight_help/src/content/docs/include/_ReviewOrganizationSettingsInstructions.mdx @@ -0,0 +1,15 @@ +import FlattenedSteps from '../../../components/FlattenedSteps.astro'; +import NavigationSteps from "../../../components/NavigationSteps.astro" +import UserGroupsIntro from "./_UserGroupsIntro.mdx" + +Review the settings for your organization to set everything up how you want it +to be. + + + + + + + 1. Click on the **Organization settings** and **Organization + permissions** tabs, as well as any others that are of interest. + diff --git a/starlight_help/src/content/docs/include/_RightSidebarUserCard.mdx b/starlight_help/src/content/docs/include/_RightSidebarUserCard.mdx new file mode 100644 index 0000000000..eaa7cd2ab7 --- /dev/null +++ b/starlight_help/src/content/docs/include/_RightSidebarUserCard.mdx @@ -0,0 +1,5 @@ +import MoreVerticalIcon from "~icons/zulip-icon/more-vertical" + +1. Hover over a user's name in the right sidebar. +1. Click on their avatar or the **ellipsis** () to the right of their name to open their + **user card**. diff --git a/starlight_help/src/content/docs/include/_RightSidebarViewProfile.mdx b/starlight_help/src/content/docs/include/_RightSidebarViewProfile.mdx new file mode 100644 index 0000000000..f5afbf5685 --- /dev/null +++ b/starlight_help/src/content/docs/include/_RightSidebarViewProfile.mdx @@ -0,0 +1,8 @@ +import FlattenedSteps from '../../../components/FlattenedSteps.astro'; +import RightSidebarUserCard from "./_RightSidebarUserCard.mdx" + + + + + 1. Click **View profile**. + diff --git a/starlight_help/src/content/docs/include/_SamlLoginButton.mdx b/starlight_help/src/content/docs/include/_SamlLoginButton.mdx new file mode 100644 index 0000000000..c88099f124 --- /dev/null +++ b/starlight_help/src/content/docs/include/_SamlLoginButton.mdx @@ -0,0 +1,2 @@ +* How you would like the Zulip log in button to be labeled: “Log in with...” +* *(optional)* An icon to use on the log in button diff --git a/starlight_help/src/content/docs/include/_SaveChanges.mdx b/starlight_help/src/content/docs/include/_SaveChanges.mdx new file mode 100644 index 0000000000..89e1c72d20 --- /dev/null +++ b/starlight_help/src/content/docs/include/_SaveChanges.mdx @@ -0,0 +1 @@ +1. Click **Save changes**. diff --git a/starlight_help/src/content/docs/include/_SelectChannelViewGeneral.mdx b/starlight_help/src/content/docs/include/_SelectChannelViewGeneral.mdx new file mode 100644 index 0000000000..0b0e325ec6 --- /dev/null +++ b/starlight_help/src/content/docs/include/_SelectChannelViewGeneral.mdx @@ -0,0 +1 @@ +1. Select the **General** tab on the right. diff --git a/starlight_help/src/content/docs/include/_SelectChannelViewGeneralAdvanced.mdx b/starlight_help/src/content/docs/include/_SelectChannelViewGeneralAdvanced.mdx new file mode 100644 index 0000000000..408195f22f --- /dev/null +++ b/starlight_help/src/content/docs/include/_SelectChannelViewGeneralAdvanced.mdx @@ -0,0 +1,8 @@ +import FlattenedSteps from '../../../components/FlattenedSteps.astro'; +import SelectChannelViewGeneral from "./_SelectChannelViewGeneral.mdx" + + + + + 1. Click **Advanced configuration** to view advanced configuration options. + diff --git a/starlight_help/src/content/docs/include/_SelectChannelViewPersonal.mdx b/starlight_help/src/content/docs/include/_SelectChannelViewPersonal.mdx new file mode 100644 index 0000000000..1994f6e30c --- /dev/null +++ b/starlight_help/src/content/docs/include/_SelectChannelViewPersonal.mdx @@ -0,0 +1 @@ +1. Select the **Personal** tab on the right. diff --git a/starlight_help/src/content/docs/include/_SelectChannelViewSubscribers.mdx b/starlight_help/src/content/docs/include/_SelectChannelViewSubscribers.mdx new file mode 100644 index 0000000000..649057cf6a --- /dev/null +++ b/starlight_help/src/content/docs/include/_SelectChannelViewSubscribers.mdx @@ -0,0 +1 @@ +1. Select the **Subscribers** tab on the right. diff --git a/starlight_help/src/content/docs/include/_SelfHostedBillingLogInStep.mdx b/starlight_help/src/content/docs/include/_SelfHostedBillingLogInStep.mdx new file mode 100644 index 0000000000..88093915b6 --- /dev/null +++ b/starlight_help/src/content/docs/include/_SelfHostedBillingLogInStep.mdx @@ -0,0 +1 @@ +1. [Log in to billing management](#log-in-to-billing-management). diff --git a/starlight_help/src/content/docs/include/_SelfUserCard.mdx b/starlight_help/src/content/docs/include/_SelfUserCard.mdx new file mode 100644 index 0000000000..e7cd762c25 --- /dev/null +++ b/starlight_help/src/content/docs/include/_SelfUserCard.mdx @@ -0,0 +1,5 @@ +import MoreVerticalIcon from "~icons/zulip-icon/more-vertical" + +1. Hover over your name in the right sidebar. +1. Click on the **ellipsis** () + to open your [**user card**](/help/user-cards). diff --git a/starlight_help/src/content/docs/include/_SendDm.mdx b/starlight_help/src/content/docs/include/_SendDm.mdx new file mode 100644 index 0000000000..288da667c4 --- /dev/null +++ b/starlight_help/src/content/docs/include/_SendDm.mdx @@ -0,0 +1,54 @@ +import MobileDirectMessages from "./_MobileDirectMessages.mdx" +import ComposeAndSendMessage from "./_ComposeAndSendMessage.mdx" +import SendIcon from "~icons/zulip-icon/send" +import SquarePlusIcon from "~icons/zulip-icon/square-plus" +import ZulipTip from '../../../components/ZulipTip.astro'; +import FlattenedSteps from '../../../components/FlattenedSteps.astro'; +import KeyboardTip from '../../../components/KeyboardTip.astro'; +import { Tabs, TabItem } from '@astrojs/starlight/components' + + + + + 1. Click the **new direct message** () + button next to the **direct messages** heading in the left sidebar, or + the **New direct message** button at the bottom of the app. + 1. Start typing the name of the person or [group](/help/user-groups) you want to + message, and select their name from the list of suggestions. You can continue + adding as many message recipients as you like. + + + + + + You can also use the X keyboard shortcut to start a new direct + message conversation. + + + + You can also click on any user in the right sidebar to start composing + a direct message to them. Or open their **user card** by clicking on + their profile picture or name, and select **Send direct message**. + + + + + + + + 1. Tap the **New DM** button. + 1. Start typing the name of the person you want to message, and + select their name from the list of suggestions. You can continue + adding as many message recipients as you like. + 1. Approve by tapping the **Compose** button in the top right corner of the app. + 1. Compose your message, and tap the **Send** + () button in the + bottom right corner of the app. + + + + You can also tap on a user's profile picture or name, and tap the + **Send direct message** button at the bottom of the app. + + + diff --git a/starlight_help/src/content/docs/include/_SendUsInfo.mdx b/starlight_help/src/content/docs/include/_SendUsInfo.mdx new file mode 100644 index 0000000000..a1d9b38981 --- /dev/null +++ b/starlight_help/src/content/docs/include/_SendUsInfo.mdx @@ -0,0 +1,2 @@ +If you are using Zulip Cloud, we'll take it from here! Please email +[support@zulip.com](mailto:support@zulip.com) with the following information: diff --git a/starlight_help/src/content/docs/include/_SetStatus.mdx b/starlight_help/src/content/docs/include/_SetStatus.mdx new file mode 100644 index 0000000000..413972e69b --- /dev/null +++ b/starlight_help/src/content/docs/include/_SetStatus.mdx @@ -0,0 +1,4 @@ +1. Click **Set status** or **Edit status**. +1. Click to select one of the common statuses, *or* choose any emoji and/or + write a short message. +1. Click **Save**. diff --git a/starlight_help/src/content/docs/include/_SetUpYourAccount.mdx b/starlight_help/src/content/docs/include/_SetUpYourAccount.mdx new file mode 100644 index 0000000000..87d963f72e --- /dev/null +++ b/starlight_help/src/content/docs/include/_SetUpYourAccount.mdx @@ -0,0 +1,24 @@ +import ZulipTip from '../../../components/ZulipTip.astro'; + + + If this is your first time using Zulip, we recommend starting with the web + or desktop experience to set up your account and get oriented. + + +* Get the [mobile and desktop apps](/apps/). Zulip also works great in a + [browser](/help/supported-browsers). +* [Add a profile picture](/help/change-your-profile-picture) and + [edit your profile information](/help/edit-your-profile) to tell others + about yourself. +* [Review your preferences](/help/review-your-settings#review-your-preferences). + You can [switch between light and dark theme](/help/dark-theme), [customize + the font size](/help/font-size), [pick your favorite emoji + theme](/help/emoji-and-emoticons#change-your-emoji-set), [change your + language](/help/change-your-language), and make other tweaks to your Zulip + experience. +* [Browse and subscribe to channels](/help/introduction-to-channels#browse-and-subscribe-to-channels). +* Decide whether you want Enter [to send your message or add a + new line](/help/configure-send-message-keys). +* [Configure your notifications](/help/review-your-settings#review-your-notification-settings) + to work the way you do. If you're joining a low traffic organization and + aren't using the desktop app, consider sending all messages to email. diff --git a/starlight_help/src/content/docs/include/_SidebarIndex.mdx b/starlight_help/src/content/docs/include/_SidebarIndex.mdx new file mode 100644 index 0000000000..46191dc7e7 --- /dev/null +++ b/starlight_help/src/content/docs/include/_SidebarIndex.mdx @@ -0,0 +1,315 @@ +{/* Changes to this file should be propagated to starlight_help/astro.config.mjs. */} + +## Guides + +* [Getting started with Zulip](/help/getting-started-with-zulip) +* [Choosing a team chat app](https://blog.zulip.com/2024/11/04/choosing-a-team-chat-app/) +* [Why Zulip](https://zulip.com/why-zulip/) +* [Trying out Zulip](/help/trying-out-zulip) +* [Zulip Cloud or self-hosting?](/help/zulip-cloud-or-self-hosting) +* [Moving to Zulip](/help/moving-to-zulip) +* [Community moderation toolkit](/help/moderating-open-organizations) +* [Setting up Zulip for a class](/help/setting-up-zulip-for-a-class) +* [Using Zulip for a class](/help/using-zulip-for-a-class) +* [Using Zulip via email](/help/using-zulip-via-email) + +## Getting started + +* [Joining an organization](/help/join-a-zulip-organization) +* [Set up your account](/help/set-up-your-account) +* [Introduction to topics](/help/introduction-to-topics) +* [Starting a new topic](/help/introduction-to-topics#how-to-start-a-new-topic) +* [Finding a conversation to read](/help/finding-a-conversation-to-read) +* [Reading conversations](/help/reading-conversations) +* [Starting a new direct message](/help/starting-a-new-direct-message) +* [Replying to messages](/help/replying-to-messages) +* [Messaging tips & tricks](/help/messaging-tips) +* [Keyboard shortcuts](/help/keyboard-shortcuts) + +## Setting up your organization + +* [Migrating from other chat tools](/help/migrating-from-other-chat-tools) +* [Create your organization profile](/help/create-your-organization-profile) +* [Create user groups](/help/create-user-groups) +* [Customize organization settings](/help/customize-organization-settings) +* [Create channels](/help/create-channels) +* [Customize settings for new users](/help/customize-settings-for-new-users) +* [Invite users to join](/help/invite-users-to-join) +* [Set up integrations](/help/set-up-integrations) + +## Account basics + +* [Edit your profile](/help/edit-your-profile) +* [Change your name](/help/change-your-name) +* [Change your email address](/help/change-your-email-address) +* [Change your profile picture](/help/change-your-profile-picture) +* [Change your password](/help/change-your-password) +* [Configure email visibility](/help/configure-email-visibility) +* [Logging in](/help/logging-in) +* [Logging out](/help/logging-out) +* [Switching between organizations](/help/switching-between-organizations) +* [Import your settings](/help/import-your-settings) +* [Review your settings](/help/review-your-settings) +* [Deactivate your account](/help/deactivate-your-account) + +## Preferences + +* [Dark theme](/help/dark-theme) +* [Font size](/help/font-size) +* [Line spacing](/help/line-spacing) +* [Configure send message keys](/help/configure-send-message-keys) +* [Change your language](/help/change-your-language) +* [Change your time zone](/help/change-your-timezone) +* [Change the time format](/help/change-the-time-format) +* [Configure emoticon translations](/help/configure-emoticon-translations) +* [Configure home view](/help/configure-home-view) +* [Enable full width display](/help/enable-full-width-display) +* [Manage your uploaded files](/help/manage-your-uploaded-files) + +## Writing messages + +* [Message formatting](/help/format-your-message-using-markdown) +* [Mention a user or group](/help/mention-a-user-or-group) +* [Link to a channel, topic, or message](/help/link-to-a-message-or-conversation) +* [Format a quote](/help/format-a-quote) +* [Quote or forward a message](/help/quote-or-forward-a-message) +* [Emoji and emoticons](/help/emoji-and-emoticons) +* [Insert a link](/help/insert-a-link) +* [Saved snippets](/help/saved-snippets) +* [Share and upload files](/help/share-and-upload-files) +* [Animated GIFs](/help/animated-gifs-from-giphy) +* [Text emphasis](/help/text-emphasis) +* [Paragraph and section formatting](/help/paragraph-and-section-formatting) +* [Bulleted lists](/help/bulleted-lists) +* [Numbered lists](/help/numbered-lists) +* [Tables](/help/tables) +* [Code blocks](/help/code-blocks) +* [LaTeX](/help/latex) +* [Spoilers](/help/spoilers) +* [/me action messages](/help/me-action-messages) +* [Polls](/help/create-a-poll) +* [Collaborative to-do lists](/help/collaborative-to-do-lists) +* [Global times](/help/global-times) +* [Start a call](/help/start-a-call) + +## Sending messages + +* [Open the compose box](/help/open-the-compose-box) +* [Mastering the compose box](/help/mastering-the-compose-box) +* [Resize the compose box](/help/resize-the-compose-box) +* [Typing notifications](/help/typing-notifications) +* [Preview messages before sending](/help/preview-your-message-before-sending) +* [Verify a message was sent](/help/verify-your-message-was-successfully-sent) +* [Edit a message](/help/edit-a-message) +* [Delete a message](/help/delete-a-message) +* [Draft messages](/help/view-and-edit-your-message-drafts) +* [Schedule a message](/help/schedule-a-message) +* [Message a channel by email](/help/message-a-channel-by-email) + +## Reading messages + +* [Reading strategies](/help/reading-strategies) +* [Inbox](/help/inbox) +* [Recent conversations](/help/recent-conversations) +* [Combined feed](/help/combined-feed) +* [Channel feed](/help/channel-feed) +* [List of topics in a channel](/help/list-of-topics) +* [Left sidebar](/help/left-sidebar) +* [Message actions](/help/message-actions) +* [Marking messages as read](/help/marking-messages-as-read) +* [Marking messages as unread](/help/marking-messages-as-unread) +* [Configure unread message counters](/help/configure-unread-message-counters) +* [Configure where you land](/help/configure-where-you-land) +* [Emoji reactions](/help/emoji-reactions) +* [View your mentions](/help/view-your-mentions) +* [Star a message](/help/star-a-message) +* [Schedule a reminder](/help/schedule-a-reminder) +* [View images and videos](/help/view-images-and-videos) +* [View messages sent by a user](/help/view-messages-sent-by-a-user) +* [Link to a message or conversation](/help/link-to-a-message-or-conversation) +* [Searching for messages](/help/search-for-messages) +* [Printing messages](/help/printing-messages) +* [View message content as Markdown](/help/view-the-markdown-source-of-a-message) +* [View when message was sent](/help/view-the-exact-time-a-message-was-sent) +* [View a message's edit history](/help/view-a-messages-edit-history) +* [Collapse a message](/help/collapse-a-message) +* [Read receipts](/help/read-receipts) + +## People + +* [Introduction to users](/help/introduction-to-users) +* [User list](/help/user-list) +* [Status and availability](/help/status-and-availability) +* [User cards](/help/user-cards) +* [View someone's profile](/help/view-someones-profile) +* [Direct messages](/help/direct-messages) +* [Find administrators](/help/find-administrators) + +## Groups + +* [User groups](/help/user-groups) +* [View group members](/help/view-group-members) + +## Channels + +* [Introduction to channels](/help/introduction-to-channels) +* [Subscribe to a channel](/help/introduction-to-channels#browse-and-subscribe-to-channels) +* [Create a channel](/help/create-a-channel) +* [Pin a channel](/help/pin-a-channel) +* [Change the color of a channel](/help/change-the-color-of-a-channel) +* [Channel folders](/help/channel-folders) +* [Unsubscribe from a channel](/help/unsubscribe-from-a-channel) +* [Hide or reveal inactive channels](/help/manage-inactive-channels) +* [Move content to another channel](/help/move-content-to-another-channel) +* [View channel information](/help/view-channel-information) +* [View channel subscribers](/help/view-channel-subscribers) + +## Topics + +* [Introduction to topics](/help/introduction-to-topics) +* [Rename a topic](/help/rename-a-topic) +* [Resolve a topic](/help/resolve-a-topic) +* [Move content to another topic](/help/move-content-to-another-topic) +* [“General chat” topic](/help/general-chat-topic) +* [Delete a topic](/help/delete-a-topic) + +## Notifications + +* [Channel notifications](/help/channel-notifications) +* [Topic notifications](/help/topic-notifications) +* [Follow a topic](/help/follow-a-topic) +* [DMs, mentions, and alerts](/help/dm-mention-alert-notifications) +* [Mute or unmute a channel](/help/mute-a-channel) +* [Mute or unmute a topic](/help/mute-a-topic) +* [Mute a user](/help/mute-a-user) +* [Email notifications](/help/email-notifications) +* [Desktop notifications](/help/desktop-notifications) +* [Mobile notifications](/help/mobile-notifications) +* [Do not disturb](/help/do-not-disturb) + +## Apps + +* [Download apps for every platform](https://zulip.com/apps/) +* [Mobile app installation guides](/help/mobile-app-install-guide) +* [Desktop installation guides](/help/desktop-app-install-guide) +* [Supported browsers](/help/supported-browsers) +* [Configure how links open](/help/configure-how-links-open) +* [Connect through a proxy](/help/connect-through-a-proxy) +* [Use a custom certificate](/help/custom-certificates) + +# Zulip administration + +## Organization profile + +* [Organization type](/help/organization-type) +* [Communities directory](/help/communities-directory) +* [Linking to your organization](/help/linking-to-zulip) +* [Change organization URL](/help/change-organization-url) +* [Deactivate your organization](/help/deactivate-your-organization) + +## Import an organization + +* [Import from Mattermost](/help/import-from-mattermost) +* [Import from Slack](/help/import-from-slack) +* [Import from Rocket.Chat](/help/import-from-rocketchat) +* [Export your organization](/help/export-your-organization) + +## Account creation and authentication + +* [Configure default new user settings](/help/configure-default-new-user-settings) +* [Custom profile fields](/help/custom-profile-fields) +* [Invite new users](/help/invite-new-users) +* [Restrict account creation](/help/restrict-account-creation) +* [Configure authentication methods](/help/configure-authentication-methods) +* [SAML authentication](/help/saml-authentication) +* [SCIM provisioning](/help/scim) + +## User management + +* [Manage a user](/help/manage-a-user) +* [Deactivate or reactivate a user](/help/deactivate-or-reactivate-a-user) +* [Change a user's name](/help/change-a-users-name) +* [Manage a user's channel subscriptions](/help/manage-user-channel-subscriptions) +* [Manage a user's group membership](/help/manage-user-group-membership) + +## Channel management + +* [Create a channel](/help/create-a-channel) +* [Private channels](/help/channel-permissions#private-channels) +* [Public channels](/help/channel-permissions#public-channels) +* [Public access option](/help/public-access-option) +* [“General chat” channels](/help/general-chat-channels) +* [Manage channel folders](/help/manage-channel-folders) +* [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) +* [Restrict channel creation](/help/configure-who-can-create-channels) +* [Configure who can subscribe](/help/configure-who-can-subscribe) +* [Configure who can subscribe others](/help/configure-who-can-invite-to-channels) +* [Configure who can unsubscribe anyone](/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) +* [Set default channels for new users](/help/set-default-channels-for-new-users) +* [Rename a channel](/help/rename-a-channel) +* [Change a channel's description](/help/change-the-channel-description) +* [Pin information](/help/pin-information) +* [Change the privacy of a channel](/help/change-the-privacy-of-a-channel) +* [Delete or archive a channel](/help/archive-a-channel) + +## Permissions management + +* [Manage permissions](/help/manage-permissions) +* [Manage user groups](/help/manage-user-groups) +* [Deactivate a user group](/help/deactivate-a-user-group) +* [User roles](/help/user-roles) +* [Guest users](/help/guest-users) +* [Restrict direct messages](/help/restrict-direct-messages) +* [Restrict wildcard mentions](/help/restrict-wildcard-mentions) +* [Restrict message editing](/help/restrict-message-editing-and-deletion) +* [Restrict message edit history access](/help/restrict-message-edit-history-access) +* [Restrict moving messages](/help/restrict-moving-messages) +* [Restrict resolving topics](/help/restrict-resolving-topics) +* [Restrict name and email changes](/help/restrict-name-and-email-changes) +* [Restrict profile picture changes](/help/restrict-profile-picture-changes) +* [Restrict permissions of new members](/help/restrict-permissions-of-new-members) + +## Organization settings + +* [Configure organization language](/help/configure-organization-language) +* [Custom emoji](/help/custom-emoji) +* [Configure call provider](/help/configure-call-provider) +* [Add a custom linkifier](/help/add-a-custom-linkifier) +* [Require topics in channel messages](/help/require-topics) +* [Image, video and website previews](/help/image-video-and-website-previews) +* [Hide message content in emails](/help/hide-message-content-in-emails) +* [Message retention policy](/help/message-retention-policy) +* [Weekly digest emails](/help/digest-emails) +* [Disable welcome emails](/help/disable-welcome-emails) +* [Configure a custom welcome message](/help/configure-a-custom-welcome-message) +* [Configure automated notices](/help/configure-automated-notices) +* [Configure multi-language search](/help/configure-multi-language-search) +* [Usage statistics](/help/analytics) + +## Bots & integrations + +* [Bots overview](/help/bots-overview) +* [Integrations overview](/help/integrations-overview) +* [Add a bot or integration](/help/add-a-bot-or-integration) +* [Generate integration URL](/help/generate-integration-url) +* [Manage a bot](/help/manage-a-bot) +* [Deactivate or reactivate a bot](/help/deactivate-or-reactivate-a-bot) +* [Request an integration](/help/request-an-integration) +* [Restrict bot creation](/help/restrict-bot-creation) +* [View your bots](/help/view-your-bots) +* [View all bots in your organization](/help/view-all-bots-in-your-organization) + +## Support + +* [View Zulip version](/help/view-zulip-version) +* [Zulip Cloud billing](/help/zulip-cloud-billing) +* [Self-hosted billing](/help/self-hosted-billing) +* [GDPR compliance](/help/gdpr-compliance) +* [Move to Zulip Cloud](/help/move-to-zulip-cloud) +* [Support the Zulip project](/help/support-zulip-project) +* [Linking to the Zulip website](/help/linking-to-zulip-website) +* [Contact support](/help/contact-support) diff --git a/starlight_help/src/content/docs/include/_SpoilersExamples.mdx b/starlight_help/src/content/docs/include/_SpoilersExamples.mdx new file mode 100644 index 0000000000..3dd2004b03 --- /dev/null +++ b/starlight_help/src/content/docs/include/_SpoilersExamples.mdx @@ -0,0 +1,28 @@ +### What you type + +```` + +```spoiler The spoiler heading might summarize what's inside +This content is initially hidden. + +> You can combine spoilers with other formatting. + +``` + +A message can contain both spoilers and other content. + +```spoiler +Leave the heading blank if you like. +``` + +```` + +### What it looks like + +Collapsed spoilers: + +![Spoiler collapsed](../../../../../static/images/help/spoiler-collapsed.png) + +Expanded spoilers: + +![Spoiler expanded](../../../../../static/images/help/spoiler-expanded.png) diff --git a/starlight_help/src/content/docs/include/_SpoilersIntro.mdx b/starlight_help/src/content/docs/include/_SpoilersIntro.mdx new file mode 100644 index 0000000000..348edfa0cc --- /dev/null +++ b/starlight_help/src/content/docs/include/_SpoilersIntro.mdx @@ -0,0 +1,3 @@ +Zulip lets you temporarily hide content in a collapsible **spoiler** section, +with only the header initially shown. Clicking on the header reveals the hidden +content. diff --git a/starlight_help/src/content/docs/include/_StartComposing.mdx b/starlight_help/src/content/docs/include/_StartComposing.mdx new file mode 100644 index 0000000000..952cc000fd --- /dev/null +++ b/starlight_help/src/content/docs/include/_StartComposing.mdx @@ -0,0 +1 @@ +1. [Open the compose box](/help/open-the-compose-box). diff --git a/starlight_help/src/content/docs/include/_StartTopicViaLeftSidebar.mdx b/starlight_help/src/content/docs/include/_StartTopicViaLeftSidebar.mdx new file mode 100644 index 0000000000..4d68e39897 --- /dev/null +++ b/starlight_help/src/content/docs/include/_StartTopicViaLeftSidebar.mdx @@ -0,0 +1,17 @@ +import FlattenedSteps from '../../../components/FlattenedSteps.astro'; +import KeyboardTip from '../../../components/KeyboardTip.astro'; +import ComposeAndSendMessage from "./_ComposeAndSendMessage.mdx" +import SquarePlusIcon from "~icons/zulip-icon/square-plus" + + + 1. Click the **new topic** () button + next to the name of the channel where you'd like to start a conversation. + 1. Enter a topic name. Think about finishing the sentence: “Hey, can we chat about… ?” + + + + + + You can also use the C keyboard shortcut to start a new topic in + the channel you're viewing. + diff --git a/starlight_help/src/content/docs/include/_StartingANewDirectMessage.mdx b/starlight_help/src/content/docs/include/_StartingANewDirectMessage.mdx new file mode 100644 index 0000000000..1b430f2354 --- /dev/null +++ b/starlight_help/src/content/docs/include/_StartingANewDirectMessage.mdx @@ -0,0 +1,9 @@ +import SendDm from "./_SendDm.mdx" +import ZulipTip from '../../../components/ZulipTip.astro'; + + + + + Rather than kicking off a group direct message, consider starting the + conversation in a new topic to make it easier to browse later on. + diff --git a/starlight_help/src/content/docs/include/_SubscribeUserToChannel.mdx b/starlight_help/src/content/docs/include/_SubscribeUserToChannel.mdx new file mode 100644 index 0000000000..d9c63a711d --- /dev/null +++ b/starlight_help/src/content/docs/include/_SubscribeUserToChannel.mdx @@ -0,0 +1,72 @@ +import NavigationSteps from "../../../components/NavigationSteps.astro" +import { Steps } from '@astrojs/starlight/components'; +import DependsOnPermissions from "./_DependsOnPermissions.mdx" +import AutomatedDmChannelSubscription from "./_AutomatedDmChannelSubscription.mdx" +import SelectChannelViewSubscribers from "./_SelectChannelViewSubscribers.mdx" +import ZulipTip from '../../../components/ZulipTip.astro'; +import FlattenedSteps from '../../../components/FlattenedSteps.astro'; +import { Tabs, TabItem } from '@astrojs/starlight/components' +import ChannelMenuSubscribersTabTip from "./_ChannelMenuSubscribersTabTip.mdx" +import RightSidebarViewProfile from "./_RightSidebarViewProfile.mdx" + + + + + + + + + 1. Select a channel. + + + + 1. Under **Add subscribers**, enter the user's name or email address. To + subscribe users in bulk, you can copy members from an existing channel or + [user group](/help/user-groups). The typeahead will only include users who + aren't already subscribed to the channel. + 1. Configure **Send notification message to newly subscribed users** as desired. + 1. Click **Add**. + + + + + + + + + + 1. Select the **Channels** tab. + 1. Under **Subscribe user to channels**, select a channel from the + dropdown list. You can start typing to filter channels. + 1. Click the **Subscribe** button. + + + + + + 1. Start a message in the channel you want to subscribe someone to, in a + [new](/help/introduction-to-topics#how-to-start-a-new-topic) or + [existing](/help/replying-to-messages) conversation. + 1. [Mention](/help/mention-a-user-or-group#from-the-compose-box) the user you + want to subscribe. + 1. Click the **Subscribe them** button on the banner that appears above the + compose box. + + + + You don't have to send the message you started composing. + + + + + 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/1222). If + you're interested in this feature, please react to the issue's + description with 👍. + + + + diff --git a/starlight_help/src/content/docs/include/_SupportingZulipMotivation.mdx b/starlight_help/src/content/docs/include/_SupportingZulipMotivation.mdx new file mode 100644 index 0000000000..7523e489e7 --- /dev/null +++ b/starlight_help/src/content/docs/include/_SupportingZulipMotivation.mdx @@ -0,0 +1,5 @@ +Zulip sponsors free [Zulip Cloud Standard](https://zulip.com/plans/) hosting for +hundreds of worthy organizations. Zulip has also invested into making it as easy +as possible to [self-host](https://zulip.com/self-hosting/) its [100% +open-source](https://github.com/zulip/zulip#readme) software. Read about the +[Zulip project values](https://zulip.com/values/) to learn more. diff --git a/starlight_help/src/content/docs/include/_SwitchingBetweenOrganizations.mdx b/starlight_help/src/content/docs/include/_SwitchingBetweenOrganizations.mdx new file mode 100644 index 0000000000..8aa68d6346 --- /dev/null +++ b/starlight_help/src/content/docs/include/_SwitchingBetweenOrganizations.mdx @@ -0,0 +1,30 @@ +import MobileSwitchAccount from "./_MobileSwitchAccount.mdx" +import { Steps } from '@astrojs/starlight/components'; +import FlattenedSteps from '../../../components/FlattenedSteps.astro'; +import { Tabs, TabItem } from '@astrojs/starlight/components' +import DesktopToggleSidebarTip from "./_DesktopToggleSidebarTip.mdx" + + + + + + + 1. Tap on the desired Zulip organization. + + + + + + 1. Click on a logo in the **organizations sidebar** on the left, or choose + an organization from the **Window** menu in the top menu bar. + + + + + + + You can log in to multiple Zulip organizations by opening multiple tabs, and + logging into one Zulip organization in each tab. To switch Zulip organizations, + just switch tabs. + + diff --git a/starlight_help/src/content/docs/include/_TablesExamples.mdx b/starlight_help/src/content/docs/include/_TablesExamples.mdx new file mode 100644 index 0000000000..5dcb555b1f --- /dev/null +++ b/starlight_help/src/content/docs/include/_TablesExamples.mdx @@ -0,0 +1,21 @@ +import ZulipTip from '../../../components/ZulipTip.astro'; + +### What you type + +``` +|| yes | no | maybe +|---|---|:---:|------: +| A | left-aligned | centered | right-aligned +| B | extra spaces | are | ok +| C | **bold** *italic* ~~strikethrough~~ :smile: || +``` + + + The initial pipes (`|`) are optional if every entry in the first column is + non-empty. + The header separators (`---`) must be at least three dashes long. + + +### What it looks like + +![Markdown table](../../../../../static/images/help/markdown-table.png) diff --git a/starlight_help/src/content/docs/include/_TablesIntro.mdx b/starlight_help/src/content/docs/include/_TablesIntro.mdx new file mode 100644 index 0000000000..6a620145b5 --- /dev/null +++ b/starlight_help/src/content/docs/include/_TablesIntro.mdx @@ -0,0 +1 @@ +Zulip supports Markdown formatting for tables. diff --git a/starlight_help/src/content/docs/include/_ToDoListsExamples.mdx b/starlight_help/src/content/docs/include/_ToDoListsExamples.mdx new file mode 100644 index 0000000000..a91c4de2b8 --- /dev/null +++ b/starlight_help/src/content/docs/include/_ToDoListsExamples.mdx @@ -0,0 +1,15 @@ +### What you type + +``` +/todo Today's tasks +Task 1: This is the first task. +Task 2: This is the second task. +Last task +``` + +### What it looks like + +Tasks are marked (and unmarked) as completed by clicking the checkboxes +on the left. + +![Markdown todo-lists](../../../../../static/images/help/markdown-todo.png) diff --git a/starlight_help/src/content/docs/include/_ToDoListsIntro.mdx b/starlight_help/src/content/docs/include/_ToDoListsIntro.mdx new file mode 100644 index 0000000000..3aaf997a18 --- /dev/null +++ b/starlight_help/src/content/docs/include/_ToDoListsIntro.mdx @@ -0,0 +1,4 @@ +Zulip supports creating shared to-do lists where any user who can access the +message can add tasks by entering the task's title and description, and clicking +**Add task**. Once created, task titles and descriptions cannot be edited. The task +list title can be edited any time by the to-do list's creator. diff --git a/starlight_help/src/content/docs/include/_TopicActions.mdx b/starlight_help/src/content/docs/include/_TopicActions.mdx new file mode 100644 index 0000000000..fe08e2837c --- /dev/null +++ b/starlight_help/src/content/docs/include/_TopicActions.mdx @@ -0,0 +1,4 @@ +import MoreVerticalIcon from "~icons/zulip-icon/more-vertical" + +1. Hover over a topic in the left sidebar. +1. Click on the **ellipsis** (). diff --git a/starlight_help/src/content/docs/include/_TopicLongPressMenu.mdx b/starlight_help/src/content/docs/include/_TopicLongPressMenu.mdx new file mode 100644 index 0000000000..15037f8415 --- /dev/null +++ b/starlight_help/src/content/docs/include/_TopicLongPressMenu.mdx @@ -0,0 +1 @@ +1. Press and hold a topic until the long-press menu appears. diff --git a/starlight_help/src/content/docs/include/_TopicLongPressMenuTip.mdx b/starlight_help/src/content/docs/include/_TopicLongPressMenuTip.mdx new file mode 100644 index 0000000000..f4c9ea04bd --- /dev/null +++ b/starlight_help/src/content/docs/include/_TopicLongPressMenuTip.mdx @@ -0,0 +1,6 @@ +import ZulipTip from '../../../components/ZulipTip.astro'; + + + If you are viewing a single topic, you can access the long-press + menu from the bar at the top of the app. + diff --git a/starlight_help/src/content/docs/include/_TopicsIntro.mdx b/starlight_help/src/content/docs/include/_TopicsIntro.mdx new file mode 100644 index 0000000000..3aeebeb698 --- /dev/null +++ b/starlight_help/src/content/docs/include/_TopicsIntro.mdx @@ -0,0 +1,19 @@ +Zulip is designed around conversations that are labeled with **topics**, to make +communication organized and efficient. It’s easy to get an overview of what +conversations are happening, and to read one conversation at a time. + +Here is what topics look like in Zulip. + +![Channels and topics](../../../../../static/images/help/channels-and-topics.png) + +Topics are one of the most wonderful aspects of using Zulip: + +* Lots of conversations can happen in the same channel at the same time, each in + its own topic. You never have to worry about interrupting — each conversation + has its own space. +* Conversations can last many hours or days, letting everyone respond in their + own time. Don't worry about replying long after a message is sent — + everyone will see your reply in context. + +[Learn more](https://zulip.com/why-zulip) about how Zulip's topic model helps +transform how your organization communicates. diff --git a/starlight_help/src/content/docs/include/_TranslationProjectInfo.mdx b/starlight_help/src/content/docs/include/_TranslationProjectInfo.mdx new file mode 100644 index 0000000000..7e8eaba4f9 --- /dev/null +++ b/starlight_help/src/content/docs/include/_TranslationProjectInfo.mdx @@ -0,0 +1,10 @@ +Zulip has been translated or partially translated into dozens of +languages by Zulip's amazing community of volunteer translators. +You can see which languages Zulip supports [on Weblate][weblate-zulip]. + +If you'd like to help by contributing as a translator, see the +[Zulip translation guidelines][translating-zulip] to get started. + +[weblate-zulip]: https://hosted.weblate.org/projects/zulip/ + +[translating-zulip]: https://zulip.readthedocs.io/en/stable/translating/translating.html diff --git a/starlight_help/src/content/docs/include/_UnsubscribeUserFromChannel.mdx b/starlight_help/src/content/docs/include/_UnsubscribeUserFromChannel.mdx new file mode 100644 index 0000000000..95d67cfb44 --- /dev/null +++ b/starlight_help/src/content/docs/include/_UnsubscribeUserFromChannel.mdx @@ -0,0 +1,39 @@ +import NavigationSteps from "../../../components/NavigationSteps.astro" +import CloseIcon from "~icons/zulip-icon/close" +import DependsOnPermissions from "./_DependsOnPermissions.mdx" +import SelectChannelViewSubscribers from "./_SelectChannelViewSubscribers.mdx" +import FlattenedSteps from '../../../components/FlattenedSteps.astro'; +import { Tabs, TabItem } from '@astrojs/starlight/components' +import ChannelMenuSubscribersTabTip from "./_ChannelMenuSubscribersTabTip.mdx" +import RightSidebarViewProfile from "./_RightSidebarViewProfile.mdx" + + + + + + + + + 1. Select a channel. + + + + 1. Under **Subscribers**, find the user you would like + to unsubscribe from the channel. + 1. Click the **Unsubscribe** () icon in that row. + + + + + + + + + + 1. Select the **Channels** tab. + 1. Under **Subscribed channels**, find the channel you would like + to unsubscribe the user from. + 1. Click the **Unsubscribe** () icon in that row. + + + diff --git a/starlight_help/src/content/docs/include/_UpgradeToPlusIfNeeded.mdx b/starlight_help/src/content/docs/include/_UpgradeToPlusIfNeeded.mdx new file mode 100644 index 0000000000..c5e3bbd508 --- /dev/null +++ b/starlight_help/src/content/docs/include/_UpgradeToPlusIfNeeded.mdx @@ -0,0 +1,2 @@ +1. Make sure your Zulip Cloud organization is on the [Zulip Cloud + Plus](https://zulip.com/plans/) plan. diff --git a/starlight_help/src/content/docs/include/_UserCardThreeDotMenu.mdx b/starlight_help/src/content/docs/include/_UserCardThreeDotMenu.mdx new file mode 100644 index 0000000000..351b3a53f1 --- /dev/null +++ b/starlight_help/src/content/docs/include/_UserCardThreeDotMenu.mdx @@ -0,0 +1,9 @@ +import FlattenedSteps from '../../../components/FlattenedSteps.astro'; +import RightSidebarUserCard from "./_RightSidebarUserCard.mdx" +import MoreVerticalIcon from "~icons/zulip-icon/more-vertical" + + + + + 1. Click on the **ellipsis** () in the user card. + diff --git a/starlight_help/src/content/docs/include/_UserGroupsApplications.mdx b/starlight_help/src/content/docs/include/_UserGroupsApplications.mdx new file mode 100644 index 0000000000..b9b23340ca --- /dev/null +++ b/starlight_help/src/content/docs/include/_UserGroupsApplications.mdx @@ -0,0 +1,9 @@ +Groups provide an easy way to refer to multiple users at once. You can: + +* [Mention](/help/mention-a-user-or-group) a group of users, + [notifying](/help/dm-mention-alert-notifications) everyone in the group as if + they were personally mentioned. +* Compose a [direct message](/help/direct-messages) to a user group. This + automatically puts all the users in the group into the addressee field. +* Subscribe a user group to a channel. This individually subscribes all the users + in the group. diff --git a/starlight_help/src/content/docs/include/_UserGroupsIntro.mdx b/starlight_help/src/content/docs/include/_UserGroupsIntro.mdx new file mode 100644 index 0000000000..cc37184037 --- /dev/null +++ b/starlight_help/src/content/docs/include/_UserGroupsIntro.mdx @@ -0,0 +1,4 @@ +User groups offer a flexible way to manage permissions in your organization. +Most permissions in Zulip can be granted to any combination of +[roles](/help/user-roles), [groups](/help/user-groups), and +individual [users](/help/introduction-to-users). diff --git a/starlight_help/src/content/docs/include/_UserRolesIntro.mdx b/starlight_help/src/content/docs/include/_UserRolesIntro.mdx new file mode 100644 index 0000000000..6947e18cbf --- /dev/null +++ b/starlight_help/src/content/docs/include/_UserRolesIntro.mdx @@ -0,0 +1,8 @@ +Permissions in Zulip can be granted to any combination of +[roles](/help/user-roles), [groups](/help/user-groups), and +individual [users](/help/introduction-to-users). + +User roles make it convenient to configure permissions for your organization. +You can decide what role a user will have when you [send them an +invitation](/help/invite-new-users), and later [change a user's +role](/help/user-roles#change-a-users-role) if needed. diff --git a/starlight_help/src/content/docs/include/_UserSubgroupsIntro.mdx b/starlight_help/src/content/docs/include/_UserSubgroupsIntro.mdx new file mode 100644 index 0000000000..97b8988c4e --- /dev/null +++ b/starlight_help/src/content/docs/include/_UserSubgroupsIntro.mdx @@ -0,0 +1,13 @@ +You can add a group to another user group, making it easy to express your +organization's structure in Zulip's permissions system. A user who belongs to a +subgroup of a group is treated as a member of that group. For example: + +* The “engineering” group could be made up of “engineering-managers” and + “engineering-staff”. +* The “managers” group could be made up of “engineering-managers”, + “design-managers”, etc. + +Updating the members of a group automatically updates the members of all the +groups that contain it. In the above example, adding a new team member to +“engineering-managers” automatically adds them to “engineering” and “managers” +as well. Removing a team member who transferred automatically removes them. diff --git a/starlight_help/src/content/docs/include/_ViewDmsLeftSidebar.mdx b/starlight_help/src/content/docs/include/_ViewDmsLeftSidebar.mdx new file mode 100644 index 0000000000..d45397919b --- /dev/null +++ b/starlight_help/src/content/docs/include/_ViewDmsLeftSidebar.mdx @@ -0,0 +1,5 @@ +1. If the **direct messages** section in the left sidebar is collapsed, click on + the **direct messages** heading to expand it. +1. Click on a recent DM conversation to view it, or click **more + conversations**. If you don't see this link, then you are already viewing all + of your direct message conversations. diff --git a/starlight_help/src/content/docs/include/_ViewEmojiReactions.mdx b/starlight_help/src/content/docs/include/_ViewEmojiReactions.mdx new file mode 100644 index 0000000000..42661fc467 --- /dev/null +++ b/starlight_help/src/content/docs/include/_ViewEmojiReactions.mdx @@ -0,0 +1,27 @@ +import MoreVerticalIcon from "~icons/zulip-icon/more-vertical" +import SmileIcon from "~icons/zulip-icon/smile" +import { Steps } from '@astrojs/starlight/components'; +import ZulipTip from '../../../components/ZulipTip.astro'; +import { Tabs, TabItem } from '@astrojs/starlight/components' + +The reactions view lets you see all of your messages that have received at least +one [emoji reaction](/help/emoji-reactions). You can see what resonated with +others, or confirm that key stakeholders have seen and responded to a message. + + + + + 1. Click on **Reactions** in the left + sidebar. If the **views** section is collapsed, click on + the **ellipsis** (), + and select **Reactions**. + 1. Browse your reactions. You can click on a message recipient bar to go + to the [conversation](/help/reading-conversations) where you sent the message. + + + + You can also [search all messages with reactions](/help/search-for-messages) using the + `has:reaction` filter. + + + diff --git a/starlight_help/src/content/docs/include/_ViewMentions.mdx b/starlight_help/src/content/docs/include/_ViewMentions.mdx new file mode 100644 index 0000000000..5a21ca72bd --- /dev/null +++ b/starlight_help/src/content/docs/include/_ViewMentions.mdx @@ -0,0 +1,33 @@ +import MobileMenu from "./_MobileMenu.mdx" +import AtSignIcon from "~icons/zulip-icon/at-sign" +import { Steps } from '@astrojs/starlight/components'; +import ZulipTip from '../../../components/ZulipTip.astro'; +import FlattenedSteps from '../../../components/FlattenedSteps.astro'; +import { Tabs, TabItem } from '@astrojs/starlight/components' + + + + + 1. Click on **Mentions** + (or if the **views** + section is collapsed) in the left sidebar. + 1. Browse your mentions. You can click on a message recipient bar to go + to the [conversation](/help/reading-conversations) where you were mentioned. + + + + You can also [search your mentions](/help/search-for-messages) using the + `is:mentioned` filter. + + + + + + + + 1. Tap **Mentions**. + 1. Browse your mentions. You can tap on a message recipient bar to go + to the conversation where you were mentioned. + + + diff --git a/starlight_help/src/content/docs/include/_ViewStarredMessages.mdx b/starlight_help/src/content/docs/include/_ViewStarredMessages.mdx new file mode 100644 index 0000000000..2acaeff82d --- /dev/null +++ b/starlight_help/src/content/docs/include/_ViewStarredMessages.mdx @@ -0,0 +1,34 @@ +import MobileMenu from "./_MobileMenu.mdx" +import StarIcon from "~icons/zulip-icon/star" +import { Steps } from '@astrojs/starlight/components'; +import ZulipTip from '../../../components/ZulipTip.astro'; +import FlattenedSteps from '../../../components/FlattenedSteps.astro'; +import KeyboardTip from '../../../components/KeyboardTip.astro'; +import { Tabs, TabItem } from '@astrojs/starlight/components' + + + + + 1. Click on **Starred messages** + (or if the **views** + section is collapsed) in the left sidebar. + + + + You can also [search your starred messages](/help/search-for-messages) + using the `is:starred` filter. + + + + Use \* to view your starred messages. + + + + + + + + 1. Tap **Starred messages**. + + + diff --git a/starlight_help/src/content/docs/include/_ViewUsersByRole.mdx b/starlight_help/src/content/docs/include/_ViewUsersByRole.mdx new file mode 100644 index 0000000000..bd73cc400a --- /dev/null +++ b/starlight_help/src/content/docs/include/_ViewUsersByRole.mdx @@ -0,0 +1,8 @@ +import FlattenedSteps from '../../../components/FlattenedSteps.astro'; +import NavigationSteps from "../../../components/NavigationSteps.astro" + + + + + 1. Select the desired role from the dropdown above the **Users** table. + diff --git a/starlight_help/src/content/docs/include/_WebPublicChannelsIntro.mdx b/starlight_help/src/content/docs/include/_WebPublicChannelsIntro.mdx new file mode 100644 index 0000000000..c7c1e2cada --- /dev/null +++ b/starlight_help/src/content/docs/include/_WebPublicChannelsIntro.mdx @@ -0,0 +1,17 @@ +import GlobeIcon from "~icons/zulip-icon/globe" + +The public access option lets administrators configure selected channels to be +**web-public**. Web-public channels (indicated by a ) can be viewed by anyone on the Internet without creating +an account in your organization. + +For example, you can [link to a Zulip +topic](/help/link-to-a-message-or-conversation) in a web-public channel +from a GitHub issue, a social media post, or a forum thread, and +anyone will be able to click the link and view the discussion in the +Zulip web application without needing to create an account. + +To see this feature in action, you can [view web-public channels in the Zulip +development community](https://chat.zulip.org/) without logging in. + +Users who wish to post content will need to create an account in order +to do so. diff --git a/starlight_help/src/content/docs/include/_WhenToStartANewTopic.mdx b/starlight_help/src/content/docs/include/_WhenToStartANewTopic.mdx new file mode 100644 index 0000000000..e3595d85b5 --- /dev/null +++ b/starlight_help/src/content/docs/include/_WhenToStartANewTopic.mdx @@ -0,0 +1,20 @@ +To get the full benefits of Zulip's topic model, when starting a new +conversation, you should start a new topic! + +Starting a topic is like a lighter weight version of giving your email a subject. +Topic names should be brief but specific, for example: + +* **Good topic names:** "question about topics", "welcome Anna Smith!", "issue #1234" +* **Not so good topic names:** "question", "hi", "help", "this topic is about + a question I have about topics" + +Don't stress about making it perfect! The first 2-3 words that +come to mind are probably fine, and you can always [change it +later](/help/rename-a-topic). + +With time, there will be lots of topics in your organization, which is just how +it's supposed to be. Zulip's UI is designed to make it easy to see what's new +(in your [inbox](/help/inbox), [recent +conversations](/help/recent-conversations), and the [left +sidebar](/help/left-sidebar)), while still helping you +[find](/help/search-for-messages) prior discussions. diff --git a/starlight_help/src/content/docs/index.mdx b/starlight_help/src/content/docs/index.mdx new file mode 100644 index 0000000000..9d93dd9e2e --- /dev/null +++ b/starlight_help/src/content/docs/index.mdx @@ -0,0 +1,9 @@ +--- +title: Zulip help center +--- + +import SidebarIndex from "./include/_SidebarIndex.mdx" + +Welcome to the [Zulip](/) help center! + + diff --git a/starlight_help/src/content/docs/insert-a-link.mdx b/starlight_help/src/content/docs/insert-a-link.mdx new file mode 100644 index 0000000000..914af0b2cd --- /dev/null +++ b/starlight_help/src/content/docs/insert-a-link.mdx @@ -0,0 +1,73 @@ +--- +title: Insert a link +--- + +import FlattenedSteps from '../../components/FlattenedSteps.astro'; +import LinksIntro from "./include/_LinksIntro.mdx" +import KeyboardTip from '../../components/KeyboardTip.astro'; +import LinksExamples from "./include/_LinksExamples.mdx" +import LinkIcon from "~icons/zulip-icon/link" +import StartComposing from "./include/_StartComposing.mdx" +import { Tabs, TabItem } from '@astrojs/starlight/components' + + + +## Insert a link + + + + + + + 1. Select the text you want to linkify. + 1. Paste a URL to turn the selected text into a named link. + + + + You can also use Ctrl + Shift + L + to insert link formatting. + + + + + + + + 1. Select the text you want to linkify. + 1. Click the **link** () icon at the + bottom of the compose box. + 1. Replace `url` with a valid URL. + + + + You can also use Ctrl + Shift + L + to insert link formatting. + + + + + + + + 1. To create a named link, use `[ ]` around the link text, and `( )` around the + URL: `[Link text](URL)`. + + + + You can also use Ctrl + Shift + L + to insert link formatting. + + + + +## Examples + + + +## 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) +* [Animated GIFs](/help/animated-gifs-from-giphy) +* [Video calls](/help/start-a-call) diff --git a/starlight_help/src/content/docs/integrations-overview.mdx b/starlight_help/src/content/docs/integrations-overview.mdx new file mode 100644 index 0000000000..75d6afc99d --- /dev/null +++ b/starlight_help/src/content/docs/integrations-overview.mdx @@ -0,0 +1,128 @@ +--- +title: Integrations overview +--- + +import { Steps } from '@astrojs/starlight/components'; +import ZulipNote from '../../components/ZulipNote.astro'; + +Integrations let you connect Zulip with other products. For example, you can get +notification messages in Zulip when an issue in your tracker is updated, or for +alerts from your monitoring tool. + +Zulip offers [over 120 native integrations](/integrations/), which take +advantage of Zulip's [topics](/help/introduction-to-topics) to organize +notification messages. Additionally, thousands of integrations are available +through [Zapier](https://zapier.com/apps) and [IFTTT](https://ifttt.com/search). +You can also [connect any webhook designed to work with +Slack](/integrations/doc/slack_incoming) to Zulip. + +If you don't find an integration you need, you can: + +* [Write your own integration](#write-your-own-integration). You can [submit a + pull + request](https://zulip.readthedocs.io/en/latest/contributing/reviewable-prs.html) + to get your integration merged into the main Zulip repository. +* [File an issue](https://github.com/zulip/zulip/issues/new/choose) to request + an integration (if it's a nice-to-have). +* [Contact Zulip Sales](mailto:sales@zulip.com) to inquire about a custom + development contract. + +## Set up an integration + +### Native integrations + + + 1. [Search Zulip's integrations](/integrations/) for the product you'd like to + connect to Zulip. + 1. Click on the card for the product, and follow the instructions on the page. + + +### Integrate via Zapier or IFTTT + +If you don't see a native Zulip integration, you can access thousands of +additional integrations through [Zapier](https://zapier.com/apps) and +[IFTTT](https://ifttt.com/search). + + + 1. Search [Zapier](https://zapier.com/apps) or [IFTTT](https://ifttt.com/search) + for the product you'd like to connect to Zulip. + 1. Follow the integration instructions for [Zapier](/integrations/doc/zapier) or + [IFTTT](/integrations/doc/ifttt). + + +### Integrate via Slack-compatible webhook API + +Zulip can process incoming webhook messages written to work with [Slack's +webhook API](https://api.slack.com/messaging/webhooks). This makes it easy to +quickly move your integrations when [migrating your +organization](/help/import-from-slack) from Slack to Zulip, or integrate any +product that has a Slack webhook integration with Zulip . + + + **Note:** In the long term, the recommended approach is to use + Zulip's native integrations, which take advantage of Zulip's topics. + There may also be some quirks when Slack's formatting system is + translated into Zulip's. + + + + 1. [Create a bot](/help/add-a-bot-or-integration) for the Slack-compatible + webhook. Make sure that you select **Incoming webhook** as the **Bot type**. + 1. Decide where to send Slack-compatible webhook notifications, and [generate + the integration URL](https://zulip.com/help/generate-integration-url). + 1. Use the generated URL anywhere you would use a Slack webhook. + + +### Integrate via email + +If the product you'd like to integrate can send email notifications, you can +[send those emails to a Zulip channel](/help/message-a-channel-by-email). The +email subject will become the Zulip topic, and the email body will become the +Zulip message. + +For example, you can configure your personal GitHub notifications to go to a +Zulip channel rather than your email inbox. Notifications for each issue or pull +request will be grouped into a single topic. + +## Write your own integration + +You can write your own Zulip integrations using the well-documented APIs below. +For example, if your company develops software, you can create a custom +integration to connect your product to Zulip. + +If you need help, best-effort community support is available in the [Zulip +development community](https://zulip.com/development-community/). To inquire +about options for custom development, [contact Zulip +Sales](mailto:sales@zulip.com). + +### Sending content into Zulip + +* If the third-party service supports outgoing webhooks, you likely want to + build an [incoming webhook integration](/api/incoming-webhooks-overview). +* If it doesn't, you may want to write a + [script or plugin integration](/api/non-webhook-integrations). +* The [`zulip-send` tool](/api/send-message) makes it easy to send Zulip + messages from shell scripts. +* Finally, you can + [send messages using Zulip's API](/api/send-message), with bindings for + Python, JavaScript and [other languages](/api/client-libraries). + +### Sending and receiving content + +* To react to activity inside Zulip, look at Zulip's + [Python framework for interactive bots](/api/running-bots) or + [Zulip's real-time events API](/api/get-events). +* If what you want isn't covered by the above, check out the full + [REST API](/api/rest). The web, mobile, desktop, and terminal apps are + built on top of this API, so it can do anything a human user can do. Most + but not all of the endpoints are documented on this site; if you need + something that isn't there check out Zulip's + [REST endpoints](https://github.com/zulip/zulip/blob/main/zproject/urls.py). + +## Related articles + +* [Bots overview](/help/bots-overview) +* [Set up integrations](/help/set-up-integrations) +* [Add a bot or integration](/help/add-a-bot-or-integration) +* [Generate integration URL](/help/generate-integration-url) +* [Request an integration](/help/request-an-integration) diff --git a/starlight_help/src/content/docs/introduction-to-channels.mdx b/starlight_help/src/content/docs/introduction-to-channels.mdx new file mode 100644 index 0000000000..6cbf4b2fe9 --- /dev/null +++ b/starlight_help/src/content/docs/introduction-to-channels.mdx @@ -0,0 +1,62 @@ +--- +title: Introduction to channels +--- + +import NavigationSteps from "../../components/NavigationSteps.astro" +import SortAlphaAscIcon from "~icons/fa/sort-alpha-asc" +import ZulipTip from '../../components/ZulipTip.astro'; +import FlattenedSteps from '../../components/FlattenedSteps.astro'; +import UserOIcon from "~icons/fa/user-o" +import ChannelsIntro from "./include/_ChannelsIntro.mdx" +import { Tabs, TabItem } from '@astrojs/starlight/components' +import BarChartIcon from "~icons/fa/bar-chart" + + + +## Browse and subscribe to channels + +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. Channel +administrators can [configure](/help/configure-who-can-subscribe) who can +subscribe to [private](/help/channel-permissions#private-channels) channels. + + + + + + + 1. Scroll through the list of channels. You can use the **search box** near the + top of the menu to filter the list by channel name or description. + 1. Click the **subscribe to channel** + (plus) + icon to the left of a channel to subscribe to it. + + + + You can click on the icons in the upper right to sort the list of channels + **by name** (), + **by number of subscribers** (), or + **by estimated weekly traffic** (). + + + + + Access this feature by following the web app instructions in your mobile + device browser. You can also follow a link to an unsubscribed channel in + a Zulip message, press and hold the channel name until the long-press menu + appears, and tap **Subscribe**. + + Implementation of a list of channels to subscribe to in the mobile app is + tracked [on GitHub](https://github.com/zulip/zulip-flutter/issues/188). + If you're interested in this feature, please react to the issue's + description with 👍. + + + +## Related articles + +* [Introduction to topics](/help/introduction-to-topics) +* [Create channels](/help/create-channels) +* [Channel permissions](/help/channel-permissions) +* [View channel information](/help/view-channel-information) diff --git a/starlight_help/src/content/docs/introduction-to-topics.mdx b/starlight_help/src/content/docs/introduction-to-topics.mdx new file mode 100644 index 0000000000..baba7e7af8 --- /dev/null +++ b/starlight_help/src/content/docs/introduction-to-topics.mdx @@ -0,0 +1,66 @@ +--- +title: Introduction to topics +--- + +import HowToReplyIntro from "./include/_HowToReplyIntro.mdx" +import WhenToStartANewTopic from "./include/_WhenToStartANewTopic.mdx" +import TopicsIntro from "./include/_TopicsIntro.mdx" +import HowToStartANewTopic from "./include/_HowToStartANewTopic.mdx" + + + +## When to start a new topic + + + +## How to start a new topic + +Zulip lets you start a new conversation in any channel, no matter where you are. + + + +## What about threads? + +Topics in Zulip fill the role of threads in other chat apps. This +section will help you understand how concepts you might be familiar +with from other applications show up in Zulip. + +### Where are the threads? + +In other team chat applications, you might be used to seeing threads +in a small panel on the side of the app. In busy organizations, that +cramped panel is where you may read most of the substantive +discussions. + +In Zulip, you won't see a threads sidebar, because threads appear in the main +message view instead. Threads help keep conversations organized, so Zulip puts +them front and center. + +### How do I find threads? + +In other apps, threads generally start from a message in the main channel feed. +That message becomes the key to finding a thread (which can often be tricky to +do). + +In Zulip, there's nothing special about the first message in a thread. Instead, +each thread is labeled with a topic. This makes threads in Zulip easy to find. +You can: + +* See recent threads in each channel you're subscribed to in the [left + sidebar](/help/left-sidebar). +* See a list of threads where you have unread messages in your + [inbox](/help/inbox). +* Get an overview of all threads with recent messages in [recent + conversations](/help/recent-conversations). + +### How do I reply? + + + +## Further reading + +* [Getting started with Zulip](/help/getting-started-with-zulip) +* [Introduction to channels](/help/introduction-to-channels) +* [Finding a conversation to read](/help/finding-a-conversation-to-read) +* [Reading conversations](/help/reading-conversations) +* [Replying to messages](/help/replying-to-messages) diff --git a/starlight_help/src/content/docs/introduction-to-users.mdx b/starlight_help/src/content/docs/introduction-to-users.mdx new file mode 100644 index 0000000000..2e4ed2286a --- /dev/null +++ b/starlight_help/src/content/docs/introduction-to-users.mdx @@ -0,0 +1,34 @@ +--- +title: Introduction to users +--- + +A **user** is an individual's account within a Zulip +[organization](/help/join-a-zulip-organization). Administrators can +[configure](/help/restrict-account-creation) how accounts are created in their +organization, and [how users will log +in](/help/configure-authentication-methods). + +Zulip lets users and organization administrators configure the following +details. This information is summarized in a user's [card](/help/user-cards), +and presented in detail in their [profile](/help/view-someones-profile). + +* [Profile picture](/help/change-your-profile-picture) +* [Name](/help/change-your-name) +* [Role](/help/user-roles) in the organization +* [Status and availability](/help/status-and-availability), and whether + the account has been [deactivated](/help/deactivate-or-reactivate-a-user) +* Current [local time](/help/change-your-timezone) +* Email address, with configurable [permissions to view it](/help/configure-email-visibility) +* [Custom profile fields](/help/custom-profile-fields) + +Users can also be members of [groups](/help/user-groups), and subscribe to +[channels](/help/introduction-to-channels). + +## Related articles + +* [User list](/help/user-list) +* [Status and availability](/help/status-and-availability) +* [User cards](/help/user-cards) +* [View someone's profile](/help/view-someones-profile) +* [Manage a user](/help/manage-a-user) +* [Bots overview](/help/bots-overview) diff --git a/starlight_help/src/content/docs/invite-new-users.mdx b/starlight_help/src/content/docs/invite-new-users.mdx new file mode 100644 index 0000000000..816a26cb89 --- /dev/null +++ b/starlight_help/src/content/docs/invite-new-users.mdx @@ -0,0 +1,137 @@ +--- +title: Invite new users +--- + +import NavigationSteps from "../../components/NavigationSteps.astro" +import ZulipNote from '../../components/ZulipNote.astro'; +import FlattenedSteps from '../../components/FlattenedSteps.astro'; +import SendDmIcon from "~icons/zulip-icon/send-dm" +import InviteUsers from "./include/_InviteUsers.mdx" +import TrashIcon from "~icons/zulip-icon/trash" + +You can invite users to join your organization by sending out email invitations, +or creating reusable invitation links to share. + +Prior to inviting users to your organization, it is recommended that administrators: + +* Configure [default settings](/help/configure-default-new-user-settings) for + new users. +* Configure a [custom welcome message](/help/configure-a-custom-welcome-message) + for new users. +* Configure the [organization language for automated messages and invitation + emails][org-lang] for your organization. + +When you invite users, you can: + +* Set the [role](/help/user-roles) that they will have when + they join. +* Configure which [channels](/help/introduction-to-channels) they will be + subscribed to. The organization's [default + channels](/help/set-default-channels-for-new-users) will be preselected. +* Configure which [groups](/help/user-groups) they will be added to. +* [Customize](/help/configure-a-custom-welcome-message#customize-the-welcome-message-when-sending-an-invitation) + the welcome message. + +Organization administrators can +[configure](/help/restrict-account-creation#change-who-can-send-invitations) who +is allowed to invite users to the organization. You will only see an **Invite +users** menu option if you have permission to invite users. + +## Send email invitations + + + + + 1. Enter a list of email addresses. + 1. Toggle **Send me a direct message when my invitation is accepted**, + to receive a notification when an invitation is accepted. + 1. Select when the invitations will expire. + 1. Select what [role](/help/user-roles) the users will join as. + 1. Configure which [channels](/help/introduction-to-channels) they will be subscribed + to. + 1. Configure which [groups](/help/user-groups) they will be added to. + 1. *(optional; administrators only)* Customize the [welcome + message](/help/configure-a-custom-welcome-message). + 1. Click **Invite**. + + + + **Note**: As an anti-spam measure, the number of email invitations + you can send in a day is limited on the Zulip Cloud Free plan. If + you hit the limit and need to invite more users, consider creating an + [invitation link](#create-a-reusable-invitation-link) and sharing it + with your users directly, or [contact support](/help/contact-support) + to ask for a higher limit. + + + + **Warning**: When an account is created by accepting an email + invitation, the user is immediately logged in to their new account. + Any restrictions on [allowed authentication + methods](/help/configure-authentication-methods) are not applied. + + +## Example email invitation + +![Email invitation](../../../../static/images/help/example-invitation-email.png) + +## Create a reusable invitation link + + + + + 1. Select **Invitation link**. + 1. Select when the invitation will expire. + 1. Select what [role](/help/user-roles) the users will join as. + 1. Configure which [channels](/help/introduction-to-channels) they will be subscribed + to. + 1. Configure which [groups](/help/user-groups) they will be added to. + 1. *(optional; administrators only)* Customize the [welcome + message](/help/configure-a-custom-welcome-message). + 1. Click **Create link**. + 1. Copy the link, and send it to anyone you'd like to invite. + + +## Manage pending invitations + +Organization owners can revoke or resend any invitation or reusable +invitation link. Organization administrators can do the same except +for invitations for the organization owners role. + +### Revoke an invitation + + + + + 1. Select the **Invitations** tab. + 1. Find the invitation you want to revoke. + 1. Click the **Revoke** () icon next to the invitation. + + +### Resend an invitation + + + + + 1. Select the **Invitations** tab. + 1. Find the invitation you want to resend. + 1. Click the **Resend** () icon next to the invitation. + + + + **Note:** You can **revoke** both email invitations and invitation links, + but you can **resend** only email invitations. + + +## Related articles + +* [Restrict account creation](/help/restrict-account-creation) +* [Set default channels for new users](/help/set-default-channels-for-new-users) +* [Configure default new user settings](/help/configure-default-new-user-settings) +* [Configure a custom welcome message](/help/configure-a-custom-welcome-message) +* [Configure organization language for automated messages and invitation emails][org-lang] +* [User roles](/help/user-roles) +* [User groups](/help/user-groups) +* [Joining a Zulip organization](/help/join-a-zulip-organization) + +[org-lang]: /help/configure-organization-language diff --git a/starlight_help/src/content/docs/invite-users-to-join.mdx b/starlight_help/src/content/docs/invite-users-to-join.mdx new file mode 100644 index 0000000000..af5eda0fe5 --- /dev/null +++ b/starlight_help/src/content/docs/invite-users-to-join.mdx @@ -0,0 +1,33 @@ +--- +title: Invite users to join +--- + +import HowToInviteUsersToJoin from "./include/_HowToInviteUsersToJoin.mdx" +import ZulipTip from '../../components/ZulipTip.astro'; + + + Before inviting users, you may want to [delete any test messages][delete-message] + or [topics](/help/delete-a-topic). + + +[delete-message]: /help/delete-a-message#delete-a-message-completely + +## How to invite users to join + + + +To get everyone off to a good start, you may wish to share the guide +to [Getting started with Zulip](/help/getting-started-with-zulip). + + + You can link to your Zulip organization with a [nice badge](/help/linking-to-zulip). + + +## Related articles + +* [Moving to Zulip](/help/moving-to-zulip) +* [Invite new users](/help/invite-new-users) +* [Restrict account creation](/help/restrict-account-creation) +* [Set default channels for new users](/help/set-default-channels-for-new-users) +* [Customize settings for new users](/help/customize-settings-for-new-users) +* [Getting started with Zulip](/help/getting-started-with-zulip) diff --git a/starlight_help/src/content/docs/join-a-zulip-organization.mdx b/starlight_help/src/content/docs/join-a-zulip-organization.mdx new file mode 100644 index 0000000000..55bb8ad031 --- /dev/null +++ b/starlight_help/src/content/docs/join-a-zulip-organization.mdx @@ -0,0 +1,55 @@ +--- +title: Joining a Zulip organization +--- + +import { Steps } from '@astrojs/starlight/components'; + +By default, Zulip organizations require an invitation to join. + +Organization owners can also allow anyone to join without an +invitation, and/or restrict user email addresses to a company domain. See +[inviting new users](/help/invite-new-users). + +## Check if you need an invitation to join + + + 1. Go to the Zulip URL of the organization. + 1. Click **Sign up** in the top right corner of the page. + 1. If you see a sign-up form, invitations are not required! Otherwise, the + page will say that you need an invitation to join. + + +## Check if you need an email from a specific domain + + + 1. Go to the Zulip URL of the organization. + 1. Click **Sign up** in the top right corner of the page. + 1. Try to create an account with your desired email address. + 1. If your email address is not from an allowed domain, you will get an + error message to that effect. + + +## Accept an invitation + +Invitations to Zulip organizations often come by email. Look for an email +from Zulip. It may take a few minutes for the invitation email to reach your +inbox. + +Alternatively, an organization administrator may have sent you an invitation +link via another method. + +## Tips + +* If you are joining multiple Zulip organizations, we recommend + using the [Zulip Desktop app](../apps/). The desktop app makes it easy to + [switch between different organizations](/help/switching-between-organizations). +* If your company uses single sign-on (SSO) authentication for Zulip, + these instructions may not apply. Try going to your company's Zulip URL + to see if there are instructions there; otherwise contact your manager + or IT department for company-specific instructions. + +## Related articles + +* [Invite new users](/help/invite-new-users) +* [Switching between organizations](/help/switching-between-organizations) +* [Import your settings](/help/import-your-settings) diff --git a/starlight_help/src/content/docs/keyboard-shortcuts.mdx b/starlight_help/src/content/docs/keyboard-shortcuts.mdx new file mode 100644 index 0000000000..d7d331a79c --- /dev/null +++ b/starlight_help/src/content/docs/keyboard-shortcuts.mdx @@ -0,0 +1,228 @@ +--- +title: Keyboard shortcuts +--- + +import NavigationSteps from "../../components/NavigationSteps.astro" +import ZulipTip from '../../components/ZulipTip.astro'; +import FlattenedSteps from '../../components/FlattenedSteps.astro'; +import KeyboardTip from '../../components/KeyboardTip.astro'; +import { Tabs, TabItem } from '@astrojs/starlight/components' + +Everything in Zulip can be done with the mouse, but mastering a few keyboard +shortcuts will change your experience of the app. Start with the basics below, +and use the convenient [**keyboard shortcuts**](#keyboard-shortcuts-reference) +reference in the Zulip app to add more to your repertoire as needed. + +* [The basics](#the-basics) +* [Search](#search) +* [Scrolling](#scrolling) +* [Navigation](#navigation) +* [Composing messages](#composing-messages) +* [Message actions](#message-actions) +* [Drafts](#drafts) +* [Menus](#menus) +* [Channel settings](#channel-settings) + +## The basics + +* **Reply to message**: R or Enter — Reply to the + selected message (outlined in blue). +* **New channel message**: C — Start a new topic in the current + channel. +* **New direct message**: X +* **Paste formatted text**: Ctrl + V +* **Paste as plain text**: Ctrl + + Shift + V. You can also paste formatted text with + Ctrl + V, and press Ctrl + Z to + remove formatting. +* **Cancel compose and save draft**: Esc or + Ctrl + \[ — Close the compose box + and save the unsent message as a draft. +* **View drafts**: D — Use the arrow keys and Enter + to restore a draft. Press D again to close. +* **Next message**: ↓ or J +* **Last message**: End or Shift + G — + Also marks all messages in the current view as read. +* **Next unread topic**: N +* **Next unread followed topic**: Shift + N +* **Next unread direct message**: P +* **Search messages**: / +* **Toggle keyboard shortcuts view**: ? +* **Go to your home view**: Ctrl + \[ + (or Esc, [if enabled][disable-escape]) + until you are in your [home view](/help/configure-home-view). + +[disable-escape]: /help/configure-home-view#configure-whether-esc-navigates-to-the-home-view + +## Search + +* **Search messages**: / or Ctrl + K +* **Filter left sidebar**: Q +* **Filter users**: W + +## Scrolling + +* **Last message**: End or Fn + → + or Shift + G — Also marks all messages in the current view + as read. +* **First message**: Home or Fn + ← +* **Previous message**: ↑ or K +* **Next message**: ↓ or J +* **Scroll up**: PgUp or Fn + ↑ + or Shift + K +* **Scroll down**: PgDn or Fn + ↓ + or Shift + J or Spacebar + +## Navigation + +* **Go back through viewing history**: Alt + + ← +* **Go forward through viewing history**: Alt + + → +* **Go to next unread topic**: N +* **Go to next unread followed topic**: Shift + N +* **Go to next unread direct message**: P +* **Go to topic or DM conversation**: S +* **Go to channel feed from topic view**: S +* **Go to direct message feed**: Shift + P +* **Go to list of topics for the current channel**: Y +* **Zoom to message in conversation context**: Z — This view does not mark messages as read. +* **Cycle between channel views**: Shift + A + (previous) and Shift + D (next) +* **Go to inbox**: Shift + I — Shows conversations with unread messages. +* **Go to recent conversations**: T +* **Go to combined feed**: A — Shows all unmuted messages. +* **Go to starred messages**: \* +* **Go to the conversation you are composing to**: Ctrl + . + +## Composing messages + +* **New channel message**: C — For starting a new topic in a + channel. +* **New direct message**: X +* **Reply to message**: R or Enter — Reply to the + selected message (outlined in blue). Same behavior as clicking on the + message. +* **Quote message**: > +* **Forward message**: \< +* **Reply directly to sender**: Shift + R +* **Reply @-mentioning sender**: @ + +[toggle-enter-to-send]: /help/configure-send-message-keys + +### In the compose box + +* **Send message**: Tab then Enter, or either + Enter or Ctrl + Enter based on + [your settings][toggle-enter-to-send] +* **Insert new line**: Shift + Enter, or either + Enter or Ctrl + Enter based on + [your settings][toggle-enter-to-send] +* **Insert italic text**: `*italic*` or Ctrl + I +* **Insert bold text**: `**bold**` or Ctrl + B +* **Insert link**: `[Zulip website](https://zulip.org)` or Ctrl + + Shift + L +* **Insert or create a [saved snippet](/help/saved-snippets)**: + Ctrl + ' +* **Toggle preview mode**: Alt + P +* **Cancel compose and save draft**: Esc or + Ctrl + \[ — Close the compose box + and save the unsent message as a draft. + +## Message actions + +* **Edit your last message**: ← — Scroll to the + most recent message you are allowed to edit in the current view, and open it + for editing. If there are no messages you can edit, nothing happens. + +### For a selected message (outlined in blue) + +* **Toggle message actions menu**: I +* **Edit message or view original message**: E +* **Show message sender's user card**: U +* **View read receipts**: Shift + V — Same shortcut + also closes the read receipts menu (if open). +* **View image**: V +* **Move message and (optionally) other messages in the same topic**: M +* **View message edit and move history**: Shift + + H. Viewing message edit history [must be + allowed](/help/restrict-message-edit-history-access). +* **Star message**: Ctrl + S +* **Add emoji reaction**: : +* **Toggle first emoji reaction**: = +* **React with 👍**: + +* **Mark as unread from selected message**: Shift + U +* **Collapse/show message**: - +* **Toggle topic mute**: Shift + M. This works in both + message views and views that list topics (e.g., [inbox](/help/inbox), [recent + conversations](/help/recent-conversations)). Learn about [muted + topics](/help/mute-a-topic). + +## Recent conversations + +* **View recent conversations**: T +* **Search recent conversations**: T +* **Escape from recent conversations search**: Esc or arrow keys +* **Navigate recent conversations**: Use arrow keys or vim keys + (J, K, L, H). + +Use Enter to engage with elements. + +## Drafts + +* **Toggle drafts view**: D + +### Within the drafts view + +* **Edit selected draft**: Enter +* **Delete selected draft**: Backspace + +Keyboard navigation (e.g., arrow keys) works as expected. + +## Menus + +* **Toggle shortcuts help**: ? +* **Toggle gear menu**: G +* **Open personal menu**: G + → +* **Open help menu**: G + ← +* **Toggle message actions menu** for a selected message (outlined in blue): + I + +## Channel settings + +* **Scroll through channels**: ↑ and + ↓ + + + Pressing ↑ from the first channel + in the list moves you to the **Filter channels** input. + +* **Switch between tabs**: ← and + → — Switch between the **Subscribed** + and **All channels** tabs. +* **Create new channel**: N + +### For a selected channel + +* **View channel messages**: Shift + V +* **Toggle subscription**: Shift + S + +## Keyboard shortcuts reference + +A summary of the keyboard shortcuts above is available in the Zulip app. + + + + + + + + + You can also use ? to open the keyboard shortcuts reference. + + + + +## Related articles + +* [Reading strategies](/help/reading-strategies) diff --git a/starlight_help/src/content/docs/latex.mdx b/starlight_help/src/content/docs/latex.mdx new file mode 100644 index 0000000000..f2c82c07eb --- /dev/null +++ b/starlight_help/src/content/docs/latex.mdx @@ -0,0 +1,98 @@ +--- +title: LaTeX +--- + +import ZulipTip from '../../components/ZulipTip.astro'; +import FlattenedSteps from '../../components/FlattenedSteps.astro'; +import MathIcon from "~icons/zulip-icon/math" +import StartComposing from "./include/_StartComposing.mdx" +import LatexExamples from "./include/_LatexExamples.mdx" +import { Tabs, TabItem } from '@astrojs/starlight/components' +import LatexIntro from "./include/_LatexIntro.mdx" + + + +## Insert LaTeX formatting + +Zulip's compose box has a smart **Math (LaTeX)** () button, which inserts contextually appropriate LaTeX +formatting: + +* If no text is selected, the button inserts displayed LaTeX (\`\`\`\`math\`) formatting. +* If selected text is on one line, the button inserts inline LaTeX (`$$`) + formatting. +* If selected text is on multiple lines, the button inserts displayed LaTeX + (\`\`\`\`math\`) formatting. + + + + + + + 1. *(optional)* Select the text you want to format. + 1. Click the **Math (LaTeX)** () icon at the + bottom of the compose box to insert LaTeX formatting. + + + + You can also use the **Math (LaTeX)** () + icon to remove existing LaTeX formatting from the selected text. + + + + + + + + 1. To use inline LaTeX, use double dollar signs (`$$`) around the text: + $$O(n^2)$$ + To use displayed LaTeX, use triple backticks and the word math + (\`\`\`\`math\`) followed by some text and triple backticks at the end: + ```math + \int_a^b f(t)\, dt = F(b) - F(a) + ``` + + + + +## Examples + + + +## Copy and paste formatted LaTeX + +### Copy LateX from a message in Zulip + +Zulip supports [quoting](/help/quote-or-forward-a-message#quote-a-message), +[forwarding](/help/quote-or-forward-a-message#forward-a-message), or copying +math expressions, and pasting them into the compose box. + + + If you select part of a math expression to copy, Zulip will automatically + expand your selection to copy the full expression. + + +### Copy LaTeX from an external website + +You can copy LaTeX from many third-party sites that use KaTeX, and paste it into +Zulip. + + + If copy-pasting math from a website isn't working, consider contacting the + website's administrators with the information below, as it may be an easy fix. + + +This feature is powered by KaTeX's MathML annotations, which embed the original +LaTeX source in the HTML for a math expression. For it to work, the website +needs to: + +* Generate math expressions using KaTeX in the default `htmlAndMathml` [output + mode](https://katex.org/docs/options.html). +* Allow MathML annotations to be included in HTML copied by the browser (for + Zulip, this was [a couple lines of + CSS](https://github.com/zulip/zulip/commit/353f57e518b88333615911f12a031177c46d7fbe)). + +## 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) diff --git a/starlight_help/src/content/docs/left-sidebar.mdx b/starlight_help/src/content/docs/left-sidebar.mdx new file mode 100644 index 0000000000..9976f55f5b --- /dev/null +++ b/starlight_help/src/content/docs/left-sidebar.mdx @@ -0,0 +1,186 @@ +--- +title: Left sidebar +--- + +import ZulipTip from '../../components/ZulipTip.astro'; +import FlattenedSteps from '../../components/FlattenedSteps.astro'; +import FilterResolvedLeftSidebar from "./include/_FilterResolvedLeftSidebar.mdx" +import FilterChannels from "./include/_FilterChannels.mdx" +import StartTopicViaLeftSidebar from "./include/_StartTopicViaLeftSidebar.mdx" +import KeyboardTip from '../../components/KeyboardTip.astro'; +import { Steps } from '@astrojs/starlight/components'; +import ViewDmsLeftSidebar from "./include/_ViewDmsLeftSidebar.mdx" +import ConfigureChannelLinks from "./include/_ConfigureChannelLinks.mdx" +import FindDmConversationLeftSidebar from "./include/_FindDmConversationLeftSidebar.mdx" +import PanelLeftDashedIcon from "~icons/zulip-icon/panel-left-dashed" +import ComposeAndSendMessage from "./include/_ComposeAndSendMessage.mdx" +import PanelLeftIcon from "~icons/zulip-icon/panel-left" +import SquarePlusIcon from "~icons/zulip-icon/square-plus" +import { Tabs, TabItem } from '@astrojs/starlight/components' + +The left sidebar in the Zulip web and desktop apps helps you navigate your +conversations, and [start new +ones](#start-a-new-conversation-from-the-left-sidebar). It's divided into +sections: + +* **Views** provide various ways to get an overview of your messages. +* The **direct messages** section shows your [direct + message](/help/direct-messages) conversations. +* [Channels](/help/introduction-to-channels) you are subscribed to are shown + organized into sections by [folder](/help/channel-folders). + +You can customize how channels are organized within the **channels** +section by: + +* [Pinning channels](/help/pin-a-channel) so that they appear in a dedicated + section at the top of the list of channels. +* [Changing channel colors](/help/change-the-color-of-a-channel). +* [Configuring](/help/channel-folders#configure-whether-channels-are-grouped-by-folder-in-the-left-sidebar) + whether channels are grouped by folder. +* [Configuring](/help/manage-inactive-channels) whether inactive channels are + hidden. + +You can also [configure](#configure-where-channel-links-in-the-left-sidebar-go) +where clicking on channel links in the left sidebar takes you. + +## Find a direct message conversation + + + +## Find a channel you're subscribed to + + + +## Adjust what information is shown + +There are many ways you can adjust the left sidebar to help you focus on the +information you need in the moment. + +### Expand or collapse the views section + + + + + 1. Click the triangle to the left of the **views** heading in the left sidebar. + + + + +### Expand or collapse the direct messages section + + + + + 1. Click the triangle to the left of the **direct messages** heading in the left + sidebar. + + + + +### Show more direct message conversations + + + + + + + + + To return to the channel list in the left sidebar, click the **back to + channels** link above the search box. + + + + +### Show all topics in a channel + + + + + 1. Click on a channel in the left sidebar. + 1. Click **show all topics** at the bottom of the list of recent topics in the + selected channel. + + + + To return to the channel list in the left sidebar, click the **back to + channels** link above the search box. + + + + +### Filter by whether topics are resolved + + + +### Show the left sidebar + + + + + 1. At the top left corner, click the icon. + + + + +### Hide the left sidebar + + + + + 1. At the top left corner, click the icon. + + + + +## Configure where channel links in the left sidebar go + + + +## Start a new conversation from the left sidebar + +You can start any new conversation from the left sidebar, regardless of what +you’re currently viewing. + +### Start a new direct message conversation + + + + + 1. Click the **new direct message** () + button next to the **direct messages** heading in the left sidebar. + 1. Start typing the name of the person or [group](/help/user-groups) you want to + message, and select their name from the list of suggestions. You can continue + adding as many message recipients as you like. + + + + + + You can also use the X keyboard shortcut to start a new direct + message conversation. + + + + +### Start a new topic + + + + + + + + + +## Related articles + +* [Reading strategies](/help/reading-strategies) +* [Configuring unread message counters](/help/configure-unread-message-counters) +* [Inbox](/help/inbox) +* [Recent conversations](/help/recent-conversations) +* [Combined feed](/help/combined-feed) +* [Channel feed](/help/channel-feed) +* [List of topics in a channel](/help/list-of-topics) +* [View your mentions](/help/view-your-mentions) +* [Star a message](/help/star-a-message) diff --git a/starlight_help/src/content/docs/line-spacing.mdx b/starlight_help/src/content/docs/line-spacing.mdx new file mode 100644 index 0000000000..b0518570ce --- /dev/null +++ b/starlight_help/src/content/docs/line-spacing.mdx @@ -0,0 +1,40 @@ +--- +title: Line spacing +--- + +import FlattenedSteps from '../../components/FlattenedSteps.astro'; +import LineHeightBigIcon from "~icons/zulip-icon/line-height-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 lets you adjust line spacing in the web and desktop apps, to +make the Zulip interface feel most comfortable for you. Most +importantly, this setting modifies how much space there is between +lines of text in multi-line messages. You can experiment to see what +configuration makes reading most pleasant for you. + +Reducing line spacing and [font size](/help/font-size) may be helpful on small +screens, so that you can see more content at a time. + +## Change line spacing + + + + + + + 1. Click to increase the line + spacing, to decrease it, and to reset to the default. + + + + +## 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) +* [Font size](/help/font-size) +* [Dark theme](/help/dark-theme) diff --git a/starlight_help/src/content/docs/link-to-a-message-or-conversation.mdx b/starlight_help/src/content/docs/link-to-a-message-or-conversation.mdx new file mode 100644 index 0000000000..4a98a30a03 --- /dev/null +++ b/starlight_help/src/content/docs/link-to-a-message-or-conversation.mdx @@ -0,0 +1,211 @@ +--- +title: Link to a message or conversation +--- + +import ChannelActions from "./include/_ChannelActions.mdx" +import TopicLongPressMenu from "./include/_TopicLongPressMenu.mdx" +import ChannelLongPressMenu from "./include/_ChannelLongPressMenu.mdx" +import ZulipTip from '../../components/ZulipTip.astro'; +import FlattenedSteps from '../../components/FlattenedSteps.astro'; +import MessageLongPressMenu from "./include/_MessageLongPressMenu.mdx" +import MessageActionsMenu from "./include/_MessageActionsMenu.mdx" +import StartComposing from "./include/_StartComposing.mdx" +import { Tabs, TabItem } from '@astrojs/starlight/components' +import TopicActions from "./include/_TopicActions.mdx" + +Zulip makes it easy to share links to messages, topics, and channels. You can +link from one Zulip [conversation](/help/reading-conversations) to another, or +share links to Zulip conversations in issue trackers, emails, or other external +tools. + +## Link to a channel within Zulip + +Channel links are automatically formatted as [#channel name](#link-to-a-channel-within-zulip). + + + + + + + 1. Type `#` followed by a few letters from the channel name. + 1. Pick the desired channel from the autocomplete. + 1. Pick the top option from the autocomplete to link to the channel without + selecting a topic. + + + + To link to the channel you're composing to, type `#>`, and pick the + top option from the autocomplete. + + + + +In the web and desktop apps, when you paste a channel link into Zulip, +it's automatically formatted as `#**channel name**`. You can use +Ctrl + Shift + +V to paste as plain text if you prefer. + +You can create a channel link manually by typing `#**channel name**`. + +## Link to a topic within Zulip + +Topic links are automatically formatted as [#channel > topic](#link-to-a-topic-within-zulip). + + + + + + + 1. Type `#` followed by a few letters from the channel name. + 1. Pick the desired channel from the autocomplete. + 1. Type a few letters from the topic name. + 1. Pick the desired topic from the autocomplete. + + + + To link to a topic in the channel you're composing to, type `#>` + followed by a few letters from the topic name, and pick the desired + topic from the autocomplete. + + + + +In the web and desktop apps, when you paste a topic link into Zulip, it's +automatically formatted as `#**channel name>topic name**`. You can use +Ctrl + Shift + +V to paste as plain text if you prefer. + +You can create a topic link manually by typing `#**channel name>topic name**`. + +## Link to Zulip from anywhere + +All URLs in Zulip are designed to be **shareable**, including: + +* Links to messages, topics, and channels. +* Search URLs, though note that personal + [filters](/help/search-for-messages#search-filters) (e.g., `is:followed`) will + be applied according to the user who's viewing the URL. + +In addition, links to messages, topics, and channels are **permanent**: + +* [Message links](#get-a-link-to-a-specific-message) will still work even when + the message is [moved to another topic](/help/move-content-to-another-topic) + or [channel](/help/move-content-to-another-channel), or if its [topic is + resolved](/help/resolve-a-topic). Zulip uses the same permanent link syntax + when [quoting a message](/help/quote-or-forward-a-message). +* [Topic links](#get-a-link-to-a-specific-topic) will still work even when the + topic is [renamed](/help/rename-a-topic), [moved to another + channel](/help/move-content-to-another-channel), or + [resolved](/help/resolve-a-topic). + + + When some messages are [moved out of a + topic](/help/move-content-to-another-topic) and others are left in place, + links to that topic will follow the location of the message whose ID is + encoded in the topic URL (usually the first or last message in the topic). + +* [Channel links](#get-a-link-to-a-specific-channel) will still work even when a + channel is [renamed](/help/rename-a-channel) or + [archived](/help/archive-a-channel). + +When you copy a Zulip link in the web and desktop apps, and paste it anywhere that +accepts HTML formatting (e.g., your email, GitHub, docs, etc.), the link will be +formatted as it would be in Zulip (e.g., [#channel > topic](#link-to-a-topic-within-zulip)). +To paste the plain URL, you can paste without formatting (likely Ctrl + +Shift + V in your browser). + +### Get a link to a specific message + +This copies to your clipboard a permanent link to the message, displayed in the +context of its conversation. To preserve your reading status, messages won't be +automatically marked as read when you view a conversation via a message link. + +In the web and desktop apps, when you paste a message link into the compose box, +it gets automatically formatted to be easy to read: + +``` +#**channel name>topic name@message ID** +``` + +When you send your message, the link will appear as +[#channel > topic @ 💬](#get-a-link-to-a-specific-message). + + + + + + + 1. Click **Copy link to message**. + + + + If using Zulip in a browser, you can also click on the timestamp + of a message, and copy the URL from your browser's address bar. + + + + + + + + 1. Tap **Copy link to message**. + + + + +In the web and desktop apps, when you paste a message link into Zulip, +it is automatically formatted for you. You can use +Ctrl + Shift + +V to paste as plain text if you prefer. + +### Get a link to a specific topic + + + + + + + 1. Click **Copy link to topic**. + + + + If using Zulip in a browser, you can also click on a topic name, + and copy the URL from your browser's address bar. + + + + + + + + 1. Tap **Copy link to topic**. + + + + +### Get a link to a specific channel + + + + + + + 1. Click **Copy link to channel**. + + + + + + + + 1. Tap **Copy link to channel**. + + + + +## Related articles + +* [Add a custom linkifier](/help/add-a-custom-linkifier) +* [Message formatting](/help/format-your-message-using-markdown) +* [Linking to your organization](/help/linking-to-zulip) +* [Pin information](/help/pin-information) diff --git a/starlight_help/src/content/docs/linking-to-zulip-website.mdx b/starlight_help/src/content/docs/linking-to-zulip-website.mdx new file mode 100644 index 0000000000..2dc423b86c --- /dev/null +++ b/starlight_help/src/content/docs/linking-to-zulip-website.mdx @@ -0,0 +1,30 @@ +--- +title: Linking to the Zulip website +--- + +import { Steps } from '@astrojs/starlight/components'; +import SupportingZulipMotivation from "./include/_SupportingZulipMotivation.mdx" + + + +If your organization is sponsored by Zulip, or wishes to express appreciation +for the Zulip project, please help others find out about Zulip. To do so, follow the +guidelines below to list Zulip in the appropriate section of your organization's +website (e.g., **Sponsors** or **Acknowledgements**). + +## Link to the Zulip website + + + 1. Select a [Zulip + logo](https://github.com/zulip/zulip/tree/main/static/images/logo), + preferably a **round Zulip icon** (available in `.png` and `.svg` formats). + 1. Link to [https://zulip.com/](https://zulip.com/). + 1. If appropriate, add a brief description: + > Zulip is an organized team chat app designed for efficient communication. + + +## Related articles + +* [Support the Zulip project](/help/support-zulip-project) +* [Linking to your Zulip organization](/help/linking-to-zulip) +* [Zulip communities directory](/help/communities-directory) diff --git a/starlight_help/src/content/docs/linking-to-zulip.mdx b/starlight_help/src/content/docs/linking-to-zulip.mdx new file mode 100644 index 0000000000..aeb22f10de --- /dev/null +++ b/starlight_help/src/content/docs/linking-to-zulip.mdx @@ -0,0 +1,31 @@ +--- +title: Linking to your organization +--- + +You can link to your Zulip organization from the web with a Zulip +[shields.io](https://github.com/badges/shields) badge: + +[![Zulip chat](https://img.shields.io/badge/zulip-join_chat-brightgreen.svg)](https://chat.zulip.org) + +Good places for the badge include your project's landing page, support +pages, and/or GitHub homepage. + +To embed a Zulip badge, copy and paste the following, replacing +`https://chat.zulip.org` with the URL of your Zulip organization: + +Markdown + +``` +[![project chat](https://img.shields.io/badge/zulip-join_chat-brightgreen.svg)](https://chat.zulip.org) +``` + +HTML + +``` + +``` + +## Related articles + +* [Link to a message or conversation](/help/link-to-a-message-or-conversation) +* [Linking to the Zulip website](/help/linking-to-zulip-website) diff --git a/starlight_help/src/content/docs/list-of-topics.mdx b/starlight_help/src/content/docs/list-of-topics.mdx new file mode 100644 index 0000000000..73dc46d8b7 --- /dev/null +++ b/starlight_help/src/content/docs/list-of-topics.mdx @@ -0,0 +1,94 @@ +--- +title: List of topics in a channel +--- + +import ChannelActions from "./include/_ChannelActions.mdx" +import FlattenedSteps from '../../components/FlattenedSteps.astro'; +import MobileChannels from "./include/_MobileChannels.mdx" +import KeyboardTip from '../../components/KeyboardTip.astro'; +import { Steps } from '@astrojs/starlight/components'; +import TopicListIcon from "~icons/zulip-icon/topic-list" +import ConfigureChannelLinks from "./include/_ConfigureChannelLinks.mdx" +import { Tabs, TabItem } from '@astrojs/starlight/components' + +You can view a list of recent topics any channel. It's a great way to get an +overview if you like reading your messages one channel at a time. + +## Use the list of topics in a subscribed channel + + + + + + + 1. Click **Go to list of topics**. 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 list of topics. + 1. Click on a conversation you're interested in to view it. You can return to + the list of topics when done (e.g., by using the **back** button in your + browser or desktop app) to select the next conversation. + + + + Use Y to go to the list of topics for the current channel. + + + + + + + + 1. Select a channel. + 1. Tap **topics** () + in the upper right corner of the app. + 1. Tap on a conversation you're interested in to view it. You can return to + the list of topics when done (e.g., by using the **back** button) to select + the next conversation. + + + + +## Configure where channel links in the left sidebar go + + + +## Filter conversations + +### Filter by topic status + +In the web app, you can control whether the list of topics includes all topics, +just topics you haven't [muted](/help/mute-a-topic), or only topics you +[follow](/help/follow-a-topic). + + + + + 1. In the list of topics for a channel, select **All topics**, **Standard + view**, or **Followed topics** from the dropdown in the upper left. + + + + +In muted channels, the **Standard view** includes all topics you haven't +explicitly muted. + +### Filter by keyword + + + + + 1. In the list of topics for a channel, use the **Filter** box at the top to + find a conversation. + + + + +## Related articles + +* [Channel feed](/help/channel-feed) +* [Inbox](/help/inbox) +* [Recent conversations](/help/recent-conversations) +* [Left sidebar](/help/left-sidebar) +* [Reading strategies](/help/reading-strategies) +* [Reading conversations](/help/reading-conversations) diff --git a/starlight_help/src/content/docs/logging-in.mdx b/starlight_help/src/content/docs/logging-in.mdx new file mode 100644 index 0000000000..5d31add5e3 --- /dev/null +++ b/starlight_help/src/content/docs/logging-in.mdx @@ -0,0 +1,127 @@ +--- +title: Logging in +--- + +import ZulipNote from '../../components/ZulipNote.astro'; +import GearIcon from "~icons/zulip-icon/gear" +import FlattenedSteps from '../../components/FlattenedSteps.astro'; +import { Steps } from '@astrojs/starlight/components'; +import DesktopToggleSidebarTip from "./include/_DesktopToggleSidebarTip.mdx" +import PlusIcon from "~icons/fa/plus" +import { Tabs, TabItem } from '@astrojs/starlight/components' +import ChangePasswordViaEmailConfirmation from "./include/_ChangePasswordViaEmailConfirmation.mdx" +import SwitchingBetweenOrganizations from "./include/_SwitchingBetweenOrganizations.mdx" +import MobileSwitchAccount from "./include/_MobileSwitchAccount.mdx" + +By default, Zulip allows logging in via email/password as well as +various social authentication providers like Google, GitHub, GitLab, +and Apple. + +Organization administrators can +[add other authentication methods](/help/configure-authentication-methods), +including the SAML and LDAP integrations, or disable any of the methods above. + +You can log in with any method allowed by your organization, regardless of +how you signed up. For example, if you originally signed up using your Google +account, you can later log in using GitHub, as long as your Google account +and GitHub account use the same email address. + +## Find the Zulip log in URL + +Here are some ways to find the URL for your Zulip organization. + + + + * If your organization is hosted on [Zulip Cloud](https://zulip.com/plans/) + (usually at `*.zulipchat.com`), go to the [**Find your + accounts**](https://zulip.com/accounts/find/) page and enter the email address + that you signed up with. You will receive an email with the sign-in + information for any Zulip organizations associated with your email address. + * Search your email account for a registration email from Zulip. The subject + line will include `Zulip: Your new account details` or `Zulip: Your new + organization details`. This email provides your organization's log in URL. + * If you have visited your organization's log in page in the past, try reviewing + your browser's history. Searching for `zulipchat.com` should find the right + page if your Zulip organization is hosted on [Zulip + Cloud](https://zulip.com/plans/). + * You can ask your organization administrators for your Zulip URL. + + + + * If using Zulip in the browser, your organization's Zulip log in URL is the first part + of what you see in the URL bar (e.g., `.zulipchat.com` for + [Zulip Cloud](https://zulip.com/plans/) organizations). + * In the Desktop app, select **Copy Zulip URL** from the **Zulip** menu to + copy the URL of the currently active organization. You can also access the + **Copy Zulip URL** option by right-clicking on an organization logo in the + **organizations sidebar** on the left. + * In the Mobile app, tap your **profile picture** in the bottom right corner of + the app, then tap **switch account** to see the URLs for all the organizations + you are logged in to. + * On [Zulip Cloud](https://zulip.com/plans/) and other Zulip servers updated to + [Zulip 6.0 or + higher](https://zulip.readthedocs.io/en/stable/overview/changelog.html#zulip-6-x-series), + click the **gear** () icon in the upper right + corner of the web or desktop app. Your organization's log in URL is shown in the top + section of the menu. + + + +## Log in to a new organization + + + + + + + 1. Tap **Add new account**. + 1. Enter the Zulip URL of the organization, and tap **Continue**. + 1. Follow the on-screen instructions. + + + + + + If you are having trouble connecting, you may need to set your + [proxy settings](/help/connect-through-a-proxy) or add a + [custom certificate](/help/custom-certificates). + + + + 1. Click the **add organization** () icon in the + **organizations sidebar** on the left. You can also select **Add Organization** + from the **Zulip** menu in the top menu bar. + 1. Enter the Zulip URL of the organization, and click **Connect**. + 1. Follow the on-screen instructions. + + + + + + + + 1. Go to the Zulip URL of the organization. + 1. Follow the on-screen instructions. + + + + +## Switch between organizations + + + +## Set or reset your password + +If you signed up using passwordless authentication and want to start logging in +via email/password, you will need to create a password by following the instructions below. You can also reset a +forgotten password. + + + +## Related articles + +* [Logging out](logging-out) +* [Switching between organizations](switching-between-organizations) +* [Change your email address](change-your-email-address) +* [Change your password](change-your-password) +* [Deactivate your account](deactivate-your-account) diff --git a/starlight_help/src/content/docs/logging-out.mdx b/starlight_help/src/content/docs/logging-out.mdx new file mode 100644 index 0000000000..ef721dc205 --- /dev/null +++ b/starlight_help/src/content/docs/logging-out.mdx @@ -0,0 +1,44 @@ +--- +title: Logging out +--- + +import MoreVerticalIcon from "~icons/zulip-icon/more-vertical" +import GearIcon from "~icons/zulip-icon/gear" +import ZulipTip from '../../components/ZulipTip.astro'; +import FlattenedSteps from '../../components/FlattenedSteps.astro'; +import { Steps } from '@astrojs/starlight/components'; +import { Tabs, TabItem } from '@astrojs/starlight/components' +import MobileSwitchAccount from "./include/_MobileSwitchAccount.mdx" + + + + + 1. Click the **gear** () icon in the top + right corner of the app. + 1. Click **Log out**. + + + + + + + + 1. Tap the **ellipsis** () + to the right of the Zulip organization you want to log out of. + 1. Tap **Log out**. + 1. Approve by tapping **Log out**. + + + + + + Logging out doesn't affect any other organizations you may be logged in + to. To log out of all your Zulip organizations, repeat the steps above + for each one. + + +## Related articles + +* [Logging in](logging-in) +* [Switching between organizations](switching-between-organizations) +* [Deactivate your account](deactivate-your-account) diff --git a/starlight_help/src/content/docs/manage-a-bot.mdx b/starlight_help/src/content/docs/manage-a-bot.mdx new file mode 100644 index 0000000000..a7e8628f79 --- /dev/null +++ b/starlight_help/src/content/docs/manage-a-bot.mdx @@ -0,0 +1,41 @@ +--- +title: Manage a bot +--- + +import NavigationSteps from "../../components/NavigationSteps.astro" +import UserCogIcon from "~icons/zulip-icon/user-cog" +import AdminOnly from "./include/_AdminOnly.mdx" +import FlattenedSteps from '../../components/FlattenedSteps.astro'; + +Zulip lets you manage the properties of any bot for which you are the owner. +Organization [administrators](/help/user-roles) can also manage any +active bot in the organization. + +## Manage your bot + + + + + 1. Click the **manage bot** () + icon on the profile card for the bot you want to manage. + 1. Update bot information as desired, and click **Save changes**. + + +## Manage a bot in your organization + + + + + + + 1. In the **Actions** column, click the **manage bot** () icon for the bot you want to manage. + 1. Update bot information as desired, and click **Save changes**. + + +## Related articles + +* [Bots overview](/help/bots-overview) +* [Integrations overview](/help/integrations-overview) +* [Add a bot or integration](/help/add-a-bot-or-integration) +* [Deactivate or reactivate a bot](/help/deactivate-or-reactivate-a-bot) +* [View all bots in your organization](/help/view-all-bots-in-your-organization) diff --git a/starlight_help/src/content/docs/manage-a-user.mdx b/starlight_help/src/content/docs/manage-a-user.mdx new file mode 100644 index 0000000000..bce38aac80 --- /dev/null +++ b/starlight_help/src/content/docs/manage-a-user.mdx @@ -0,0 +1,39 @@ +--- +title: Manage a user +--- + +import NavigationSteps from "../../components/NavigationSteps.astro" +import FlattenedSteps from '../../components/FlattenedSteps.astro'; +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" + + + + + + + + + + + + + + + + + 1. Find the user you would like to manage. Click the **manage user** + () icon to the right + of their name. + + + + +## Related articles + +* [Deactivate or reactivate a user](/help/deactivate-or-reactivate-a-user) +* [Change a user's role](/help/user-roles#change-a-users-role) +* [Change a user's name](/help/change-a-users-name) diff --git a/starlight_help/src/content/docs/manage-channel-folders.mdx b/starlight_help/src/content/docs/manage-channel-folders.mdx new file mode 100644 index 0000000000..d6185400db --- /dev/null +++ b/starlight_help/src/content/docs/manage-channel-folders.mdx @@ -0,0 +1,135 @@ +--- +title: Manage channel folders +--- + +import NavigationSteps from "../../components/NavigationSteps.astro" +import EditIcon from "~icons/zulip-icon/edit" +import MoveChannelToFolder from "./include/_MoveChannelToFolder.mdx" +import FlattenedSteps from '../../components/FlattenedSteps.astro'; +import ChannelFoldersIntro from "./include/_ChannelFoldersIntro.mdx" +import TrashIcon from "~icons/zulip-icon/trash" +import SelectChannelViewGeneral from "./include/_SelectChannelViewGeneral.mdx" +import { Tabs, TabItem } from '@astrojs/starlight/components' +import AdminOnly from "./include/_AdminOnly.mdx" + + + +## Move a channel to a folder + + + +## Create a new channel folder + + + + + + + + + 1. Click **Add a new channel folder**. + 1. Fill out channel folder information as desired, and click **Create**. + 1. In the **Name** column, click and drag the vertical dots to reorder channel + folders. + + + + + + + + 1. Select any channel. + + + + 1. Under **Folders**, click the **Create new folder** button to the right of the + folder selection dropdown. + 1. Fill out the requested information, and click **Create**. + + + + +## Edit a channel folder + + + + + + + + + 1. In the **Actions** column, click the **edit** () + icon for the channel folder you want to edit. + 1. Edit channel folder information as desired, and click **Save changes**. + + + + + + + + 1. Select any channel. + + + + 1. Under **Folders**, click the **edit** () icon for the channel folder you want to edit in the + **Channel folder** dropdown. + 1. Edit channel folder information as desired, and click **Save changes**. + + + + +## Delete a channel folder + + + + + + + + + 1. In the **Actions** column, click the **delete** () icon for the channel folder you want to delete. + 1. Approve by clicking **Confirm**. + + + + + + + + 1. Select any channel. + + + + 1. Under **Folders**, click the **delete** () icon for the channel folder you want to delete in the + **Channel folder** dropdown. + 1. Approve by clicking **Confirm**. + + + + +## Reorder channel folders + + + +Users will see channel folders in the specified order. + + + + + + + 1. In the **Name** column, click and drag the vertical dots to reorder channel + folders. + + + + +## Related articles + +* [Channel folders](/help/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) +* [Manage user groups](/help/manage-user-groups) diff --git a/starlight_help/src/content/docs/manage-inactive-channels.mdx b/starlight_help/src/content/docs/manage-inactive-channels.mdx new file mode 100644 index 0000000000..e6aaad44f4 --- /dev/null +++ b/starlight_help/src/content/docs/manage-inactive-channels.mdx @@ -0,0 +1,66 @@ +--- +title: Hide or reveal inactive channels +--- + +import NavigationSteps from "../../components/NavigationSteps.astro" +import FlattenedSteps from '../../components/FlattenedSteps.astro'; +import FilterChannels from "./include/_FilterChannels.mdx" +import { Steps } from '@astrojs/starlight/components'; +import { Tabs, TabItem } from '@astrojs/starlight/components' + +To avoid clutter in the [left sidebar](/help/left-sidebar), Zulip automatically +hides channels with no recent messages if you're subscribed to 20+ channels. You +can [configure](#configure-hiding-inactive-channels) Zulip to show or hide +inactive channels regardless of how many you're subscribed to. + +It's easy to [reveal](#reveal-inactive-channels) or [find]() hidden inactive +channels if you need to access them. + +## Reveal inactive channels + + + + + 1. In the left sidebar, scroll to the bottom of the list of channels in the + [folder](/help/channel-folders) you're viewing. + 1. Click **inactive channels** to reveal inactive channels. If you don't see + this button, there are no inactive channels, or they are already revealed. + + + + +## Hide inactive channels + + + + + 1. In the left sidebar, scroll to the bottom of the list of channels in the + [folder](/help/channel-folders) you're viewing. + 1. Click **hide inactive channels**. If you don't see this button, there are no + inactive channels, or they are already hidden. + + + + +## Find inactive channels + + + +## Configure hiding inactive channels + + + + + + + 1. Under **Left sidebar**, configure **Hide inactive channels**. + + + + +## Related articles + +* [Introduction to channels](/help/introduction-to-channels) +* [Pin a channel](/help/pin-a-channel) +* [Mute or unmute a channel](/help/mute-a-channel) +* [Channel folders](/help/channel-folders) diff --git a/starlight_help/src/content/docs/manage-permissions.mdx b/starlight_help/src/content/docs/manage-permissions.mdx new file mode 100644 index 0000000000..ddba5066d0 --- /dev/null +++ b/starlight_help/src/content/docs/manage-permissions.mdx @@ -0,0 +1,37 @@ +--- +title: Manage permissions +--- + +import NavigationSteps from "../../components/NavigationSteps.astro" +import ZulipTip from '../../components/ZulipTip.astro'; +import FlattenedSteps from '../../components/FlattenedSteps.astro'; +import UserRolesIntro from "./include/_UserRolesIntro.mdx" +import SaveChanges from "./include/_SaveChanges.mdx" + + + +User groups offer a flexible way to manage permissions. + + + Learn about channel [types and permissions](/help/channel-permissions), + including **public** and **private** channels. + + +## Manage organization permissions + + + + + 1. Review organization permissions, and modify as needed. + + + + +## Related articles + +* [Change a user's role](/help/user-roles#change-a-users-role) +* [User groups](/help/user-groups) +* [Channel permissions](/help/channel-permissions) +* [Inviting new users](/help/invite-new-users) +* [Zulip Cloud billing](/help/zulip-cloud-billing) +* [Guest users](/help/guest-users) diff --git a/starlight_help/src/content/docs/manage-user-channel-subscriptions.mdx b/starlight_help/src/content/docs/manage-user-channel-subscriptions.mdx new file mode 100644 index 0000000000..b3936cb8f7 --- /dev/null +++ b/starlight_help/src/content/docs/manage-user-channel-subscriptions.mdx @@ -0,0 +1,39 @@ +--- +title: Manage a user's channel subscriptions +--- + +import ZulipNote from '../../components/ZulipNote.astro'; +import FlattenedSteps from '../../components/FlattenedSteps.astro'; +import RightSidebarViewProfile from "./include/_RightSidebarViewProfile.mdx" +import UnsubscribeUserFromChannel from "./include/_UnsubscribeUserFromChannel.mdx" +import SubscribeUserToChannel from "./include/_SubscribeUserToChannel.mdx" + +## View a user's channel subscriptions + + + **Note**: The list of a user's **Subscribed channels** will be limited to + [channels you can see](/help/channel-permissions). + + + + + + 1. Select the **Channels** tab. + + +## Subscribe a user to a channel + + + +## Unsubscribe a user from a channel + + + +## Related articles + +* [Channel permissions](/help/channel-permissions) +* [User roles](/help/user-roles) +* [Subscribe users to a channel](/help/subscribe-users-to-a-channel) +* [Unsubscribe users from a channel](/help/unsubscribe-users-from-a-channel) +* [Unsubscribe from a channel](/help/unsubscribe-from-a-channel) +* [View channel subscribers](/help/view-channel-subscribers) diff --git a/starlight_help/src/content/docs/manage-user-group-membership.mdx b/starlight_help/src/content/docs/manage-user-group-membership.mdx new file mode 100644 index 0000000000..98cc79e222 --- /dev/null +++ b/starlight_help/src/content/docs/manage-user-group-membership.mdx @@ -0,0 +1,64 @@ +--- +title: Manage a user's group membership +--- + +import NavigationSteps from "../../components/NavigationSteps.astro" +import CloseIcon from "~icons/zulip-icon/close" +import FlattenedSteps from '../../components/FlattenedSteps.astro'; +import RightSidebarViewProfile from "./include/_RightSidebarViewProfile.mdx" +import AddUsersToAGroup from "./include/_AddUsersToAGroup.mdx" +import DependsOnPermissions from "./include/_DependsOnPermissions.mdx" +import { Tabs, TabItem } from '@astrojs/starlight/components' + +## View a user's group membership + + + + + 1. Select the **User groups** tab. + + +## Add a user to a group + + + + + +## Remove user or group from a group + + + + + + + + + 1. Select a user group. + 1. Select the **Members** tab on the right. + 1. Under **Members**, find the user or group you would like to remove. + 1. Click the **Remove** () icon in that row. Zulip will notify everyone who is + removed from the group. + + + + + + + + 1. Select the **User groups** tab. + 1. Find the group you would like to remove the user from. + 1. Click the **Remove** () icon in that row. Zulip will notify the user about the + groups they've been removed from. + + + + +## Related articles + +* [User groups](/help/user-groups) +* [Manage user groups](/help/user-groups) +* [Mention a user or group](/help/mention-a-user-or-group) +* [Create user groups](/help/create-user-groups) +* [User roles](/help/user-roles) + +[configure-invites]: /help/configure-who-can-invite-to-channels diff --git a/starlight_help/src/content/docs/manage-user-groups.mdx b/starlight_help/src/content/docs/manage-user-groups.mdx new file mode 100644 index 0000000000..7c2434357f --- /dev/null +++ b/starlight_help/src/content/docs/manage-user-groups.mdx @@ -0,0 +1,206 @@ +--- +title: Manage user groups +--- + +import NavigationSteps from "../../components/NavigationSteps.astro" +import UserGroupsApplications from "./include/_UserGroupsApplications.mdx" +import UserGroupsIntro from "./include/_UserGroupsIntro.mdx" +import CloseIcon from "~icons/zulip-icon/close" +import ZulipTip from '../../components/ZulipTip.astro'; +import FlattenedSteps from '../../components/FlattenedSteps.astro'; +import UserGroupEditIcon from "~icons/zulip-icon/user-group-edit" +import SaveChanges from "./include/_SaveChanges.mdx" +import RightSidebarViewProfile from "./include/_RightSidebarViewProfile.mdx" +import AddUsersToAGroup from "./include/_AddUsersToAGroup.mdx" +import CloudPaidPlansOnly from "./include/_CloudPaidPlansOnly.mdx" +import HowToCreateAUserGroup from "./include/_HowToCreateAUserGroup.mdx" +import UserSubgroupsIntro from "./include/_UserSubgroupsIntro.mdx" +import { Tabs, TabItem } from '@astrojs/starlight/components' +import ExpandBothDiagonalsIcon from "~icons/zulip-icon/expand-both-diagonals" +import ZulipNote from '../../components/ZulipNote.astro'; +import AdminOnly from "./include/_AdminOnly.mdx" + + + + + + + +## Create a user group + + + You can modify the group's name, description, and other settings after it + has been created. + + + + +## Change a user group's name or description + + + + + + + 1. Select a user group. + 1. Select the **General** tab on the right. + 1. Click the **change group info** () + icon to the right of the user group, and enter a new name or description. + + + + + + +## Configure group permissions + + + Guests can never administer user groups, add anyone else to a group, or remove + anyone else from a group, even if they belong to a group that has permissions + to do so. + + + + Users who can add members to a group can always join the group. + + + + + + + + 1. Select a user group. + 1. Select the **General** tab on the right. + 1. Under **Group permissions**, configure **Who can administer this group**, **Who + can mention this group**, **Who can add members to this group**, **Who can remove + members from this group**, **Who can join this group**, and **Who can leave this group**. + + + + + + +## Add users to a group + + + +## Add user groups to a group + + + + + + + + + 1. Select a user group. + 1. Select the **Members** tab on the right. + 1. Under **Add members**, enter groups you want to add. + 1. Click **Add**. + + + + Click the icon + on a user group pill to add all the members of the group, rather than the + group itself. + + + + +## Remove user or group from a group + + + + + + + 1. Select a user group. + 1. Select the **Members** tab on the right. + 1. Under **Members**, find the user or group you would like to remove. + 1. Click the **Remove** () icon in that row. Zulip will notify everyone who is + removed from the group. + + + + + + + + 1. Select the **User groups** tab. + 1. Find the group you would like to remove the user from. + 1. Click the **Remove** () icon in that row. + + + + +## Review and remove permissions assigned to a group + +You can review which permissions are assigned to a group, and remove permissions +as needed. + + + + + + + 1. Select a user group. + 1. Select the **Permissions** tab on the right. + 1. Toggle the checkboxes next to any permissions you'd like to remove. + 1. Click **Save changes**. + + + + +## Configure who can create user groups + + + +You can configure who can create groups in your organization. Guests can never +create user groups, even if they belong to a group that has permissions to do +so. + + + + + + + 1. Under **Group permissions**, configure **Who can create user groups**. + + + + + + +## Configure who can administer all user groups + + + +You can configure who can administer all user groups in your +organization. Guests can never administer user groups, even if they +belong to a group that has permissions to do so. + +In addition, you can [give users +permission](#configure-group-permissions) to administer a specific +group. + + + + + + + 1. Under **Group permissions**, configure **Who can administer all user groups**. + + + + + + +## Related articles + +* [User groups](/help/user-groups) +* [View group members](/help/view-group-members) +* [Mention a user or group](/help/mention-a-user-or-group) +* [Create user groups](/help/create-user-groups) +* [Deactivate a user group](/help/deactivate-a-user-group) +* [Moving to Zulip](/help/moving-to-zulip) +* [User roles](/help/user-roles) diff --git a/starlight_help/src/content/docs/manage-your-uploaded-files.mdx b/starlight_help/src/content/docs/manage-your-uploaded-files.mdx new file mode 100644 index 0000000000..46af2ded3c --- /dev/null +++ b/starlight_help/src/content/docs/manage-your-uploaded-files.mdx @@ -0,0 +1,67 @@ +--- +title: Manage your uploaded files +--- + +import NavigationSteps from "../../components/NavigationSteps.astro" +import ZulipTip from '../../components/ZulipTip.astro'; +import FlattenedSteps from '../../components/FlattenedSteps.astro'; +import DownloadIcon from "~icons/zulip-icon/download" +import TrashIcon from "~icons/zulip-icon/trash" + +Zulip lets you view, sort, filter, download, and delete any files that you have +uploaded. + +## View a file + + + + + 1. Click on the name of a file in the **File** column. + + + + You can also view a file in the context of the + [conversations](/help/recent-conversations) where it was + mentioned by clicking on a message ID in the **Mentioned in** column. + + +## Sort your files + +You can sort your uploaded files by name, upload date, message ID, and size. + + + + + 1. Click on the name of a column to toggle between ascending and descending order. + + + + You can filter your current view by using the **search box** near the top + right corner of the menu. + + +## Download a file + + + + + 1. In the **Actions** column, click the **download** + () icon for the file you want to download. + + +## Delete a file + + + + + 1. In the **Actions** column, click the **delete** + () icon for the file you want to remove. + 1. Approve by clicking **Delete**. If you delete a file, your message will still + contain a file link, but the link will no longer work. + + +## Related articles + +* [Share and upload files](/help/share-and-upload-files) +* [View images and videos](/help/view-images-and-videos) +* [Image, video and website previews](/help/image-video-and-website-previews) diff --git a/starlight_help/src/content/docs/marking-messages-as-read.mdx b/starlight_help/src/content/docs/marking-messages-as-read.mdx new file mode 100644 index 0000000000..eeb1910193 --- /dev/null +++ b/starlight_help/src/content/docs/marking-messages-as-read.mdx @@ -0,0 +1,164 @@ +--- +title: Marking messages as read +--- + +import NavigationSteps from "../../components/NavigationSteps.astro" +import ChevronDownIcon from "~icons/fa/chevron-down" +import ZulipTip from '../../components/ZulipTip.astro'; +import FlattenedSteps from '../../components/FlattenedSteps.astro'; +import AllMessagesIcon from "~icons/zulip-icon/all-messages" +import { Steps } from '@astrojs/starlight/components'; +import MobileSettings from "./include/_MobileSettings.mdx" +import GoToRecentConversations from "./include/_GoToRecentConversations.mdx" +import MoreVerticalIcon from "~icons/zulip-icon/more-vertical" +import GoToInbox from "./include/_GoToInbox.mdx" +import { Tabs, TabItem } from '@astrojs/starlight/components' +import ConfigureResolvedNoticesMarkedAsRead from "./include/_ConfigureResolvedNoticesMarkedAsRead.mdx" + +Zulip automatically keeps track of which messages you have and haven't read. +Unread messages have a line along the left side, which fades when the message +gets marked as read. + +Zulip offers tools to manually mark one or more messages as read, and you can +configure whether messages are marked as read automatically when you scroll. + +## Configure whether messages are automatically marked as read + +You can choose how messages are automatically marked as read in the Zulip web +and mobile apps. You can configure the mobile app differently from the +web/desktop app. + +* **Always**: Messages are marked as read whenever you scroll through them in + the app. You may be used to this from other chat applications. +* **Only in conversation views**: 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 makes it + convenient to preview new messages in a channel, or skim [Combined + feed](/help/combined-feed), and later read each topic in detail. +* **Never**: Messages are marked as read only manually. For example, + if you often need to follow up on messages at your computer after + reading them in the mobile app, you can choose this option for the + mobile app. + + + + + + + 1. Under **Navigation**, click on the **Automatically mark messages as + read** dropdown, and select **Always**, **Never** or **Only in + [conversation](/help/reading-conversations) views**. + + + + + + + + 1. Tap **Mark messages as read on scroll**. + 1. Select **Always**, **Never** or **Only in + [conversation](/help/reading-conversations) views**. + + + + +## Configure whether resolved topic notices are marked as read + + + +## Mark a message as read + + + + + 1. Select the message using the **blue box** to mark it as read. You can scroll + the **blue box** using the mouse, or with [keyboard navigation + shortcuts](/help/keyboard-shortcuts#navigation). + + + + +## Mark all messages in a channel or topic as read + + + + + 1. Hover over a channel or topic in the left sidebar. + 1. Click on the **ellipsis** (). + 1. Click **Mark all messages as read**. + + + + You can also mark all messages in your current view as read by + jumping to the bottom with the **Scroll to bottom** + () button or the End shortcut. + + + + + + + + 1. Click on an unread messages counter to mark all messages in that topic or + channel as read. + + + + + + + + 1. Click on an unread messages counter in the **Topic** column to mark all + messages in that topic as read. + + + + + + 1. Press and hold a channel or topic until the long-press menu appears. + 1. Tap **Mark channel as read** or **Mark topic as read**. + + + + You can also scroll down to the bottom of a message view, and tap **Mark + all messages as read**. + + + + +## Mark messages in multiple topics and channels as read + +In the web and desktop apps, you can mark all messages as read, or just messages +in muted topics or topics you don't follow. + + + + + 1. Hover over your [home view](/help/configure-home-view) in the left sidebar. + 1. Click on the **ellipsis** (). + 1. Select the desired option from the dropdown, and click **Confirm**. + + + + You can also mark all messages in your current view as read by + jumping to the bottom with the **Scroll to bottom** + () button or the End shortcut. + + + + + + 1. Tap the **Combined feed** + () tab. + 1. Scroll down to the bottom of the message view, and tap **Mark all messages + as read**. + + + + +## Related articles + +* [Marking messages as unread](/help/marking-messages-as-unread) +* [Configure where you land in message feeds](/help/configure-where-you-land) +* [Reading strategies](/help/reading-strategies) +* [Read receipts](/help/read-receipts) diff --git a/starlight_help/src/content/docs/marking-messages-as-unread.mdx b/starlight_help/src/content/docs/marking-messages-as-unread.mdx new file mode 100644 index 0000000000..c9849e1d72 --- /dev/null +++ b/starlight_help/src/content/docs/marking-messages-as-unread.mdx @@ -0,0 +1,93 @@ +--- +title: Marking messages as unread +--- + +import MoreVerticalIcon from "~icons/zulip-icon/more-vertical" +import FollowIcon from "~icons/zulip-icon/follow" +import ZulipTip from '../../components/ZulipTip.astro'; +import FlattenedSteps from '../../components/FlattenedSteps.astro'; +import MuteIcon from "~icons/zulip-icon/mute" +import MessageLongPressMenu from "./include/_MessageLongPressMenu.mdx" +import KeyboardTip from '../../components/KeyboardTip.astro'; +import { Steps } from '@astrojs/starlight/components'; +import MessageActionsMenu from "./include/_MessageActionsMenu.mdx" +import GoToRecentConversations from "./include/_GoToRecentConversations.mdx" +import { Tabs, TabItem } from '@astrojs/starlight/components' + +Zulip lets you manually mark messages as unread. Specifically, Zulip offers a +**Mark as unread from here** option, which lets you mark the selected message +and all newer messages in your current view as unread. + +There are many ways to use this feature, including: + +* When you don't have time to read a conversation carefully, or to follow up on + action items, mark messages as unread to return to them later. +* You can mark messages as unread when you [subscribe to a + channel](/help/introduction-to-channels#browse-and-subscribe-to-channels). This makes it + [convenient](/help/reading-strategies) to review all the recent + conversations in that channel. +* Mark the results of your [search](/help/search-for-messages) as unread to + review them at leisure. + +## Mark as unread from selected message + + + + + + + 1. Click **Mark as unread from here**. + + + + You can also mark messages as unread by selecting a message, and using the + Shift + U shortcut. + + + + + + + + 1. Tap **Mark as unread from here**. + + + + +## Mark all messages in a topic or channel as unread + + + + + 1. Hover over a topic or channel in the left sidebar. + 1. Click on the **ellipsis** (). + 1. Click **Mark all messages as unread**. This option will appear only if all + messages in the topic or channel are currently marked as read. + + + + You can also mark all messages in your current view as unread by + jumping to the top with the Home key, and marking as unread + [from the first message](#mark-as-unread-from-selected-message). + + + + + + + + 1. Hover over a topic. + 1. Click on the **ellipsis** () next to the unread messages counter. You may + need to hover over the indicator icon for a followed () or muted () topic in order to see it. + 1. Click **Mark all messages as unread**. This option will appear only if all + messages in the topic are currently marked as read. + + + + +## Related articles + +* [Reading strategies](/help/reading-strategies) +* [Marking messages as read](/help/marking-messages-as-read) +* [Star a message](/help/star-a-message) +* [Read receipts](/help/read-receipts) diff --git a/starlight_help/src/content/docs/mastering-the-compose-box.mdx b/starlight_help/src/content/docs/mastering-the-compose-box.mdx new file mode 100644 index 0000000000..97ae948bbb --- /dev/null +++ b/starlight_help/src/content/docs/mastering-the-compose-box.mdx @@ -0,0 +1,90 @@ +--- +title: Mastering the compose box +--- + +import NavigationSteps from "../../components/NavigationSteps.astro" +import FlattenedSteps from '../../components/FlattenedSteps.astro'; +import { Steps } from '@astrojs/starlight/components'; +import KeyboardTip from '../../components/KeyboardTip.astro'; +import StartComposing from "./include/_StartComposing.mdx" +import { Tabs, TabItem } from '@astrojs/starlight/components' +import ChevronRightIcon from "~icons/zulip-icon/chevron-right" + +Here is an overview of all the information and actions you can take in Zulip's +compose box. + +![Compose box information and actions](../../../../static/images/help/compose-actions.png) + +## Composing to a different conversation + +When composing a message, Zulip lets you view a different +[conversation](/help/reading-conversations) from the one you are composing to. +For example, you can start a new topic without changing your view, send a +direct message about the topic you're viewing, or look up a related discussion. + +In this context, the parts of the message view that are outside of the +conversation you are composing to are faded for clarity. + +### Change where you are composing to + +No matter where you start composing your message, it's easy to change where it +will be sent. + + + + + + + 1. Select any channel from the dropdown in the top left of the compose box. You can + start typing to filter channels. + 1. Enter a topic name. Auto-complete will provide suggestions for previously + used topics. + + + + + + + + 1. Select **Direct message** from the dropdown in the top left of the compose + box. + 1. Start typing the name of the person you want to message, and + select their name from the list of suggestions. You can continue + adding as many message recipients as you like. + + + + +### Go to conversation + +Zulip lets you jump to the [conversation](/help/reading-conversations) you're +currently composing to. + + + 1. [Open the compose box](/help/open-the-compose-box). + 1. Click the highlighted **Go to conversation** () button at the top of the compose box. It will + be clickable only if you're viewing a different conversation from the one you + are composing to. + + + + Use Ctrl + . to go to the conversation you're + composing to. + + +### Automatically go to conversation where you sent a message + + + + + 1. Under **Navigation**, toggle **Automatically go to conversation + where you sent a message**, as desired. + + +## Related articles + +* [Resize the compose box](/help/resize-the-compose-box) +* [Message formatting](/help/format-your-message-using-markdown) +* [Preview messages before sending](/help/preview-your-message-before-sending) +* [Configure send message keys](/help/configure-send-message-keys) +* [Messaging tips and tricks](/help/messaging-tips) diff --git a/starlight_help/src/content/docs/me-action-messages.mdx b/starlight_help/src/content/docs/me-action-messages.mdx new file mode 100644 index 0000000000..f01b07d029 --- /dev/null +++ b/starlight_help/src/content/docs/me-action-messages.mdx @@ -0,0 +1,18 @@ +--- +title: /me action messages +--- + +import MeActionMessagesIntro from "./include/_MeActionMessagesIntro.mdx" +import MeActionMessagesExamples from "./include/_MeActionMessagesExamples.mdx" + + + +## Examples + + + +## 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) diff --git a/starlight_help/src/content/docs/mention-a-user-or-group.mdx b/starlight_help/src/content/docs/mention-a-user-or-group.mdx new file mode 100644 index 0000000000..e17aa48e9d --- /dev/null +++ b/starlight_help/src/content/docs/mention-a-user-or-group.mdx @@ -0,0 +1,113 @@ +--- +title: Mention a user or group +--- + +import ZulipTip from '../../components/ZulipTip.astro'; +import FlattenedSteps from '../../components/FlattenedSteps.astro'; +import { Steps } from '@astrojs/starlight/components'; +import MentionsExamples from "./include/_MentionsExamples.mdx" +import RightSidebarUserCard from "./include/_RightSidebarUserCard.mdx" +import StartComposing from "./include/_StartComposing.mdx" +import MentionsIntro from "./include/_MentionsIntro.mdx" +import { Tabs, TabItem } from '@astrojs/starlight/components' + + + + + If you edit a message, adding or removing mentions will update message + notifications. [Learn more](/help/edit-a-message#message-notifications). + + +## Mention a user or group + +### From the compose box + + + + + + + 1. Type `@` followed by a few letters from a name or email address. + 1. Pick the appropriate user or user group from the autocomplete. + + + + + + 1. Tap the compose box at the bottom of the app. + 1. Type `@` followed by a few letters from a name. + 1. Pick the appropriate user or user group from the autocomplete. + + + + +### From the user list + + + + + 1. Select **Copy mention syntax** to add it to your clipboard. + 1. Paste the user's mention syntax in the compose box. + + +### Via a message + + + 1. Click on a user's profile picture or name on a message they sent + to open their **user card**. + 1. Select **Reply mentioning user** to start a reply to the conversation + with a mention inserted into the compose box. + + +## Silently mention a user + +A silent mention allows you to refer to a user without triggering a +notification. Silent mentions start with `@_` instead of `@`. + + + + + 1. Type `@_` followed by a few letters from a name or email address. + 1. Pick the appropriate user or user group from the autocomplete. + + +## Mention all topic participants + +Using the `@**topic**` mention, you can mention everyone who has previously +participated in the topic by sending a message or +[reacting](/help/emoji-reactions) with an emoji. This lets you notify just those +who have already engaged in the conversation. + +Users can disable notifications for `@**topic**` mentions by: + +* Disabling notifications for wildcard mentions + [globally](/help/dm-mention-alert-notifications) or for [individual + channels](/help/channel-notifications). +* Muting the [topic](/help/mute-a-topic) or [channel](/help/mute-a-channel). + +## Mention everyone on a channel + +You can mention everyone on a channel with the `@**all**` mention (or, +equivalently, `@**everyone**` or `@**channel**`). It's best to use these mentions +only when your message requires timely attention from many channel subscribers. +An organization can be configured to +[restrict](/help/restrict-wildcard-mentions) wildcard mentions in large channels. + +Users can disable notifications for `@**all**`, `@**everyone**`, and +`@**channel**` mentions by: + +* Disabling notifications for wildcard mentions + [globally](/help/dm-mention-alert-notifications) or for [individual + channels](/help/channel-notifications). +* Muting the [topic](/help/mute-a-topic) or [channel](/help/mute-a-channel). + +## Examples + + + +## Related articles + +* [Message formatting](/help/format-your-message-using-markdown) +* [Restrict wildcard mentions](/help/restrict-wildcard-mentions) +* [Quote message](/help/quote-or-forward-a-message) +* [View your mentions](/help/view-your-mentions) diff --git a/starlight_help/src/content/docs/message-a-channel-by-email.mdx b/starlight_help/src/content/docs/message-a-channel-by-email.mdx new file mode 100644 index 0000000000..5c3eb0c3cc --- /dev/null +++ b/starlight_help/src/content/docs/message-a-channel-by-email.mdx @@ -0,0 +1,85 @@ +--- +title: Message a channel by email +--- + +import SelectChannelViewGeneral from "./include/_SelectChannelViewGeneral.mdx" +import NavigationSteps from "../../components/NavigationSteps.astro" +import ZulipTip from '../../components/ZulipTip.astro'; +import FlattenedSteps from '../../components/FlattenedSteps.astro'; + + + This feature is not available on self-hosted Zulip servers where + the [incoming email gateway][email-gateway] has not been + configured by a system administrator. + + +[email-gateway]: https://zulip.readthedocs.io/en/stable/production/email-gateway.html + +You can send emails to Zulip channels. This can be useful: + +* If you have an email that you want to discuss on Zulip +* For mirroring mailing list traffic +* For integrating a third-party app that can send emails, but which does not + easily lend itself to a more direct integration + +If you're planning on doing this in an automated way, and have some +programming experience, another option is to use our [send message +API](/api/send-message). + +### Message a channel by email + + + + + 1. Select a channel. + + + + 1. Under **Channel details**, click **Generate email address**. + 1. Select **Who should be the sender of the Zulip messages for this email + address**. + 1. Toggle the configuration options as desired. + 1. Click **Copy address** to add the channel email address to your clipboard. + 1. Send an email to that address. + + +The email subject will become the Zulip topic, and the email body will +become the Zulip message. + +Note that it may take up to one minute for the message to show +up in Zulip. + +## Configuration options + +You can configure **who should be the sender of the Zulip messages** for the +generated email address, with the following options: + +* **Email Gateway bot**: This option makes it easy to see that the message + was sent via email. +* **You**: Messages will look the same as messages you send from the Zulip UI. +* [Any bot you own](/help/view-your-bots) + +The following options control which parts of the email are included in the +Zulip message. + +* **The sender's email address**: Adds `From: ` to + the top of the Zulip message. +* **Email footers**: By default, Zulip tries to automatically remove some footer + text (like signatures). With this option enabled, Zulip will include all footers. +* **Quoted original email**: In many email clients, when you reply to a message + (e.g., a message notification email), a copy of the original message is + automatically added to the bottom of your reply. By default, Zulip tries + to remove that copied message. With this option enabled, Zulip will include it. +* **Use html encoding**: The body of an email is typically encoded using + one or both of two common formats: plain text (`text/plain`) and + HTML (`text/html`). Zulip supports constructing the Zulip message + content using either (converting HTML to Markdown for the HTML + format). By default, Zulip will prefer using the plain text version + of an email over the converted HTML version if both are present. + Enabling this option overrides that behavior to prefer the HTML version + instead. + +## Related articles + +* [Using Zulip via email](/help/using-zulip-via-email) +* [Bots overview](/help/bots-overview) diff --git a/starlight_help/src/content/docs/message-actions.mdx b/starlight_help/src/content/docs/message-actions.mdx new file mode 100644 index 0000000000..5379c07843 --- /dev/null +++ b/starlight_help/src/content/docs/message-actions.mdx @@ -0,0 +1,50 @@ +--- +title: Message actions +--- + +import { Tabs, TabItem } from '@astrojs/starlight/components' +import MessageActionsMenu from "./include/_MessageActionsMenu.mdx" +import MessageLongPressMenu from "./include/_MessageLongPressMenu.mdx" +import FlattenedSteps from '../../components/FlattenedSteps.astro'; + +There are many ways to interact with a Zulip message. Here's an overview of the +message actions in the web and desktop apps: + +![Message actions](../../../../static/images/help/message-actions.png) + +In the mobile app, the message actions menu lets you: + +* Add a [reaction](/help/emoji-reactions). +* [Star](/help/star-a-message) the message. +* [Quote](/help/quote-or-forward-a-message) the message. +* [Copy message + content](/help/view-the-markdown-source-of-a-message#copy-message-content-as-markdown) in + Markdown, or [share + it](/help/view-the-markdown-source-of-a-message#share-message-content) to + other apps. +* Copy a [link to the + message](/help/link-to-a-message-or-conversation#get-a-link-to-a-specific-message). + +## Open the message actions menu + + + + + + + + + + + + + + + +## Related articles + +* [User cards](/help/user-cards) +* [Emoji reactions](/help/emoji-reactions) +* [Star a message](/help/star-a-message) +* [View a message's edit history](/help/view-a-messages-edit-history) +* [Link to a message or conversation](/help/link-to-a-message-or-conversation) diff --git a/starlight_help/src/content/docs/message-retention-policy.mdx b/starlight_help/src/content/docs/message-retention-policy.mdx new file mode 100644 index 0000000000..a9a121e9dc --- /dev/null +++ b/starlight_help/src/content/docs/message-retention-policy.mdx @@ -0,0 +1,80 @@ +--- +title: Message retention 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" +import OwnerOnly from "./include/_OwnerOnly.mdx" + + + +By default, Zulip stores messages indefinitely, allowing full-text +search of your complete history. + +Zulip supports configuring both a global organization-level message +retention policy, as well as retention policies for individual +channels. These policies control how many days a message is stored +before being automatically deleted (the default being forever). +Zulip's system supports: + +* Setting an organization-level retention policy, which applies to + all direct messages and all channels without a specific policy. +* Setting a retention policy for individual channels, which overrides + the organization-level policy for that channel. This can be used to + just delete messages on specific channels, to only retain messages + forever on specific channels, or just to have a different retention + period. + +In Zulip Cloud, message retention policies are available on the Zulip +Cloud Standard and Zulip Cloud Plus [plans](https://zulip.com/plans/), +as well as for the hundreds of communities with sponsored Cloud +Standard hosting. + +### Configure message retention policy for organization + + + + + 1. Under **Message retention period**, configure **Message retention + period**. + + + + +### Configure message retention policy for individual channels + + + + + 1. Select a channel. + + + + 1. Under **Administrative permissions**, configure the + **Message retention period**. + + + + + + +## Important details + +* Retention policies are processed in a daily job; so changes in the + policy won't have any effect until the next time the daily job runs. +* Deleted messages are preserved temporarily in a special archive. So + if you discover a misconfiguration accidentally deleted content you + meant to preserve, contact Zulip support promptly for assistance with + restoration. See the [deletion + documentation](/help/delete-a-message#delete-a-message-completely) for + more details on precisely how message deletion works in Zulip. + +## Related articles + +* [Edit a message](/help/edit-a-message) +* [Delete a message](/help/delete-a-message) +* [Delete a topic](/help/delete-a-topic) +* [Archive a channel](/help/archive-a-channel) diff --git a/starlight_help/src/content/docs/messaging-tips.mdx b/starlight_help/src/content/docs/messaging-tips.mdx new file mode 100644 index 0000000000..095bb21404 --- /dev/null +++ b/starlight_help/src/content/docs/messaging-tips.mdx @@ -0,0 +1,14 @@ +--- +title: Messaging tips & tricks +--- + +import MessagingTips from "./include/_MessagingTips.mdx" + + + +## Related articles + +* [Getting started with Zulip](/help/getting-started-with-zulip) +* [Introduction to topics](/help/introduction-to-topics) +* [Starting a new direct message](/help/starting-a-new-direct-message) +* [Replying to messages](/help/replying-to-messages) diff --git a/starlight_help/src/content/docs/migrating-from-other-chat-tools.mdx b/starlight_help/src/content/docs/migrating-from-other-chat-tools.mdx new file mode 100644 index 0000000000..791964e472 --- /dev/null +++ b/starlight_help/src/content/docs/migrating-from-other-chat-tools.mdx @@ -0,0 +1,29 @@ +--- +title: Migrating from other chat tools +--- + +import ZulipNote from '../../components/ZulipNote.astro'; + +If your organization is moving to Zulip from another chat tool, you can use +Zulip's tools to import your data, including users, channels, messages, and +more. Follow the detailed import guides: + +* [Import from Slack](/help/import-from-slack). Zulip's [Slack-compatible + incoming webhook](https://zulip.com/integrations/doc/slack_incoming) also + makes it easy to migrate any integrations. +* [Import from Mattermost](/help/import-from-mattermost) +* [Import from Rocket.Chat](/help/import-from-rocketchat) + + + **You can only import a workspace as a new Zulip organization.** Your imported + message history cannot be added into an existing Zulip organization. + + +## Related articles + +* [Zulip Cloud or self-hosting?](/help/zulip-cloud-or-self-hosting) +* [Trying out Zulip](/help/trying-out-zulip) +* [Self-hosting Zulip](/self-hosting/) +* [Installing a Zulip server](https://zulip.readthedocs.io/en/stable/production/install.html) +* [Moving to Zulip](/help/moving-to-zulip) +* [Getting started with Zulip](/help/getting-started-with-zulip) diff --git a/starlight_help/src/content/docs/missing.mdx b/starlight_help/src/content/docs/missing.mdx new file mode 100644 index 0000000000..1c681bb745 --- /dev/null +++ b/starlight_help/src/content/docs/missing.mdx @@ -0,0 +1,5 @@ +--- +title: No such article. +--- + +No such article. diff --git a/starlight_help/src/content/docs/mobile-app-install-guide.mdx b/starlight_help/src/content/docs/mobile-app-install-guide.mdx new file mode 100644 index 0000000000..04a8c87be4 --- /dev/null +++ b/starlight_help/src/content/docs/mobile-app-install-guide.mdx @@ -0,0 +1,87 @@ +--- +title: Installing the Zulip mobile apps +--- + +import { Steps } from '@astrojs/starlight/components'; +import { Tabs, TabItem } from '@astrojs/starlight/components' + +Zulip's native Android and iOS apps make it easy to keep up while on the go, +with fully customizable [mobile notifications](/help/mobile-notifications). + +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 + + + + **Google Play** + + + 1. Download [Zulip for Android](https://zulip.com/apps/android). + 1. Open the app on your device. + + + **Download an APK** + + + 1. Download [the latest release](https://github.com/zulip/zulip-flutter/releases/latest). + 1. Open the app on your device. + + + + + + 1. Download [Zulip for iOS](https://zulip.com/apps/ios). + 1. Open the app on your device. + + + + +## Install a beta release + +Get a peek at new features before they're released! + + + + + 1. Follow the Google Play instructions above to + [install the latest release](#install-the-latest-release). + 1. [Join the testing program](https://play.google.com/apps/testing/com.zulipmobile/) + on Google Play. + + + + + + 1. Install [TestFlight](https://testflight.apple.com/) on your device. + 1. Open [this public invitation link](https://testflight.apple.com/join/ZuzqwXGf) + on your device. + + + + +## Install the legacy app + +Zulip replaced the legacy mobile app with a [new mobile +app](https://blog.zulip.com/2025/06/17/flutter-mobile-app-launched/) in +June 2025. Android users can still install the legacy app, which will +not be updated with bug fixes or new features. + + + + **Download an APK** + + + 1. Uninstall the Zulip app, if it's already installed. + 1. Download [the legacy app](https://github.com/zulip/zulip-mobile/releases/latest) + APK file. + 1. Open the APK file, and follow prompts to install it. + + + + +## Related articles + +* [Mobile notifications](/help/mobile-notifications) diff --git a/starlight_help/src/content/docs/mobile-notifications.mdx b/starlight_help/src/content/docs/mobile-notifications.mdx new file mode 100644 index 0000000000..080170522f --- /dev/null +++ b/starlight_help/src/content/docs/mobile-notifications.mdx @@ -0,0 +1,150 @@ +--- +title: Mobile notifications +--- + +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 { Tabs, TabItem } from '@astrojs/starlight/components' +import AdminOnly from "./include/_AdminOnly.mdx" + +Zulip can be configured to send [mobile](/help/mobile-app-install-guide) +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). + + + + + + + 1. Toggle the checkboxes in the **Mobile** column of the **Notification + triggers** table. + + + + +[notifications-wildcard-mentions]: /help/dm-mention-alert-notifications#wildcard-mentions + +## End-to-end encryption (E2EE) for mobile push notifications + +Zulip Server 11.0+ and Zulip Cloud support end-to-end encryption for mobile push +notifications. Support is [coming soon][e2ee-flutter-issue] to the Zulip mobile +app. Once implemented, all push notifications sent from an up-to-date version of +the server to an updated version of the app will be end-to-end encrypted. + +[e2ee-flutter-issue]: https://github.com/zulip/zulip-flutter/issues/1764 + +Organization administrators can require end-to-end encryption for +message content in mobile push notifications. When this setting is +enabled, message content will be omitted when sending notifications to +an app that doesn't support end-to-end encryption. Users will see “New +message” in place of message text. See [technical +documentation](https://zulip.readthedocs.io/en/latest/production/mobile-push-notifications.html#security-and-privacy) +for details. + +### Require end-to-end encryption for mobile push notifications + + + + + + + 1. Under **Notifications security**, toggle + **Require end-to-end encryption for push notification content**. + + +## Mobile notifications while online + +You can customize whether or not Zulip will send mobile push +notifications while you are actively using one of the Zulip apps. + + + + + + + 1. Under **Mobile message notifications**, toggle + **Send mobile notifications even if I'm online**, as desired. + + + + +## Testing mobile notifications + +Start by configuring your notifications settings to make it easy to trigger a +notification. + + + + + + + 1. In the **Mobile** column of the **Notification triggers** table, make sure + the **DMs, mentions, and alerts** checkbox is checked. + 1. Under **Mobile message notifications**, make sure the **Send mobile + notifications even if I'm online** checkbox is checked. + + + + +Next, test Zulip push notifications on your mobile device. + + + + + 1. [Download](https://zulip.com/apps/) and install the Zulip mobile app if you + have not done so already. + 1. If your Zulip organization is self-hosted (not at `*.zulipchat.com`), + [check](/help/mobile-notifications#enabling-push-notifications-for-self-hosted-servers) + whether push notifications have been set up. If they were set up recently, + you will need to [log out](/help/logging-out) of your account. + 1. [Log in](/help/logging-in) to the account you want to test. + 1. Ask *another* user (not yourself) to [send you a direct + message](/help/starting-a-new-direct-message). You should see a Zulip message + notification in the **notifications area** on your device. + + + + +## Troubleshooting mobile notifications + +### Checking your device settings + +Some Android vendors have added extra device-level settings that can impact the +delivery of mobile notifications to apps like Zulip. If you're having issues +with Zulip notifications on your Android phone, we recommend Signal's excellent +[troubleshooting guide](https://support.signal.org/hc/en-us/articles/360007318711-Troubleshooting-Notifications#android_notifications_troubleshooting), +which explains the notification settings for many popular Android vendors. + +Android users using microG: we have heard reports of notifications working +if microG's "Cloud Messaging" setting is enabled. + +### Enabling push notifications for self-hosted servers + + + These instructions do not apply to Zulip Cloud organizations (`*.zulipchat.com`). + + +To enable push notifications for your organization: + + + 1. Your server administrator needs to register your Zulip server with the + [Zulip Mobile Push Notification + Service](https://zulip.readthedocs.io/en/stable/production/mobile-push-notifications.html). + 1. For organizations with more than 10 users, an + [owner](/help/user-roles) or billing administrator needs to sign + up for a [plan](https://zulip.com/plans/#self-hosted) for your organization. + + +## Related articles + +* [Mobile app installation guides](/help/mobile-app-install-guide) +* [Channel notifications](/help/channel-notifications) +* [DMs, mentions, and alerts](/help/dm-mention-alert-notifications) +* [Email notifications](/help/email-notifications) +* [Desktop notifications](/help/desktop-notifications) +* [Do not disturb](/help/do-not-disturb) +* [Hide message content in emails](/help/hide-message-content-in-emails) diff --git a/starlight_help/src/content/docs/moderating-open-organizations.mdx b/starlight_help/src/content/docs/moderating-open-organizations.mdx new file mode 100644 index 0000000000..699bf5b0cc --- /dev/null +++ b/starlight_help/src/content/docs/moderating-open-organizations.mdx @@ -0,0 +1,107 @@ +--- +title: Community moderation toolkit +--- + +import WebPublicChannelsIntro from "./include/_WebPublicChannelsIntro.mdx" +import CommunitiesDirectoryIntro from "./include/_CommunitiesDirectoryIntro.mdx" + +Zulip offers a comprehensive toolkit for moderating communities. + +## Prevention + +Zulip has many features designed to simplify moderation by preventing +problematic behavior. + +### Manage new users + +* Decide whether to [allow anyone to create an + account](/help/restrict-account-creation#set-whether-invitations-are-required-to-join), + or require invitations to join. +* Link to a code of conduct in your [organization + description](/help/create-your-organization-profile) (displayed on the + registration page) and [custom welcome + message](/help/configure-a-custom-welcome-message). +* [Disallow disposable email + addresses](/help/restrict-account-creation#dont-allow-disposable-domains) + or [limit authentication + methods](/help/configure-authentication-methods) to increase the + effort for a bad actor to replace a banned account. +* Add a [waiting period](/help/restrict-permissions-of-new-members) before + new users can take disruptive actions. +* Monitor new users by enabling [new user + announcements](/help/configure-automated-notices#new-user-announcements). + +### Restrict permissions for making changes + +* Restrict who can [create channels](/help/configure-who-can-create-channels), or + monitor new channels by enabling [new channel + announcements](/help/configure-automated-notices#new-channel-announcements). +* Restrict who can [add custom emoji](/help/custom-emoji#change-who-can-add-custom-emoji). +* Restrict who can [move messages to another + channel](/help/restrict-moving-messages#configure-who-can-move-messages-out-of-any-channel), + and set a [time + limit](/help/restrict-moving-messages#set-a-time-limit-for-editing-topics) for + editing topics. +* Restrict who can + [edit](/help/restrict-message-editing-and-deletion#configure-message-editing-permissions) + and + [delete](/help/restrict-message-editing-and-deletion#configure-message-deletion-permissions) + messages, and set time limits on message editing and deletion. +* If you are concerned about impersonation, you can [prevent users from changing + their name](/help/restrict-name-and-email-changes#restrict-name-changes), or + [require unique + names](/help/restrict-name-and-email-changes#require-unique-names). + +### Minimize spam + +* [Configure email visibility](/help/configure-email-visibility) + to prevent off-platform spam. +* [Restrict wildcard mentions](/help/restrict-wildcard-mentions) + so only [moderators](/help/user-roles) can mention everyone in your organization. +* Create a [default channel](/help/set-default-channels-for-new-users) + for announcements where [only admins can + post](/help/channel-posting-policy). +* Configure who can [authorize and start](/help/restrict-direct-messages) direct + message conversations. + +## Response + +The following features are an important part of an organization's +playbook when responding to abuse or spam that is not prevented by the +organization's policy choices. + +* Individual users can [mute abusive users](/help/mute-a-user) to stop + harassment that moderators have not yet addressed, or [collapse + individual messages](/help/collapse-a-message) that they don't want + to see. +* [Ban (deactivate) users](/help/deactivate-or-reactivate-a-user) acting in bad + faith. They will not be able to rejoin using the same email address, unless + their account is reactivated by an administrator. +* Investigate behavior by [viewing messages sent by a + user](/help/view-messages-sent-by-a-user). +* [Delete messages](/help/delete-a-message#delete-a-message-completely), + [archive channels](/help/archive-a-channel), and + [unsubscribe users from channels](/help/unsubscribe-users-from-a-channel). +* [Move topics](/help/rename-a-topic), including between channels, when + users start conversations in the wrong place. +* [Change users' names](/help/change-a-users-name) (e.g., to "Name (Spammer)") + for users who sent spam direct messages to many community members. +* [Deactivate bots](/help/deactivate-or-reactivate-a-bot) or + [deactivate custom emoji](/help/custom-emoji#deactivate-custom-emoji). + +## Public access option + + + +## Zulip communities directory + + + +For details on how to get your community listed, see [Communities +directory](/help/communities-directory). + +## Related articles + +* [Moving to Zulip](/help/moving-to-zulip) +* [Public access option](/help/public-access-option) +* [Communities directory](/help/communities-directory) diff --git a/starlight_help/src/content/docs/move-content-to-another-channel.mdx b/starlight_help/src/content/docs/move-content-to-another-channel.mdx new file mode 100644 index 0000000000..4a95b04ac2 --- /dev/null +++ b/starlight_help/src/content/docs/move-content-to-another-channel.mdx @@ -0,0 +1,96 @@ +--- +title: Move content to another channel +--- + +import TopicActions from "./include/_TopicActions.mdx" +import ZulipNote from '../../components/ZulipNote.astro'; +import MessageActionsMenu from "./include/_MessageActionsMenu.mdx" +import FlattenedSteps from '../../components/FlattenedSteps.astro'; + +Zulip makes it possible to move messages, or an entire topic, to another +channel. Organization administrators can +[configure](/help/restrict-moving-messages) who can move messages between +channels. + +To help others find moved content, you can have Notification Bot send +automated notices to the source topic, the destination topic, or both. +These notices include: + +* A link to the source or destination topic. +* How many messages were moved, or whether the whole topic was moved. +* Who moved the content. + +## Move a topic to another channel + + + + + 1. Select **Move topic**. If you do not see this option, you do not have permission + to move this topic. + 1. Select the destination channel for the topic from the channels dropdown list. + 1. *(optional)* Change the topic name. + 1. Toggle whether automated notices should be sent. + 1. Click **Confirm** to move the topic to another channel. + + + + **Note**: When a topic is moved to a private channel with protected history, + messages in the topic will be visible to all the subscribers. + + +## Move messages to another channel + + + + + 1. Select **Move messages**. If you do not see this option, you do not have permission + to move this message. + 1. Select the destination channel from the channels dropdown list. If + the channel input is disabled, you do not have permission to move + this message to a different channel. + 1. *(optional)* Change the topic name. + 1. From the dropdown menu, select which messages to move. + 1. Toggle whether automated notices should be sent. + 1. Click **Confirm** to move the selected content to another channel. + + + + **Note**: You cannot edit content of a message while changing its channel. + + +## Moving content to private channels + +Access to messages moved to another channel will immediately be controlled by the +access policies for the destination channel. Content moved to a private channel will +thus appear to be deleted to users who are not subscribers of the destination channel. + +Content moved to a [private channel with protected +history](/help/channel-permissions#private-channels) will only be accessible to +users who both: + +* Were subscribed to the *original* channel when the content was *sent*. +* Are subscribed to the *destination* channel when the content is *moved*. + +## Moving content out of private channels + +In [private channels with protected +history](/help/channel-permissions#private-channels), Zulip determines whether +to treat the entire topic as moved using the access permissions of the user +requesting the topic move. This means that the automated notices sent by +Notification Bot will report that the entire topic was moved if the requesting +user moved every message in the topic that they can access, regardless of +whether older messages exist that they cannot access. + +Similarly, [muted topics](/help/mute-a-topic) will be migrated to the +new channel and topic if the requesting user moved every message in the +topic that they can access. + +This model ensures that the topic editing feature cannot be abused to +determine any information about the existence of messages or topics +that one does not have permission to access. + +## Related articles + +* [Rename a topic](/help/rename-a-topic) +* [Move content to another topic](/help/move-content-to-another-topic) +* [Restrict moving messages](/help/restrict-moving-messages) diff --git a/starlight_help/src/content/docs/move-content-to-another-topic.mdx b/starlight_help/src/content/docs/move-content-to-another-topic.mdx new file mode 100644 index 0000000000..995f15b2bf --- /dev/null +++ b/starlight_help/src/content/docs/move-content-to-another-topic.mdx @@ -0,0 +1,44 @@ +--- +title: Move content to another topic +--- + +import { Tabs, TabItem } from '@astrojs/starlight/components' +import MessageActionsMenu from "./include/_MessageActionsMenu.mdx" +import FlattenedSteps from '../../components/FlattenedSteps.astro'; + +Zulip makes it possible to move messages between topics. This is +useful for keeping messages organized when there is a digression, or +the discussion shifts from the original topic. You can also [rename a +topic](/help/rename-a-topic). + +When messages are moved, Zulip's [permanent links to messages in +context](/help/link-to-a-message-or-conversation#get-a-link-to-a-specific-message) +will automatically redirect to the new location of the message. [Muted +topics](/help/mute-a-topic) are automatically migrated when an entire +topic is moved. + +Organization administrators can [configure](/help/restrict-moving-messages) who +is allowed to move messages. + +## Move messages to another topic + + + + + + + 1. Select **Move messages**. If you do not see this option, you do not have permission + to move this message. + 1. Set the destination topic. + 1. From the dropdown menu, select which messages to move. + 1. Toggle whether automated notices should be sent. + 1. Click **Confirm** to move the selected content to another topic. + + + + +## Related articles + +* [Rename a topic](/help/rename-a-topic) +* [Move content to another channel](/help/move-content-to-another-channel) +* [Restrict moving messages](/help/restrict-moving-messages) diff --git a/starlight_help/src/content/docs/move-to-zulip-cloud.mdx b/starlight_help/src/content/docs/move-to-zulip-cloud.mdx new file mode 100644 index 0000000000..f18007a7bb --- /dev/null +++ b/starlight_help/src/content/docs/move-to-zulip-cloud.mdx @@ -0,0 +1,127 @@ +--- +title: Move from self-hosting to Zulip Cloud +--- + +import { Steps } from '@astrojs/starlight/components'; +import ZulipNote from '../../components/ZulipNote.astro'; +import AdvantagesOfZulipCloud from "./include/_AdvantagesOfZulipCloud.mdx" +import ZulipTip from '../../components/ZulipTip.astro'; + +With Zulip's high quality import and export tools, you can always +move from self-hosting your own Zulip server to using the Zulip +Cloud service (and back). + +## Process overview + +To move your Zulip organization from a self-hosted server to Zulip +Cloud, you will need to take the following steps, which are described +in more detail below: + + + 1. [Plan the process and coordinate with Zulip support](#plan-the-process-and-coordinate-with-zulip-support). + 1. [Upgrade your self-hosted server](#upgrade-your-self-hosted-server). + 1. [Export organization data](#export-organization-data). + 1. [Decide how users will log in](#decide-how-users-will-log-in). + + +## Plan the process and coordinate with Zulip support + +To import your self-hosted organization into Zulip Cloud, your server will need +to have the same database format as Zulip Cloud. Zulip Cloud is updated every +couple of weeks, so it's important to coordinate the timing with Zulip's support +team. + + + 1. Review the process described on this page, and decide when you will be ready + to make the transition. + 1. Email [support@zulip.com](mailto:support@zulip.com) with the following information: + * URL of the organization you plan to migrate + * Your estimated timeline for generating a data export + * Any other timing considerations for the transition (e.g., time of day) + * If you're planning to purchase the [Zulip Cloud Plus + plan](https://zulip.com/plans), details on the Plus plan features (e.g., + authentication methods) you intend to use. These features will be + configured for your organization as part of the import process. + + +Zulip's support team will coordinate with you to make the transition with +minimal disruption for your team. + +## Upgrade your self-hosted server + +You will need to upgrade your server to use the same database format +as Zulip Cloud, using the published `zulip-cloud-current` branch. + + + 1. [Check](/help/view-zulip-version#view-zulip-server-and-web-app-version) your + Zulip server version. + 1. [Upgrade to the latest maintenance + release](https://zulip.readthedocs.io/en/stable/production/upgrade.html#upgrading-to-a-release) + if you are running an older version of the Zulip server. + 1. [Upgrade](https://zulip.readthedocs.io/en/stable/production/upgrade.html#upgrading-from-a-git-repository) + to the `zulip-cloud-current` branch. + + +For additional support with upgrading from an older version of Zulip, contact +[sales@zulip.com](mailto:sales@zulip.com) for paid support options. + +## Export organization data + + + 1. Make sure you [have a + plan](#plan-the-process-and-coordinate-with-zulip-support) for when the + import into Zulip Cloud will take place. + 1. Announce the migration and schedule Zulip downtime for your team. + 1. [Follow these instructions](https://zulip.readthedocs.io/en/stable/production/export-and-import.html#data-export) + to export your Zulip data. + 1. Send an email to [support@zulip.com](mailto:support@zulip.com) with: + * Your data export. + * The subdomain you would like to use for your organization. Your Zulip + Cloud organization will be hosted at `.zulipchat.com`. + + +Zulip's support team will let you know when the data import process is complete. + +## Decide how users will log in + +When user accounts are imported, users initially do not have passwords +configured. There are a few options for how users can log in for the first time. + + + For security reasons, passwords are never exported. + + +### Allow users to log in with non-password authentication + +Users will immediately be able to log in with [authentication +methods](/help/configure-authentication-methods) that do not require a password, +if these [authentication methods](/help/configure-authentication-methods) are +enabled. + +### Send password reset emails to all users + +You can ask [support@zulip.com](mailto:support@zulip.com) to send password reset +emails to all users in your organization, which will allow them to set an +initial password. + + + To avoid confusion, first make sure that the users in your + organization are aware that their account has been moved, + and are expecting to receive a password reset email. + + +### Manual password resets + +Alternatively, users can reset their own passwords by following the instructions +on your Zulip organization's login page. + +## Advantages of Zulip Cloud + + + +## Related articles + +* [Choosing between Zulip Cloud and self-hosting](/help/zulip-cloud-or-self-hosting) +* [Zulip Cloud billing](/help/zulip-cloud-billing) +* [Upgrade Zulip server](https://zulip.readthedocs.io/en/stable/production/upgrade.html) +* [Zulip data export tool](https://zulip.readthedocs.io/en/stable/production/export-and-import.html#data-export) diff --git a/starlight_help/src/content/docs/moving-to-zulip.mdx b/starlight_help/src/content/docs/moving-to-zulip.mdx new file mode 100644 index 0000000000..8d7031ce7b --- /dev/null +++ b/starlight_help/src/content/docs/moving-to-zulip.mdx @@ -0,0 +1,190 @@ +--- +title: Moving to Zulip +--- + +import { Steps } from '@astrojs/starlight/components'; +import { Tabs, TabItem } from '@astrojs/starlight/components' +import HowToInviteUsersToJoin from "./include/_HowToInviteUsersToJoin.mdx" + +Welcome to Zulip! This page will guide you through the process of transitioning +your organization to Zulip. It assumes that you have [completed your initial +evaluation](/help/trying-out-zulip) of Zulip, decided [whether to use Zulip +Cloud or self-host](/help/zulip-cloud-or-self-hosting), and are ready to +introduce Zulip to your organization. + +The following steps are described in more detail below: + + + 1. [Create your organization](#create-your-organization). + 1. [Sign up for a plan](#sign-up-for-a-plan). + 1. [Configure your organization](#configure-your-organization). + 1. [Prepare users for the transition](#prepare-users-for-the-transition). + 1. [Invite users to join](#invite-users-to-join). + 1. [Update your guidelines](#update-your-guidelines). + + +Each organization is unique, but we hope these common practices will help you +think through the transition process in your own context. + +## Create your organization + +You can create a new Zulip Cloud organization in less than two minutes. Setting +up a self-hosted server will take a bit longer, but is easy to do with Zulip's +[robust +installer](https://zulip.readthedocs.io/en/stable/production/install.html). + +Zulip has import tools for [Slack](/help/import-from-slack), +[Mattermost](/help/import-from-mattermost) and +[Rocket.Chat](/help/import-from-rocketchat). You can import your organization's +chat data, including message history, users, channels, and custom emoji. To +inquire about importing data from another product, [contact Zulip +support](/help/contact-support). + +Data is imported into Zulip as a new organization, so the best time to import is +when your team is about to start using Zulip for day-to-day work. This may be +part of your evaluation process, or after you've made the decision to move to +Zulip. + + + + + 1. If you plan to self-host, [set up your Zulip + server](https://zulip.readthedocs.io/en/stable/production/install.html). You + can self-host Zulip directly on Ubuntu or Debian Linux, in + [Docker](https://github.com/zulip/docker-zulip), or with prebuilt images for + [Digital Ocean](https://marketplace.digitalocean.com/apps/zulip) and + [Render](https://render.com/docs/deploy-zulip). + 1. Create a Zulip organization [on Zulip Cloud](https://zulip.com/new/) or [on + your self-hosted + server](https://zulip.readthedocs.io/en/stable/production/install.html#step-3-create-a-zulip-organization-and-log-in). + + + + + + 1. If you plan to self-host, [set up your Zulip + server](https://zulip.readthedocs.io/en/stable/production/install.html). You + can self-host Zulip directly on Ubuntu or Debian Linux, in + [Docker](https://github.com/zulip/docker-zulip), or with prebuilt images for + [Digital Ocean](https://marketplace.digitalocean.com/apps/zulip) and + [Render](https://render.com/docs/deploy-zulip). + 1. To import data, follow the steps in the detailed import guides: + * [Import from Slack](/help/import-from-slack) + * [Import from Mattermost](/help/import-from-mattermost) + * [Import from Rocket.Chat](/help/import-from-rocketchat) + + + + +## Sign up for a plan + +If you require features that are not available on [Zulip Cloud +Free](https://zulip.com/plans/#cloud) or the [Zulip +Free](https://zulip.com/plans/#self-hosted) plan for self-hosted organizations, +you will need to upgrade your plan. + + + + + 1. Follow the + [instructions](/help/zulip-cloud-billing#upgrade-to-a-zulip-cloud-standard-or-plus-plan) + to upgrade to a Zulip Cloud Standard or Plus plan. If your organization may + be + [eligible](/help/zulip-cloud-billing#free-and-discounted-zulip-cloud-standard) + for a free or discounted plan, you can [apply for + sponsorship](/help/zulip-cloud-billing#apply-for-sponsorship). + + + + + + 1. Follow the [instructions](/help/self-hosted-billing#upgrade-to-a-paid-plan) + to upgrade to a Zulip Basic or Zulip Business plan. If your organization may + be [eligible](/help/self-hosted-billing#free-community-plan) for a free or + discounted plan, you can [apply for + sponsorship](/help/self-hosted-billing#apply-for-community-plan). To inquire + about Zulip Enterprise, please reach out to + [sales@zulip.com](mailto:sales@zulip.com). + + + + +## Configure your organization + + + 1. [Create your organization profile](/help/create-your-organization-profile), + which is displayed on your organization's registration and login pages. + 1. [Create user groups](/help/create-user-groups), which offer a flexible way to + manage permissions. + 1. Review [organization permissions](/help/manage-permissions), such as who + can invite users, create channels, etc. + 1. If your organization uses an issue tracker (e.g., GitHub, Salesforce, + Zendesk, Jira, etc.), configure [linkifiers](/help/add-a-custom-linkifier) to + automatically turn issue numbers (e.g., #2468) into links. + 1. Set up [custom profile fields](/help/custom-profile-fields), which make it + easy for users to share information, such as their pronouns, job title, or + team. + 1. Review [default user settings](/help/configure-default-new-user-settings), + including language, [default visibility for email + addresses](/help/configure-email-visibility), and notification preferences. + 1. [Create channels](/help/create-channels), unless you've imported + channels from another app. Zulip's [topics](/help/introduction-to-topics) + give each conversation its own space, so one channel per team should be + enough to get you started. + 1. [Set up integrations](/help/set-up-integrations) so that your + team can experience all their regular workflows inside the Zulip app. Zulip's + [Slack-compatible incoming + webhook](https://zulip.com/integrations/doc/slack_incoming) makes it easy to + move your integrations when migrating an organization from Slack to Zulip. + + +## Prepare users for the transition + + + 1. Plan how you will introduce users to Zulip. You may want to: + * Share Zulip's [getting started guide](/help/getting-started-with-zulip). + * Prepare a live demo / training session. Consider recording it for + future use! + 1. Inform users about the transition, including why you're moving to Zulip, the + timeline, and what they'll need to do. + + +## Invite users to join + + + +## Update your guidelines + + + 1. Update any links and login instructions to point to your Zulip organization. + 1. Share basic instructions for getting started with Zulip. You can refer users + to Zulip's [help center](/help), [getting started + guide](/help/getting-started-with-zulip), and any onboarding content you've + created. + 1. Consider updating your organization's communication policies and best + practice recommendations to take advantage of Zulip's organized + conversations: + * Many organizations find that with Zulip, there’s no longer a reason to use + email for internal communications. You get the organization of an email + [inbox](/help/inbox) together with all the features of a modern chat app, + like instant delivery of messages, emoji reactions, typing notifications, + @-mentions, and more. + * Using Zulip, you can discuss complex topics and make decisions with input + from all stakeholders, without the overhead of scheduling meeting. Are + there standing meetings you might not need? + * With conversations organized by topic, you can review prior discussions to + understand past work, explanations, and decisions — your chat history + becomes a knowledge base. Should it be standard practice to link to Zulip + conversations from docs, issue trackers, etc. for additional context? + + +Congratulations on making the move! If you have any questions or feedback +throughout this process, please [reach out](/help/contact-support) to the Zulip +team. + +## Related articles + +* [Trying out Zulip](/help/trying-out-zulip) +* [Zulip Cloud or self-hosting?](/help/zulip-cloud-or-self-hosting) +* [Migrating from other chat tools](/help/migrating-from-other-chat-tools) +* [Getting started with Zulip](/help/getting-started-with-zulip) diff --git a/starlight_help/src/content/docs/mute-a-channel.mdx b/starlight_help/src/content/docs/mute-a-channel.mdx new file mode 100644 index 0000000000..5a5eaa6a51 --- /dev/null +++ b/starlight_help/src/content/docs/mute-a-channel.mdx @@ -0,0 +1,89 @@ +--- +title: Mute or unmute a channel +--- + +import ChannelActions from "./include/_ChannelActions.mdx" +import NavigationSteps from "../../components/NavigationSteps.astro" +import FlattenedSteps from '../../components/FlattenedSteps.astro'; +import MuteUnmuteIntro from "./include/_MuteUnmuteIntro.mdx" +import SelectChannelViewPersonal from "./include/_SelectChannelViewPersonal.mdx" +import { Tabs, TabItem } from '@astrojs/starlight/components' + + + +## Mute a channel + + + + + + + 1. Click **Mute channel**. + + + + + 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/347). If + you're interested in this feature, please react to the issue's + description with 👍. + + + +## Unmute a channel + + + + + + + 1. Click **Unmute channel**. + + + + + 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/347). If + you're interested in this feature, please react to the issue's + description with 👍. + + + +## Alternate method to mute or unmute a channel + + + + + + + 1. Select a channel. + + + + 1. Under **Notification settings**, toggle **Mute channel**. + + + + +## Managing muted channels + +Zulip works best when most of the messages you receive are not muted. If you +find yourself muting a lot of channels, consider +[unsubscribing](/help/unsubscribe-from-a-channel) from public channels you've +muted. You can always +[re-subscribe](/help/introduction-to-channels#browse-and-subscribe-to-channels) +if you need to, [view the channel +feed](/help/channel-feed#go-to-channel-feed-for-an-unsubscribed-channel) without +subscribing, or search for messages [in all public +channels](/help/search-for-messages#search-by-location). + +## Related articles + +* [Mute or unmute a topic](/help/mute-a-topic) +* [Mute a user](/help/mute-a-user) diff --git a/starlight_help/src/content/docs/mute-a-topic.mdx b/starlight_help/src/content/docs/mute-a-topic.mdx new file mode 100644 index 0000000000..626f42d109 --- /dev/null +++ b/starlight_help/src/content/docs/mute-a-topic.mdx @@ -0,0 +1,71 @@ +--- +title: Mute or unmute 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 MuteUnmuteIntro from "./include/_MuteUnmuteIntro.mdx" +import KeyboardTip from '../../components/KeyboardTip.astro'; +import AutomaticallyUnmuteTopicsInMutedChannels from "./include/_AutomaticallyUnmuteTopicsInMutedChannels.mdx" +import TopicLongPressMenuTip from "./include/_TopicLongPressMenuTip.mdx" +import { Tabs, TabItem } from '@astrojs/starlight/components' +import ManageConfiguredTopicsMobile from "./include/_ManageConfiguredTopicsMobile.mdx" + + + +## Mute or unmute a topic + + + + + + + + + + + + + 1. Tap **Mute topic** or **Unmute topic**. + + + + + + + + You can also use the Shift + M [keyboard + shortcut](/help/keyboard-shortcuts) to mute or unmute a topic. + + +## Automatically unmute topics in muted channels + + + +## Manage configured topics + + + + + + + + + + + + + Muted topics are grayed out in the topics list. + + + + +## Related articles + +* [Mute or unmute a channel](/help/mute-a-channel) +* [Follow a topic](/help/follow-a-topic) +* [Topic notifications](/help/topic-notifications) +* [Mute a user](/help/mute-a-user) diff --git a/starlight_help/src/content/docs/mute-a-user.mdx b/starlight_help/src/content/docs/mute-a-user.mdx new file mode 100644 index 0000000000..98e8730ffc --- /dev/null +++ b/starlight_help/src/content/docs/mute-a-user.mdx @@ -0,0 +1,87 @@ +--- +title: Mute a user +--- + +import NavigationSteps from "../../components/NavigationSteps.astro" +import ZulipTip from '../../components/ZulipTip.astro'; +import FlattenedSteps from '../../components/FlattenedSteps.astro'; +import MessageActionsMenu from "./include/_MessageActionsMenu.mdx" +import UserCardThreeDotMenu from "./include/_UserCardThreeDotMenu.mdx" + + + This feature mutes a user from your personal perspective, and does not + automatically notify anyone. + + +You can mute any user you do not wish to interact with. Muting someone will +have the following effects: + +* Combined feed sent by a muted user will automatically be [marked as + read](/help/marking-messages-as-read) for you, and will never + generate any desktop, email, or mobile push notifications. +* Combined feed sent by muted users, including the name, profile + picture, and message content, are hidden behind a **Click here to + reveal** banner. A revealed message can later be + [re-hidden](/help/mute-a-user#re-hide-a-message-that-has-been-revealed). +* Muted users are hidden from [**direct messages**](/help/direct-messages) + in the left sidebar and the list of users in the right sidebar. Direct + messages between you and a muted user are excluded from all views, + including search, unless you + [explicitly search](/help/search-for-messages) for `dm-with:`. +* Muted users have their name displayed as "Muted user" for [emoji + reactions][view-emoji-reactions], [polls](/help/create-a-poll), and + when displaying the recipients of group direct messages. +* Muted users are excluded from the autocomplete for composing a + direct message or [mentioning a user](/help/mention-a-user-or-group). +* Muted users are excluded from [read receipts](/help/read-receipts) + for all messages. Zulip never shares whether or not you have read + a message with a user you've muted. +* **Recent conversations** and other features that display avatars will + show a generic user symbol in place of a muted user's profile picture. +* To avoid interfering with administration tasks, channel and + organization settings display muted users' names and other details. + + + Muting someone does not affect their Zulip experience in any way. + + +[view-emoji-reactions]: /help/emoji-reactions#view-who-reacted-to-a-message + +## Mute a user + + + + + 1. Click **Mute this user**. + 1. On the confirmation popup, click **Confirm**. + + + + You can also click on a user's profile picture or name on a + message they sent to open their **user card**, and skip to + step 3. + + +## Re-hide a message that has been revealed + + + + + 1. Click **Hide muted message again**. + + +## See your list of muted users + + + + + +From there, you can also search for and **unmute** users. + +## Related articles + +* [Deactivate a user](/help/deactivate-or-reactivate-a-user) +* [Moderating open organizations](/help/moderating-open-organizations) +* [Mute or unmute a channel](/help/mute-a-channel) +* [Mute or unmute a topic](/help/mute-a-topic) diff --git a/starlight_help/src/content/docs/numbered-lists.mdx b/starlight_help/src/content/docs/numbered-lists.mdx new file mode 100644 index 0000000000..4b31ab64f6 --- /dev/null +++ b/starlight_help/src/content/docs/numbered-lists.mdx @@ -0,0 +1,59 @@ +--- +title: Numbered lists +--- + +import NumberedListsIntro from "./include/_NumberedListsIntro.mdx" +import ZulipTip from '../../components/ZulipTip.astro'; +import FlattenedSteps from '../../components/FlattenedSteps.astro'; +import NumberedListsExamples from "./include/_NumberedListsExamples.mdx" +import OrderedListIcon from "~icons/zulip-icon/ordered-list" +import StartComposing from "./include/_StartComposing.mdx" +import { Tabs, TabItem } from '@astrojs/starlight/components' + + + +## Create a numbered list + + + + + + + 1. *(optional)* Select the text you want to format. + 1. Click the **Numbered list** + () icon at the + bottom of the compose box to insert list formatting. + 1. Press Enter to automatically add a new number to the list. + 1. When your list is done, press Enter a second time to remove the + number. + + + + You can also use the **Numbered list** + () icon + to remove existing list formatting from the current line or selected text. + + + + + + + + 1. Type a number followed by a `.` and some text to start a numbered list. + 1. Press Enter to automatically add a new number to the list. + 1. When your list is done, press Enter a second time to remove the + number. + + + + +## Examples + + + +## 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) +* [Bulleted lists](/help/bulleted-lists) diff --git a/starlight_help/src/content/docs/open-the-compose-box.mdx b/starlight_help/src/content/docs/open-the-compose-box.mdx new file mode 100644 index 0000000000..df0bcd45c3 --- /dev/null +++ b/starlight_help/src/content/docs/open-the-compose-box.mdx @@ -0,0 +1,43 @@ +--- +title: Open the compose box +--- + +import ZulipTip from '../../components/ZulipTip.astro'; + +The Zulip compose box starts off closed by default, leaving more vertical +space for the message feed. There are a number of ways to open the compose box. + +## Using the mouse + +* Click on any message. +* Click on **Start new conversation**, or **New direct message** at the + bottom of the app. + +## Using the keyboard + +All replies are to the message in the **blue box**. + +* **Reply**: R or Enter +* **New topic**: C +* **New direct message**: X + +You can move the blue box around using the **arrow keys**, J, or +K. You can close the compose box using Esc, or up/down +arrow if the box is empty. + + + Zulip offers handy one-character + [keyboard shortcuts](/help/keyboard-shortcuts) for + [reading messages](/help/reading-strategies). With the compose + box closed, there is no need to use the Ctrl key all the time. + + +## Related articles + +* [Getting started with Zulip](/help/getting-started-with-zulip) +* [Introduction to topics](/help/introduction-to-topics) +* [Starting a new direct message](/help/starting-a-new-direct-message) +* [Replying to messages](/help/replying-to-messages) +* [Messaging tips & tricks](/help/messaging-tips) +* [Keyboard shortcuts](/help/keyboard-shortcuts) +* [Resize the compose box](/help/resize-the-compose-box) diff --git a/starlight_help/src/content/docs/organization-type.mdx b/starlight_help/src/content/docs/organization-type.mdx new file mode 100644 index 0000000000..d2ecb3b512 --- /dev/null +++ b/starlight_help/src/content/docs/organization-type.mdx @@ -0,0 +1,30 @@ +--- +title: Organization type +--- + +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 **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. + +## Set organization type + + + + + + + 1. Under **Organization type**, select the option that best fits + your organization. + + + + +## Related articles + +* [Configure default new user settings](/help/configure-default-new-user-settings) +* [Communities directory](/help/communities-directory) diff --git a/starlight_help/src/content/docs/paragraph-and-section-formatting.mdx b/starlight_help/src/content/docs/paragraph-and-section-formatting.mdx new file mode 100644 index 0000000000..576f187b32 --- /dev/null +++ b/starlight_help/src/content/docs/paragraph-and-section-formatting.mdx @@ -0,0 +1,18 @@ +--- +title: Paragraph and section formatting +--- + +import ParagraphsAndSectionsIntro from "./include/_ParagraphsAndSectionsIntro.mdx" +import ParagraphsAndSectionsExamples from "./include/_ParagraphsAndSectionsExamples.mdx" + + + +## Examples + + + +## 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) diff --git a/starlight_help/src/content/docs/pin-a-channel.mdx b/starlight_help/src/content/docs/pin-a-channel.mdx new file mode 100644 index 0000000000..cf849c9896 --- /dev/null +++ b/starlight_help/src/content/docs/pin-a-channel.mdx @@ -0,0 +1,88 @@ +--- +title: Pin 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' + +You can [pin channels](/help/pin-a-channel) that you want to pay close attention +to. Pinned channels appear in a dedicated **pinned channels** section above +[channel folders](/help/channel-folders) in the [left +sidebar](/help/left-sidebar) and the [**Inbox**](/help/inbox) view. + +## Pin a channel + + + + + + + 1. Click **Pin channel to top**. + + + + + + + + 1. Select a channel. + + + + 1. Under **Personal settings**, toggle **Pin channel to top of left sidebar**. + + + + + 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 👍. + + + +## Unpin a channel + + + + + + + 1. Click **Unpin channel from top**. + + + + + + + + 1. Select a channel. + + + + 1. Under **Personal settings**, toggle **Pin channel to top of left sidebar**. + + + + + 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 👍. + + + +## Related articles + +* [Introduction to channels](/help/introduction-to-channels) +* [Mute or unmute a channel](/help/mute-a-channel) +* [Channel folders](/help/channel-folders) diff --git a/starlight_help/src/content/docs/pin-information.mdx b/starlight_help/src/content/docs/pin-information.mdx new file mode 100644 index 0000000000..64c746f8a4 --- /dev/null +++ b/starlight_help/src/content/docs/pin-information.mdx @@ -0,0 +1,65 @@ +--- +title: Pin information +--- + +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 SaveChanges from "./include/_SaveChanges.mdx" +import ChannelSettingsGeneralTabTip from "./include/_ChannelSettingsGeneralTabTip.mdx" +import SelectChannelViewGeneral from "./include/_SelectChannelViewGeneral.mdx" +import { Tabs, TabItem } from '@astrojs/starlight/components' + +You can use [channel +descriptions](/help/view-channel-information#view-channel-description) to pin +reference information, such as: + +* Related channels +* Important topics or messages +* Documentation and other external references + +Channel descriptions 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. + +You can also pin messages for yourself by [starring](/help/star-a-message) them. + +## Pin information in a channel description + + + + + + + 1. Select a channel. + + + + 1. Click the **edit channel name and description** + () icon to the right of the + channel name to edit the description. + 1. Add any number of links, which you can separate with `|` or another symbol. + * Channel links: `#**channel name**` + * Topic links: `#**channel name>topic name**` + * Message links: `#**channel name>topic name@message ID**` + * External references: `[link text](URL)` + + + + + + + + If you aren't sure how to format a link, copy it from the compose box. + [Learn more about linking to content in + Zulip.](/help/link-to-a-message-or-conversation) + + + + +## Related articles + +* [Link to a channel, topic, or message](/help/link-to-a-message-or-conversation) +* [Change a channel's description](/help/change-the-channel-description) +* [Starred messages](/help/star-a-message) diff --git a/starlight_help/src/content/docs/preview-your-message-before-sending.mdx b/starlight_help/src/content/docs/preview-your-message-before-sending.mdx new file mode 100644 index 0000000000..67ec4534e1 --- /dev/null +++ b/starlight_help/src/content/docs/preview-your-message-before-sending.mdx @@ -0,0 +1,34 @@ +--- +title: Preview your message before sending +--- + +import EditIcon from "~icons/zulip-icon/edit" +import PreviewIcon from "~icons/zulip-icon/preview" +import FlattenedSteps from '../../components/FlattenedSteps.astro'; +import KeyboardTip from '../../components/KeyboardTip.astro'; +import StartComposing from "./include/_StartComposing.mdx" +import { Tabs, TabItem } from '@astrojs/starlight/components' + + + + + + + 1. Write a message. + 1. Click the **preview mode** () + icon at the bottom of the compose box. + 1. *(optional)* Click the **exit preview mode** () icon to edit your message. + + + + You can also use Alt + P to toggle between previewing + and editing your message. + + + + +## Related articles + +* [Message formatting](/help/format-your-message-using-markdown) +* [Resize the compose box](/help/resize-the-compose-box) +* [Mastering the compose box](/help/mastering-the-compose-box) diff --git a/starlight_help/src/content/docs/printing-messages.mdx b/starlight_help/src/content/docs/printing-messages.mdx new file mode 100644 index 0000000000..b79d919af5 --- /dev/null +++ b/starlight_help/src/content/docs/printing-messages.mdx @@ -0,0 +1,38 @@ +--- +title: Printing messages +--- + +import { Steps } from '@astrojs/starlight/components'; +import { Tabs, TabItem } from '@astrojs/starlight/components' +import ZulipTip from '../../components/ZulipTip.astro'; + +Zulip lets you print the messages in any view, including +[conversations](/help/reading-conversations) and +[searches](/help/search-for-messages). + +Printouts include just the content you need, without sidebars and buttons. +Messages will be printed with black text on a white background, regardless of +whether you're using [light or dark theme](/help/dark-theme). + + + + + 1. Navigate to any message view. + 1. Scroll up through message history until you can see the oldest message that + you wish to print. + 1. Use your browser's print feature (e.g., **File** > **Print**) to preview + and print your messages. + + + + If the print preview includes more messages than you need, select which + pages you want from the printing menu. + + + + +## Related articles + +* [Reading conversations](/help/reading-conversations) +* [Dark theme](/help/dark-theme) +* [Supported browsers](/help/supported-browsers) diff --git a/starlight_help/src/content/docs/public-access-option.mdx b/starlight_help/src/content/docs/public-access-option.mdx new file mode 100644 index 0000000000..3720d2ab39 --- /dev/null +++ b/starlight_help/src/content/docs/public-access-option.mdx @@ -0,0 +1,180 @@ +--- +title: Public access option +--- + +import NavigationSteps from "../../components/NavigationSteps.astro" +import WebPublicChannelsIntro from "./include/_WebPublicChannelsIntro.mdx" +import ZulipNote from '../../components/ZulipNote.astro'; +import ZulipTip from '../../components/ZulipTip.astro'; +import FlattenedSteps from '../../components/FlattenedSteps.astro'; + + + +## Enabling web-public channels in your organization + +Enabling web-public channels makes it possible to create web-public +channels in your organization. It also makes certain information about +your organization accessible to anyone on the Internet via the Zulip +API (details below). + +To help protect closed organizations, creating web-public channels is +disabled by default for all organizations. + +### Information that can be accessed via API when web-public channels are enabled + +The following information about your organization can be accessed via the Zulip +API if web-public channels are enabled and there is currently at least one +web-public channel. + +* The organization's settings (linkifiers, custom emoji, permissions + settings, etc.) +* Names of users +* Names of user groups and their membership +* Names and descriptions of channels + +Enabling web-public channels is thus primarily recommended for open +communities such as open-source projects and research communities. + +### Enable or disable web-public channels + + + Self-hosted Zulip servers must enable support for web-public channels in their + [server settings](https://zulip.readthedocs.io/en/stable/production/settings.html) + by setting `WEB_PUBLIC_STREAMS_ENABLED = True` prior to proceeding. + + + + + + 1. Under **Channel permissions**, toggle the checkbox labeled **Allow + creating web-public channels (visible to anyone on the Internet)**. + + +### Manage who can create web-public channels + + + + + 1. Under **Channel permissions**, make sure the checkbox labeled **Allow + creating web-public channels (visible to anyone on the Internet)** is + checked. + 1. Under **Who can create web-public channels?**, select the option you prefer. + + + + See [Managing abuse](#managing-abuse) to learn why only + trusted roles like moderators and administrators can create web-public channels. + + +## Creating a web-public channel + +To create a new web-public channel, follow the [instructions for creating a +channel](/help/create-a-channel), selecting the **Web-public** option for **Who +can access this channel**. + +To make an existing channel web-public, follow the instructions to +[change the privacy of a +channel](/help/change-the-privacy-of-a-channel), selecting the +**Web-public** option for **Who can access this channel**. + +## What can logged out visitors do? + +Logged out visitors can browse all content in web-public channels, +including using Zulip's [built-in search](/help/search-for-messages) +to find conversations. Logged out visitors can only access +the web-public channels in your organization, and the topics, messages +(including uploaded files) and emoji reactions in those channels. + +They **cannot**: + +* View channels that are not configured as web-public channels (or see + whether any such channels exist) without creating an account. +* Send messages. +* React with emoji. +* Participate in polls, or do anything else that might be visible to + other users. + +Logged out visitors have access to a subset of the metadata +information available to any new account in the Zulip organization, +detailed below. + +### Information about the organization + +* The **Organization settings** and **Channel settings** menus are not + available to logged out visitors. However, organization settings data is + required for Zulip to load, and may thus be [accessed via the Zulip API][info-via-api]. +* Logged out visitors cannot view [usage statistics](/help/analytics). + +[info-via-api]: /help/public-access-option#information-that-can-be-accessed-via-api-when-web-public-channels-are-enabled + +### Information about users + +Logged out visitors can see the following information about users who +participate in web-public channels. They do not see this information +about users who do not participate in web-public channels in the Zulip +UI, though they may access it via the Zulip API. + +* Name +* Avatar +* Role (e.g., Administrator) +* Join date + +The following additional information is not available in the UI for +logged out visitors, but may be accessed without an account via the +Zulip API: + +* Configured time zone +* Which user groups a user belongs to + +The following information is available to all users with an account, +but not to logged out visitors: + +* Presence information, i.e. whether the user is currently online, + [their status](/help/status-and-availability), + and whether they have set themselves as unavailable. +* Detailed profile information, such as [custom profile + fields](/help/custom-profile-fields). +* Which users are subscribed to which web-public channels. + +## Managing abuse + +The unfortunate reality is that any service +that allows hosting files visible to the Internet is a potential target for bad +actors looking for places to distribute illegal or malicious content. + +In order to protect Zulip organizations from +bad actors, web-public channels have a few limitations designed to make +Zulip an inconvenient target: + +* Only users in trusted roles (moderators and administrators) can be given + permission to create web-public channels. This is intended to make it hard + for an attacker to host malicious content in an unadvertised web-public + channel in a legitimate organization. +* There are rate limits for unauthenticated access to uploaded + files, including viewing avatars and custom emoji. + +Our aim is to tune anti-abuse protections so that they don't +interfere with legitimate use. Please [contact us](/help/contact-support) +if your organization encounters any problems with legitimate activity caused +these anti-abuse features. + +As a reminder, Zulip Cloud organizations are expected to +[moderate content](/help/moderating-open-organizations) to ensure compliance +with [Zulip's Rules of Use](https://zulip.com/policies/rules). + +## Caveats + +* Web-public channels do not yet support search engine indexing. You + can use [zulip-archive](https://github.com/zulip/zulip-archive) to + create an archive of a Zulip organization that can be indexed by + search engines. +* The web-public view is not yet integrated with Zulip's live-update + system. As a result, a visitor will not see new messages that are + sent to a topic they are currently viewing without reloading the + browser window. + +## Related articles + +* [Moderating open organizations](/help/moderating-open-organizations) +* [Channel permissions](/help/channel-permissions) +* [Restrict channel creation](/help/configure-who-can-create-channels) diff --git a/starlight_help/src/content/docs/quote-or-forward-a-message.mdx b/starlight_help/src/content/docs/quote-or-forward-a-message.mdx new file mode 100644 index 0000000000..78f7404c2a --- /dev/null +++ b/starlight_help/src/content/docs/quote-or-forward-a-message.mdx @@ -0,0 +1,98 @@ +--- +title: Quote or forward a message +--- + +import ZulipTip from '../../components/ZulipTip.astro'; +import FlattenedSteps from '../../components/FlattenedSteps.astro'; +import MessageLongPressMenu from "./include/_MessageLongPressMenu.mdx" +import KeyboardTip from '../../components/KeyboardTip.astro'; +import MessageActionsMenu from "./include/_MessageActionsMenu.mdx" +import { Tabs, TabItem } from '@astrojs/starlight/components' + +Conversations in Zulip are [organized by topic](/help/introduction-to-topics), +so it's generally clear what you're responding to when you send a message. +However, when responding to an older message, you may want to +[quote](#quote-a-message) all or part of it for reference. + +You can also [forward](#forward-a-message) a message to another conversation. + +The first line of a quoted or forwarded message contains a [permanent +link][link-to-message] to the original message. Zulip automatically turns +mentions in the quoted text into [silent +mentions](/help/mention-a-user-or-group#silently-mention-a-user) to avoid +unnecessarily mentioning someone twice. + + + You can use [quote blocks](/help/format-a-quote) + when quoting emails or other non-Zulip content. + + +## Quote a message + + + + + 1. *(optional)* To quote only part of a message, select the part that you want + to quote. + + + + 1. Click **Quote message**. + 1. Send your message. + + + + You can also use > to quote to the + selected message. + + + + + + + + 1. Tap **Quote message**. + 1. *(optional)* Delete any parts of the quoted message that are not + relevant to your reply. + 1. Send your message. + + + + If you are in a channel view, you can set a different destination + topic by tapping the compose box and selecting an existing topic + or typing a new topic name. + + + + +## Forward a message + + + + + 1. *(optional)* To forward only part of a message, select the part that you want + to forward. + + + + 1. Click **Forward message**. + 1. Select the desired destination channel or **Direct message** from the dropdown + in the top left of the compose box. + 1. Enter a topic name, or recipient names for a direct message. + 1. Send your message. + + + + You can also use \< to forward the selected message. + + + + +## Related articles + +* [Replying to messages](/help/replying-to-messages) +* [Format a quote](/help/format-a-quote) +* [Link to a message or conversation][link-to-message] +* [Mention a user or group](/help/mention-a-user-or-group) + +[link-to-message]: /help/link-to-a-message-or-conversation diff --git a/starlight_help/src/content/docs/read-receipts.mdx b/starlight_help/src/content/docs/read-receipts.mdx new file mode 100644 index 0000000000..c1e0b5ac1b --- /dev/null +++ b/starlight_help/src/content/docs/read-receipts.mdx @@ -0,0 +1,110 @@ +--- +title: Read receipts +--- + +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 MessageLongPressMenu from "./include/_MessageLongPressMenu.mdx" +import KeyboardTip from '../../components/KeyboardTip.astro'; +import MessageActionsMenu from "./include/_MessageActionsMenu.mdx" +import { Tabs, TabItem } from '@astrojs/starlight/components' +import AdminOnly from "./include/_AdminOnly.mdx" + +Read receipts let you check who has read a message. You can see read receipts +for any message, including both [channel messages](/help/introduction-to-channels) +and [direct messages](/help/direct-messages). + +With privacy in mind, Zulip lets you [control][configure-personal-read-receipts] +whether your read receipts are shared, and administrators can +[choose][configure-organization-read-receipts] whether to enable read receipts in +their organization. + + + Read receipts reflect whether or not someone has marked a message as read, + whether by viewing it, or [by marking messages as read in + bulk](/help/marking-messages-as-read). + + +## View who has read a message + + + + + + + 1. Click **View read receipts**. + + + + You can also use Shift + V to show or hide read receipts + for the selected message. + + + + + + + + 1. Tap **View read receipts**. + + + + + + In addition to a list of names, you will see how many people have read + the message. + + +## Configure whether Zulip lets others see when you've read messages + +Zulip supports the privacy option of never sharing whether or not you have read +a message. If this setting is turned off, your name will never appear in the +list of read receipts. + + + + + 1. Under **Privacy**, toggle **Let others see when I've read messages**. + + +## Configure read receipts for your organization + + + +You can configure: + +* Whether read receipts are enabled in your organization. +* Whether new users will allow others to view read receipts by default. (Note + that users [can always change this setting][configure-personal-read-receipts] + once they join.) + +### Configure whether read receipts are enabled in your organization + + + + + 1. Under **Message feed settings**, toggle **Enable read receipts**. + + + + +### Configure default read receipt sharing settings for new users + + + + + 1. Under **Privacy settings**, toggle **Allow other users to view read receipts**. + + +## Related articles + +* [Status and availability](/help/status-and-availability) +* [Typing notifications](/help/typing-notifications) +* [Marking messages as read](/help/marking-messages-as-read) +* [Marking messages as unread](/help/marking-messages-as-unread) + +[configure-personal-read-receipts]: /help/read-receipts#configure-whether-zulip-lets-others-see-when-youve-read-messages + +[configure-organization-read-receipts]: /help/read-receipts#configure-whether-read-receipts-are-enabled-in-your-organization diff --git a/starlight_help/src/content/docs/reading-conversations.mdx b/starlight_help/src/content/docs/reading-conversations.mdx new file mode 100644 index 0000000000..fc45b19a83 --- /dev/null +++ b/starlight_help/src/content/docs/reading-conversations.mdx @@ -0,0 +1,13 @@ +--- +title: Reading conversations +--- + +import ReadingConversations from "./include/_ReadingConversations.mdx" + + + +## Related articles + +* [Getting started with Zulip](/help/getting-started-with-zulip) +* [Finding a conversation to read](/help/finding-a-conversation-to-read) +* [Reading strategies](/help/reading-strategies) diff --git a/starlight_help/src/content/docs/reading-strategies.mdx b/starlight_help/src/content/docs/reading-strategies.mdx new file mode 100644 index 0000000000..7ab36581c1 --- /dev/null +++ b/starlight_help/src/content/docs/reading-strategies.mdx @@ -0,0 +1,99 @@ +--- +title: Reading strategies +--- + +import FollowedTopicWorkflows from "./include/_FollowedTopicWorkflows.mdx" +import DmFeedInstructions from "./include/_DmFeedInstructions.mdx" +import { Steps } from '@astrojs/starlight/components'; +import ViewMentions from "./include/_ViewMentions.mdx" +import CombinedFeed from "./include/_CombinedFeed.mdx" +import { Tabs, TabItem } from '@astrojs/starlight/components' +import ViewStarredMessages from "./include/_ViewStarredMessages.mdx" +import ReadingConversations from "./include/_ReadingConversations.mdx" +import ViewEmojiReactions from "./include/_ViewEmojiReactions.mdx" + +In Zulip, channels determine who gets a message. Topics tell you what +the message is about. If you are not yet familiar with Zulip's topics, +we recommend first reading about [channels](introduction-to-channels) and +[topics](/help/introduction-to-topics). + +This article describes a few ways to efficiently read through messages +in Zulip. + +## Conversation by conversation + + + +### Following, muting and unmuting conversations + +You can improve your workflow for catching up on messages by taking advantage of +[following topics](/help/follow-a-topic), as well as muting and unmuting +[channels](/help/mute-a-channel) and [topics](/help/mute-a-topic). Some example +workflows: + + + +## Combined views + +### Combined feed + + + +### Direct message feed + +You can see all your direct messages in one place. + + + +### Channel view + +Sometimes it's useful to scroll through all the messages in a channel, +especially in situations where you just want a general idea of what's going +on. + + + + + 1. Find the channel you want to read in the left sidebar. If you don't see it + right away, you can search for a channel by clicking on **channels** in the + left sidebar, or using the Q [keyboard + shortcut](/help/keyboard-shortcuts). + 1. Click on the channel name in the left sidebar. + 1. Read messages in the channel, starting from your first unread message. You can + scroll using your mouse, the arrow keys, End, or page up/down. + 1. You can click on a topic in the left sidebar or a message recipient bar to + view that topic. + + + + +## Special views + +### Mentions + +The mentions view lets you quickly find all the places where you were +[mentioned](/help/mention-a-user-or-group). Reviewing your mentions can be a +good way to start your day. + + + +### Starred messages + +You can [star messages](/help/star-a-message) that you plan to follow up on later. + +#### View starred messages + + + +### Reactions + + + +## Related articles + +* [Getting started with Zulip](/help/getting-started-with-zulip) +* [Inbox](/help/inbox) +* [Recent conversations](/help/recent-conversations) +* [Searching for messages](/help/search-for-messages) +* [Marking messages as read](/help/marking-messages-as-read) +* [Marking messages as unread](/help/marking-messages-as-unread) diff --git a/starlight_help/src/content/docs/recent-conversations.mdx b/starlight_help/src/content/docs/recent-conversations.mdx new file mode 100644 index 0000000000..c072a23f80 --- /dev/null +++ b/starlight_help/src/content/docs/recent-conversations.mdx @@ -0,0 +1,52 @@ +--- +title: Recent conversations +--- + +import RecentConversations from "./include/_RecentConversations.mdx" +import FlattenedSteps from '../../components/FlattenedSteps.astro'; +import ConversationDefinition from "./include/_ConversationDefinition.mdx" +import KeyboardTip from '../../components/KeyboardTip.astro'; +import GoToRecentConversations from "./include/_GoToRecentConversations.mdx" +import ZulipTip from '../../components/ZulipTip.astro'; +import { Tabs, TabItem } from '@astrojs/starlight/components' + + + + + + + The arrow keys and vim navigation keys (J, K, + L, H) can be used to move between elements. + + +## Load more conversations + +The **recent conversations** view displays a limited number of conversations +containing the most recent messages. + + + Use the [search bar](/help/search-for-messages) at the top of the web app + to search through all conversations, not just recent ones. + + + + + + + + 1. Scroll to the bottom of the list of conversations, or bring the bottom into + view by filtering for a non-existent keyword. + 1. Click the **Load more** button in the banner at the bottom. + + + + +## Related articles + +* [Finding a conversation to read](/help/finding-a-conversation-to-read) +* [Reading conversations](/help/reading-conversations) +* [Reading strategies](/help/reading-strategies) +* [Inbox](/help/inbox) +* [List of topics in a channel](/help/list-of-topics) +* [Combined feed](/help/combined-feed) +* [Configure home view](/help/configure-home-view) diff --git a/starlight_help/src/content/docs/rename-a-channel.mdx b/starlight_help/src/content/docs/rename-a-channel.mdx new file mode 100644 index 0000000000..b7117838bf --- /dev/null +++ b/starlight_help/src/content/docs/rename-a-channel.mdx @@ -0,0 +1,53 @@ +--- +title: Rename a channel +--- + +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' + +A channel's name can be in any language, and can include spaces, punctuation, +and Unicode emoji. + + + + + + + 1. Select a channel. + + + + 1. Click the **edit channel name and description** + () icon to the right of the + channel name, and enter a new channel name. + + + + + + + + + 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 👍. + + + + + +## Related articles + +* [View channel information](/help/view-channel-information) +* [Change a channel's description](/help/change-the-channel-description) +* [Channel permissions](/help/channel-permissions) diff --git a/starlight_help/src/content/docs/rename-a-topic.mdx b/starlight_help/src/content/docs/rename-a-topic.mdx new file mode 100644 index 0000000000..759ced0879 --- /dev/null +++ b/starlight_help/src/content/docs/rename-a-topic.mdx @@ -0,0 +1,72 @@ +--- +title: Rename a topic +--- + +import FlattenedSteps from '../../components/FlattenedSteps.astro'; +import PencilIcon from "~icons/zulip-icon/pencil" +import { Steps } from '@astrojs/starlight/components'; +import CheckIcon from "~icons/zulip-icon/check" +import { Tabs, TabItem } from '@astrojs/starlight/components' +import TopicActions from "./include/_TopicActions.mdx" + +Zulip makes it possible to rename topics. This is useful for keeping messages +organized, even if some users are still learning how to use topics effectively. +You can also [move content to another +topic](/help/move-content-to-another-topic). + +When a topic is renamed, links [to the +topic](/help/link-to-a-message-or-conversation#get-a-link-to-a-specific-topic) +and [to messages in that +topic](/help/link-to-a-message-or-conversation#get-a-link-to-a-specific-message) +will automatically redirect to the new location of the message. [Muted +topics](/help/mute-a-topic) are automatically migrated when a topic is renamed. + +Organization administrators can [configure](/help/restrict-moving-messages) who +is allowed to rename topics. + +## Rename a topic + + + + + 1. Click the **edit topic** () icon in + the message recipient bar. If you do not see the + **edit topic** () icon, you do not + have permission to rename this topic. + 1. Edit the topic name. + 1. Click the **save** () icon + to save your changes. + + + + + + + + 1. Select **Move topic** or **Rename topic**. If you do not see either option, + you do not have permission to rename this topic. + 1. Edit the topic name. + 1. *(optional)* If using the **Move topic** menu, select the destination channel + for the topic from the channels dropdown list. + 1. Toggle whether automated notices should be sent. + 1. Click **Confirm** to rename the topic. + + + + + 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/1439). If + you're interested in this feature, please react to the issue's + description with 👍. + + + +## Related articles + +* [Move content to another topic](/help/move-content-to-another-topic) +* [Move content to another channel](/help/move-content-to-another-channel) +* [Resolve a topic](/help/resolve-a-topic) +* [Restrict moving messages](/help/restrict-moving-messages) diff --git a/starlight_help/src/content/docs/replying-to-messages.mdx b/starlight_help/src/content/docs/replying-to-messages.mdx new file mode 100644 index 0000000000..5430779261 --- /dev/null +++ b/starlight_help/src/content/docs/replying-to-messages.mdx @@ -0,0 +1,20 @@ +--- +title: Replying to messages +--- + +import HowToReplyIntro from "./include/_HowToReplyIntro.mdx" +import ReplyingToMessages from "./include/_ReplyingToMessages.mdx" + + + +## Reply to messages in a conversation + + + +## Related articles + +* [Getting started with Zulip](/help/getting-started-with-zulip) +* [Introduction to topics](/help/introduction-to-topics) +* [Starting a new direct message](/help/starting-a-new-direct-message) +* [Quote or forward a message](/help/quote-or-forward-a-message) +* [Messaging tips & tricks](/help/messaging-tips) diff --git a/starlight_help/src/content/docs/request-an-integration.mdx b/starlight_help/src/content/docs/request-an-integration.mdx new file mode 100644 index 0000000000..165fdc6776 --- /dev/null +++ b/starlight_help/src/content/docs/request-an-integration.mdx @@ -0,0 +1,25 @@ +--- +title: Request an integration +--- + +Zulip comes with over 100 native integrations. Hundreds more are +available through +[Zapier](https://zapier.com/home), [IFTTT](https://ifttt.com/), and +the [Slack compatible webhook](/integrations/doc/slack_incoming). + +However, sometimes there is no integration for a tool you use, or an +existing integration doesn't do what you need. If that's the case for +a third-party product you use, we'd love to [hear about +it](/help/contact-support)! + +Or if you're familiar with GitHub, you can [browse open integrations +issues][integrations-issues], and if none exists, [open a new +issue](https://github.com/zulip/zulip/issues/new). + +[integrations-issues]: https://github.com/zulip/zulip/issues?q=is%3Aopen+label%3A%22area%3A+integrations%22+is%3Aissue + +## Related articles + +* [Integrations overview](/help/integrations-overview) +* [Bots overview](/help/bots-overview) +* [Add a bot or integration](/help/add-a-bot-or-integration) diff --git a/starlight_help/src/content/docs/require-topics.mdx b/starlight_help/src/content/docs/require-topics.mdx new file mode 100644 index 0000000000..0ae7d18351 --- /dev/null +++ b/starlight_help/src/content/docs/require-topics.mdx @@ -0,0 +1,59 @@ +--- +title: Configure whether topics are required in channel messages +--- + +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 GeneralChatIntro from "./include/_GeneralChatIntro.mdx" +import { Tabs, TabItem } from '@astrojs/starlight/components' +import AdminOnly from "./include/_AdminOnly.mdx" + + + +Administrators can configure the default for whether topics are required in +channel messages (i.e., whether it's possible to send messages to the “*general +chat*” topic). + +The default configuration can be overridden for any channel. You can also +configure channels to [allow only the “*general chat*” +topic](/help/general-chat-channels). + +## Set the default *general chat* topic configuration + + + + + + + 1. Under **Compose settings**, select the desired option from the **Default + *general chat* topic configuration for channels** dropdown. + + + + +## Configure permission to post to “*general chat*” in a specific channel + + + + + + + 1. Select a channel. + + + + 1. Under **Messaging permissions**, choose the desired option from the **Allow + posting to the *general chat* topic?** dropdown. + + + + + + +## Related articles + +* [Introduction to topics](/help/introduction-to-topics) +* [“*General chat*” topic](/help/general-chat-topic) +* [“*General chat*” channels](/help/general-chat-channels) diff --git a/starlight_help/src/content/docs/resize-the-compose-box.mdx b/starlight_help/src/content/docs/resize-the-compose-box.mdx new file mode 100644 index 0000000000..72149fc6a4 --- /dev/null +++ b/starlight_help/src/content/docs/resize-the-compose-box.mdx @@ -0,0 +1,32 @@ +--- +title: Resize the compose box +--- + +import ExpandDiagonalIcon from "~icons/zulip-icon/expand-diagonal" +import ZulipTip from '../../components/ZulipTip.astro'; +import FlattenedSteps from '../../components/FlattenedSteps.astro'; +import MaximizeDiagonalIcon from "~icons/zulip-icon/maximize-diagonal" +import StartComposing from "./include/_StartComposing.mdx" +import CollapseDiagonalIcon from "~icons/zulip-icon/collapse-diagonal" + +When composing a long message, it can be helpful to expand the compose +box to display more text and avoid distractions. Note that the compose +box also stretches automatically when you type a long message. + + + + + 1. Move your mouse to the compose box area. + 1. Click the , , or button in the top right corner of the text + box. + + + + Which button you see depends on the current size of the compose box. + + +## Related articles + +* [Open the compose box](/help/open-the-compose-box) +* [Preview messages before sending](/help/preview-your-message-before-sending) +* [Mastering the compose box](/help/mastering-the-compose-box) diff --git a/starlight_help/src/content/docs/resolve-a-topic.mdx b/starlight_help/src/content/docs/resolve-a-topic.mdx new file mode 100644 index 0000000000..1c507523a8 --- /dev/null +++ b/starlight_help/src/content/docs/resolve-a-topic.mdx @@ -0,0 +1,188 @@ +--- +title: Resolve a topic +--- + +import TopicLongPressMenu from "./include/_TopicLongPressMenu.mdx" +import MoreVerticalIcon from "~icons/zulip-icon/more-vertical" +import ZulipTip from '../../components/ZulipTip.astro'; +import FlattenedSteps from '../../components/FlattenedSteps.astro'; +import FilterResolvedLeftSidebar from "./include/_FilterResolvedLeftSidebar.mdx" +import KeyboardTip from '../../components/KeyboardTip.astro'; +import { Steps } from '@astrojs/starlight/components'; +import CheckIcon from "~icons/zulip-icon/check" +import TopicLongPressMenuTip from "./include/_TopicLongPressMenuTip.mdx" +import SearchIcon from "~icons/zulip-icon/search" +import { Tabs, TabItem } from '@astrojs/starlight/components' +import ConfigureResolvedNoticesMarkedAsRead from "./include/_ConfigureResolvedNoticesMarkedAsRead.mdx" +import TopicActions from "./include/_TopicActions.mdx" + +Zulip's [topics](/help/introduction-to-topics) are very +helpful for customer support, answering questions, investigating +issues and production errors, as well as other workflows. +Resolving topics makes it easy to track the status of each question, +investigation, or notification. + +Marking a topic as resolved: + +* Puts a ✔ at the beginning of the topic name, e.g., `example topic` + becomes `✔ example topic`. +* Triggers an automated notice from Notification Bot indicating that + you resolved the 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. +* Changes whether the topic appears when using the `is:resolved` and + `-is:resolved` [search filters](/help/search-for-messages#search-filters). + +Marking a topic as unresolved removes the ✔ and also triggers an +automated notice from Notification Bot. + +It's often helpful to define a policy for when to resolve topics that +fits how topics are used in a given channel. Here are some common +approaches for deciding when to mark a topic as resolved: + +* **Support**: When the support interaction is complete. Resolving + topics is particularly useful for internal support teams that might + not need a dedicated support ticket tracker. +* **Issues, errors and production incidents**: When investigation or + incident response is complete, and any follow-up work has been + transferred to the appropriate tracker. +* **Workflow management**: When the work described in the topic is + complete and any follow-ups have been transcribed. +* **Answering questions**: When the question has been fully answered, + and follow-ups would be best discussed in a new topic. + +Users can resolve or unresolve a topic if they have +[permission](/help/restrict-resolving-topics) to do so. + +## Mark a topic as resolved + + + + + + + 1. Select **Mark as resolved**. + + + + You can also click on the **mark as resolved** () + icon in the message recipient bar to mark an unresolved topic as resolved. + + + + + + + + 1. Tap **Mark as resolved**. + + + + + + +## Mark a topic as unresolved + +Marking a topic as unresolved normally triggers an automated notice from +Notification Bot. However, unresolving a topic right after you resolved it +removes the original notice instead. This is helpful if you resolved a topic by +accident. + + + + + + + 1. Select **Mark as unresolved**. + + + + You can also click on the **ellipsis** () + in the message recipient bar, and select the **Mark as unresolved** option. + + + + + + + + 1. Tap **Mark as unresolved**. + + + + + + +## Search for messages in unresolved topics + + + + + 1. Click the **search** () icon in the top bar to open the search box. + 1. Type `-is:resolved`, or start typing and select **Exclude topics marked as + resolved** from the typeahead. + 1. *(optional)* Enter additional search terms or + [filters](/help/search-for-messages). + 1. Press Enter. + + + + You can also use the / or Ctrl + K + keyboard shortcut to start searching messages. + + + + + + To get a feed of unread messages in all unresolved topics, search for + `is:unresolved is:unread`. + + +## Search for messages in resolved topics + + + + + 1. Click the **search** () icon in the top bar to open the search box. + 1. Type `is:resolved`, or start typing and select **Topics marked as resolved** + from the typeahead. + 1. *(optional)* Enter additional search terms or + [filters](/help/search-for-messages). + 1. Press Enter. + + + + You can also use the / or Ctrl + K + keyboard shortcut to start searching messages. + + + + +## Filter by whether topics are resolved + + + +## Configure whether resolved topic notices are marked as read + + + +## Sending messages to resolved topics + +You can send messages to a resolved topic, which is handy for *"thank you"* +messages, or to discuss whether a topic was incorrectly marked as resolved. + +When a topic is resolved or unresolved, users' compose boxes and message views +automatically update to show the topic's current state. This helps make sure +everyone sends messages to the correct place. + +[Integrations](/help/integrations-overview) will still send messages to the +original topic after a topic is resolved. This is useful for alerting +integrations, where a repeating alert might have a different cause. As usual, +you can mark the topic resolved once you've investigated the situation. + +## Related articles + +* [Rename a topic](/help/rename-a-topic) +* [Move content to another topic](/help/move-content-to-another-topic) +* [Restrict topic editing](/help/restrict-moving-messages) +* [API documentation for resolving topics](/api/update-message) diff --git a/starlight_help/src/content/docs/restrict-account-creation.mdx b/starlight_help/src/content/docs/restrict-account-creation.mdx new file mode 100644 index 0000000000..5abaf76439 --- /dev/null +++ b/starlight_help/src/content/docs/restrict-account-creation.mdx @@ -0,0 +1,111 @@ +--- +title: Restrict account creation +--- + +import NavigationSteps from "../../components/NavigationSteps.astro" +import SaveChanges from "./include/_SaveChanges.mdx" +import OwnerOnly from "./include/_OwnerOnly.mdx" +import FlattenedSteps from '../../components/FlattenedSteps.astro'; + + + +Each Zulip account is associated with an email address. If your organization +allows multiple authentication methods, it doesn't matter which one is used to +create an account. All authentication methods will work for all users in your +organization, provided that they are associated with the account email. To log +in with email, users are required to verify their email account by clicking on a +validation link. + +Zulip provides a number of configuration options to control who can create a new +account and how users access their accounts: + +* You can [require an invitation](#set-whether-invitations-are-required-to-join) + to sign up (default), or you can [allow anyone to + join](#set-whether-invitations-are-required-to-join) without an invitation. +* You can [restrict the ability to invite new + users](#change-who-can-send-invitations) to any combination of + [roles](/help/user-roles), [groups](/help/user-groups), and individual + [users](/help/introduction-to-users). + +Regardless of whether invitations are required, you can: + +* [Configure allowed authentication + methods](/help/configure-authentication-methods). +* [Restrict sign-ups to a fixed list of allowed + domains](#restrict-sign-ups-to-a-list-of-domains) + (including subdomains). For example, you can require users to sign up with + the email domain for your business or university. +* Disallow signups with known [disposable email + address](https://en.wikipedia.org/wiki/Disposable_email_address). This + is recommended for open organizations to help protect against abuse. + +## Set whether invitations are required to join + + + + + 1. Under **Joining the organization**, toggle **Invitations are required for + joining this organization**. + + + + +## Change who can send invitations + + + + + 1. Under **Joining the organization**, configure + **Who can send email invitations to new users** and + **Who can create reusable invitation links**. + + + + +## Configuring email domain restrictions + +Email domain restrictions apply to both new user accounts and [email +changes](/help/change-your-email-address). + +### Restrict sign-ups to a list of domains + + + + + 1. Set **Restrict email domains of new users** to + **Restrict to a list of domains**. + 1. Click **Configure** to add any number of domains. For each domain, you can + toggle **Allow subdomains**. + 1. When you are done adding domains, click **Close**. + + + + +### Don't allow disposable domains + + + + + 1. Set **Restrict email domains of new users** to + **Don't allow disposable emails**. + + + + +### Allow all email domains + + + + + 1. Set **Restrict email domains of new users** to + **No restrictions**. + + + + +## Related articles + +* [Configure authentication methods](/help/configure-authentication-methods) +* [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) diff --git a/starlight_help/src/content/docs/restrict-bot-creation.mdx b/starlight_help/src/content/docs/restrict-bot-creation.mdx new file mode 100644 index 0000000000..df505ee257 --- /dev/null +++ b/starlight_help/src/content/docs/restrict-bot-creation.mdx @@ -0,0 +1,58 @@ +--- +title: Configure who can add bots +--- + +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 AdminOnly from "./include/_AdminOnly.mdx" + + + +Zulip lets you create three types of [bots](/help/bots-overview): + +* **Incoming webhook bots**, which are limited to only sending messages into Zulip. +* **Generic bots**, which act like a normal user account. +* **Outgoing webhook bots**, which are generic bots that also receive + new messages via HTTPS POST requests. + +You can configure who can create incoming webhook bots (which are more limited +in what they can do), and who can create any bot. Both permissions can be +assigned to any combination of [roles](/help/user-roles), [groups](/help/user-groups), and +individual [users](/help/introduction-to-users). + + + These settings only affect new bots. Existing bots will not be + deactivated. + + +## Configure who can create bots that can only send messages (incoming webhook bots) + + + + + 1. Under **Other permissions**, configure **Who can create bots that send messages into Zulip**. + + + + +## Configure who can create any type of bot + + + + + 1. Under **Other permissions**, configure **Who can create any bot**. + + + + +## Related articles + +* [Bots overview](/help/bots-overview) +* [Integrations overview](/help/integrations-overview) +* [Add a bot or integration](/help/add-a-bot-or-integration) +* [Deactivate or reactivate a bot](/help/deactivate-or-reactivate-a-bot) +* [Incoming webhooks](/api/incoming-webhooks-overview) +* [Outgoing webhooks](/api/outgoing-webhooks) +* [Non-webhook integrations](/api/non-webhook-integrations) diff --git a/starlight_help/src/content/docs/restrict-direct-messages.mdx b/starlight_help/src/content/docs/restrict-direct-messages.mdx new file mode 100644 index 0000000000..e0143a10ae --- /dev/null +++ b/starlight_help/src/content/docs/restrict-direct-messages.mdx @@ -0,0 +1,77 @@ +--- +title: Restrict direct messages +--- + +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" + + + +Organization administrators can configure two types of permissions for [direct +messages](/help/direct-messages): + +* Who can **authorize** a direct message conversation. To send a DM, the recipients + must include at least one user who can authorize the conversation (the sender + or someone else). +* Who can **start** a direct message conversation. + +These permissions can be granted to any combination of +[roles](/help/user-roles), [groups](/help/user-groups), and individual +[users](/help/introduction-to-users). They are designed so that users can always +respond to a direct message they've received (unless organization permissions +change). They also provide a lot of flexibility for managing DMs in your +organization. For example, you can: + +* Prevent 1:1 DMs between [guest users](/help/guest-users). +* Allow members to respond to DMs from an admin or moderator, but not to start + DM conversations. +* Disable direct messages altogether. + +Regardless of how these settings are configured, users can always send direct messages +to bots and to themselves. + + + When restricting direct messages, consider also [restricting who can create + private channels](/help/configure-who-can-create-channels). + + +## Configure who can authorize a direct message conversation + + + + + 1. Under **Direct message permissions**, configure **Who can authorize a direct + message conversation**. + + + + +## Configure who can start a direct message conversation + + + + + 1. Under **Direct message permissions**, configure **Who can start a direct + message conversation**. + + + + +## Disable direct messages + + + + + 1. Under **Direct message permissions**, set **Who can authorize a direct + message conversation** to **Direct messages disabled**. + + + + +## Related articles + +* [Direct messages](/help/direct-messages) +* [Restrict channel creation](/help/configure-who-can-create-channels) diff --git a/starlight_help/src/content/docs/restrict-message-edit-history-access.mdx b/starlight_help/src/content/docs/restrict-message-edit-history-access.mdx new file mode 100644 index 0000000000..f9c8fee4c6 --- /dev/null +++ b/starlight_help/src/content/docs/restrict-message-edit-history-access.mdx @@ -0,0 +1,42 @@ +--- +title: Restrict message edit history access +--- + +import NavigationSteps from "../../components/NavigationSteps.astro" +import ZulipTip from '../../components/ZulipTip.astro'; +import FlattenedSteps from '../../components/FlattenedSteps.astro'; +import MessageEditHistoryIntro from "./include/_MessageEditHistoryIntro.mdx" +import SaveChanges from "./include/_SaveChanges.mdx" +import AdminOnly from "./include/_AdminOnly.mdx" + + + + + + + You can remove the edit history of a single message by + [deleting it](/help/delete-a-message#delete-a-message-completely). + + +## Restrict message edit history access + +You can restrict message edit history access to only show moves, or disable it +altogether. + + + + + 1. Under **Message editing**, configure **Allow viewing the history of a + message?**. + + + + +## Related articles + +* [Restrict message editing and deletion](/help/restrict-message-editing-and-deletion) +* [Restrict moving messages](/help/restrict-moving-messages) +* [Edit a message](/help/edit-a-message) +* [Delete a message](/help/delete-a-message) +* [Move content to another topic](/help/move-content-to-another-topic) +* [Move content to another channel](/help/move-content-to-another-channel) diff --git a/starlight_help/src/content/docs/restrict-message-editing-and-deletion.mdx b/starlight_help/src/content/docs/restrict-message-editing-and-deletion.mdx new file mode 100644 index 0000000000..2af908ab1c --- /dev/null +++ b/starlight_help/src/content/docs/restrict-message-editing-and-deletion.mdx @@ -0,0 +1,94 @@ +--- +title: Restrict message editing and deletion +--- + +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' +import AdminOnly from "./include/_AdminOnly.mdx" + + + +Zulip lets you separately configure permissions for editing and deleting +messages, and you can set time limits for both actions. Regardless of the +configuration you select, message content can only ever be modified by the +original author. + +Note that if a user can edit a message, they can also “delete” it by removing +all the message content. This is different from proper message deletion in two +ways: the original content will still show up in [message edit +history](/help/view-a-messages-edit-history), and will be included in +[data exports](/help/export-your-organization). Deletion permanently (and +irretrievably) removes the message from Zulip. + +## Configure message editing permissions + + + Users can only edit their own messages. + + + + + + 1. Under **Message editing**: + * Toggle **Allow message editing**. + * Configure **Time limit for editing messages**. + + + + +## Configure message deletion permissions + +These permissions can be granted to any combination of +[roles](/help/user-roles), [groups](/help/user-groups), and individual +[users](/help/introduction-to-users). + + + + + 1. Under **Message deletion**: + * Configure **Who can delete any message**. + * Configure **Who can delete their own messages everywhere**. + * Configure **Time limit for deleting messages**. This time limit does not + apply to users who can delete any message. + * Configure **Who can allow users to delete messages in channels they + administer**. + + + + + + A user can delete messages sent by [bots that they + own](/help/view-your-bots) just like messages they sent themself. + + +## Configure who can delete messages in a specific channel + + + + + + + 1. Select a channel. + + + + 1. Under **Moderation permissions**, configure **Who can delete any message in + this channel** and **Who can delete their own messages in this channel**. + + + + + + +## Related articles + +* [Edit a message](/help/edit-a-message) +* [Delete a message](/help/delete-a-message) +* [Delete a topic](/help/delete-a-topic) +* [Restrict message edit history access](/help/restrict-message-edit-history-access) +* [Configure message retention policy](/help/message-retention-policy) +* [Restrict moving messages](/help/restrict-moving-messages) diff --git a/starlight_help/src/content/docs/restrict-moving-messages.mdx b/starlight_help/src/content/docs/restrict-moving-messages.mdx new file mode 100644 index 0000000000..0e485b6348 --- /dev/null +++ b/starlight_help/src/content/docs/restrict-moving-messages.mdx @@ -0,0 +1,135 @@ +--- +title: Restrict moving messages +--- + +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' +import AdminOnly from "./include/_AdminOnly.mdx" + +Zulip lets you configure who can edit message topics and move topics between +channels. These permissions can be granted to any combination of +[roles](/help/user-roles), [groups](/help/user-groups), and individual +[users](/help/introduction-to-users). + +In addition to granting organization-wide permissions, you can configure +permissions for each channel. For example, you could allow the "engineering" +group to move messages just in the #engineering channel. + +In general, allowing all organization members to edit message topics is highly +recommended because: + +* It allows the community to keep conversations organized, even if some members + are still learning how to use topics effectively. +* It makes it possible to fix a typo in the topic of a message you just sent. + +You can let users edit topics without a time limit, or prohibit topic editing on +older messages to avoid potential abuse. The time limit will never apply to +administrators and moderators. + +Permissions for moving messages between channels can be configured separately. + +## Configure who can edit topics in any channel + + + + + + + 1. Under **Moving messages**, configure **Who can edit topics in any channel**. + + + + +## Configure who can edit topics in a specific channel + + + + + + + 1. Select a channel. + + + + 1. Under **Moderation permissions**, configure **Who can move messages inside this + channel**. + + + + + + +## Set a time limit for editing topics + + + The time limit you set will not apply to administrators and moderators. + + + + + + 1. Under **Moving messages**, configure **Time limit for editing topics**. + + + + +## Configure who can move messages out of any channel + + + + + + + 1. Under **Moving messages**, configure **Who can move messages out of any channel**. + + + + +## Configure who can move messages to another channel from a specific channel + + + + + + + 1. Select a channel. + + + + 1. Under **Moderation permissions**, configure **Who can move messages out of this + channel**. + + + + + + +## Set a time limit for moving messages between channels + + + The time limit you set will not apply to administrators and moderators. + + + + + + 1. Under **Moving messages**, configure **Time limit for moving messages + between channels**. + + + + +## Related articles + +* [Rename a topic](/help/rename-a-topic) +* [Resolve a topic](/help/resolve-a-topic) +* [Move content to another topic](/help/move-content-to-another-topic) +* [Move content to another channel](/help/move-content-to-another-channel) +* [Restrict message editing and deletion](/help/restrict-message-editing-and-deletion) +* [Restrict resolving topics](/help/restrict-resolving-topics) +* [Restrict message edit history access](/help/restrict-message-edit-history-access) +* [User roles](/help/user-roles) diff --git a/starlight_help/src/content/docs/restrict-name-and-email-changes.mdx b/starlight_help/src/content/docs/restrict-name-and-email-changes.mdx new file mode 100644 index 0000000000..5a066eb57f --- /dev/null +++ b/starlight_help/src/content/docs/restrict-name-and-email-changes.mdx @@ -0,0 +1,76 @@ +--- +title: Restrict name and email changes +--- + +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" + + + +## Restrict name changes + +By default, any user can [change their name](/help/change-your-name). +You can instead prevent users from changing their name. This setting is +especially useful if user names are managed via an external source, and +synced into Zulip via the [Zulip API](/api/), [LDAP][ldap-sync-data] or +another method. + + + Organization administrators can always [change anyone's + name](/help/change-a-users-name). + + + + + + 1. Under **User identity**, select **Prevent users from changing their + name**. + + + + +## Restrict email changes + +By default, any user can [change their email address][change-email]. +However, you can instead prevent users from changing their email +address. This setting is especially useful for organizations that +are using [LDAP][ldap-sync-data] or another single sign-on solution +to manage user emails. + + + Organization administrators can always change their own email + address. + + + + + + 1. Under **User identity**, select **Prevent users from changing their + email address**. + + + + +## Require unique names + +You can require users to choose unique names when joining your organization, or +changing their name. This helps prevent accidental creation of duplicate +accounts, and makes it harder to impersonate other users. + +When you turn on this setting, users who already have non-unique names are not +required to change their name. + + + + + 1. Under **User identity**, select **Require unique names**. + + + + +[change-email]: /help/change-your-email-address + +[ldap-sync-data]: https://zulip.readthedocs.io/en/stable/production/authentication-methods.html#synchronizing-data diff --git a/starlight_help/src/content/docs/restrict-permissions-of-new-members.mdx b/starlight_help/src/content/docs/restrict-permissions-of-new-members.mdx new file mode 100644 index 0000000000..3e538692fe --- /dev/null +++ b/starlight_help/src/content/docs/restrict-permissions-of-new-members.mdx @@ -0,0 +1,41 @@ +--- +title: Restrict permissions of new members +--- + +import NavigationSteps from "../../components/NavigationSteps.astro" +import SaveChanges from "./include/_SaveChanges.mdx" +import OwnerOnly from "./include/_OwnerOnly.mdx" +import FlattenedSteps from '../../components/FlattenedSteps.astro'; + + + +In large Zulip organizations where +[anyone can join](/help/restrict-account-creation#set-whether-invitations-are-required-to-join), it can +be useful to restrict what new members can do, to make it easier to cope +with spammers and confused users. + +Members are **new members** from when they join till when their account ages +past a certain **waiting period** threshold. After that they are **full members**. +You can configure how long the waiting period is, as well as which actions require +being a full member. + +For some features, Zulip supports restricting access to only full members. These +features include [creating channels](/help/configure-who-can-create-channels), +[inviting users to the organization](/help/invite-new-users), +[adding custom emoji](/help/custom-emoji#change-who-can-add-custom-emoji), +and many more. + +## Set waiting period for new members + + + + + 1. Under **Joining the organization**, configure + **Waiting period before new members turn into full members**. + + + + +## Related articles + +* [User roles](/help/user-roles) diff --git a/starlight_help/src/content/docs/restrict-profile-picture-changes.mdx b/starlight_help/src/content/docs/restrict-profile-picture-changes.mdx new file mode 100644 index 0000000000..fe6958ca43 --- /dev/null +++ b/starlight_help/src/content/docs/restrict-profile-picture-changes.mdx @@ -0,0 +1,34 @@ +--- +title: Restrict profile picture changes +--- + +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" + + + +By default, any user can [change their profile picture][change-avatar]. +You can instead prevent users from changing their profile picture. This +setting is primarily useful in organizations that are [synchronizing +profile pictures from LDAP][ldap-sync-avatars] or a similar directory. + + + Organization administrators can always change their own profile + picture. + + + + + + 1. Under **User identity**, select **Prevent users from changing their + avatar**. + + + + +[change-avatar]: /help/change-your-profile-picture + +[ldap-sync-avatars]: https://zulip.readthedocs.io/en/stable/production/authentication-methods.html#synchronizing-avatars diff --git a/starlight_help/src/content/docs/restrict-resolving-topics.mdx b/starlight_help/src/content/docs/restrict-resolving-topics.mdx new file mode 100644 index 0000000000..64dd20fb7a --- /dev/null +++ b/starlight_help/src/content/docs/restrict-resolving-topics.mdx @@ -0,0 +1,58 @@ +--- +title: Restrict resolving topics +--- + +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' +import AdminOnly from "./include/_AdminOnly.mdx" + +Zulip lets you configure who can [mark topics as resolved](/help/resolve-a-topic). This +permission can be granted to any combination of [roles](/help/user-roles), +[groups](/help/user-groups), and individual +[users](/help/introduction-to-users). + +## Configure who can resolve topics in any channel + + + + + + + + + 1. Under **Moving messages**, configure **Who can resolve topics**. + + + + + + +## Configure who can resolve topics in a specific channel + + + + + + + 1. Select a channel. + + + + 1. Under **Moderation permissions**, configure **Who can resolve topics in this + channel**. + + + + + + +## Related articles + +* [Restrict moving messages](/help/restrict-moving-messages) +* [Resolve a topic](/help/resolve-a-topic) +* [Rename a topic](/help/rename-a-topic) +* [Move content to another topic](/help/move-content-to-another-topic) +* [Move content to another channel](/help/move-content-to-another-channel) diff --git a/starlight_help/src/content/docs/restrict-wildcard-mentions.mdx b/starlight_help/src/content/docs/restrict-wildcard-mentions.mdx new file mode 100644 index 0000000000..ea48e31525 --- /dev/null +++ b/starlight_help/src/content/docs/restrict-wildcard-mentions.mdx @@ -0,0 +1,33 @@ +--- +title: Restrict wildcard mentions +--- + +import NavigationSteps from "../../components/NavigationSteps.astro" +import AdminOnly from "./include/_AdminOnly.mdx" +import SaveChanges from "./include/_SaveChanges.mdx" +import FlattenedSteps from '../../components/FlattenedSteps.astro'; + + + +Organization administrators can configure who is allowed to use [wildcard +mentions](/help/dm-mention-alert-notifications#wildcard-mentions) that affect a +large number of users. In particular, an organization can restrict who is +allowed to use `@all` (and, equivalently, `@everyone` and `@channel`) in channels +with more than 15 subscribers, and `@topic` in topics with more than 15 +participants. + +This permission can be granted to any combination of [roles](/help/user-roles), +[groups](/help/user-groups), and individual [users](/help/introduction-to-users). + + + + + 1. Under **Channel permissions**, configure **Who can notify a large number of + users with a wildcard mention**. + + + + +## Related articles + +* [DMs, mentions, and alerts](/help/dm-mention-alert-notifications) diff --git a/starlight_help/src/content/docs/review-your-settings.mdx b/starlight_help/src/content/docs/review-your-settings.mdx new file mode 100644 index 0000000000..55e4a0356d --- /dev/null +++ b/starlight_help/src/content/docs/review-your-settings.mdx @@ -0,0 +1,46 @@ +--- +title: Review your settings +--- + +import NavigationSteps from "../../components/NavigationSteps.astro" +import FlattenedSteps from '../../components/FlattenedSteps.astro'; + +We recommend reviewing all of your settings when you start using Zulip, and +then once again a few weeks later once you've gotten a better feel for how +you use Zulip. + +## Review your settings + + + + + 1. Click on each tab on the left. + + +## Review your preferences + + + + + 1. Click on the **Preferences** tab on the left. + + +## Review your privacy settings + + + + + 1. Click on the **Account & privacy** tab on the left. + + +## Review your notification settings + + + + + 1. Click on the **Notifications** tab on the left. + + +## Related articles + +* [Import your settings](/help/import-your-settings) diff --git a/starlight_help/src/content/docs/saml-authentication.mdx b/starlight_help/src/content/docs/saml-authentication.mdx new file mode 100644 index 0000000000..b9bf7eefcd --- /dev/null +++ b/starlight_help/src/content/docs/saml-authentication.mdx @@ -0,0 +1,258 @@ +--- +title: SAML authentication +--- + +import SendUsInfo from "./include/_SendUsInfo.mdx" +import ZulipTip from '../../components/ZulipTip.astro'; +import FlattenedSteps from '../../components/FlattenedSteps.astro'; +import SamlLoginButton from "./include/_SamlLoginButton.mdx" +import CloudPlusOnly from "./include/_CloudPlusOnly.mdx" +import { Steps } from '@astrojs/starlight/components'; +import { Tabs, TabItem } from '@astrojs/starlight/components' +import AdminOnly from "./include/_AdminOnly.mdx" +import UpgradeToPlusIfNeeded from "./include/_UpgradeToPlusIfNeeded.mdx" + + + +Zulip supports using SAML authentication for single sign-on, both for Zulip +Cloud and self-hosted Zulip servers. SAML Single Logout is also supported. + +This page describes how to configure SAML authentication with several common providers: + +* Okta +* OneLogin +* Entra ID (AzureAD) +* Keycloak +* Auth0 + +Other SAML providers are supported as well. + +If you are [self-hosting](/self-hosting/) Zulip, please follow the detailed setup instructions in +the [SAML configuration for self-hosting][saml-readthedocs]. The documentation +on this page may be a useful reference for how to set up specific SAML +providers. + + + +## Configure SAML + + + + + + + 1. Set up SAML authentication by following + [Okta's documentation](https://developer.okta.com/docs/guides/saml-application-setup/overview/). + Specify the following fields, skipping **Default RelayState** and **Name ID format**: + * **Single sign on URL**: `https://auth.zulipchat.com/complete/saml/` + * **Audience URI (SP Entity ID)**: `https://zulipchat.com` + * **Application username format**: `Email` + * **Attribute statements**: + * `email` to `user.email` + * `first_name` to `user.firstName` + * `last_name` to `user.lastName` + 1. Assign the appropriate accounts in the **Assignments** tab. These are the users + that will be able to log in to your Zulip organization. + 1. + * Your organization's URL + * The **Identity Provider metadata** provided by Okta for the application. + To get the data, click the **View SAML setup instructions button** in + the right sidebar in the **Sign on** tab. + Copy the IdP metadata shown at the bottom of the page. + + + + + + + + + 1. Navigate to the OneLogin **Applications** page, and click **Add App**. + 1. Search for the **SAML Custom Connector (Advanced)** app and select it. + 1. Set a name and logo and click **Save**. This doesn't affect anything in Zulip, + but will be shown on your OneLogin **Applications** page. + 1. In the **Configuration** section, specify the following fields. Leave the + remaining fields as they are, including blank fields. + * **Audience**: `https://zulipchat.com` + * **Recipient**: `https://auth.zulipchat.com/complete/saml/` + * **ACS URL**: `https://auth.zulipchat.com/complete/saml/` + * **ACS URL Validator**: `https://auth.zulipchat.com/complete/saml/` + 1. In the **Parameters** section, add the following custom parameters. Set the + **Include in SAML assertion** flag on each parameter. + | Field name | Value + |--- |--- + | email | Email + | first\_name | First Name + | last\_name | Last Name + | username | Email + 1. + * Your organization's URL + * The **issuer URL** from the **SSO** section. It contains required **Identity Provider** metadata. + + + + + + + + + 1. From your Entra ID Dashboard, navigate to **Enterprise applications**, + click **New application**, followed by **Create your own application**. + 1. Enter a name (e.g., `Zulip Cloud`) for the new Entra ID application, + choose **Integrate any other application you don't find in the + gallery (Non-gallery)**, and click **Create**. + 1. From your new Entra ID application's **Overview** page that opens, go to + **Single sign-on**, and select **SAML**. + 1. In the **Basic SAML Configuration** section, specify the following fields: + * **Identifier (Entity ID)**: `https://zulipchat.com` + * **Default**: *checked* (This is required for enabling IdP-initiated sign on.) + * **Reply URL (Assertion Consumer Service URL)**: `https://auth.zulipchat.com/complete/saml/` + 1. If you want to set up IdP-initiated sign on, in the **Basic SAML + Configuration** section, also specify: + * **RelayState**: `\{"subdomain": ""\}` + 1. Check the **User Attributes & Claims** configuration, which should already be + set to the following. If the configuration is different, please + indicate this when contacting [support@zulip.com](mailto:support@zulip.com) + (see next step). + * **givenname**: `user.givenname` + * **surname**: `user.surname` + * **emailaddress**: `user.mail` + * **name**: `user.principalname` + * **Unique User Identifier**: `user.principalname` + 1. + * Your organization's URL + * From the **SAML Signing Certificate** section: + * **App Federation Metadata Url** + * Certificate downloaded from **Certificate (Base64)** + * From the **Set up** section + * **Login URL** + * **Microsoft Entra Identifier** + + + + + + + + + 1. Make sure your Keycloak server is up and running. + 1. In Keycloak, register a new Client for your Zulip organization: + * **Client-ID**: `https://zulipchat.com` + * **Client Protocol**: `saml` + * **Client SAML Endpoint**: *(empty)* + 1. In the **Settings** tab for your new Keycloak client, set the following properties: + * **Valid Redirect URIs**: `https://auth.zulipchat.com/*` + * **Base URL**: `https://auth.zulipchat.com/complete/saml/` + * **Client Signature Required**: `Disable` + 1. In the **Mappers** tab for your new Keycloak client: + * Create a Mapper for the first name: + * **Property**: `firstName` + * **Friendly Name**: `first_name` + * **SAML Attribute Name**: `first_name` + * **SAML Attribute Name Format**: `Basic` + * Create a Mapper for the last name: + * **Property**: `lastName` + * **Friendly Name**: `last_name` + * **SAML Attribute Name**: `last_name` + * **SAML Attribute Name Format**: `Basic` + * Create a Mapper for the email address: + * **Property**: `email` + * **Friendly Name**: `email` + * **SAML Attribute Name**: `email` + * **SAML Attribute Name Format**: `Basic` + 1. + * Your organization's URL + * The URL of your Keycloak realm. + + + + + Your Keycloak realm URL will look something like this: `https://keycloak.example.com/auth/realms/yourrealm`. + + + + + + + + 1. Set up SAML authentication by following [Auth0's documentation](https://auth0.com/docs/authenticate/protocols/saml/saml-sso-integrations/configure-auth0-saml-identity-provider#configure-saml-sso-in-auth0) + to create a new application. You don't need to save the certificates or other information detailed. + All you will need is the **SAML Metadata URL**. + 1. In the **Addon: SAML2 Web App** **Settings** tab, set the **Application Callback URL** to + `https://auth.zulipchat.com/complete/saml/`. + 1. Edit the **Settings** section to match: + ``` + \{ + "audience": "https://zulipchat.com", + "mappings": \{ + "email": "email", + "given_name": "first_name", + "family_name": "last_name" + \}, + "binding": "urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect" + \} + ``` + 1. + * Your organization's URL + * The **SAML Metadata URL** value mentioned above. It contains required **Identity Provider** metadata. + + + + + + + Once SAML has been configured, consider also [configuring SCIM](/help/scim). + + +## Synchronizing group membership with SAML + +You can configure each Zulip user's [groups](/help/user-groups) to be updated based +on their groups in your Identity Provider's (IdP's) directory every time they +log in. + +Your IdP directory's group names don't have to match the associated Zulip group +names (e.g., membership in your IdP's group **finance** can be synced to +membership in the Zulip group **finance-department**). See the [technical +documentation][saml-group-sync-readthedocs] on how your IdP's groups are mapped +to Zulip groups for details. + + + It should be possible to set this up with any provider. If you're interested + in using this functionality with a provider other than Okta, reach out to + [support@zulip.com](mailto:support@zulip.com). + + + + + + 1. Follow the instructions [above](#configure-saml) to configure SAML, and go to + the application you created for using SAML with Zulip in your + **Applications** menu. + 1. Select the **General** tab, and **Edit** the **SAML Settings** section. + 1. Proceed through the prompts until the main **Configure SAML** prompt. + 1. Scroll down below the **Attribute Statements** section (which you configured + when creating the app) to **Group Attribute Statements**. + 1. Add the following attribute: + * **Name**: `zulip_groups` + * **Name format**: `Unspecified` + * **Filter**: `Matches regex: .*` + When a user signs in to Zulip via SAML, Okta will now include a list of the + user's groups in its response to the Zulip server. + 1. To enable this feature, please email + [support@zulip.com](mailto:support@zulip.com) with the following information: + * Your Zulip organization URL. + * Which groups should be synced from your IdP's directory. + * Which groups should have a different name in Zulip (if any). + + + + +## Related articles + +* [SAML configuration for self-hosting][saml-readthedocs] +* [SCIM provisioning](/help/scim) +* [Moving to Zulip](/help/moving-to-zulip) + +[saml-readthedocs]: https://zulip.readthedocs.io/en/stable/production/authentication-methods.html#saml + +[saml-group-sync-readthedocs]: https://zulip.readthedocs.io/en/latest/production/authentication-methods.html#synchronizing-group-membership-with-saml diff --git a/starlight_help/src/content/docs/saved-snippets.mdx b/starlight_help/src/content/docs/saved-snippets.mdx new file mode 100644 index 0000000000..6d65306283 --- /dev/null +++ b/starlight_help/src/content/docs/saved-snippets.mdx @@ -0,0 +1,93 @@ +--- +title: Saved snippets +--- + +import MessageSquareTextIcon from "~icons/zulip-icon/message-square-text" +import EditIcon from "~icons/zulip-icon/edit" +import FlattenedSteps from '../../components/FlattenedSteps.astro'; +import KeyboardTip from '../../components/KeyboardTip.astro'; +import TrashIcon from "~icons/zulip-icon/trash" +import StartComposing from "./include/_StartComposing.mdx" + +You can save snippets of message content, and quickly insert them into the +message you're composing. + +## Insert a saved snippet + + + + + 1. Click the **Add saved snippet** () icon at the bottom of the compose box to + open the saved snippets menu. + 1. Start typing to filter saved snippets by title. Select a saved snippet to + insert it into the compose box. + + + + You can also use Ctrl + ' to open the saved + snippets menu. + + +## Create a saved snippet + + + + + 1. *(optional)* Write the text you'd like to use as save as a snippet in the + compose box. You can [preview](/help/preview-your-message-before-sending) what + it will look like once sent. + 1. Click the **Add saved snippet** () icon at the bottom of the compose box to + open the saved snippets menu. + 1. Select **Create a new saved snippet**. + 1. Enter a **Title** for the saved snippet, which will be used for finding saved + snippets. + 1. Enter the **Content** you'd like to save as a snippet, or modify the content + from the compose box as needed. + 1. Click **Save**. + + + + You can also use Ctrl + ' to open the saved + snippets menu. + + +## Edit a saved snippet + + + + + 1. Click the **Add saved snippet** () icon at the bottom of the compose box to + open the saved snippets menu. + 1. Hover over the saved snippet you'd like to edit, and click the **Edit + snippet** () icon on the right. + 1. Edit the **Title** and **Content** as desired. + 1. Click **Save**. + + + + You can also use Ctrl + ' to open the saved + snippets menu. + + +## Delete a saved snippet + + + + + 1. Click the **Add saved snippet** () icon at the bottom of the compose box to + open the saved snippets menu. + 1. Hover over the saved snippet you'd like to delete, and click the **Delete + snippet** () icon on the right. + + + + You can also use Ctrl + ' to open the saved + snippets menu. + + +## 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) +* [Keyboard shortcuts](/help/keyboard-shortcuts) diff --git a/starlight_help/src/content/docs/schedule-a-message.mdx b/starlight_help/src/content/docs/schedule-a-message.mdx new file mode 100644 index 0000000000..2a461ba9be --- /dev/null +++ b/starlight_help/src/content/docs/schedule-a-message.mdx @@ -0,0 +1,124 @@ +--- +title: Schedule a message +--- + +import MoreVerticalIcon from "~icons/zulip-icon/more-vertical" +import GoToScheduledMessages from "./include/_GoToScheduledMessages.mdx" +import ZulipTip from '../../components/ZulipTip.astro'; +import FlattenedSteps from '../../components/FlattenedSteps.astro'; +import KeyboardTip from '../../components/KeyboardTip.astro'; +import TrashIcon from "~icons/zulip-icon/trash" +import StartComposing from "./include/_StartComposing.mdx" +import SendIcon from "~icons/zulip-icon/send" +import { Tabs, TabItem } from '@astrojs/starlight/components' + +Zulip lets you schedule a message to be sent at a later time. For example, if +you are working outside of regular business hours for your organization, you can +schedule a message for next morning to avoid disturbing others. You can also +[schedule a message reminder](/help/schedule-a-reminder) for yourself. + +## Schedule a message + + + + + + + 1. Write a message. + 1. Click on the **ellipsis** () next to the **Send** + () button. + 1. Click **Schedule message**. + 1. Select one of the suggested scheduling options, or pick a custom time. + + + + From the compose box, you can use Tab, Tab, + Enter to open the compose menu and start scheduling a message. + + + + +## Edit or reschedule a message + + + + + + + 1. Click on the message you want to edit or reschedule. + 1. *(optional)* Edit the message. + 1. Click the **ellipsis** () next to the **Send** + () button. + 1. Select the previously scheduled time, or click **Schedule message** to pick a + new time. + + + + You can also click **Undo** in the confirmation banner shown immediately + after a message is scheduled. + + + + +## Send a scheduled message now + + + + + + + 1. Click on the message you want to send now. + 1. *(optional)* Edit the message. + 1. Click the **Send** () button. + + + + You can also use Enter within the scheduled messages view to + edit or reschedule the selected message. + + + + +## Delete a scheduled message + + + + + + + 1. Click the **delete** () icon on the message you + want to delete. + + + + You can also use Backspace within the scheduled messages view to + delete the selected message. + + + + +## View scheduled messages + + + + + + + + + You can also view scheduled messages by clicking on the **ellipsis** + () next to the **Send** + () button in the compose + box, and selecting **View scheduled messages**. + + + + +## Related articles + +* [Schedule a reminder](/help/schedule-a-reminder) +* [Message drafts](/help/view-and-edit-your-message-drafts) +* [Preview messages before sending](/help/preview-your-message-before-sending) +* [Verify a message was sent](/help/verify-your-message-was-successfully-sent) +* [Edit a message](/help/edit-a-message) +* [Delete a message](/help/delete-a-message) diff --git a/starlight_help/src/content/docs/schedule-a-reminder.mdx b/starlight_help/src/content/docs/schedule-a-reminder.mdx new file mode 100644 index 0000000000..c90da4a2c3 --- /dev/null +++ b/starlight_help/src/content/docs/schedule-a-reminder.mdx @@ -0,0 +1,75 @@ +--- +title: Schedule a reminder +--- + +import MoreVerticalIcon from "~icons/zulip-icon/more-vertical" +import FlattenedSteps from '../../components/FlattenedSteps.astro'; +import { Steps } from '@astrojs/starlight/components'; +import KeyboardTip from '../../components/KeyboardTip.astro'; +import TrashIcon from "~icons/zulip-icon/trash" +import MessageActions from "./include/_MessageActions.mdx" +import { Tabs, TabItem } from '@astrojs/starlight/components' +import GoToReminders from "./include/_GoToReminders.mdx" + +Zulip allows you to schedule a reminder for a message at a later time. The +reminder is delivered to you as a [direct message](/help/direct-messages) by +Notification Bot at the scheduled time. For example, you might schedule a +reminder for a message to reply to when you have more time, or one about a task +to take care of. + +You can also [schedule a message](/help/schedule-a-message) to be sent to any +conversation at a later time. + +## Schedule a reminder + + + + + + + 1. Click on the **ellipsis** (). + 1. Click **Remind me about this**. + 1. *(optional)* Add a note for yourself. You can use Zulip's standard \[Markdown + + + formatting]\(/help/format-your-message-using-markdown). + + + 1. Select one of the suggested scheduling options, or pick a custom time. + + + + +## Delete a reminder + + + + + + + 1. Click the **delete** () + icon on the reminder that you want to delete. + + + + You can also use Backspace within the reminders view to + delete the selected reminder. + + + + +## View reminders + + + + + + + + + +## Related articles + +* [Star a message](/help/star-a-message) +* [Marking messages as unread](/help/marking-messages-as-unread) +* [Schedule a message](/help/schedule-a-message) diff --git a/starlight_help/src/content/docs/scim.mdx b/starlight_help/src/content/docs/scim.mdx new file mode 100644 index 0000000000..8f7a08420f --- /dev/null +++ b/starlight_help/src/content/docs/scim.mdx @@ -0,0 +1,195 @@ +--- +title: SCIM provisioning +--- + +import ZulipNote from '../../components/ZulipNote.astro'; +import ZulipTip from '../../components/ZulipTip.astro'; +import FlattenedSteps from '../../components/FlattenedSteps.astro'; +import CloudPlusOnly from "./include/_CloudPlusOnly.mdx" +import { Steps } from '@astrojs/starlight/components'; +import { Tabs, TabItem } from '@astrojs/starlight/components' +import AdminOnly from "./include/_AdminOnly.mdx" +import UpgradeToPlusIfNeeded from "./include/_UpgradeToPlusIfNeeded.mdx" + + + +SCIM (System for Cross-domain Identity Management) is a standard +protocol used by Single Sign-On (SSO) services and identity providers +to provision/deprovision user accounts and [groups](/help/user-groups). +Zulip supports SCIM integration, both in Zulip Cloud and for +[self-hosted](/self-hosting/) Zulip servers. This page describes how to +configure SCIM provisioning for Zulip. + + + + + While Zulip's SCIM integration is generic, we've only fully + documented the setup process with the Okta and Microsoft EntraID + SCIM providers. [Zulip support](/help/contact-support) is happy to + help customers configure this integration with SCIM providers that + do not yet have detailed self-service documentation on this page. + + +## Configure SCIM + + + + + + + 1. Contact [support@zulip.com](mailto:support@zulip.com) to request the + **Bearer token** that Okta will use to authenticate to your SCIM API. + 1. In your Okta Dashboard, go to **Applications**, and select + **Browse App Catalog**. + 1. Search for **SCIM** and select **SCIM 2.0 Test App (Header Auth)**. + 1. Click **Add** and choose your **Application label**. For example, you can + name it "Zulip SCIM". + 1. Continue to **Sign-On Options**. Leave the **SAML** options as they are. + This type of Okta application doesn't actually support SAML authentication, + and you'll need to set up a separate Okta app to activate SAML for your Zulip + organization. + 1. In **Credentials Details**, specify the following fields: + * **Application username format**: `Email` + * **Update application username on**: `Create and update` + 1. In the **Provisioning** tab, click **Configure API Integration**, check the + **Enable API integration** checkbox, and specify the following fields: + * **Base URL for Zulip Cloud**: `https://example.zulipchat.com/scim/v2` + * **Base URL for self-hosting**: `https://zulip.example.com/scim/v2` + * **API token**: `Bearer ` (given to you by Zulip support) + When you proceed to the next step, Okta will verify that these details are + correct by making a SCIM request to the Zulip server. + 1. Enable the following **Provisioning to App** settings: + * **Create Users** + * **Update User Attributes** + * **Deactivate Users** + 1. Remove all attributes in **Attribute Mappings**, *except* for the following: + * **userName** + * **givenName** + * **familyName** + 1. **Optional:** If you'd like to also sync [user role](/help/user-roles), + you can do it by adding a custom attribute in Okta. Go to the **Profile Editor**, + click into the entry of the SCIM app you've just set up and **Add Attribute**. + Configure the following: + * **Data type**: `string` + * **Variable name**: `role` + * **External name**: `role` + * **External namespace**: `urn:ietf:params:scim:schemas:core:2.0:User` + With the attribute added, you will now be able to set it for your users directly + or configure an appropriate **Attribute mapping** in the app's **Provisioning** + section. + The valid values are: **owner**, **administrator**, **moderator**, **member**, **guest**. + 1. Now that the integration is ready to manage Zulip user accounts, **assign** + users to the SCIM app. + * When you assign a user, Okta will check if the account exists in your + Zulip organization. If it doesn't, the account will be created. + * Changes to the user's email or name in Okta will automatically cause the + Zulip account to be updated accordingly. + * Unassigning a user from the app will deactivate their Zulip account. + + + + + + + + 1. Contact [support@zulip.com](mailto:support@zulip.com) to request the + **Secret Token** that Entra will use to authenticate to your SCIM API. + 1. Sign in to the [Microsoft Entra admin center](https://entra.microsoft.com/). + 1. Go to **Identity** -> **Applications** -> **Enterprise applications**. + 1. Select **New application** -> **Create your own application**. + 1. Complete the form: + * Enter a name for your application. + * Select the option **Integrate any other application you don't find in the gallery**. + * Click **Add** to create the new app. It will be added to your **Enterprise applications**. + 1. Continue to the app's management screen and click **Provisioning** in the left panel. + 1. In the **Provisioning Mode** menu, select **Automatic** and specify the following fields: + * **Tenant URL for Zulip Cloud**: `https://example.zulipchat.com/scim/v2/?aadOptscim062020`. + * **Tenant URL for self-hosting**: `https://zulip.example.com/scim/v2/?aadOptscim062020`. + The `?aadOptscim062020` part of it is a [feature flag][feature-flag] + that needs to be added to ensure SCIM compliance by Entra ID. + * **Secret Token**: `` (given to you by Zulip support) + 1. Click **Test Connection.** + 1. In the **Mappings** section, there are two sets of [attribute + mappings][attribute-mappings]: one for Users and one for + Groups. Make sure to set **Provision Microsoft Entra ID Groups** to + be disabled. Provisioning of Groups is currently not supported in + Zulip. + 1. In **Provision Microsoft Entra ID Users**, configure the necessary mappings: + * Change **userName** to map to **mail**. **Important**: You need + **mail** to be set for all your users or trying to assign them + to the app will fail. + * Delete the other default entries leaving only the **active** and + **name.formatted** mappings, until your list looks like the + image below. + ![Attribute Mappings](../../../../static/images/help/entraid-scim-mappings.png) + 1. Once your configuration is complete, set the **Provisioning + Status** to **On** and then click **Save** to start the Microsoft + Entra provisioning service. + 1. Now you can proceed to the **Users and groups** tab, where you can + assign users to be provisioned via this integration. + 1. Wait for the initial provisioning cycle to be started by + Entra. This might take up to 40 minutes. This delay is entirely + inside Entra, and not under Zulip’s control. You can also use + [**Provision on demand**][provision-on-demand] in Entra to cause + immediate SCIM provisioning for specific users, which is handy when + testing the integration. + + + + +[attribute-mappings]: https://learn.microsoft.com/en-us/entra/identity/app-provisioning/customize-application-attributes + +[feature-flag]: https://learn.microsoft.com/en-us/entra/identity/app-provisioning/application-provisioning-config-problem-scim-compatibility#flags-to-alter-the-scim-behavior + +[provision-on-demand]: https://learn.microsoft.com/en-us/entra/identity/app-provisioning/provision-on-demand + + + Once SCIM has been configured, consider also [configuring SAML](/help/saml-authentication). + + +## Synchronizing group membership with SCIM + +You can enable group sync for any of your SCIM provider's groups. When you do, +the SCIM integration will create a user group in Zulip with the matching name +and user memberships. When you add or remove users from the group in your SCIM +provider, these changes will immediately be reflected in group memberships in +Zulip. + +In order to ensure consistent state, do not modify the **name** or **user +memberships** of SCIM-managed groups inside of Zulip. Such groups are meant to +be managed in your SCIM provider. Changes made on the Zulip side will not be +reflected in your SCIM provider, and instead will cause the state of the Zulip +group to become inconsistent with the state of the SCIM provider's group. + +Zulip supports [adding user groups to other +groups](/help/manage-user-groups#add-user-groups-to-a-group), but some SCIM +providers (including Okta) do not. As a result, this concept is also not +supported in Zulip's SCIM integration. If you want to use nested groups, you can +add groups to other groups in Zulip and manage the individual members of each +subgroup in your SCIM provider. + + + + + 1. Follow the instructions [above](#configure-scim) to configure SCIM. + 1. [Rename](/help/manage-user-groups#change-a-user-groups-name-or-description) + any Zulip groups that have the same names as groups that you want to sync. If + you push a group whose name matches an existing Zulip group, the request will + fail. + 1. Open the **Application** you set up above for the Zulip SCIM integration, and + go to the **Push groups** tab. This menu allows you to choose the Okta groups + which should be synchronized with Zulip's user groups. + + + + SCIM `DELETE` requests are not supported for groups. To **Unlink** a group in + Okta from the Zulip SCIM integration, select **Leave the group in the target + app**. The **Delete the group in the target app** option is not supported. + + + + +## Related articles + +* [SAML authentication](/help/saml-authentication) +* [Moving to Zulip](/help/moving-to-zulip) diff --git a/starlight_help/src/content/docs/search-for-messages.mdx b/starlight_help/src/content/docs/search-for-messages.mdx new file mode 100644 index 0000000000..729c1cee35 --- /dev/null +++ b/starlight_help/src/content/docs/search-for-messages.mdx @@ -0,0 +1,199 @@ +--- +title: Searching for messages +--- + +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 KeyboardTip from '../../components/KeyboardTip.astro'; +import MobileMenu from "./include/_MobileMenu.mdx" +import SearchIcon from "~icons/zulip-icon/search" +import { Tabs, TabItem } from '@astrojs/starlight/components' + +It's easy to find the right conversation with Zulip's powerful search. When you +find the message you were looking for, go directly to its topic for full context. + +Whenever you need a reminder of the search filters that Zulip offers, check out +the convenient [**search filters**](#search-filters-reference) reference +in the Zulip web and desktop apps. + +## Search for messages + + + + + 1. Click the **search** () icon in the top bar to open the search box. + 1. Type your query, and press Enter. + + + + You can also use the / or Ctrl + K + keyboard shortcut to start searching messages. + + + + + + + + 1. Tap **Search**. + 1. Type your query, and tap **search** or + on your device's + keyboard. + + + + +## Keyword search + +Zulip lets you search messages and topics by keyword. For example: + +* `new logo`: Search for messages with both `new` and `logo` in the message or + its topic. +* `"new logo"`: Search for messages with the phrase "`new logo`" in the message + or its topic. + +Some details to keep in mind: + +* Keywords are case-insensitive, so `wave` will also match `Wave`. +* Zulip will find messages containing similar keywords (keywords with the same + stem), so, e.g., `wave` will match `waves` and `waving`. +* Zulip search ignores very common words like `a`, `the`, and about 100 others. +* [Emoji](/help/emoji-and-emoticons) in messages (but not [emoji + reactions](/help/emoji-reactions)) are included in searches, so if you search + for `thumbs_up`, your results will include messages with the `:thumbs_up:` emoji (👍). + +## Search filters + +Zulip also offers a wide array of search filters, which can be used on their +own, or in combination with keywords. For example: + +* `channel:design`: Navigate to **#design**. +* `channel:design logo`: Search for the keyword `logo` within **#design**. +* `channel:design has:image new logo`: Search for messages in **#design** that + include an image and contain the keywords `new` and `logo`. The keywords can + appear in the message itself or its topic. + + + As you start typing into the search box, Zulip will suggest search filters + you can use. + + +### Search by location + +Sometimes you know approximately where the message you are looking for was sent. +Zulip offers the following filters based on the location of the message. + +* `channel:design`: Search within the channel **#design**. +* `channel:design topic:new+logo`: Search within the topic "new logo" in + **#design**. +* `is:dm`: Search all your direct messages. +* `dm:Bo Lin`: Search 1-on-1 direct messages between you and Bo. +* `dm:Bo Lin, Elena García`: Search group direct messages + between you, Bo, and Elena. +* `dm-including:Bo Lin`: Search all direct message conversations + (1-on-1 and group) that include you and Bo, as well as any other users. + +### Search shared history + +To avoid cluttering your search results, by default, Zulip searches just the +messages you received. You can use `channels:` or `channel:` filters to search +additional messages. + +* `channels:public`: Search messages in all + [public](/help/channel-permissions#public-channels) and + [web-public](/help/channel-permissions#web-public-channels) channels. +* `channels:web-public`: Search messages in all + [web-public](/help/change-the-privacy-of-a-channel) channels in the organization, + including channels you are not subscribed to. +* `channel:design`: Search all messages in **#design**, including messages sent + before you were a subscriber. + +### Search by sender + +* `sender:Elena García`: Search messages sent by Elena. +* `sender:me`: Search messages you've sent. + + + You can also access all messages someone has sent [via their **user + card**](/help/view-messages-sent-by-a-user). + + +### Search for attachments or links + +* `has:link`: Search messages that contain URLs. +* `has:attachment`: Search messages that contain an [uploaded + file](/help/share-and-upload-files). +* `has:image`: Search messages that contain uploaded or linked images or videos. + + + You can also [view](/help/manage-your-uploaded-files) all the files you + have uploaded or [browse](/help/view-images-and-videos) all the images and + videos in the current view. + + +### Search your important messages + +* `is:alerted`: Search messages that contain your [alert + words](/help/dm-mention-alert-notifications#alert-words). Messages are + included in the search results based on the alerts you had configured when you + received the message. +* `is:mentioned`: Search messages where you were + [mentioned](/help/mention-a-user-or-group). +* `is:starred`: Search your [starred messages](/help/star-a-message). + +### Search by message status + +* `is:followed`: Search messages in [followed topics](/help/follow-a-topic). +* `is:resolved`: Search messages in [resolved topics](/help/resolve-a-topic). +* `-is:resolved`: Search messages in [unresolved topics](/help/resolve-a-topic). +* `is:unread`: Search your unread messages. +* `is:muted`: Search [muted](/help/mute-a-topic) messages. +* `-is:muted`: Search only [unmuted](/help/mute-a-topic) messages. By default, + both muted and unmuted messages are included in keyword search results. +* `has:reaction`: Search messages with [emoji reactions](/help/emoji-reactions). + +### Search by message ID + +Each message in Zulip has a unique ID, which is used for [linking to a specific +message](/help/link-to-a-message-or-conversation#link-to-zulip-from-anywhere). +You can use the search bar to navigate to a message by its ID. + +* `near:12345`: Show messages around the message with ID `12345`. +* `id:12345`: Show only message `12345`. +* `channel:design near:1` Show the oldest messages in the **#design** channel. + +### Exclude filters + +All of Zulip's search filters can be negated to **exclude** messages matching +the specified rule. For example: + +* `channel:design -is:resolved -has:image`: Search messages in [unresolved + topics](/help/resolve-a-topic) in the **#design** channel that don't contain + images. + +## Linking to search results + +When you search Zulip, the URL shown in the address bar of the Zulip web app is a +permanent link to your search. You can share this link with others, and they +will see *their own* search results for your query. + +## Search filters reference + +A summary of the search filters above is available in the Zulip app. + + + + + + + + + +## Related articles + +* [Configure multi-language search](/help/configure-multi-language-search) +* [Filter users](/help/user-list#filter-users) +* [Link to a message or + conversation](/help/link-to-a-message-or-conversation#link-to-zulip-from-anywhere) diff --git a/starlight_help/src/content/docs/self-hosted-billing.mdx b/starlight_help/src/content/docs/self-hosted-billing.mdx new file mode 100644 index 0000000000..a02f0623fa --- /dev/null +++ b/starlight_help/src/content/docs/self-hosted-billing.mdx @@ -0,0 +1,467 @@ +--- +title: Self-hosted Zulip billing +--- + +import ZulipNote from '../../components/ZulipNote.astro'; +import RocketIcon from "~icons/zulip-icon/rocket" +import InternationalWireTransfers from "./include/_InternationalWireTransfers.mdx" +import ManageBillingIntro from "./include/_ManageBillingIntro.mdx" +import ManualAddLicenseInstructions from "./include/_ManualAddLicenseInstructions.mdx" +import FlattenedSteps from '../../components/FlattenedSteps.astro'; +import PayByInvoiceWarning from "./include/_PayByInvoiceWarning.mdx" +import PayByInvoiceSteps from "./include/_PayByInvoiceSteps.mdx" +import { Steps } from '@astrojs/starlight/components'; +import PaymentOptions from "./include/_PaymentOptions.mdx" +import ConfigureWhoCanManagePlans from "./include/_ConfigureWhoCanManagePlans.mdx" +import GearIcon from "~icons/zulip-icon/gear" +import PlanUpgradeSteps from "./include/_PlanUpgradeSteps.mdx" +import AutomaticBilling from "./include/_AutomaticBilling.mdx" +import SelfHostedBillingLogInStep from "./include/_SelfHostedBillingLogInStep.mdx" +import ZulipTip from '../../components/ZulipTip.astro'; +import { Tabs, TabItem } from '@astrojs/starlight/components' + +This page describes how to manage your self-hosted plan, and answers some common +questions about plans and billing for self-hosted organizations. Please refer to +[Self-hosted Zulip plans and pricing](https://zulip.com/plans/#self-hosted) for plan +details. + +The topics covered include: + +* [Self-hosted plans overview](#self-hosted-plans-overview) +* [Logging in to manage billing](#log-in-to-billing-management) +* [Upgrading to a paid plan](#upgrade-to-a-paid-plan) +* [Managing billing](#manage-billing) +* [Canceling a paid plan](#cancel-paid-plan) +* [Applying for a free Community plan](#apply-for-community-plan) +* [Applying for a paid plan discount](#apply-for-a-paid-plan-discount) +* [Payment methods](#payment-methods) +* [License management options](#license-management-options) + +If you have any questions not answered here, please don't hesitate to +reach out at [sales@zulip.com](mailto:sales@zulip.com). + +## Self-hosted plans overview + +Organizations that self-host Zulip can take advantage of the following plan +options: + +* **Free**: Includes free access to Zulip's [Mobile Push Notification + Service][push-notifications] for up to 10 users. +* **Basic**: Includes unlimited access to Zulip's [Mobile Push Notification + Service][push-notifications] for organizations with more than 10 users. +* **Business**: Includes commercial support, in addition to push notifications + access. Zulip's support team can answer questions about installation and + upgrades, provide guidance in tricky situations, and help avoid painful + complications before they happen. You can also get guidance on how best to use + dozens of Zulip features and configuration options. +* **Enterprise**: If your organization requires hands-on support, such as + real-time assistance during installation and upgrades, help with advanced + deployment options, development of custom features or integrations, etc., + please contact [sales@zulip.com](mailto:sales@zulip.com) to discuss pricing. +* **Community**: This free plan includes unlimited push notifications access, + and is available for many non-commercial organizations with more than 10 users + (details [below](#free-community-plan)). + +For full plan details, please take a look at [self-hosted Zulip plans and +pricing](https://zulip.com/plans/#self-hosted). + +There is no option to combine multiple plans (e.g., Free and Basic) within a +single organization. Pricing is [based on](#license-management-options) the +number of non-deactivated users, not on which features each user is taking +advantage of. However, paid plan discounts are available in a variety of +situations; see [below](#paid-plan-discounts) for details. + +### Organization plan or server plan? + +You can purchase self-hosted plans for a Zulip organization, or for your entire +server. + +If your server hosts a single Zulip organization, follow the +[instructions](#log-in-to-billing-management) for organization-level billing +(available on Zulip Server 8.0+). This will provide a more convenient plan +management experience. + +If your server hosts multiple organizations, you can manage plans individually +for each organization, or purchase a single plan to cover your entire server. +Commercial support for any server-wide configurations requires upgrading the +organization with the largest number of users. + +## Log in to billing management + +Once you are logged in, you can [upgrade to a paid +plan](#upgrade-to-a-paid-plan), [manage billing](#manage-billing), [cancel a +paid plan](#cancel-paid-plan), or [apply for a free Community +plan](#apply-for-community-plan) or a [paid plan +discount](#apply-for-a-paid-plan-discount). + + + + + This feature is only available to organization [owners](/help/user-roles) and billing administrators. + + + + 1. Your Zulip server administrator should register the server with Zulip's + Mobile Push Notification Service, following [these + instructions](https://zulip.readthedocs.io/en/latest/production/mobile-push-notifications.html). + The Zulip Server 10.0+ installer includes a `--push-notifications` flag that + automates this registration process. + 1. Click on the **gear** () icon in + the upper right corner of the web or desktop app. + 1. Select **Plan management**. + 1. *(first-time log in)* Enter the email address you want to use for plan + management, and click **Continue**. + 1. *(first-time log in)* In your email account, open the email you received + (Subject: Confirm email for Zulip plan management), and click **Confirm and + log in**. + 1. *(first-time log in)* Enter your name, configure your email preferences, and + accept the [Terms of Service](https://zulip.com/policies/terms). + 1. Verify your information, and click **Continue**. + + + + + + A **server administrator** is anyone who sets up and manages your Zulip + installation. A **billing administrator** is anyone responsible for managing + your Zulip plan. + + + **Server administrator steps:** + + + 1. Register the server with Zulip's Mobile Push Notification Service, following + [these + instructions](https://zulip.readthedocs.io/en/latest/production/mobile-push-notifications.html). + The Zulip Server 10.0+ installer includes a `--push-notifications` flag that + automates this registration process. + 1. Go to [https://selfhosting.zulip.com/serverlogin/](https://selfhosting.zulip.com/serverlogin/). + 1. Fill out the requested server information, and click **Continue**. + 1. Enter the email address of the billing contact for your organization, + and click **Confirm email**. + + + **Billing administrator steps:** + + + 1. In your email account, open the email you received + (Subject: Log in to Zulip plan management), and click **Log in**. + 1. Verify your information, and click **Continue**. If you are logging in for + the first time, you will need to enter your name and accept the [Terms of + Service](https://zulip.com/policies/terms). + + + + +## Upgrade to a paid plan + +### Start a free trial + +**New customers** are eligible for a free 30-day trial of the **Basic** plan. +An organization is considered to be a new customer if: + +* It was not registered for Zulip's [Mobile Push Notification + Service][push-notifications] prior to December 12, 2023, and +* It has never previously signed up for a self-hosted Zulip plan (Basic, + Business, Community or Enterprise). + + + + + + + 1. On the page listing Zulip's self-hosted plans, click the **Start + 30-day trial** button at the bottom of the **Basic** plan. + 1. Click **Add card** to enter your payment details. + 1. *(optional)* Update the billing details included on receipts so that + they are different from the information entered for the payment method, + e.g., in case you would prefer that the company's name be on receipts + instead of the card holder's name. + 1. Click **Start 30-day trial** to start your free trial. + + + + Once you start the trial, you can switch between monthly and annual + billing on your organization's billing page. You can + [cancel](#cancel-paid-plan) any time during your trial to avoid any charges. + + + + + + + + + + 1. On the page listing Zulip's self-hosted plans, click the **Start + 30-day trial** button at the bottom of the **Basic** plan. + 1. Select **pay by invoice**. + 1. Select your preferred option from the **Payment schedule** dropdown. + 1. Select the **Number of licenses** you would like to purchase for your + organization. You can adjust this number to update your initial invoice any + time during your trial. + 1. Click **Update billing information** to enter your billing details, which + will be included on invoices and receipts. + 1. Click **Start 30-day trial** to start your free trial. + + + + +### Upgrade directly to a paid plan + + + + + + + 1. On the page listing Zulip's self-hosted plans, click the button at the bottom + of the plan you would like to purchase. + + + + + + + + + + + + 1. On the page listing Zulip's self-hosted plans, click the button at the bottom + of the plan you would like to purchase. + + + + + + +## Manage billing + + + +### Manage billing + + + + + +### Configure who can manage plans and billing + + + +## Cancel paid plan + +If you cancel your plan, your organization will be downgraded to the +**Free** plan at the end of the current billing period. + + + + + 1. At the bottom of the page, click **Cancel plan**. + 1. Click **Downgrade** to confirm. + + +## Free Community plan + +Zulip sponsors free plans for over 1000 worthy organizations. The following +types of organizations are generally eligible for the **Community** plan. + +* Open-source projects, including projects with a small paid team. +* Research in an academic setting, such as research groups, cross-institutional + collaborations, etc. +* Organizations operated by individual educators, such as a professor teaching + one or more classes. +* Non-profits with no paid staff. +* Communities and personal organizations (clubs, groups of + friends, volunteer groups, etc.). + +Organizations that have up to 10 users, or do not require mobile push +notifications, will likely find the **Free** plan to be the most convenient +option. Larger organizations are encouraged to apply for the **Community** +plan, which includes unlimited push notifications and support for many Zulip +features. + +If you aren't sure whether your organization qualifies, submitting a sponsorship +form describing your situation is a great starting point. Many organizations +that don't qualify for the **Community** plan can still receive [discounted paid +plan pricing](#paid-plan-discounts). + +### Apply for Community plan + +These instructions describe the **Community** plan application process for an +existing Zulip server. If you would like to inquire about eligibility prior to +setting up a self-hosted server, contact [sales@zulip.com](mailto:sales@zulip.com). + + + + + 1. On the page listing Zulip's self-hosted plans, scroll down to the + **Sponsorship and discounts** area, and click **Apply here**. + 1. Fill out the requested information, and click **Submit**. Your application + will be reviewed for **Community** plan eligibility. + + + + Organizations that do not qualify for a **Community** plan may be offered a + discount for the **Basic** plan. + + +## Paid plan discounts + +The following types of organizations are generally eligible for significant +discounts on paid plans. You can also contact +[sales@zulip.com](mailto:sales@zulip.com) to discuss bulk discount pricing for a +large organization. + +* [Education organizations](#education-pricing) and [non-profit + organizations](#non-profit-pricing). +* Discounts are available for organizations based in the **developing world**. +* Any organization where many users are **not paid staff** is likely eligible + for a discount. + +If there are any circumstances that make regular pricing unaffordable for your +organization, contact [sales@zulip.com](mailto:sales@zulip.com) to discuss your +situation. + +### Education pricing + +Organizations operated by individual educators (for example, a professor +teaching one or more classes) are generally eligible for [the Community +plan](#free-community-plan). + +Departments and other institutions using Zulip with students are eligible for +discounted education pricing. Other educational uses (e.g., by teaching staff or +university IT) may qualify for [non-profit pricing](#non-profit-pricing). + +* **For-profit education pricing**: + * **Basic plan**: $0.50 per user per month + * **Business plan**: $1 per user per month with annual billing + ($1.20/month billed monthly) with a minimum purchase of 100 licenses. +* **Non-profit education pricing**: The non-profit discount applies to + online purchases only (no additional legal agreements) for use at registered + non-profit institutions (e.g., colleges and universities). + * **Basic plan**: $0.35 per user per month + * **Business plan**: $0.67 per user per month with annual billing + ($0.80/month billed monthly) with a minimum purchase of 100 licenses. + +### Non-profit pricing + +Non-profits with no paid staff are eligible for [the Community +plan](#free-community-plan). + +For non-profits with paid staff, volunteers and other unpaid participants in +your community are eligible for free Zulip accounts. Additionally, discounts are +available for paid staff accounts. Contact +[sales@zulip.com](mailto:sales@zulip.com) to arrange discounted pricing for your +organization. + +### Guest user discounts + +There is no automatic discount for guest users. However, organizations with a +large number of guest users are very likely to be eligible for a discount. If +this is your situation, please apply for a discount or email +[sales@zulip.com](mailto:sales@zulip.com). + +### Duplicate accounts + +Some servers host multiple organizations, with some individuals having accounts in +several of these organizations. If you have this setup, the ability to +[configure whether guests can see other +users](/help/guest-users#configure-whether-guests-can-see-all-other-users) +(introduced in Zulip 8.0) may allow you to consolidate into a single Zulip +organization. + +If you want to maintain a multi-organization setup with duplicate accounts, you +may contact [sales@zulip.com](mailto:sales@zulip.com) to arrange a discounted rate. + +### Apply for a paid plan discount + +These instructions describe the paid plan discount application process for an +existing Zulip server. If you would like to inquire about paid plan discount +eligibility prior to setting up a self-hosted server, contact +[sales@zulip.com](mailto:sales@zulip.com). + + + + + 1. On the page listing Zulip's self-hosted plans, scroll down to the + **Sponsorship and discounts** area, and click **Apply here**. + 1. Select your preferred option from the **Plan** dropdown. + 1. Fill out the requested information, and click **Submit**. Your application + will be reviewed for discount eligibility. + + +## Payment methods + +### What are my payment options? + + + +### International SWIFT transfers + + + +## License management options + +### How does automatic license management work? + + + +### How does manual license management work? + +With manual license management, you choose and pay for a fixed number of +licenses for your organization or server. [Deactivating a +user](/help/deactivate-or-reactivate-a-user) frees up their license for reuse. + +If the number of active users exceeds the number of licenses you've purchased, +any paid services included in your plan will be paused until this is addressed. +For example, you will lose access to the [Mobile Push Notification +Service][push-notifications] until you have purchased more licenses or +deactivated enough users. + +#### Manually update number of licenses + + + + + + + +## How paid plans support the Zulip project + +Zulip is proudly independent, with [no venture capital funding][sustainable-growth], +which means that revenue strongly impacts the pace of Zulip’s development. Paid +plans for self-hosted customers help fund improvements in Zulip's self-hosting +experience, and overall product development. Zulip needs the support of +businesses that self-host Zulip in order to thrive as an independent, [100% +open-source](https://github.com/zulip/zulip#readme) project. + +You can also learn about [other ways](/help/support-zulip-project) to support +the Zulip project. + +## Self-hosting Zulip for free + +Zulip is 100% open-source. Organizations that do not require support with their +installation can always use Zulip for free with no limitations. Additionally, +the [Mobile Push Notification Service][push-notifications] is provided free of +charge for organizations with up to 10 users. + +You can self-manage your Zulip installation without signing up for a plan. Get +started with the [installation guide][production-install]. + +## Related articles + +* [Trying out Zulip](/help/trying-out-zulip) +* [Zulip Cloud or self-hosting?](/help/zulip-cloud-or-self-hosting) +* [Migrating from other chat tools](/help/migrating-from-other-chat-tools) +* [Contact support](/help/contact-support) + +[basic-metadata]: https://zulip.readthedocs.io/en/latest/production/mobile-push-notifications.html#uploading-basic-metadata + +[usage-statistics]: https://zulip.readthedocs.io/en/latest/production/mobile-push-notifications.html#uploading-usage-statistics + +[push-notifications]: https://zulip.readthedocs.io/en/stable/production/mobile-push-notifications.html + +[production-install]: https://zulip.readthedocs.io/en/stable/production/install.html + +[sustainable-growth]: https://zulip.com/values/#building-a-sustainable-business-aligned-with-our-values diff --git a/starlight_help/src/content/docs/set-default-channels-for-new-users.mdx b/starlight_help/src/content/docs/set-default-channels-for-new-users.mdx new file mode 100644 index 0000000000..9e875527a8 --- /dev/null +++ b/starlight_help/src/content/docs/set-default-channels-for-new-users.mdx @@ -0,0 +1,50 @@ +--- +title: Set default channels for new users +--- + +import NavigationSteps from "../../components/NavigationSteps.astro" +import AdminOnly from "./include/_AdminOnly.mdx" +import CloseIcon from "~icons/zulip-icon/close" +import FlattenedSteps from '../../components/FlattenedSteps.astro'; + + + +You can configure a default set of channels that users will be subscribed to +when they join your organization. Default channels must be [public or +web-public](/help/channel-permissions). Users will be +subscribed to the default channels configured at the time when they +accept the invitation, so there's no need to update or revoke invitations when +you change the default channels. + +When you [send an email +invitation](/help/invite-new-users#send-email-invitations) or [create a reusable +invitation link](/help/invite-new-users#create-a-reusable-invitation-link), you +can customize which channels the invited users are subscribed to. Note that +subscribing new users to a channel generally requires having +[permissions](/help/channel-permissions) to do so, but anyone with +[permissions](/help/restrict-account-creation#change-who-can-send-invitations) +to invite new users can subscribe them to any combination of default channels. + +## Add a default channel + + + + + 1. Click **Add channel**. + 1. Select one or more channels, and click **Add**. + + +## Remove a default channel + + + + + 1. Find the channel you would like to remove, and click **Remove from default** () icon. + + +## Related articles + +* [User roles](/help/user-roles) +* [User groups](/help/user-groups) +* [Channel permissions](/help/channel-permissions) +* [Create channels for a new organization](/help/create-channels) diff --git a/starlight_help/src/content/docs/set-up-integrations.mdx b/starlight_help/src/content/docs/set-up-integrations.mdx new file mode 100644 index 0000000000..aa6a6725b5 --- /dev/null +++ b/starlight_help/src/content/docs/set-up-integrations.mdx @@ -0,0 +1,25 @@ +--- +title: Set up integrations +--- + +Zulip integrates directly with dozens of products, and with hundreds +more through [Zapier](/integrations/doc/zapier) and +[IFTTT](/integrations/doc/ifttt). Popular Zulip integrations include +[GitHub](/integrations/doc/github), [Jira](/integrations/doc/jira), +[PagerDuty](/integrations/doc/pagerduty), +[Sentry](/integrations/doc/sentry) and +[Twitter](/integrations/doc/twitter). + +* The [integrations page](/integrations/) has instructions for + integrating with each product. +* If you don't see an integration you need, you can [request it](/help/request-an-integration). +* You can also create [custom incoming webhook integrations](/api/incoming-webhooks-overview) using our API. +* Want to learn more? Read about [Zulip integrations](/help/integrations-overview). + +## Related articles + +* [Integrations overview](/help/integrations-overview) +* [Moving to Zulip](/help/moving-to-zulip) +* [Bots overview](/help/bots-overview) +* [Add a bot or integration](/help/add-a-bot-or-integration) +* [Add a custom linkifier](/help/add-a-custom-linkifier) diff --git a/starlight_help/src/content/docs/set-up-your-account.mdx b/starlight_help/src/content/docs/set-up-your-account.mdx new file mode 100644 index 0000000000..f574422b01 --- /dev/null +++ b/starlight_help/src/content/docs/set-up-your-account.mdx @@ -0,0 +1,12 @@ +--- +title: Set up your account +--- + +import SetUpYourAccount from "./include/_SetUpYourAccount.mdx" + + + +## Related articles + +* [Getting started with Zulip](/help/getting-started-with-zulip) +* [Review your settings](/help/review-your-settings) diff --git a/starlight_help/src/content/docs/setting-up-zulip-for-a-class.mdx b/starlight_help/src/content/docs/setting-up-zulip-for-a-class.mdx new file mode 100644 index 0000000000..8210689cd1 --- /dev/null +++ b/starlight_help/src/content/docs/setting-up-zulip-for-a-class.mdx @@ -0,0 +1,370 @@ +--- +title: Setting up Zulip for a class +--- + +import NavigationSteps from "../../components/NavigationSteps.astro" +import ZulipNote from '../../components/ZulipNote.astro'; +import HowToInviteUsersToJoin from "./include/_HowToInviteUsersToJoin.mdx" +import ZulipTip from '../../components/ZulipTip.astro'; +import FlattenedSteps from '../../components/FlattenedSteps.astro'; +import EditOrganizationProfile from "./include/_EditOrganizationProfile.mdx" +import CustomizeSettingsForNewUsers from "./include/_CustomizeSettingsForNewUsers.mdx" +import HowToCreateAUserGroup from "./include/_HowToCreateAUserGroup.mdx" +import AddAWideLogo from "./include/_AddAWideLogo.mdx" +import ReviewOrganizationSettingsInstructions from "./include/_ReviewOrganizationSettingsInstructions.mdx" +import CreateChannelsIntro from "./include/_CreateChannelsIntro.mdx" + +Welcome to Zulip! This page will guide you through setting everything +up for [teaching with Zulip](https://zulip.com/for/education/). If you +are using Zulip for a different purpose, we recommend checking out the +[moving to Zulip](/help/moving-to-zulip) guide instead. + +If you are a student, or if your Zulip organization is already set up, +you can proceed to the [Using Zulip for a +class](/help/using-zulip-for-a-class) guide. + +If you encounter any problems as you're getting started, please drop +by our [friendly development community](/development-community/) and let +us know! + +## Trying out Zulip + +You can start by reading about [Zulip for Education](https://zulip.com/for/education/), +and how Zulip can become the communication hub for your class. Zulip +is the only [modern team chat app](/features/) that is +[ideal](/why-zulip/) for both live and asynchronous +conversations. Post lecture notes and announcements, answer students’ +questions, and coordinate with teaching staff all in one place. + +We also highly recommend trying Zulip for yourself! You can: + +* [Create a Zulip Cloud organization](/new/) for free with just a few + clicks. +* [Join the Zulip development community](/development-community/) to see + Zulip in action. Feel free to introduce yourself and ask questions! + +## Choosing between Zulip Cloud and self-hosting + +Whether [signing up for Zulip Cloud](/new/) or [self-hosting +Zulip][install-self-hosted] is the right choice for you depends on your needs. + +If you aren’t sure what you need, our high quality export and import +tools ([cloud][export-cloud], [self-hosted][export-self-hosted]) +ensure you can always move from our hosting to yours (and back). + +[install-self-hosted]: https://zulip.readthedocs.io/en/stable/production/install.html + +[export-cloud]: /help/export-your-organization + +[export-self-hosted]: https://zulip.readthedocs.io/en/stable/production/export-and-import.html + +### Advantages of Zulip Cloud + +* Simple managed solution, with no setup or maintenance + overhead. [Sign up](/new/) with just a few clicks. +* Always updated to the latest version of Zulip. +* Anyone can [start with Zulip Cloud Free](/new/), which works well for a typical class. +* For large classes and departments, we offer [special Zulip for + Education pricing](https://zulip.com/for/education/#feature-pricing), with the same + features as Zulip Cloud Standard. You can always get started with + Zulip Cloud Free, and upgrade down the line if needed. + +### Advantages of self-hosting Zulip + +* Zulip is [100% open-source software](https://github.com/zulip), with + no "open core" catch. +* We work hard to make it easy to [set up][install-zulip], + [back up][back-up-zulip], and [maintain][maintain-zulip] a self-hosted + Zulip installation. +* Retain full control over your data. If cloud hosting is not an + option due to stringent data and privacy requirements (e.g., in the + European Union), self-hosting is the option for you. +* Customize Zulip for all your needs. + +[install-zulip]: https://zulip.readthedocs.io/en/stable/production/install.html + +[back-up-zulip]: https://zulip.readthedocs.io/en/stable/production/export-and-import.html#backups + +[maintain-zulip]: https://zulip.readthedocs.io/en/stable/production/upgrade.html + +## Do I need a separate Zulip organization for each class? + +There are a few ways to set up Zulip, and different ones may be convenient for your needs: + +* If your **school or department already has a Zulip organization**, + you will probably find it easiest to just add your class to + it. Advantages: + * Students and staff can use a single Zulip account for all classes. + * You can create department-wide channels, e.g., for announcing talks or other events. + * You don’t need to set up a separate server if you’re self-hosting Zulip. +* You can **set up a separate Zulip organization for each class** + you’re teaching. Advantages: + * This makes it simple to manage permissions, e.g., if you want to + make sure TAs from one class cannot moderate discussion from a + different class. + * Students can’t see who is in channels for other classes. + * You can easily switch between multiple Zulip organizations in + the [Zulip desktop apps](/apps/). +* You can **use a single Zulip organization for several classes** + you’re teaching, perhaps re-purposing a Zulip organization from a + prior term. Advantages: + * Information from your classes is all in one place, e.g., if you + want to re-post a response to a question that was also asked + last time you taught the class. + +If you change your mind down the line, you can rename your Zulip +organization by sending a request to +[support@zulip.com](mailto:support@zulip.com). + +## Create your organization profile + +The information in your organization profile is displayed on the +registration and login page for your organization, and in the Zulip app. + +### Edit organization profile + + + +### Add a wide logo + + + +## Customize organization settings + + + +A few settings to highlight: + +* If your class 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 class 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) that your class will enjoy. + +[default-code-block-language]: /help/code-blocks#default-code-block-language + +[code-playgrounds]: /help/code-blocks#code-playgrounds + +### Roles and permissions + +Zulip offers [several levels of permissions based on user +roles](/help/user-roles). Here are some recommendations for +how to assign roles and permissions for a class. + +#### Recommended roles and permissions for a single-class Zulip organization + +| Who | Role | +| ----------------------------------- | ---------------------------------------------- | +| Lead instructor, IT | Owner (also has all Administrator permissions) | +| Other instructors, head TA | Administrator | +| Teaching assistants, lab assistants | Moderator | +| Students | Member | + +##### Settings + + + These are the default permissions for new **Education + (non-profit)** and **Education (for-profit)** organizations. + + +* Set [who can invite new users](/help/restrict-account-creation#change-who-can-send-invitations). + (Recommended: Admins) +* Set [who can access user email addresses](/help/configure-email-visibility). + (Recommended: Admins only) +* Set [who can create channels](/help/configure-who-can-create-channels). + (Recommended: Admins for public channels; Admins, moderators and members for private channels) +* Set [who can subscribe other users to channels](/help/configure-who-can-invite-to-channels). + (Recommended: Admins and moderators) +* Set [who can edit the topic of any message](/help/restrict-moving-messages). + (Recommended: (default) Members for small classes; + Admins and moderators for large classes) +* Set [who can move messages between channels][move-between-channels]. + (Recommended: Admins and moderators) +* Set [who can create and manage user groups][user-group-permissions]. + (Recommended: Admins and moderators) + +[user-group-permissions]: /help/manage-user-groups#configure-who-can-create-user-groups + +[move-between-channels]: /help/restrict-moving-messages#configure-who-can-move-messages-out-of-any-channel + +#### Recommended roles and permissions for a department + +| Who | Role | +| --------------------------------------------- | ---------------------------------------------- | +| IT | Owner (also has all Administrator permissions) | +| IT, department leadership | Administrator | +| Professors, Lecturers, head TAs | Moderator | +| Teaching assistants, lab assistants, students | Member | + +##### Settings + +* Set [who can invite new users](/help/restrict-account-creation#change-who-can-send-invitations). + (Recommended: Admins and moderators) +* Set [who can access user email addresses](/help/configure-email-visibility). + (Recommended: Admins only) +* Set [who can create channels](/help/configure-who-can-create-channels). + (Recommended: Admins and moderators for public channels; + Admins, moderators and members for private channels) +* Set [who can subscribe other users to channels](/help/configure-who-can-invite-to-channels). + (Recommended: Admins and moderators) +* Set [who can edit the topic of any message](/help/restrict-moving-messages). + (Recommended: Admins and moderators) +* Set [who can move messages between channels][move-between-channels]. + (Recommended: Admins and moderators) +* Set [who can create and manage user groups][user-group-permissions]. + (Recommended: Admins and moderators) + +## Create channels + + + +### How to create a channel + + + + + 1. Click **Create channel** on the right. + 1. Fill out the requested info, and click **Create**. + + +### Tips for creating channels + +For most classes, the following channels are recommended: + +* **#announcements**: For general announcements about the class. When + creating this channel, [restrict posting + permissions](/help/channel-posting-policy) so that only course staff + ([administrators and moderators](/help/user-roles)) are + allowed to post. +* **#staff (private)**: For discussions among course staff. +* **#general**: For random topics, e.g., students forming study groups. +* A channel for each **lecture** or **unit**, e.g., “Lecture 1: Course + intro” or “Unit 3: Sorting algorithms”. +* A channel for each **section**/**tutorial group** (e.g., “Section 1”) + + + You can start by creating channels for just the first few + lectures/units at this point. When you create a new channel, + you will be able to copy channel membership from existing channels. + + +A few notes: + +* Small classes may need just one discussion channel for all lectures. +* If you are [using a single Zulip organization][separate-orgs] for + more than one class, all channel names should be prefixed with the + name of the class, e.g., “CS101 > Lecture 1: Course intro”. + +[separate-orgs]: /help/setting-up-zulip-for-a-class#do-i-need-a-separate-zulip-organization-for-each-class + +## Customize settings for new users + + + + + If using your Zulip organization for a single class, set default + channels for new users to include **#announcements**, **#general**, + and all lecture/unit channels. + + +## Invite users to join + + + Before inviting users, you may want to [delete any test + messages][delete-message] or [topics](/help/delete-a-topic). + + +[delete-message]: /help/delete-a-message#delete-a-message-completely + +### How to invite users to join + +To simplify subscription management, be sure to set the channels +students and staff should be subscribed to when you create the +invitations. You may choose to send invitations to course staff +separately, so that they can immediately be subscribed to private +channels for your class. + + + +To get everyone off to a good start, you may wish to share the guide +to [Getting started with Zulip][getting-started] and the guide to +[Using Zulip for a class](/help/using-zulip-for-a-class). + + + If you create new channels later on, you can subscribe users + [by group][create-user-groups] or copy membership from another + channel (e.g., from Lecture 5 to Lecture 6). + + +[create-user-groups]: /help/setting-up-zulip-for-a-class#create-user-groups + +## Create user groups + +User groups allow you to [mention](/help/mention-a-user-or-group) +multiple users at once, +[notifying](/help/dm-mention-alert-notifications) them about a +message. For example, you may find it useful to set up the following +user groups: + +* @staff +* @TAs +* @graders +* @students +* @section1, @section2, etc. + +### How to create a user group + + + +## Set up integrations + +Zulip integrates directly with dozens of products, and with hundreds +more through [Zapier](/integrations/doc/zapier) and +[IFTTT](/integrations/doc/ifttt). Popular Zulip integrations include +[GitHub](/integrations/doc/github) and +[Twitter](/integrations/doc/twitter). The [integrations +page](/integrations/) has instructions for integrating with each +product. + +## Cleaning up at the end of a class + +If you plan to use the same Zulip organization in future terms (either +for your own classes or for your department), you will likely want to: + +* Rename all channels to indicate the class and term in which they were used, for + example: + * **#announcements** → **#FA21 - CS101 - announcements** + * **#CS101 > Lecture 1: Course intro** → **#FA21 - CS101 > Lecture 1: Course + intro** +* If you do *not* want students from future classes to see messages + from the prior term (e.g., because you posted homework solutions), + [make all the channels from the class private][make-private]. You’ll + be able to find and reuse content yourself, and [invite course + staff][subscribe-to-channel] to these private channels as needed. +* You may choose to [deactivate students’ Zulip + accounts][deactivate-user] when the class is over. +* [Unpin channels](/help/pin-a-channel) from the class from your + personal view. + +If you do not plan to reuse the Zulip organization, you can instead: + +* [Export the organization](/help/export-your-organization) or [generate a static + HTML archive](https://github.com/zulip/zulip-archive) to archive the information. +* [Deactivate the organization](/help/deactivate-your-organization). + +## Further reading + +* [Using Zulip for a class](/help/using-zulip-for-a-class) +* [Getting started with Zulip](/help/getting-started-with-zulip) +* [Introduction to topics](/help/introduction-to-topics) +* [Moderating open organizations](/help/moderating-open-organizations) + +[make-private]: /help/change-the-privacy-of-a-channel + +[subscribe-to-channel]: /help/subscribe-users-to-a-channel + +[deactivate-user]: /help/deactivate-or-reactivate-a-user#deactivate-a-user + +[getting-started]: /help/getting-started-with-zulip diff --git a/starlight_help/src/content/docs/share-and-upload-files.mdx b/starlight_help/src/content/docs/share-and-upload-files.mdx new file mode 100644 index 0000000000..2c8eb4861b --- /dev/null +++ b/starlight_help/src/content/docs/share-and-upload-files.mdx @@ -0,0 +1,170 @@ +--- +title: Share and upload files +--- + +import MobileCameraIcon from "~icons/zulip-icon/mobile-camera" +import ModifyLinkText from "./include/_ModifyLinkText.mdx" +import ZulipTip from '../../components/ZulipTip.astro'; +import FlattenedSteps from '../../components/FlattenedSteps.astro'; +import MobileImageIcon from "~icons/zulip-icon/mobile-image" +import AttachmentIcon from "~icons/zulip-icon/attachment" +import { Steps } from '@astrojs/starlight/components'; +import StartComposing from "./include/_StartComposing.mdx" +import { Tabs, TabItem } from '@astrojs/starlight/components' + +Zulip supports attaching multiple files to messages, including images, +documents, sound, and video. You can edit the names of the files others see +after you [upload](#uploading-files) or +[share](#sharing-files-from-other-mobile-apps) them. + +For images and videos, a small preview will be shown directly in the message, if +there are up to 24 attachments. People reading the message can click on the +preview to [view the full-size image or video](/help/view-images-and-videos). + +## Uploading files + + + + + 1. Drag and drop one or more files anywhere in the Zulip app, + whether or not the compose box is open. + Zulip will upload the files, and insert named links using + [Markdown formatting](/help/format-your-message-using-markdown#links): + `[Link text](URL)`. + + + + + + You can [preview the message](/help/preview-your-message-before-sending) + before sending to see what your uploaded files will look like. + + + + + + + + 1. Copy and paste one or more files into the compose box. + Zulip will upload the files, and insert named links using + [Markdown formatting](/help/format-your-message-using-markdown#links): + `[Link text](URL)`. + + + + + + You can [preview the message](/help/preview-your-message-before-sending) + before sending to see what your uploaded files will look like. + + + + + + + + 1. Click the **paperclip** () + icon at the bottom of the compose box to select one or more files. + Zulip will upload the files, and insert named links using + [Markdown formatting](/help/format-your-message-using-markdown#links): + `[Link text](URL)`. + + + + + + You can [preview the message](/help/preview-your-message-before-sending) + before sending to see what your uploaded files will look like. + + + + + + 1. Navigate to a channel, topic, or direct message view. + 1. Tap the + **paperclip** (), + **image** (), + or **camera** () + button at the bottom of the app to select one or more files. Zulip will + upload the files, and insert named links using + [Markdown formatting](/help/format-your-message-using-markdown#links): + `[Link text](URL)`. + + + + + + +## Sharing files from other mobile apps + + + + + 1. In another mobile app, select text or one or more files, and tap the + **share** button. + 1. Tap the **Zulip** (logo) logo to share to Zulip. + 1. To send a channel message, select a channel and type a topic name. + To send a direct message, tap the **Direct message** tab, and choose + an existing direct message conversation or tap the **New DM** button + at the bottom of the screen and select message recipients. + 1. *(optional)* Write a message. + 1. Tap the **Send** button. + + + + + Implementation of this feature for the IOS version of the mobile app is + tracked [on GitHub](https://github.com/zulip/zulip-flutter/issues/54). + If you're interested in this feature, please react to the issue's + description with 👍. + + + +## Convert pasted to text to a file + +When pasting a large amount of text, you can convert it to a text file upload. + + + + + 1. Paste a large amount of text into the compose box (2,000+ characters). + 1. In the banner above the compose box, click **Yes, convert** to convert the + pasted text to a file. + + + + +## Named file example + +### What you type + +``` +[A whale of a good time](https://your.zulip.domain/user_uploads/1/46/IPvysqXEtiTG1ZdNBrwAZODi/whale-time.png) +``` + +### What it looks like + +![Markdown image](../../../../static/images/help/markdown-image.png) + +## File upload limits + +The Zulip Cloud Standard and Zulip Cloud Plus +[plans](https://zulip.com/plans/#cloud) include 5 GB of file storage per user. +Each uploaded file can be up to 1 GB. + +The Zulip Cloud Free [plan](https://zulip.com/plans/#cloud) includes a total of +5 GB of file storage. Each uploaded file can be up to 10 MB. + +In organizations on a self-hosted server, server administrators can configure +the maximum size for uploaded files via the `MAX_FILE_UPLOAD_SIZE` +[server setting][system-settings]. Setting it to 0 disables file uploads, and +hides the UI for uploading files from the web and desktop apps. + +[system-settings]: https://zulip.readthedocs.io/en/stable/production/settings.html + +## Related articles + +* [Manage your uploaded files](/help/manage-your-uploaded-files) +* [View images and videos](/help/view-images-and-videos) +* [Image, video and website previews](/help/image-video-and-website-previews) +* [Animated GIFs](/help/animated-gifs-from-giphy) diff --git a/starlight_help/src/content/docs/spoilers.mdx b/starlight_help/src/content/docs/spoilers.mdx new file mode 100644 index 0000000000..d8a1fa9912 --- /dev/null +++ b/starlight_help/src/content/docs/spoilers.mdx @@ -0,0 +1,62 @@ +--- +title: Spoilers +--- + +import ZulipTip from '../../components/ZulipTip.astro'; +import FlattenedSteps from '../../components/FlattenedSteps.astro'; +import SpoilersIntro from "./include/_SpoilersIntro.mdx" +import SpoilerIcon from "~icons/zulip-icon/spoiler" +import SpoilersExamples from "./include/_SpoilersExamples.mdx" +import StartComposing from "./include/_StartComposing.mdx" +import { Tabs, TabItem } from '@astrojs/starlight/components' + + + +## Insert spoiler formatting + + + + + + + 1. *(optional)* Select the text you want to hide inside the spoiler. + 1. Click the **Spoiler** () + icon at the bottom of the compose box to insert spoiler formatting. + 1. Replace `Header` with the desired heading text. + + + + You can also use the **Spoiler** + () icon + to remove existing spoiler formatting from the selected text. + + + + + + + + 1. To create a spoiler section, use triple backticks and the word spoiler + (\`\`\`\`spoiler\`) followed by an optional spoiler heading, some text, and triple + backticks at the end: + ```spoiler The spoiler heading + This content is initially hidden. + ``` + + + + A message can contain both spoilers and other content, and you can combine + spoilers with other formatting. + + + + +## Examples + + + +## 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) diff --git a/starlight_help/src/content/docs/star-a-message.mdx b/starlight_help/src/content/docs/star-a-message.mdx new file mode 100644 index 0000000000..953f491a12 --- /dev/null +++ b/starlight_help/src/content/docs/star-a-message.mdx @@ -0,0 +1,119 @@ +--- +title: Star a message +--- + +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 StarIcon from "~icons/zulip-icon/star" +import MessageLongPressMenu from "./include/_MessageLongPressMenu.mdx" +import StarFilledIcon from "~icons/zulip-icon/star-filled" +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 ViewStarredMessages from "./include/_ViewStarredMessages.mdx" +import TopicActions from "./include/_TopicActions.mdx" + +Starring messages is a good way to keep track of important messages, such as +tasks you need to go back to or documents you reference often. + +## Star a message + +Starred messages have a filled in star () +to their right. + + + + + + + 1. Click the **star** () icon. + + + + You can unstar a message using the same instructions used to star it. + + + + You can use Ctrl + S to star or unstar the selected + message. + + + + + + + + 1. Tap **Star message**. + + + + You can unstar a message by tapping **Unstar message** in the + long-press menu. + + + + +## View your starred messages + + + +## Unstar all messages in a topic + + + + + + + 1. Click **Unstar all messages in topic**. If you don't see this option, + then you have no starred messages in the selected topic. + 1. Approve by clicking **Confirm**. + + + + +## Unstar all messages + + + + + 1. Hover over **Starred messages** + in the **views** section of the left sidebar. + 1. Click on the **ellipsis** (). + 1. Click **Unstar all messages**. If you don't see this option, + then you have no starred messages. + 1. Approve by clicking **Confirm**. + + + + If the **views** section in the left sidebar is collapsed, click the + triangle to the left of **views** to uncollapse it. + + + + +## Toggle starred messages counter + +By default, Zulip displays the number of starred messages in the left +sidebar; this allows you to use them as an inbox of messages you'd +like to come back to. If you are using starred messages for something +else and would prefer not to see the count in your left sidebar, you +can disable that feature. + + + + + + + 1. Under **Left sidebar**, toggle **Show counts for starred messages**. + + + + +## Related articles + +* [Marking messages as unread](/help/marking-messages-as-unread) +* [Reading strategies](/help/reading-strategies) +* [Searching for messages](/help/search-for-messages) diff --git a/starlight_help/src/content/docs/start-a-call.mdx b/starlight_help/src/content/docs/start-a-call.mdx new file mode 100644 index 0000000000..d5c8eb49d8 --- /dev/null +++ b/starlight_help/src/content/docs/start-a-call.mdx @@ -0,0 +1,97 @@ +--- +title: Start a call +--- + +import ZulipNote from '../../components/ZulipNote.astro'; +import ZulipTip from '../../components/ZulipTip.astro'; +import FlattenedSteps from '../../components/FlattenedSteps.astro'; +import { Steps } from '@astrojs/starlight/components'; +import VideoCallIcon from "~icons/zulip-icon/video-call" +import StartComposing from "./include/_StartComposing.mdx" +import { Tabs, TabItem } from '@astrojs/starlight/components' +import VoiceCallIcon from "~icons/zulip-icon/voice-call" + +Zulip makes it convenient to add a video or voice call link to any message, +using the call provider (Jitsi, Zoom, etc.) +[configured](/help/configure-call-provider) by your organization's +administrators. + +## Start a video call + + + When you join a call, you may need to log in to a separate account for the + call provider (Jitsi, Zoom, etc.). + + + + + + + + 1. Click the **Add video call** () + icon at the bottom of the compose box. This will insert a **Join video call.** + link into your message. + 1. Send the message. + 1. Click on the link in the message to start or join the call. + + + + You can replace the "Join video call." label for the link with any text you + like. + + + + + 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/1000). If + you're interested in this feature, please react to the issue's + description with 👍. + + + +## Start a voice call + + + + + + + 1. Click the **Add voice call** () icon at the bottom of the compose box. This + will insert a **Join voice call.** link into your message. + 1. Send the message. + 1. Click on the link in the message to start or join the call. + + + + You can replace the "Join voice call." label for the link with any text you + like. + + + + +## Unlink your Zoom account from Zulip + +If you linked your Zoom account to Zulip, and no longer want it to be connected, +you can unlink it. + + + 1. Log in to the [Zoom App Marketplace](https://marketplace.zoom.us/), and + select **Manage**. + 1. Select **Added Apps** and click the **Remove** button next to the Zulip app. + 1. Click **Confirm**. + + +[big-blue-button-configuration]: https://zulip.readthedocs.io/en/stable/production/video-calls.html#bigbluebutton + +[zoom-configuration]: https://zulip.readthedocs.io/en/stable/production/video-calls.html#zoom + +## Related articles + +* [Configure call provider](/help/configure-call-provider) +* [Jitsi Meet integration](/integrations/doc/jitsi) +* [Zoom integration](/integrations/doc/zoom) +* [BigBlueButton integration](/integrations/doc/big-blue-button) +* [Insert a link](/help/insert-a-link) diff --git a/starlight_help/src/content/docs/starting-a-new-direct-message.mdx b/starlight_help/src/content/docs/starting-a-new-direct-message.mdx new file mode 100644 index 0000000000..83d68241ea --- /dev/null +++ b/starlight_help/src/content/docs/starting-a-new-direct-message.mdx @@ -0,0 +1,14 @@ +--- +title: Starting a new direct message +--- + +import StartingANewDirectMessage from "./include/_StartingANewDirectMessage.mdx" + + + +## Related articles + +* [Getting started with Zulip](/help/getting-started-with-zulip) +* [Introduction to topics](/help/introduction-to-topics) +* [Replying to messages](/help/replying-to-messages) +* [Messaging tips & tricks](/help/messaging-tips) diff --git a/starlight_help/src/content/docs/status-and-availability.mdx b/starlight_help/src/content/docs/status-and-availability.mdx new file mode 100644 index 0000000000..0dfea9210b --- /dev/null +++ b/starlight_help/src/content/docs/status-and-availability.mdx @@ -0,0 +1,233 @@ +--- +title: Status and availability +--- + +import SelfUserCard from "./include/_SelfUserCard.mdx" +import NavigationSteps from "../../components/NavigationSteps.astro" +import UserCircleActiveIcon from "~icons/zulip-icon/user-circle-active" +import ZulipTip from '../../components/ZulipTip.astro'; +import FlattenedSteps from '../../components/FlattenedSteps.astro'; +import UserCircleOfflineIcon from "~icons/zulip-icon/user-circle-offline" +import ClearStatus from "./include/_ClearStatus.mdx" +import { Steps } from '@astrojs/starlight/components'; +import MobileMenu from "./include/_MobileMenu.mdx" +import SetStatus from "./include/_SetStatus.mdx" +import PersonalMenu from "./include/_PersonalMenu.mdx" +import { Tabs, TabItem } from '@astrojs/starlight/components' +import UserCircleIdleIcon from "~icons/zulip-icon/user-circle-idle" + +Status and availability let everyone know roughly how quickly you'll be +responding to messages. + +A **status** is a customizable emoji, along with a short message. A typical +status might be "📅 In a meeting" or "🏠 Working remotely". To make it easy to +notice, the status emoji is shown next to your name in the sidebars, message +feed, and compose box. + +Your **availability** is a colored dot (like ) that indicates if you're currently active on Zulip, idle, +or offline. You can also [go invisible](#invisible-mode) to appear offline +to other users. + +## Statuses + +### Set a status + +You can set a status emoji, status message, or both. + + + + + + + + + + + + + + + + + + + + + + + 1. Tap **My profile**. + 1. Tap **Set status** or **Status**. + 1. Select one of the common statuses, or choose any emoji and/or write + a short message. + 1. Tap **Save**. + + + + +### Clear a status + + + + + + + + + + + + + + + + + + + + + + + 1. Tap **My profile**. + 1. Tap **Status**. + 1. Tap **Clear**, and then **Save** in the top right corner of the app. + + + + +### View a status + +Status emoji are shown next to a user's name in the sidebars, message feed, +and compose box in the web and desktop apps, and next to the user's profile +picture and name in the mobile app. + +Status emoji and status messages are also shown on [user cards](/help/user-cards) +in the web and desktop apps. + + + + + 1. Hover over a user's name in the right sidebar, or in the **Direct messages** + section in the left sidebar, to view their status message if they have one + set. + + + + You can also click on a user's profile picture or name on a message they + sent to view their status in their **user card**, or configure status text + to always be shown in the right sidebar. + + + + + + 1. Tap on a user's profile picture or name to view their status message. + 1. If they have one set, it will appear under their name on their profile. + + + + +### Configure how statuses are displayed + +You can choose whether or not status text is displayed in the right sidebar. +With the compact option, only status emoji are shown. + + + + + + + 1. Under **Information**, select **Compact** or **Show status and text** for the + user list style. + + + + You can always hover over a user's name in the right sidebar to view their + status message if they have one set. + + + + +## Availability + +There are three availability states: + +* **Active** (): Zulip is open and in focus on web, + desktop or mobile, or was in the last 140 seconds. +* **Idle** (): Zulip is open on your computer (either + desktop or web), but you are not active. +* **Offline** (): Zulip is not open on your computer, + or you have turned on invisible mode. + +### View availability + + + + + 1. View a user's availability on the [user list](/help/user-list) in the right + sidebar, the [direct messages](/help/direct-messages) list in the left + sidebar, or their [user card](/help/user-cards). If there is no availability + indicator, the user is offline. + + + + You can see when someone offline was last active by hovering over their + name in the left or right sidebar. + + + + + + 1. Tap on a user's profile picture or name. Their availability appears to the + left of their name on their profile. + + + + +### Invisible mode + +Zulip supports the privacy option of never updating the availability +information for your account. The result is that you will always +appear to other users as **Offline**, regardless of your activity in +Zulip. + +With this setting, your "Last active" time displayed to other users in +the UI will be frozen as the approximate time you enabled this setting. +Your activity will still be included in your organization's [statistics](/help/analytics). + + + Consider also [not + allowing](/help/read-receipts#configure-whether-zulip-lets-others-see-when-youve-read-messages) + other users to see when you have read messages. + + +### Toggle invisible mode + + + + + + + 1. To enable, you'll select **Go invisible**. + 1. To disable, you'll select **Turn off invisible mode**. + + + + You can also toggle this setting in the **Account & privacy** + tab of your **Personal settings** menu. + + + + + + + + 1. Tap **My profile**. + 1. Toggle **Invisible mode**. + + + + +## Related articles + +* [Typing notifications](/help/typing-notifications) +* [Read receipts](/help/read-receipts) diff --git a/starlight_help/src/content/docs/subscribe-users-to-a-channel.mdx b/starlight_help/src/content/docs/subscribe-users-to-a-channel.mdx new file mode 100644 index 0000000000..b36a9138b3 --- /dev/null +++ b/starlight_help/src/content/docs/subscribe-users-to-a-channel.mdx @@ -0,0 +1,25 @@ +--- +title: Subscribe users to a channel +--- + +import SubscribeUserToChannel from "./include/_SubscribeUserToChannel.mdx" + +Organization [administrators](/help/user-roles) can +[configure](/help/configure-who-can-invite-to-channels#configure-who-can-subscribe-others-to-channels-in-general) +who can subscribe other users to channels. Channel administrators can +configure who can +[subscribe](/help/configure-who-can-invite-to-channels#configure-who-can-subscribe-anyone-to-a-specific-channel) +anyone to a particular channel. + + + +## Related articles + +* [Introduction to channels](/help/introduction-to-channels) +* [Unsubscribe users from a channel](/help/unsubscribe-users-from-a-channel) +* [Manage a user's channel subscriptions](/help/manage-user-channel-subscriptions) +* [Configure who can subscribe other users to channels](/help/configure-who-can-invite-to-channels) +* [Set default channels for new users](/help/set-default-channels-for-new-users) +* [User roles](/help/user-roles) +* [Mention a user or group](/help/mention-a-user-or-group) +* [View channel subscribers](/help/view-channel-subscribers) diff --git a/starlight_help/src/content/docs/support-zulip-project.mdx b/starlight_help/src/content/docs/support-zulip-project.mdx new file mode 100644 index 0000000000..409c7e2d06 --- /dev/null +++ b/starlight_help/src/content/docs/support-zulip-project.mdx @@ -0,0 +1,91 @@ +--- +title: Support the Zulip project +--- + +import SupportingZulipMotivation from "./include/_SupportingZulipMotivation.mdx" + + + +The Zulip community (which includes you!) is a huge part of what makes Zulip +successful. If you appreciate Zulip, there are many different ways you can +support the project. Some of these will only take a few minutes of your +time, but still make a big difference. + +* [Support Zulip financially](#support-zulip-financially): Sponsoring Zulip + helps fund free [Zulip Cloud Standard](https://zulip.com/plans/) hosting for + hundreds of open source projects, research communities, and other worthy + organizations. +* [Help others find Zulip](#help-others-find-zulip): As a business that's + [growing sustainably](https://zulip.com/values/) without venture capital + funding, Zulip cannot afford splashy ad campaigns to compete with giant + corporations like Salesforce (Slack) and Microsoft (Teams). Zulip depends + on users and other members of the community to spread the word about the + difference that using Zulip's organized team chat has made for you or your + organization. +* [Help improve Zulip](#help-improve-zulip): Zulip is developed by a [vibrant + open-source community](https://zulip.com/team/), and there are many ways to + contribute even without writing a single line of code. + +## Support Zulip financially + +You can sponsor Zulip through the [GitHub sponsors +program](https://github.com/sponsors/zulip) (preferred), on +[Patreon](https://patreon.com/zulip), or on [Open +Collective](https://opencollective.com/zulip). + +## Help others find Zulip + +* [**Link to Zulip**](/help/linking-to-zulip-website) from your organization's + website. In addition to providing information for anyone browsing your + website, this helps people find Zulip in Google and other search engines. +* [**List your organization**](/help/communities-directory) in the [Zulip + communities directory](https://zulip.com/communities/). Browsing open + communities helps folks see how others are using Zulip, and learn best + practices. +* **Star** Zulip on GitHub. There are four main repositories: + [server/web](https://github.com/zulip/zulip), + [mobile](https://github.com/zulip/zulip-flutter), + [desktop](https://github.com/zulip/zulip-desktop), and + [Python API](https://github.com/zulip/python-zulip-api). +* **Review** Zulip on product comparison websites, such as + [G2](https://www.g2.com/products/zulip/reviews/start) and [Software + Advice](https://reviews.softwareadvice.com/new/316022). Organizations rely on + review sites more and more when choosing software for their team, and sharing + your experience with Zulip (good or bad) helps them evaluate whether Zulip + might work for their needs. +* **Subscribe** to [our blog](https://blog.zulip.org/), and share our posts. +* **Mention** Zulip on social media, or like and retweet [Zulip's + tweets](https://twitter.com/zulip), or retoot [Zulip's + toots](https://fosstodon.org/@zulip). +* **Share** your Zulip story on your blog, or get it posted [on the Zulip + website](https://zulip.com/use-cases/#customer-stories) (contact + [support@zulip.com](mailto:support@zulip.com) to learn more). +* **Tell** your friends and colleagues about your Zulip experience. + +## Help improve Zulip + +* **Report issues**, including both [feature + requests](https://zulip.readthedocs.io/en/latest/contributing/suggesting-features.html) + and [bug + reports](https://zulip.readthedocs.io/en/latest/contributing/reporting-bugs.html). + Many improvements to the Zulip app start with a user's suggestion. +* [**Give + feedback**](https://zulip.readthedocs.io/en/latest/contributing/suggesting-features.html#evaluation-and-onboarding-feedback) + if you are evaluating or using Zulip. +* [**Translate**](https://zulip.readthedocs.io/en/latest/translating/translating.html) + Zulip into your language. Zulip has been translated into over 25 languages by + an amazing group of volunteers, and you can help expand, improve, and + maintain the translation for your language, or start working on a language + that hasn't been covered yet. +* [**Contribute + code**](https://zulip.readthedocs.io/en/latest/contributing/contributing.html) + to the Zulip open-source project. To make it easy for contributors from a + variety of backgrounds to get started, we have invested into making Zulip’s + code uniquely readable, well tested, and easy to modify. + +## Related articles + +* [Zulip project values](https://zulip.com/values/) +* [Linking to Zulip](/help/linking-to-zulip-website) +* [Zulip communities directory](/help/communities-directory) +* [Contact Zulip](/help/contact-support) diff --git a/starlight_help/src/content/docs/supported-browsers.mdx b/starlight_help/src/content/docs/supported-browsers.mdx new file mode 100644 index 0000000000..e020a671d8 --- /dev/null +++ b/starlight_help/src/content/docs/supported-browsers.mdx @@ -0,0 +1,32 @@ +--- +title: Supported browsers +--- + +import ZulipTip from '../../components/ZulipTip.astro'; + +In addition to the [mobile and desktop apps](https://zulip.com/apps/), +Zulip works great in all major modern web browsers. We recommend +pinning the Zulip tab in your favorite browser, so that it's always +easy to find. + +For the best user experience, the latest stable versions of the +browsers below are recommended. + +* [Chrome](https://www.google.com/chrome/) +* [Firefox](https://mozilla.org/en-US/firefox/browsers/) +* [Edge](https://microsoft.com/en-us/edge/) +* [Safari](https://apple.com/safari/) + +## Multi protocol chat apps + +Zulip is supported by most browser-based multi protocol desktop chat apps like +[Rambox](https://rambox.pro) and [Ferdium](https://ferdium.org/). + + + Choose an app that releases regular security updates. Running + an out-of-date app is a major security risk for your computer. + + +## Related articles + +* [Desktop installation guides](/help/desktop-app-install-guide) diff --git a/starlight_help/src/content/docs/switching-between-organizations.mdx b/starlight_help/src/content/docs/switching-between-organizations.mdx new file mode 100644 index 0000000000..dd8c7db146 --- /dev/null +++ b/starlight_help/src/content/docs/switching-between-organizations.mdx @@ -0,0 +1,17 @@ +--- +title: Switching between organizations +--- + +import SwitchingBetweenOrganizations from "./include/_SwitchingBetweenOrganizations.mdx" + +This article assumes you've [logged in](/help/logging-in) to each organization at least once. + + + +## Related articles + +* [Logging in](logging-in) +* [Logging out](logging-out) +* [Deactivate your account](deactivate-your-account) +* [Create your organization profile](create-your-organization-profile) +* [Joining a Zulip organization](/help/join-a-zulip-organization) diff --git a/starlight_help/src/content/docs/tables.mdx b/starlight_help/src/content/docs/tables.mdx new file mode 100644 index 0000000000..56b3276880 --- /dev/null +++ b/starlight_help/src/content/docs/tables.mdx @@ -0,0 +1,18 @@ +--- +title: Tables +--- + +import TablesIntro from "./include/_TablesIntro.mdx" +import TablesExamples from "./include/_TablesExamples.mdx" + + + +## Examples + + + +## 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) diff --git a/starlight_help/src/content/docs/text-emphasis.mdx b/starlight_help/src/content/docs/text-emphasis.mdx new file mode 100644 index 0000000000..caed53c7dd --- /dev/null +++ b/starlight_help/src/content/docs/text-emphasis.mdx @@ -0,0 +1,109 @@ +--- +title: Text emphasis +--- + +import FlattenedSteps from '../../components/FlattenedSteps.astro'; +import StrikethroughIcon from "~icons/zulip-icon/strikethrough" +import BoldIcon from "~icons/zulip-icon/bold" +import EmphasisExamples from "./include/_EmphasisExamples.mdx" +import KeyboardTip from '../../components/KeyboardTip.astro'; +import StartComposing from "./include/_StartComposing.mdx" +import ItalicIcon from "~icons/zulip-icon/italic" +import EmphasisIntro from "./include/_EmphasisIntro.mdx" +import { Tabs, TabItem } from '@astrojs/starlight/components' + + + +## Making text bold + + + + + + + 1. Select the text you want to format. + 1. Click the **Bold** () icon at the + bottom of the compose box. + + + + You can also use Ctrl + B to insert bold formatting. + + + + + + + + 1. To make text bold, use double asterisks (`**`) around the text: `**text**`. + + + + You can also use Ctrl + B to insert bold formatting. + + + + +## Making text italic + + + + + + + 1. Select the text you want to format. + 1. Click the **Italic** () icon at + the bottom of the compose box. + + + + You can also use Ctrl + I to insert italic formatting. + + + + + + + + 1. To make text italic, use single asterisks (`*`) around the text: `*text*`. + + + + You can also use Ctrl + I to insert italic formatting. + + + + +## Applying strikethrough formatting + + + + + + + 1. Select the text you want to format. + 1. Click the **Strikethrough** + () icon at the + bottom of the compose box. + + + + + + + + 1. To apply strikethrough formatting, use two tildes (`~~`) around the text: + `~~text~~`. + + + + +## Examples + + + +## 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) diff --git a/starlight_help/src/content/docs/topic-notifications.mdx b/starlight_help/src/content/docs/topic-notifications.mdx new file mode 100644 index 0000000000..401137e333 --- /dev/null +++ b/starlight_help/src/content/docs/topic-notifications.mdx @@ -0,0 +1,33 @@ +--- +title: Topic notifications +--- + +import AutomaticallyUnmuteTopicsInMutedChannels from "./include/_AutomaticallyUnmuteTopicsInMutedChannels.mdx" +import ConfigureNotificationsForFollowedTopics from "./include/_ConfigureNotificationsForFollowedTopics.mdx" +import AutomaticallyFollowTopics from "./include/_AutomaticallyFollowTopics.mdx" + +In Zulip, you can configure how you get notified about new messages for topics +you follow. + +In muted channels, topics you follow are automatically treated as +[unmuted](/help/mute-a-topic), and you can configure when to automatically +unmute topics. + +## Configure notifications for followed topics + + + +## Automatically follow topics + + + +## Automatically unmute topics in muted channels + + + +## Related articles + +* [Follow a topic](/help/follow-a-topic) +* [Channel notifications](/help/channel-notifications) +* [Mute or unmute a topic](/help/mute-a-topic) +* [Mute or unmute a channel](/help/mute-a-channel) diff --git a/starlight_help/src/content/docs/trying-out-zulip.mdx b/starlight_help/src/content/docs/trying-out-zulip.mdx new file mode 100644 index 0000000000..b2798685b5 --- /dev/null +++ b/starlight_help/src/content/docs/trying-out-zulip.mdx @@ -0,0 +1,50 @@ +--- +title: Trying out Zulip +--- + +import { Steps } from '@astrojs/starlight/components'; + +You can start by reading about how [Zulip’s](/hello/) unique +topic-based threading [combines the best of email and +chat](/why-zulip/) to make [remote work](https://zulip.com/for/business/) productive +and delightful. + +It's also easy to try out Zulip for yourself. + + + 1. **Check out the Zulip app**. You can: + * [View the Zulip development community](https://chat.zulip.org/?show_try_zulip_modal), + where hundreds of participants collaborate to improve Zulip. Many parts of + the community are open for [public access](/help/public-access-option), so + you can start exploring without creating an account. + * [See how Zulip is being used](https://zulip.com/communities/) in open + organizations that have opted in to be listed in the [Zulip communities + directory](/help/communities-directory). + 1. [Create a Zulip Cloud organization](https://zulip.com/new/) for free in just + a few minutes. This is a great way to explore Zulip even if you plan to + [self-host](https://zulip.com/self-hosting/). + 1. [Invite your teammates](/help/invite-users-to-join) to explore Zulip with you. + They will have a variety of perspectives on what's important in a chat app. + 1. **Run a week-long Zulip trial** with your team, without using any other chat tools. This + is the only way to truly experience how a new chat app will help your team + communicate. You can: + * Customize [organization settings](/help/customize-organization-settings) + and [settings for new users](/help/customize-settings-for-new-users), but + plan to adjust the details as you go. + * [Create](/help/create-channels) your initial + [channels](/help/introduction-to-channels), including a dedicated channel for + questions and feedback about using Zulip. + * Educate others about how to use Zulip's [topics](/help/introduction-to-topics), + and how to [move](/help/move-content-to-another-topic) any messages that + belong elsewhere. + * [Set up integrations](/help/set-up-integrations) so that your team can + experience all their regular workflows inside the Zulip app. + + +## Related articles + +* [Getting started with Zulip](/help/getting-started-with-zulip) +* [Moving to Zulip](/help/moving-to-zulip) +* [Zulip Cloud or self-hosting?](/help/zulip-cloud-or-self-hosting) +* [Migrating from other chat tools](/help/migrating-from-other-chat-tools) +* [Introduction to topics](/help/introduction-to-topics) diff --git a/starlight_help/src/content/docs/typing-notifications.mdx b/starlight_help/src/content/docs/typing-notifications.mdx new file mode 100644 index 0000000000..a44880dece --- /dev/null +++ b/starlight_help/src/content/docs/typing-notifications.mdx @@ -0,0 +1,56 @@ +--- +title: Typing notifications +--- + +import NavigationSteps from "../../components/NavigationSteps.astro" +import { Tabs, TabItem } from '@astrojs/starlight/components' +import FlattenedSteps from '../../components/FlattenedSteps.astro'; + +The Zulip web app displays typing notifications in [conversation +views](/help/reading-conversations) and the [direct message +feed](/help/direct-messages#go-to-direct-message-feed). Typing notifications are +not shown in channels with more than 100 subscribers. The mobile app displays +typing notifications in direct message conversations. + +Typing notifications are only sent while one is actively editing text in the +compose box or the [message editing](/help/edit-a-message) box. They disappear +if typing is paused for several seconds, if all the content of the message is +erased, or if the message is [saved as a +draft](/help/view-and-edit-your-message-drafts#save-a-draft). Just having the +compose box or message editing box open will not send a typing notification. + +## Disable sending typing notifications + +If you'd prefer that others not know whether you're typing, you can +configure Zulip to not send typing notifications. + + + + + + + 1. Under **Privacy**, toggle **Let recipients see when I'm typing direct + messages** and **Let recipients see when I'm typing messages in channels**. + + + + +## Disable seeing typing notifications + +If you'd prefer not to see notifications when others type, you can disable them. + + + + + + + 1. Under **Information**, toggle **Show when other users are typing**. + + + + +## Related articles + +* [Direct messages](/help/direct-messages) +* [Status and availability](/help/status-and-availability) +* [Read receipts](/help/read-receipts) diff --git a/starlight_help/src/content/docs/unsubscribe-from-a-channel.mdx b/starlight_help/src/content/docs/unsubscribe-from-a-channel.mdx new file mode 100644 index 0000000000..39c13e8167 --- /dev/null +++ b/starlight_help/src/content/docs/unsubscribe-from-a-channel.mdx @@ -0,0 +1,71 @@ +--- +title: Unsubscribe from a channel +--- + +import ChannelActions from "./include/_ChannelActions.mdx" +import NavigationSteps from "../../components/NavigationSteps.astro" +import ChannelLongPressMenu from "./include/_ChannelLongPressMenu.mdx" +import FlattenedSteps from '../../components/FlattenedSteps.astro'; +import MobileChannels from "./include/_MobileChannels.mdx" +import KeyboardTip from '../../components/KeyboardTip.astro'; +import { Tabs, TabItem } from '@astrojs/starlight/components' + +You can always unsubscribe from any channel in Zulip. + + + + + + + 1. Click **Unsubscribe**. + + + + + + + + + + 1. Tap **Unsubscribe**. + + + + +## Alternate methods to unsubscribe from a channel + +### Via subscribed channels + + + + + + + 1. Click the **unsubscribe from channel** + (checkmark) + icon to the left of a channel to unsubscribe from it. + + + + +### Via channel settings + + + + + + + 1. Click **Channel settings**. + 1. Click **Unsubscribe** near the top right corner of the channel settings panel. + + + + You can also use Shift + S to unsubscribe from the + selected channel. + + + + +## Related articles + +* [Manage a user's channel subscriptions](/help/manage-user-channel-subscriptions) diff --git a/starlight_help/src/content/docs/unsubscribe-users-from-a-channel.mdx b/starlight_help/src/content/docs/unsubscribe-users-from-a-channel.mdx new file mode 100644 index 0000000000..0b67247867 --- /dev/null +++ b/starlight_help/src/content/docs/unsubscribe-users-from-a-channel.mdx @@ -0,0 +1,22 @@ +--- +title: Unsubscribe users from a channel +--- + +import UnsubscribeUserFromChannel from "./include/_UnsubscribeUserFromChannel.mdx" + +Organization [administrators](/help/user-roles) can +unsubscribe users from any channel. Channel administrators can +configure who can +[unsubscribe](/help/configure-who-can-unsubscribe-others) anyone +from a particular channel. + + + +## Related articles + +* [Introduction to channels](/help/introduction-to-channels) +* [Unsubscribe from a channel](/help/unsubscribe-from-a-channel) +* [Subscribe users to a channel](/help/subscribe-users-to-a-channel) +* [Manage a user's channel subscriptions](/help/manage-user-channel-subscriptions) +* [User roles](/help/user-roles) +* [View channel subscribers](/help/view-channel-subscribers) diff --git a/starlight_help/src/content/docs/user-cards.mdx b/starlight_help/src/content/docs/user-cards.mdx new file mode 100644 index 0000000000..ee9675ec8d --- /dev/null +++ b/starlight_help/src/content/docs/user-cards.mdx @@ -0,0 +1,75 @@ +--- +title: User cards +--- + +import NavigationSteps from "../../components/NavigationSteps.astro" +import ZulipTip from '../../components/ZulipTip.astro'; +import FlattenedSteps from '../../components/FlattenedSteps.astro'; +import KeyboardTip from '../../components/KeyboardTip.astro'; +import RightSidebarUserCard from "./include/_RightSidebarUserCard.mdx" +import { Tabs, TabItem } from '@astrojs/starlight/components' + +In the web and desktop apps, user cards contain basic information about a user +or bot. User cards are also a handy starting point for actions such as a [viewing a +user's profile](/help/view-someones-profile) or [viewing the messages they've +sent](/help/view-messages-sent-by-a-user). + +## Information in a user's card + + + + * Their profile picture. + * Their name. + * Their [role](/help/user-roles) in the organization. + * Their [status and availability](/help/status-and-availability), and whether + the account has been [deactivated](/help/deactivate-or-reactivate-a-user). + * Their current [local time](/help/change-your-timezone). + * Their email address, if you [have + permission](/help/configure-email-visibility) to view it. + * The custom profile fields + [selected](/help/custom-profile-fields#display-custom-fields-on-user-card) by + administrators to be featured on user cards. + + + + * Its profile picture. + * Its name. + * Its owner's name. + * Its email address, if you [have + permission](/help/configure-email-visibility) to view it. + * Whether the bot has been [deactivated](/help/deactivate-or-reactivate-a-bot). + + + +## View someone's user card + + + + + + + + + You can also click on a user's profile picture or name on a message they sent. + + + + Alternatively, open someone's **user card** by selecting a message they sent, and + using the U shortcut. + + + + + + + + 1. Click on the name of a bot in the **Name** column to open its **user card**. + + + + +## Related articles + +* [Introduction to users](/help/introduction-to-users) +* [View someone's profile](/help/view-someones-profile) +* [Message actions](/help/message-actions) diff --git a/starlight_help/src/content/docs/user-groups.mdx b/starlight_help/src/content/docs/user-groups.mdx new file mode 100644 index 0000000000..0e657da1fa --- /dev/null +++ b/starlight_help/src/content/docs/user-groups.mdx @@ -0,0 +1,69 @@ +--- +title: User groups +--- + +import NavigationSteps from "../../components/NavigationSteps.astro" +import UserGroupsApplications from "./include/_UserGroupsApplications.mdx" +import UserGroupsIntro from "./include/_UserGroupsIntro.mdx" +import FlattenedSteps from '../../components/FlattenedSteps.astro'; +import { Steps } from '@astrojs/starlight/components'; +import CloudPaidPlansOnly from "./include/_CloudPaidPlansOnly.mdx" +import { Tabs, TabItem } from '@astrojs/starlight/components' + + + + + + + +You can add a group to another user group, making it easy to express your +organization's structure in Zulip's permissions system. + +## Browse and join user groups + + + + + + + 1. Scroll through the list of user groups. You can use the **search box** near + the top of the menu to filter the list by group name or description. + 1. Click the **join group** (plus) icon to the left of a user group to + join the group, if you have + [permission](/help/manage-user-groups#configure-group-permissions) to do so. + + + + +## Leave a group + + + + + + + 1. Click the **leave group** (checkmark) icon to the left of a user group to leave the + group, if you have + [permission](/help/manage-user-groups#configure-group-permissions) to do so. + + + + +## View a group's card + + + + + 1. Click on a user group mention in a message to open the **group card**. + + + + +## Related articles + +* [Mention a user or group](/help/mention-a-user-or-group) +* [View group members](/help/view-group-members) +* [Create user groups](/help/create-user-groups) +* [Manage user groups](/help/manage-user-groups) +* [Moving to Zulip](/help/moving-to-zulip) +* [User roles](/help/user-roles) diff --git a/starlight_help/src/content/docs/user-list.mdx b/starlight_help/src/content/docs/user-list.mdx new file mode 100644 index 0000000000..e53f223ce5 --- /dev/null +++ b/starlight_help/src/content/docs/user-list.mdx @@ -0,0 +1,96 @@ +--- +title: User list +--- + +import NavigationSteps from "../../components/NavigationSteps.astro" +import MoreVerticalIcon from "~icons/zulip-icon/more-vertical" +import FlattenedSteps from '../../components/FlattenedSteps.astro'; +import UserListIcon from "~icons/zulip-icon/user-list" +import { Steps } from '@astrojs/starlight/components'; +import KeyboardTip from '../../components/KeyboardTip.astro'; +import { Tabs, TabItem } from '@astrojs/starlight/components' + +In the Zulip web and desktop app, the right sidebar shows a list of users in +your organization. The user list has up to three section: + +* **This conversation**: Recent participants in the conversation you're viewing. +* **This channel**: Subscribers to the channel you're viewing. +* **Others**: Everyone else. + +In organizations with up to 600 users, everyone is shown. In larger +organizations, only users who have been active in the last two weeks are shown, +but everyone is included when you [search](#filter-users). +[Deactivated users](/help/deactivate-or-reactivate-a-user) and +[bots](/help/bots-overview) are not listed. + +You can choose to have each user's name appear with their +[avatar](/help/change-your-profile-picture), or select a one of the more compact +user list styles. To avoid distraction, you can +[hide](#show-or-hide-the-user-list) the user list any time. + +Here is an overview of all the information and actions you can take in Zulip's +user list. + +![User list information and actions](../../../../static/images/help/user-list-actions.png) + +## Filter users + + + + + 1. If the user list is hidden, click the **user list** () icon in the upper right to show it. + 1. Type the name of the user you are looking for in the **Filter users** box at + the top of the right sidebar. + + + + You can also use the W keyboard shortcut to start searching for + a person. + + + + +## Configure user list style + + + + + 1. If the user list is hidden, click the **user list** () icon in the upper right to show it. + 1. Click the **ellipsis** () + to the right of the **Filter users** box. + 1. Toggle your preferred option for **User list style**. + + + + + + + + 1. Under **Information**, toggle your preferred option for **User list style**. + + + + +## Show or hide the user list + + + + + 1. Click the **user list** () + icon in the upper right. + + + + The W keyboard shortcut to filter users reveals the user list if + it is hidden. + + + + +## Related articles + +* [Introduction to users](/help/introduction-to-users) +* [View someone's profile](/help/view-someones-profile) +* [Status and availability](/help/status-and-availability) +* [Searching for messages](/help/search-for-messages) +* [Find administrators](/help/find-administrators) diff --git a/starlight_help/src/content/docs/user-roles.mdx b/starlight_help/src/content/docs/user-roles.mdx new file mode 100644 index 0000000000..e9299631ad --- /dev/null +++ b/starlight_help/src/content/docs/user-roles.mdx @@ -0,0 +1,90 @@ +--- +title: User roles +--- + +import NavigationSteps from "../../components/NavigationSteps.astro" +import FlattenedSteps from '../../components/FlattenedSteps.astro'; +import UserRolesIntro from "./include/_UserRolesIntro.mdx" +import ManageUserTabTip from "./include/_ManageUserTabTip.mdx" +import ViewUsersByRole from "./include/_ViewUsersByRole.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" + + + +You can also manage permissions with [custom user groups](/help/user-groups). + +## Roles + +* **Organization owner**: Can manage users, public channels, organization + settings, and billing. Organization owners can do anything that an + organization administrator can do. +* **Organization administrator**: Can manage users, public channels, and + organization settings. Cannot make someone an owner, or change an existing + owner's role. +* **Moderator**: Can do anything that members can do, plus additional + permissions [configured](/help/manage-permissions) by + your organization. +* **Member**: This is the default role for most users. Members have access to + all public channels. You can [configure different + permissions](/help/restrict-permissions-of-new-members) for **new members** + and **full members**, which is especially useful for [moderating open + organizations](/help/moderating-open-organizations). New members automatically + become full members after a configurable waiting period. +* **Guest**: Can view and send messages in channels they have been subscribed to. + Guests cannot see other channels, unless they have been specifically subscribed + to the channel. See [guest users documentation](/help/guest-users) for additional + details and configuration options. +* **Billing administrator**: The user who upgrades the organization to + a paid plan is, in addition to their normal role, a billing + administrator. Billing administrators can manage billing for the organization. + For example, someone from your billing department can be a **billing + administrator**, but not an **administrator** for the organization. + +## View users by role + + + +## Change a user's role + + + +An organization owner can change the role of any user. You can make yourself no +longer an owner only if there is at least one other owner for your organization. +An organization administrator cannot make someone an owner, or change an +existing owner's role. + + + + + + + 1. Under **User role**, select a [role](#roles). + 1. Click **Save changes**. The new permissions will take effect immediately. + + + + + + + + + + 1. Find the user you would like to manage. Click the **manage bot** + () icon to the right + of their name. + 1. Under **User role**, select a [role](#roles). + 1. Click **Save changes**. The new permissions will take effect immediately. + + + + +## Related articles + +* [Guest users](/help/guest-users) +* [User groups](/help/user-groups) +* [Manage permissions](/help/manage-permissions) +* [Manage a user](/help/manage-a-user) +* [Deactivate or reactivate a user](/help/deactivate-or-reactivate-a-user) diff --git a/starlight_help/src/content/docs/using-zulip-for-a-class.mdx b/starlight_help/src/content/docs/using-zulip-for-a-class.mdx new file mode 100644 index 0000000000..330df910b9 --- /dev/null +++ b/starlight_help/src/content/docs/using-zulip-for-a-class.mdx @@ -0,0 +1,100 @@ +--- +title: Using Zulip for a class +--- + +import ZulipTip from '../../components/ZulipTip.astro'; + +Welcome to Zulip! This pages offers some tips for [using Zulip for a +class](https://zulip.com/for/education/). If this is your first time using Zulip, we +recommend checking out [Getting started with +Zulip](/help/getting-started-with-zulip) to get oriented. + +Zulip works great as the communication hub for your class, providing a +single place for: + +* [Posting lecture notes and announcements](#posting-lecture-notes-and-announcements) +* [Answering students’ questions](#answering-students-questions) +* Collecting feedback from students +* [Coordination among teaching staff](#coordination-among-teaching-staff) +* [Virtual office hours](#virtual-office-hours) + +## Posting lecture notes and announcements + + + [Subscribe to email notifications](/help/channel-notifications) for + channels such as **#announcements** to make sure you never miss an important message. + + +Many classes use a dedicated channel to post general announcements, for example: + +* **#announcements** > **office hours**: My office hours this week + will be rescheduled from `Mon, Oct 11 2021, 1:00 PM` to `Thu, Oct 14 2021, 3:30 PM`. + +Share lecture notes and reading materials with [drag-and-drop file +uploads](/help/share-and-upload-files), for example: + +* **#Unit 3: Sorting algorithms** > **lecture notes**: Here are the notes + from today’s lecture. [lecture notes 10/2.pdf](/help/using-zulip-for-a-class) You can view a recording of the lecture [here](/help/using-zulip-for-a-class). + +### Formatting tips + +* You can [post a time](/help/format-your-message-using-markdown#global-times) + that everyone will see in their own time zone. +* Share URLs as [named links](/help/format-your-message-using-markdown#links). + +## Answering students’ questions + +In Zulip, channels determine who receives a message. Topics are +light-weight subjects for individual conversations. You can more about +[channels](introduction-to-channels) and [topics](/help/introduction-to-topics). + +Zulip works best when each conversation has its own topic. When you +have a question to ask, simply start a new topic! For example, one +might see the following topics in a channel where a lecture and the +corresponding assignment are being discussed: + +* problem 2a clarification +* question about slide 7 +* code not compiling +* LaTeX diagram help + +Zulip will show auto-complete suggestions for existing topics as you +type, which helps surface relevant previous conversations. You can +also use the search bar to check whether a question has already +been addressed. + +You can [mention](/help/mention-a-user-or-group) the person who asked +a question to make sure they see timely answers. + +### Resolving topics + +When a question has been answered, you can [mark a topic as +resolved](/help/resolve-a-topic). This makes it easy for course +staff to see which conversations still require their attention. + +## Coordination among teaching staff + +Use private channels to coordinate among course staff, for example: + +* **#staff** > **homework 2 exercise 3b**: How many points should I + take off for this? The assignment says clearly to use Python 3 syntax. + + ``` + print result + ``` + +## Virtual office hours + +Zulip works great for virtual office hours! With a dedicated thread +for each question, it's easy to have several discussions at once. + +* Course staff can respond to multiple questions in parallel, making + efficient use of their time. +* Students can participate in real time, or learn by reading the + conversations afterwards. + +## Related articles + +* [Getting started with Zulip](/help/getting-started-with-zulip) +* [Moving to Zulip](/help/moving-to-zulip) +* [Message formatting](/help/format-your-message-using-markdown) diff --git a/starlight_help/src/content/docs/using-zulip-via-email.mdx b/starlight_help/src/content/docs/using-zulip-via-email.mdx new file mode 100644 index 0000000000..fc2c8b5298 --- /dev/null +++ b/starlight_help/src/content/docs/using-zulip-via-email.mdx @@ -0,0 +1,50 @@ +--- +title: Using Zulip via email +--- + +import { Steps } from '@astrojs/starlight/components'; +import NavigationSteps from "../../components/NavigationSteps.astro" +import FlattenedSteps from '../../components/FlattenedSteps.astro'; + +With Zulip, it is possible for some members of your organization to participate +from their email client, without opening the Zulip app after the initial +setup is complete. + +## Subscribe a Zulip channel to a mailing list + + + 1. Create a mailing list to use with Zulip, or use an existing one. + 1. Create a Zulip channel that will receive mailing list traffic, or + use an existing one. + 1. [Generate an email + address](/help/message-a-channel-by-email#message-a-channel-by-email_1) for + the channel you created. + 1. Add the email address for the channel to the mailing list. + + +New emails sent to the email list will now be mirrored to the channel. + +## Setup instructions for email users + +If you want to interact with Zulip primarily (or entirely) via your email client: + + + 1. [Subscribe](/help/introduction-to-channels#browse-and-subscribe-to-channels) to any channels you are + interested in. + + + + 1. In the **Notification triggers** table, make sure both of the checkboxes + under **Email** are checked. + 1. Close the Zulip window. Zulip does not send email notifications + while you are actively engaging with the web application. + + +New Zulip messages will now be delivered to your email account. You +can reply directly to the emails coming from Zulip, and your replies +will be posted in the appropriate topic or direct message +conversation on Zulip. + +## Related articles + +* [Message a channel by email](/help/message-a-channel-by-email) diff --git a/starlight_help/src/content/docs/verify-your-message-was-successfully-sent.mdx b/starlight_help/src/content/docs/verify-your-message-was-successfully-sent.mdx new file mode 100644 index 0000000000..e24478f8bd --- /dev/null +++ b/starlight_help/src/content/docs/verify-your-message-was-successfully-sent.mdx @@ -0,0 +1,38 @@ +--- +title: Verify your message was successfully sent +--- + +import RefreshIcon from "~icons/fa/refresh" +import TimesCircleIcon from "~icons/fa/times-circle" + +When you send a message, it first goes to a Zulip server, and then the Zulip +server sends it out to all the recipients. + +Sometimes there can be delays if your device is on a poor network +connection. Zulip lets you know when your message successfully reaches the +server. + +## Verify that a message reached the Zulip server + +Look for a **timestamp** (like `4:53`) on the right side of the message. If +you see a timestamp, the message successfully reached the server. + +You can see what a message without a timestamp looks like by disconnecting +your computer from the internet, and sending a message. + +## When to resend + +By default, Zulip will try to resend the message when it is re-connected to +the internet. + +If Zulip gives up (or if the Zulip server returns an error), it will +add two **red icons** ( ) to the right side of +the message. If you don't see the red icons, there is no need to resend. + +If you do see the red icons, you can either + +* Click **resend** () + to attempt a resend. +* Click **cancel** () + to delete the message. +* Reload the page to cancel all the messages with red icons. diff --git a/starlight_help/src/content/docs/view-a-messages-edit-history.mdx b/starlight_help/src/content/docs/view-a-messages-edit-history.mdx new file mode 100644 index 0000000000..40cfcd49ef --- /dev/null +++ b/starlight_help/src/content/docs/view-a-messages-edit-history.mdx @@ -0,0 +1,37 @@ +--- +title: View a message's edit history +--- + +import { Steps } from '@astrojs/starlight/components'; +import MessageEditHistoryIntro from "./include/_MessageEditHistoryIntro.mdx" +import { Tabs, TabItem } from '@astrojs/starlight/components' +import KeyboardTip from '../../components/KeyboardTip.astro'; + + + +## View a message's edit history + + + + + 1. Choose a message in the message feed. + 1. Click on the message's **edited** or **moved** label shown next to the + sender's name, or to the left of the message, to open the edit history. If + you don't see such a label, the message has not been edited or moved. + + + + You can use Shift + H to view the edit history of the + selected message. + + + + +## Related articles + +* [Edit a message](/help/edit-a-message) +* [Delete a message](/help/delete-a-message) +* [Move content to another topic](/help/move-content-to-another-topic) +* [Move content to another channel](/help/move-content-to-another-channel) +* [Restrict message editing and deletion](/help/restrict-message-editing-and-deletion) +* [Restrict message edit history access](/help/restrict-message-edit-history-access) diff --git a/starlight_help/src/content/docs/view-all-bots-in-your-organization.mdx b/starlight_help/src/content/docs/view-all-bots-in-your-organization.mdx new file mode 100644 index 0000000000..2d87e786b3 --- /dev/null +++ b/starlight_help/src/content/docs/view-all-bots-in-your-organization.mdx @@ -0,0 +1,25 @@ +--- +title: View all bots in your organization +--- + +import NavigationSteps from "../../components/NavigationSteps.astro" +import FlattenedSteps from '../../components/FlattenedSteps.astro'; + +You can view a list of all bots in your organization, including deactivated bots. + +Organization [administrators](/help/user-roles) can also +[deactivate](/help/deactivate-or-reactivate-a-bot), +[reactivate](/help/deactivate-or-reactivate-a-bot), or +[manage](/help/manage-a-bot#manage-a-bot-in-your-organization) any bot on the list. + + + + + +## Related articles + +* [Bots overview](/help/bots-overview) +* [Add a bot or integration](/help/add-a-bot-or-integration) +* [Manage a bot](/help/manage-a-bot) +* [Deactivate or reactivate a bot](/help/deactivate-or-reactivate-a-bot) +* [View your bots](/help/view-your-bots) diff --git a/starlight_help/src/content/docs/view-and-edit-your-message-drafts.mdx b/starlight_help/src/content/docs/view-and-edit-your-message-drafts.mdx new file mode 100644 index 0000000000..0a8eab7910 --- /dev/null +++ b/starlight_help/src/content/docs/view-and-edit-your-message-drafts.mdx @@ -0,0 +1,178 @@ +--- +title: Draft messages +--- + +import ZulipNote from '../../components/ZulipNote.astro'; +import CloseIcon from "~icons/zulip-icon/close" +import MoreVerticalIcon from "~icons/zulip-icon/more-vertical" +import FlattenedSteps from '../../components/FlattenedSteps.astro'; +import GoToDraftMessages from "./include/_GoToDraftMessages.mdx" +import KeyboardTip from '../../components/KeyboardTip.astro'; +import TrashIcon from "~icons/zulip-icon/trash" +import StartComposing from "./include/_StartComposing.mdx" +import SendIcon from "~icons/zulip-icon/send" +import { Tabs, TabItem } from '@astrojs/starlight/components' + +Zulip automatically saves the content of your message as a draft when you close +the compose box, ensuring that you never lose your work. When you start +composing, the most recently edited draft for the conversation you are composing +to automatically appears in the compose box. + + + **Note**: Drafts are local to your client, and are not synced to + other devices and browsers. + + +## Save a draft + +### Save a draft and stop composing + + + + + + + 1. Type at least 3 characters of text into the compose box. + 1. Close the compose box. For example, you can click the + **close** () icon in the top right + corner of the compose box, or click on an empty area of the app to close the + compose box and save your message as a draft. + + + + You can also use Esc to close the compose box and save your + message as a draft. + + + + +### Save a draft and start a new message + + + + + + + 1. Click on the **ellipsis** () + in the bottom right corner of the compose box, next to the **Send** + () button. + 1. Select **Save draft and start a new message**. + + + + +## Restore a draft + +To make it easier to find the draft you are looking for, drafts for the +conversation you are composing to are shown at the top of the drafts list in the +web and desktop apps. If you have saved drafts for the current conversation, the +counter next to the **Drafts** button in the compose box shows how many there are. + + + + + + + 1. Click on the draft you want to restore. + + + + You can also use D to bring up your list of saved drafts, and + Enter within the drafts view to restore the selected draft. + + + + + + + + 1. Click the **Drafts** button on the right side of the compose box. + 1. Click on the draft you want to restore. + + + + You can also use D to bring up your list of saved drafts, and + Enter within the drafts view to restore the selected draft. + + + + +## Delete drafts + +### Delete a draft + + + + + + + 1. Click the **delete** () icon on the draft you + want to delete. + + + + You can also use D to bring up your list of saved drafts, and + Backspace within the drafts view to delete the selected draft. + + + + + + + + 1. Click the **Drafts** button on the right side of the compose box. + 1. Click the **delete** () icon on the draft you + want to delete. + + + + You can also use D to bring up your list of saved drafts, and + Backspace within the drafts view to delete the selected draft. + + + + +### Delete multiple drafts + + + + + + + 1. Click **Select all drafts** in the upper right corner of + the drafts view, or select the drafts you want to delete + by toggling the checkboxes on the right. + 1. Click the **delete** () icon in the + upper right corner of the drafts view to delete all selected drafts. + + + + You can also use D to bring up your list of saved drafts. + + + + + + + + 1. Click the **Drafts** button on the right side of the compose box. + 1. Click **Select all drafts** in the upper right corner of + the drafts view, or select the drafts you want to delete + by toggling the checkboxes on the right. + 1. Click the **delete** () icon in the + upper right corner of the drafts view to delete all selected drafts. + + + + You can also use D to bring up your list of saved drafts. + + + + +## Related articles + +* [Schedule a message](/help/schedule-a-message) +* [Preview messages before sending](/help/preview-your-message-before-sending) +* [Verify a message was sent](/help/verify-your-message-was-successfully-sent) +* [Edit a message](/help/edit-a-message) +* [Delete a message](/help/delete-a-message) diff --git a/starlight_help/src/content/docs/view-channel-information.mdx b/starlight_help/src/content/docs/view-channel-information.mdx new file mode 100644 index 0000000000..75bc93b7ad --- /dev/null +++ b/starlight_help/src/content/docs/view-channel-information.mdx @@ -0,0 +1,58 @@ +--- +title: View channel information +--- + +import { Tabs, TabItem } from '@astrojs/starlight/components' +import GoToChannel from "./include/_GoToChannel.mdx" +import FlattenedSteps from '../../components/FlattenedSteps.astro'; + +When viewing a [topic](/help/introduction-to-topics) or a [channel +feed](/help/channel-feed), you can find the name, description and subscriber +count for the current channel directly in your message view. + +## View channel name + + + + + + + 1. The channel's name appears in the navigation bar at the top of app. + + + + +## View channel description + + + + + + + 1. The channel's description appears in the navigation bar at the top of app. If + the description doesn't fit in the navigation bar, hover over it with the + mouse to view it in full. + + + + +## View channel subscriber count + + + + + + + 1. Hover over the channel's name in the navigation bar at the top of app with + the mouse to see the subscriber count. + + + + +## Related articles + +* [Introduction to channels](/help/introduction-to-channels) +* [View channel subscribers](/help/view-channel-subscribers) +* [Pin information](/help/pin-information) +* [Rename a channel](/help/rename-a-channel) +* [Change a channel's description](/help/change-the-channel-description) diff --git a/starlight_help/src/content/docs/view-channel-subscribers.mdx b/starlight_help/src/content/docs/view-channel-subscribers.mdx new file mode 100644 index 0000000000..beb5bf9349 --- /dev/null +++ b/starlight_help/src/content/docs/view-channel-subscribers.mdx @@ -0,0 +1,57 @@ +--- +title: View channel subscribers +--- + +import NavigationSteps from "../../components/NavigationSteps.astro" +import ZulipTip from '../../components/ZulipTip.astro'; +import FlattenedSteps from '../../components/FlattenedSteps.astro'; +import ChannelMenuSubscribersTabTip from "./include/_ChannelMenuSubscribersTabTip.mdx" +import { Steps } from '@astrojs/starlight/components'; +import SelectChannelViewSubscribers from "./include/_SelectChannelViewSubscribers.mdx" +import { Tabs, TabItem } from '@astrojs/starlight/components' + +Who is subscribed to a channel determines who receives the messages sent there. +All non-[guest](/help/guest-users) users can view public channels and subscribe +themselves. Organization administrators can +[configure](/help/configure-who-can-invite-to-channels) who can subscribe and +unsubscribe other users to channels. + +## View channel subscribers + + + + + + + 1. Select a channel. + + + + + + + + + + 1. Click on a channel in the left sidebar. + 1. View subscribers in the **In this channel** section in the right sidebar. If + the section is collapsed, click **In this channel** to reveal it. + + + + To see the full list of subscribers for a channel that has more than 600 + people subscribed, scroll to the bottom of the **In this channel** section, + and click **View all subscribers**. + + + + +## Related articles + +* [Introduction to channels](/help/introduction-to-channels) +* [View channel information](/help/view-channel-information) +* [Unsubscribe from a channel](/help/unsubscribe-from-a-channel) +* [Manage a user's channel subscriptions](/help/manage-user-channel-subscriptions) +* [Subscribe users to a channel](/help/subscribe-users-to-a-channel) +* [Unsubscribe users from a channel](/help/unsubscribe-users-from-a-channel) +* [Set default channels for new users](/help/set-default-channels-for-new-users) diff --git a/starlight_help/src/content/docs/view-group-members.mdx b/starlight_help/src/content/docs/view-group-members.mdx new file mode 100644 index 0000000000..2ef9915312 --- /dev/null +++ b/starlight_help/src/content/docs/view-group-members.mdx @@ -0,0 +1,38 @@ +--- +title: View group members +--- + +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'; + +User groups can have other [groups](/help/user-groups), +[roles](/help/user-roles), and individual [users](/help/introduction-to-users) +as members. + + + + + 1. Click on a user group mention in a message to open the **group card**. The + group's members will be listed on the card. + 1. If the group has a large number of members, click the **view all** link to + see the rest of the list. + + + + + + + + 1. Select a user group. + 1. Select the **Members** tab on the right. + + + + +## Related articles + +* [User groups](/help/user-groups) +* [Manage user groups](/help/manage-user-groups) +* [User roles](/help/user-roles) diff --git a/starlight_help/src/content/docs/view-images-and-videos.mdx b/starlight_help/src/content/docs/view-images-and-videos.mdx new file mode 100644 index 0000000000..2a997673e4 --- /dev/null +++ b/starlight_help/src/content/docs/view-images-and-videos.mdx @@ -0,0 +1,125 @@ +--- +title: View images and videos +--- + +import ZulipTip from '../../components/ZulipTip.astro'; +import { Steps } from '@astrojs/starlight/components'; +import KeyboardTip from '../../components/KeyboardTip.astro'; +import CopyIcon from "~icons/zulip-icon/copy" +import { Tabs, TabItem } from '@astrojs/starlight/components' + +Zulip shows previews of attached images and videos, unless previews are +[disabled](/help/image-video-and-website-previews) in your organization. +You can click on a preview to view an image in more detail, or to play a +video. Zulip also makes it convenient to browse all images and videos +attached to messages in your current view. + +## Use the image viewer + + + + + 1. Click an image preview to open the **image viewer**. + 1. You can interact with the image. + * Zoom in and out of the image + * Click and drag the image + * **Reset zoom** so that the image is recentered and back to its original size + * **Open** the image in a new browser tab + * **Download** the image + 1. Click anywhere outside the image to close the image viewer once you are done. + + + + You can click on the file name to download an image rather than viewing it + in the Zulip app. + + + + Use V to **open** the image viewer. Use Shift + + Z and Z to zoom in and out of the image. Use + V or Esc to **close** the image viewer. + + + + + + 1. Tap an image preview or file name to open the **image viewer**. + 1. You can interact with the image. + * Zoom in and out of the image + * Pan the image if you are zoomed in + * Tap the **copy** () + icon in the bottom left corner of the app to copy a link to the image + 1. Tap the **X** in the upper left corner of the app to close the image viewer + once you are done. + + + + +## Use the video player + + + + + 1. Click a video thumbnail to open the **video player**. + 1. You can interact with the video. + * **Play** the video + * Adjust the **volume** + * Watch in **full screen** mode + * **Open** the video in a new browser tab + * **Download** the video if it was uploaded to Zulip + * Adjust **playback speed** + * Turn on **picture-in-picture** + 1. Click anywhere outside the video to close the video player once you are done. + + + + You can click on the file name to open the video in a new browser tab + rather than viewing it in the Zulip app. + + + + Use V to **open** the video player. + Use ↑ and ↓ + to increase or decrease the volume. + Use V or Esc to **close** the video player. + + + + + + 1. Tap a video thumbnail, link, or file name to open the video in your device's + default browser. + 1. You can switch back to the Zulip app once you are done. + + + + +## Browse images and videos + +In the Zulip desktop or web app, you can browse the images and videos in +the current view. For example, if you're in a channel view, you'll be able +to browse through all the images and videos in that channel. If you do a +[search](/help/search-for-messages), the **viewer** will display all the +images and videos in messages matching that search. + + + + + 1. Click an image preview or video thumbnail to open the viewer. + 1. Browse by using the left and right arrow buttons at the bottom of the viewer. + 1. Click any image or video to display it. + + + + Use V to **open** the viewer. Use + ← and → + to scroll through the collection of images and videos. + + + + +## Related articles + +* [Manage your uploaded files](/help/manage-your-uploaded-files) +* [Share and upload files](/help/share-and-upload-files) +* [Image, video and website previews](/help/image-video-and-website-previews) diff --git a/starlight_help/src/content/docs/view-messages-sent-by-a-user.mdx b/starlight_help/src/content/docs/view-messages-sent-by-a-user.mdx new file mode 100644 index 0000000000..0ff0f01921 --- /dev/null +++ b/starlight_help/src/content/docs/view-messages-sent-by-a-user.mdx @@ -0,0 +1,45 @@ +--- +title: View messages sent by a user +--- + +import SelfUserCard from "./include/_SelfUserCard.mdx" +import ZulipTip from '../../components/ZulipTip.astro'; +import RightSidebarUserCard from "./include/_RightSidebarUserCard.mdx" +import FlattenedSteps from '../../components/FlattenedSteps.astro'; + +Zulip offers a convenient feature to search all messages sent by any user +including yourself. + +## View messages sent by a user + + + + + 1. Select **View messages sent** to view all messages sent by this user. + + +## View messages you've sent + + + + + 1. Select **View messages sent** to view all the messages you've sent. + + + + You can also search your messages by typing `sender:me` in the + search bar at the top of the app and pressing Enter. + + +## View direct messages with yourself + + + + + 1. Select **View messages with yourself** to view messages you sent to + yourself. + + +## Related articles + +* [Searching for messages](/help/search-for-messages) diff --git a/starlight_help/src/content/docs/view-someones-profile.mdx b/starlight_help/src/content/docs/view-someones-profile.mdx new file mode 100644 index 0000000000..7502620b4c --- /dev/null +++ b/starlight_help/src/content/docs/view-someones-profile.mdx @@ -0,0 +1,88 @@ +--- +title: View someone's profile +--- + +import ZulipTip from '../../components/ZulipTip.astro'; +import FlattenedSteps from '../../components/FlattenedSteps.astro'; +import { Steps } from '@astrojs/starlight/components'; +import RightSidebarViewProfile from "./include/_RightSidebarViewProfile.mdx" +import LinkIcon from "~icons/zulip-icon/link" +import { Tabs, TabItem } from '@astrojs/starlight/components' + +A user's profile displays key information about the user. + +## Information in a user's profile + + + + * Their name. + * Their [availability](/help/status-and-availability#availability). + * Their profile picture. + * Their email address, if you [have + permission](/help/configure-email-visibility) to view it. + * Their user ID. + * Their [role](/help/user-roles) in the organization. + * The date they joined the organization. + * Their current [local time](/help/change-your-timezone). + * Any [custom profile fields](/help/custom-profile-fields) they've filled out. + + Additional tabs showing: + + * The channels that the user is subscribed to. Note that the list is limited to + channels for which you have [permission to see all + subscribers](/help/channel-permissions). + * The [user groups](/help/user-groups) to which they belong. + + + + * Their name. + * Their [availability](/help/status-and-availability#availability) and + [status](/help/status-and-availability#statuses). + * Their email address, if you [have + permission](/help/configure-email-visibility) to view it. + * Their [role](/help/user-roles) in the organization. + * Any [custom profile fields](/help/custom-profile-fields) they've filled out. + + + +## View someone's profile + + + + + + + + + You can also click on a user's profile picture or name on a + message they sent to open their **user card**, and skip to + the last step. + + + + + + 1. Tap on a user's profile picture or name. + + + + +## Share someone's profile + + + + + + + 1. Click on the **link** () + icon to the right of their name to copy the URL for their profile. + + + + +## Related articles + +* [Introduction to users](/help/introduction-to-users) +* [Edit your profile](/help/edit-your-profile) +* [Custom profile fields](/help/custom-profile-fields) +* [User cards](/help/user-cards) diff --git a/starlight_help/src/content/docs/view-the-exact-time-a-message-was-sent.mdx b/starlight_help/src/content/docs/view-the-exact-time-a-message-was-sent.mdx new file mode 100644 index 0000000000..d3fee33106 --- /dev/null +++ b/starlight_help/src/content/docs/view-the-exact-time-a-message-was-sent.mdx @@ -0,0 +1,29 @@ +--- +title: View the exact time a message was sent +--- + +import { Steps } from '@astrojs/starlight/components'; +import { Tabs, TabItem } from '@astrojs/starlight/components' +import MessageLongPressMenu from "./include/_MessageLongPressMenu.mdx" +import FlattenedSteps from '../../components/FlattenedSteps.astro'; + + + + + 1. Hover over the timestamp to the right of the message. + + + + + + + + 1. The timestamp will be at the top right of the menu. + + + + +## Related articles + +* [Change the time format](/help/change-the-time-format) +* [Message actions](/help/message-actions) diff --git a/starlight_help/src/content/docs/view-the-markdown-source-of-a-message.mdx b/starlight_help/src/content/docs/view-the-markdown-source-of-a-message.mdx new file mode 100644 index 0000000000..ae475a6b4c --- /dev/null +++ b/starlight_help/src/content/docs/view-the-markdown-source-of-a-message.mdx @@ -0,0 +1,83 @@ +--- +title: View, copy, and share message content as Markdown +--- + +import FlattenedSteps from '../../components/FlattenedSteps.astro'; +import MessageLongPressMenu from "./include/_MessageLongPressMenu.mdx" +import CopyIcon from "~icons/zulip-icon/copy" +import KeyboardTip from '../../components/KeyboardTip.astro'; +import MessageActionsMenu from "./include/_MessageActionsMenu.mdx" +import { Tabs, TabItem } from '@astrojs/starlight/components' + +Zulip messages are [formatted using +Markdown](/help/format-your-message-using-markdown). You can +[quote](/help/quote-or-forward-a-message#quote-a-message) or +[forward](/help/quote-or-forward-a-message#forward-a-message) a message, or +simply view, copy and share its content as Markdown. + +## View message content as Markdown + + + + + + + 1. Click **View original message**. You will not see the **View original message** + menu option for editable messages that you have sent. + + + + You can also use the E shortcut to view the content of the + selected message as Markdown. + + + + +## Copy message content as Markdown + + + + + + + 1. Click **View original message**. You will not see the **View original message** + menu option for editable messages that you have sent. + 1. Click the **Copy and close** + () + widget in the upper right corner of the message. + + + + You can also use the E shortcut to view the content of the + selected message as Markdown. + + + + + + + + 1. Tap **Copy message text**. + + + + +## Share message content + + + + + + + 1. Tap **Share**, and choose the app to which you want to share message content. + + + + +## Related articles + +* [Message formatting](/help/format-your-message-using-markdown) +* [Printing messages](/help/printing-messages) +* [Edit a message](/help/edit-a-message) +* [Delete a message](/help/delete-a-message) +* [Message actions](/help/message-actions) diff --git a/starlight_help/src/content/docs/view-your-bots.mdx b/starlight_help/src/content/docs/view-your-bots.mdx new file mode 100644 index 0000000000..408b72f2c1 --- /dev/null +++ b/starlight_help/src/content/docs/view-your-bots.mdx @@ -0,0 +1,25 @@ +--- +title: View your bots +--- + +import NavigationSteps from "../../components/NavigationSteps.astro" +import FlattenedSteps from '../../components/FlattenedSteps.astro'; + +You can view the bots that you own, including deactivated bots. + +You can also [deactivate](/help/deactivate-or-reactivate-a-bot#deactivate-a-bot), +[reactivate](/help/deactivate-or-reactivate-a-bot#reactivate-a-bot), or +[manage](/help/manage-a-bot#manage-your-bot) any of your bots. + + + + + +## 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) +* [Deactivate or reactivate a bot](/help/deactivate-or-reactivate-a-bot) +* [View all bots in your organization](/help/view-all-bots-in-your-organization) diff --git a/starlight_help/src/content/docs/view-your-mentions.mdx b/starlight_help/src/content/docs/view-your-mentions.mdx new file mode 100644 index 0000000000..ac87c92eb5 --- /dev/null +++ b/starlight_help/src/content/docs/view-your-mentions.mdx @@ -0,0 +1,29 @@ +--- +title: View your mentions +--- + +import ZulipNote from '../../components/ZulipNote.astro'; +import ViewMentions from "./include/_ViewMentions.mdx" + +You can [mention a user or a group](/help/mention-a-user-or-group) to call their +attention to a message. To make such messages easy to find, Zulip lets you view +the messages where you were mentioned from a dedicated tab. + + + Because [silent mentions](/help/mention-a-user-or-group#silently-mention-a-user) + are designed not to attract attention, they are excluded from the + **Mentions** tab. + + +## View your mentions + + + +Topics with unread @-mentions are marked with an **@** indicator next to the +number of unread messages. + +## Related articles + +* [Mention a user or group](/help/mention-a-user-or-group) +* [DMs, mentions, and alerts](/help/dm-mention-alert-notifications) +* [Reading strategies](/help/reading-strategies) diff --git a/starlight_help/src/content/docs/view-zulip-version.mdx b/starlight_help/src/content/docs/view-zulip-version.mdx new file mode 100644 index 0000000000..077712ec46 --- /dev/null +++ b/starlight_help/src/content/docs/view-zulip-version.mdx @@ -0,0 +1,85 @@ +--- +title: View Zulip version +--- + +import NavigationSteps from "../../components/NavigationSteps.astro" +import GearIcon from "~icons/zulip-icon/gear" +import ZulipTip from '../../components/ZulipTip.astro'; +import FlattenedSteps from '../../components/FlattenedSteps.astro'; +import { Steps } from '@astrojs/starlight/components'; +import InfoIcon from "~icons/zulip-icon/info" +import MobileMenu from "./include/_MobileMenu.mdx" +import { Tabs, TabItem } from '@astrojs/starlight/components' + +## Zulip server and web app version + +If your organization self-hosts Zulip, the server administrator will need to +[upgrade Zulip][upgrade-zulip] in order for you to experience the latest +improvements. You can check which [version][changelog] of the Zulip server and +web app your organization is using. + +Zulip Cloud organizations are always updated to the latest version of Zulip. + +[upgrade-zulip]: https://zulip.readthedocs.io/en/stable/production/upgrade.html + +[changelog]: https://zulip.readthedocs.io/en/latest/overview/changelog.html + +### View Zulip server and web app version + + + + + 1. Click on the **gear** () icon in the upper + right corner of the web or desktop app. + 1. View the version number or Zulip Cloud plan in the top section of the menu. + 1. *(optional)* Click on the version number or Zulip Cloud plan for additional + details. + + + + + + + + 1. View the version number under **Zulip Server**. + + + + + + If the Zulip server is running a custom branch, the **merge base** + will also be shown. It indicates which official version of Zulip + the custom branch is based on. + + +## Zulip desktop app version + +The [Zulip desktop app](/apps/) has an independent version from the server and +web app. + +### View Zulip desktop app version + + + 1. Click on the **Help** menu in the desktop app. The app version is shown in the + dropdown: **Zulip Desktop v...** + + +## Zulip mobile app version + +The [Zulip mobile apps](/apps/) have an independent version from the server and +web app. + +### View Zulip mobile app version + + + + + 1. Tap **About Zulip**. + + +## Related articles + +* [Desktop app installation guides](/help/desktop-app-install-guide) +* [Mobile app installation guides](/help/mobile-app-install-guide) +* [Upgrading Zulip][upgrade-zulip] +* [Zulip release lifecycle](https://zulip.readthedocs.io/en/stable/overview/release-lifecycle.html) diff --git a/starlight_help/src/content/docs/zulip-cloud-billing.mdx b/starlight_help/src/content/docs/zulip-cloud-billing.mdx new file mode 100644 index 0000000000..80bbde06a4 --- /dev/null +++ b/starlight_help/src/content/docs/zulip-cloud-billing.mdx @@ -0,0 +1,249 @@ +--- +title: Zulip Cloud billing +--- + +import NavigationSteps from "../../components/NavigationSteps.astro" +import InternationalWireTransfers from "./include/_InternationalWireTransfers.mdx" +import ManageBillingIntro from "./include/_ManageBillingIntro.mdx" +import ManualAddLicenseInstructions from "./include/_ManualAddLicenseInstructions.mdx" +import FlattenedSteps from '../../components/FlattenedSteps.astro'; +import PayByInvoiceWarning from "./include/_PayByInvoiceWarning.mdx" +import PayByInvoiceSteps from "./include/_PayByInvoiceSteps.mdx" +import { Steps } from '@astrojs/starlight/components'; +import PaymentOptions from "./include/_PaymentOptions.mdx" +import ConfigureWhoCanManagePlans from "./include/_ConfigureWhoCanManagePlans.mdx" +import PlanUpgradeSteps from "./include/_PlanUpgradeSteps.mdx" +import GearIcon from "~icons/zulip-icon/gear" +import AutomaticBilling from "./include/_AutomaticBilling.mdx" +import ZulipTip from '../../components/ZulipTip.astro'; +import { Tabs, TabItem } from '@astrojs/starlight/components' + +This page answers some frequently asked questions about [Zulip Cloud plans and +pricing](https://zulip.com/plans/). If you have any other questions, please +don't hesitate to reach out at [sales@zulip.com](mailto:sales@zulip.com). + +## Upgrade to a Zulip Cloud Standard or Plus plan + + + + + + + 1. On the page listing Zulip Cloud plans, click the button at the bottom + of the plan you would like to purchase. + + + + + + + + + + + + 1. On the page listing Zulip Cloud plans, click the button at the bottom + of the plan you would like to purchase. + + + + + + +## Manage billing + + + + + + + + + + + +### Configure who can manage plans and billing + + + +## Cancel paid plan + +If you cancel your plan, your organization will be downgraded to **Zulip Cloud +Free** at the end of the current billing period. + + + + + + + 1. At the bottom of the page, click **Cancel plan**. + 1. Click **Downgrade** to confirm. + + + + +## Free and discounted Zulip Cloud Standard + +Zulip sponsors free plans for over 1000 worthy organizations. The following +types of organizations are generally eligible for a free **Zulip Cloud Standard** plan. + +* Open-source projects, including projects with a small paid team. +* Research in an academic setting, such as research groups, cross-institutional + collaborations, etc. +* Academic conferences and other non-profit events. +* Non-profits with no paid staff. +* Most communities that need features beyond the Free plan in order to use Zulip. + +The following types of organizations are generally eligible for significant +discounts on **Zulip Cloud Standard**. + +* Education organizations are eligible for [education + pricing](https://zulip.com/for/education/#feature-pricing). +* Discounts are available for organizations based in the **developing world**. +* Non-profits and other organizations where many users are **not paid staff** + are generally eligible for a discount. + +If there are any circumstances that make regular pricing unaffordable for your +organization, contact [sales@zulip.com](mailto:sales@zulip.com) to discuss your +situation. + +### Education pricing + +Educators using Zulip with students are eligible for discounted [education +pricing](https://zulip.com/for/education/#feature-pricing). Other educational +uses (e.g., by teaching staff or university IT) may qualify for a non-profit +discount instead. + + + Organizations operated by individual educators (for example, a professor + teaching one or more classes) usually find that the [Zulip Cloud Free + plan](https://zulip.com/plans/#cloud) suits their needs. + + +Non-profit educational pricing applies to online purchases with no additional +legal agreements, for use at registered non-profit institutions (e.g., colleges +and universities). + +To arrange discounted pricing for your organization, please [apply for +sponosorship](#apply-for-sponsorship). Contact +[sales@zulip.com](mailto:sales@zulip.com) with any questions. + +### Apply for sponsorship + +Submit a sponsorship request to apply for a free or discounted **Zulip Cloud +Standard** plan. If you do not have a Zulip organization yet, contact +[sales@zulip.com](mailto:sales@zulip.com) to inquire about sponsorship +eligibility. + + + + + 1. Click on the **gear** () icon in + the upper right corner of the web or desktop app. + 1. Click the **Request sponsorship** link at the top of the gear menu. + 1. Fill out the requested information, and click **Submit**. + + + + If you don't see the **Request sponsorship** link in the gear menu, + update your [organization type](/help/organization-type) to one of + the eligible types of organizations [listed + above](#free-and-discounted-zulip-cloud-standard) that best fits + your organization. + + + + + + 1. Click on the **gear** () icon in + the upper right corner of the web or desktop app. + 1. Click the **Request education pricing** link at the top of the gear menu. + 1. Fill out the requested information, and click **Submit**. + + + + If you don't see the **Request education pricing** link in the gear menu, + update your [organization type](/help/organization-type) to either + **Education (non-profit)** or **Education (for-profit)**. + + + + +## Differences between Zulip Cloud plans + +### How does having 10,000 messages of search history on Zulip Cloud Free work? + +Only the most recent 10,000 messages can be viewed and searched on the Zulip +Cloud Free plan. Older messages are still stored and will become available +again if the organization is upgraded to **Zulip Cloud Standard**. + +### Will you switch to limiting Zulip Cloud Free history to messages sent in the last 90 days (like Slack has)? + +**No.** As discussed in [this blog +post](https://blog.zulip.com/2022/08/26/why-slacks-free-plan-change-is-causing-an-exodus/), +a time-based limit to message history is simply a bad model for a collaboration +tool. + +## Payment methods + +### What are my payment options? + + + +### International SWIFT transfers + + + +### How does automatic license management work? + + + +### How does manual license management work? + +With manual license management, you choose and pay for a fixed number of +licenses, which limits the number of users in your organization. + +* If the limit is reached, unlike [automatic license + management](#how-does-automatic-license-management-work), new users + cannot join and existing users cannot be reactivated until licenses + are manually added (or freed up by [deactivating existing + users](/help/deactivate-or-reactivate-a-user)). +* When you add a license for the current billing period, you will be + charged only for the remaining part of the billing period. +* If you have an annual billing period, each month, you will see a + single charge for all licenses added the previous month. If you have + a monthly billing period, the charge for licenses added during the + previous month will be combined with your monthly renewal charge. + +#### Manually update number of licenses + + + + + + + + + + + +## Temporary users and guests + +### How will I be charged for temporary users (e.g., limited-time clients)? + +Users [can be deactivated](/help/deactivate-or-reactivate-a-user) any time. +Deactivating a user frees up their license for reuse. + +### How are guest accounts billed? Is there special pricing? + +For an organization with N other users, 5\*N [guest users](/help/guest-users) +are included at no extra charge. After that, you will need to purchase an +extra license for every 5 additional guest users. + +## Related articles + +* [Trying out Zulip](/help/trying-out-zulip) +* [Zulip Cloud or self-hosting?](/help/zulip-cloud-or-self-hosting) +* [Self-hosted billing](/help/self-hosted-billing) +* [Migrating from other chat tools](/help/migrating-from-other-chat-tools) +* [Contact support](/help/contact-support) diff --git a/starlight_help/src/content/docs/zulip-cloud-or-self-hosting.mdx b/starlight_help/src/content/docs/zulip-cloud-or-self-hosting.mdx new file mode 100644 index 0000000000..bf0677e95f --- /dev/null +++ b/starlight_help/src/content/docs/zulip-cloud-or-self-hosting.mdx @@ -0,0 +1,77 @@ +--- +title: Choosing between Zulip Cloud and self-hosting +--- + +import AdvantagesOfZulipCloud from "./include/_AdvantagesOfZulipCloud.mdx" +import ZulipTip from '../../components/ZulipTip.astro'; + +This page will help you decide whether [signing up for Zulip +Cloud](https://zulip.com/new/) or [self-hosting +Zulip](https://zulip.com/self-hosting/) best fits the needs of your +organization. For additional guidance, reach out to +[sales@zulip.com](mailto:sales@zulip.com). + + + If your needs change, you can always move [to a self-hosted + installation](https://zulip.readthedocs.io/en/stable/production/export-and-import.html#import-into-a-new-zulip-server) + or [to Zulip Cloud](/help/move-to-zulip-cloud). + + +## Advantages of Zulip Cloud + + + +[Sign up](https://zulip.com/new/) with just a few clicks. + +## Advantages of self-hosting Zulip + +* **Under your control**: Retain full control over your data and simplify + compliance by self-hosting Zulip behind your firewall. +* **Access to all of Zulip's features**: All [self-hosted + plans](https://zulip.com/plans/#self-hosted) offer the same [100% open-source + software][zulip-github]. Organizations that do not require support with their + installation can always use Zulip for free with no limitations. +* **Simple set-up process**: It's easy to [install][install-zulip] Zulip + directly on Ubuntu or Debian Linux, in Docker, or with prebuilt + images for Digital + Ocean and Render. +* **Easy to maintain**: Zulip offers convenient tools for [backing + up][back-up-zulip], and [maintaining][maintain-zulip] a self-hosted Zulip + server. +* **Customizable**: Customize Zulip for all your needs. It's easy to develop and + maintain [custom integrations](/api/incoming-webhooks-overview) and + [features][modify-zulip]. +* **Budget option**: For organizations with expertise in self-hosting their + tools and a tight budget, the [Zulip Basic + plan](https://zulip.com/plans/#self-hosted) can be a great choice. + +Learn more about [self-hosting Zulip](https://zulip.com/self-hosting/). + +[zulip-github]: https://github.com/zulip/zulip#readme + +[install-zulip]: https://zulip.readthedocs.io/en/stable/production/install.html + +[back-up-zulip]: https://zulip.readthedocs.io/en/stable/production/export-and-import.html#backups + +[maintain-zulip]: https://zulip.readthedocs.io/en/stable/production/upgrade.html + +[modify-zulip]: https://zulip.readthedocs.io/en/stable/production/modify.html + +## Plans and pricing + +Compare [Zulip Cloud](https://zulip.com/plans#cloud) and [self-hosted +Zulip](https://zulip.com/plans#self-hosted) pricing. + +Free or heavily discounted pricing is available for most non-business uses. +Learn how to apply for a sponsored +[Cloud](https://zulip.com/help/zulip-cloud-billing#free-and-discounted-zulip-cloud-standard) or +[self-hosted](https://zulip.com/help/self-hosted-billing#apply-for-community-plan) plan. + +## Related resources + +* [Sign up for Zulip Cloud](https://zulip.com/new/) +* [Self-hosting Zulip](https://zulip.com/self-hosting/) +* [Trying out Zulip](/help/trying-out-zulip) +* [Plans and pricing](https://zulip.com/plans/) +* [Zulip Cloud billing](/help/zulip-cloud-billing) +* [Self-hosted billing](/help/self-hosted-billing) diff --git a/tools/convert-help-center-docs-to-mdx b/tools/convert-help-center-docs-to-mdx index fe27067f61..6eebe9a019 100755 --- a/tools/convert-help-center-docs-to-mdx +++ b/tools/convert-help-center-docs-to-mdx @@ -98,8 +98,8 @@ def replace_image_path(markdown_string: str, replacement_path: str) -> str: # We do not replace /static/images directly since there are a few # instances in the documentation where zulip.com links are # referenced with that blurb as a part of the url. - result = markdown_string.replace("(/static/images/starlight_help", f"({replacement_path}") - return result.replace('="/static/images/starlight_help', f'="{replacement_path}') + result = markdown_string.replace("(/static/images/help", f"({replacement_path}") + return result.replace('="/static/images/help', f'="{replacement_path}') def fix_file_imports( @@ -136,15 +136,6 @@ def escape_curly_braces(markdown_string: str) -> str: return result.replace("}", r"\}") -def fix_relative_path(markdown_string: str) -> str: - """ - Since the docs will live at the `starlight_help/` url - until we migrate the project completely, we will - replace `help/` with `starlight_help/` - """ - return markdown_string.replace("help/", "starlight_help/") - - def insert_string_at_line(text: str, destination_str: str, n: int) -> str: lines = destination_str.splitlines() if 1 <= n <= len(lines): @@ -587,7 +578,6 @@ def convert_help_center_file_to_mdx( # All imports inserted during conversion should be tracked here. import_statement_set: set[str] = set() - result = fix_relative_path(result) # All unordered lists at the time of writing this comment are # standalone components and we do not need to do any transformation # for them. @@ -633,7 +623,6 @@ def convert_include_file_to_mdx( # All imports inserted during conversion should be tracked here. import_statement_set: set[str] = set() - result = fix_relative_path(result) # All unordered lists at the time of writing this comment are # standalone components and we do not need to do any transformation # for them.