From ba44f308dc469b43985a680c85b7a1bf8122fd48 Mon Sep 17 00:00:00 2001 From: David Rosa Date: Fri, 28 Oct 2022 17:42:06 -0400 Subject: [PATCH] help center: Tweak "Import from Slack" page for reusability. We can reuse the content from multiple sections of the Slack article to update "Import from Mattermost/Gitter/Rocket.Chat" by making small wording tweaks. --- templates/zerver/help/import-from-slack.md | 89 +++++++++++----------- 1 file changed, 46 insertions(+), 43 deletions(-) diff --git a/templates/zerver/help/import-from-slack.md b/templates/zerver/help/import-from-slack.md index bd61c18e5b..ab5033b06e 100644 --- a/templates/zerver/help/import-from-slack.md +++ b/templates/zerver/help/import-from-slack.md @@ -1,8 +1,8 @@ # Import from Slack -You can import your Slack organization into Zulip. It's a great way to preserve -your organization's history when you migrate from Slack to Zulip, and to make -the transition easy for the members of your organization. +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: @@ -19,14 +19,13 @@ following steps, which are described in more detail below: {start_tabs} -1. [Export your Slack data](/help/import-from-slack#export-your-slack-data). +1. [Export your Slack data](#export-your-slack-data). -2. [Import you Slack data into - Zulip](/help/import-from-slack#import-your-data-into-zulip). +2. [Import your Slack data into Zulip](#import-your-data-into-zulip). -3. [Clean up](/help/import-from-slack#clean-up-after-the-slack-export) after the Slack export. +3. [Clean up](#clean-up-after-the-slack-export) after the Slack export. -4. [Get your organization started with Zulip](/help/import-from-slack#get-your-organization-started-with-zulip)! +4. [Get your organization started with Zulip](#get-your-organization-started-with-zulip)! {end_tabs} @@ -82,6 +81,7 @@ in order to export private message data. will use it to download user and emoji data from your Slack workspace. !!! warn "" + You may also come across a token starting with `xoxe-`. This token cannot be used for the Slack export process. @@ -97,8 +97,8 @@ Alternatively, you can [self-host](/self-hosting/) your Zulip organization. See !!! warn "" - **You can only import a Slack workspace as a new Zulip organization.** Slack - workspace history cannot be added into an existing Zulip organization. + **You can only import a workspace as a new Zulip organization.** Your imported + message history cannot be added into an existing Zulip organization. {start_tabs} @@ -111,24 +111,25 @@ Alternatively, you can [self-host](/self-hosting/) your Zulip organization. See 1. The subdomain you would like to use for your organization. Your Zulip chat will be hosted at `.zulipchat.com`. -2. The `zip` file containing your Slack message history export. +1. The **exported data** file containing your workspace message history export. -3. Your Slack **Bot User OAuth Token**, which will be a long - string of numbers and characters starting with `xoxb-` +1. Your Slack **Bot User OAuth Token**, which will be a long + string of numbers and characters starting with `xoxb-`. !!! warn "" - If the organization already exists, the import process will overwrite all data - that's already there. If needed, we're happy to preserve your data by moving an - organization you've already created to a new subdomain prior to running the import process. + 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. {tab|self-hosting} #### Import into a self-hosted Zulip server -Zulip's Slack import tool is robust, and has been used to import Slack -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 +Zulip's import tools are robust, and have been used to import workspaces +with 10,000 members and millions of messages. If you're planning on doing +an import much larger than that, or run into performance issues when importing, [contact us](/help/contact-support) for help. 1. Follow steps @@ -138,17 +139,23 @@ importing, [contact us](/help/contact-support) for help. of the guide for [installing a new Zulip server](https://zulip.readthedocs.io/en/stable/production/install.html). -1. Copy the `zip` file containing your Slack message history export onto your Zulip -server, and put it in `/tmp/`. +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. 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**. + (`EXTERNAL_HOST`) of the Zulip installation, run the following + commands, replacing `` with your Slack **Bot User OAuth Token**. !!! tip "" - The import could take several minutes to run, depending on how much data you're importing. + + * 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. ``` cd /home/zulip/deployments/current @@ -168,11 +175,6 @@ server, and put it in `/tmp/`. ./scripts/start-server ``` - !!! tip "" - The server stop/restart commands are only necessary when - importing on a server with minimal RAM, where an OOM kill might - otherwise occur. - 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). @@ -226,32 +228,32 @@ Once the import process is completed, you will need to: {start_tabs} 1. [Configure the settings for your organization](/help/customize-organization-settings), - which are not exported from Slack. This includes settings like [email - visibility](/help/restrict-visibility-of-email-addresses), [message editing - permissions](/help/configure-message-editing-and-deletion#configure-message-editing-and-deletion_1), - and [how users can join your organization](/help/restrict-account-creation). + which are not exported. This includes settings like [email + visibility](/help/restrict-visibility-of-email-addresses), [message editing + permissions](/help/configure-message-editing-and-deletion#configure-message-editing-and-deletion_1), + and [how users can join your organization](/help/restrict-account-creation). -2. All users from your Slack workspace will have accounts in your new Zulip +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. -3. Share the URL for your new Zulip organization, and (recommended) the [Getting +1. Share the URL for your new Zulip organization, and (recommended) the [Getting started with Zulip guide](/help/getting-started-with-zulip). -4. Migrate any [integrations](/integrations), which is easy to do with Zulip's +1. Migrate any [integrations](/integrations), which is easy to do with Zulip's [Slack-compatible incoming webhook](/integrations/doc/slack_incoming). {end_tabs} +## Decide how users will log in -### Decide how users will log in - -When user accounts are imported from Slack, users initially do not have passwords +When user accounts are imported, users initially do not have passwords configured. There are a few options for how users can log in for the first time. !!! tip "" - For security reasons, Slack passwords are never exported. + + For security reasons, passwords are never exported. ### Allow users to log in with non-password authentication @@ -269,8 +271,9 @@ If you imported your organization into Zulip Cloud, simply e-mail [support@zulip.com](mailto:support@zulip.com) to request this. !!! warn "" - To avoid confusion, first make sure that - the users in your organization are aware that their Slack account has been + + To avoid confusion, first make sure that the users in your + organization are aware that their workspace account has been moved to Zulip, and are expecting to receive a password reset email. #### Send password reset emails (self-hosted organization) @@ -314,7 +317,7 @@ If you imported your organization into Zulip Cloud, simply e-mail ### Manual password resets Alternatively, users can reset their own passwords by following the instructions -on your organization's login page. +on your Zulip organization's login page. ## Related articles