Add docs for Slack integration

source/_data/sidebar.yml

@@ -21,6 +21,7 @@ guides:
     organizations: organizations.html
     users: users.html
     github-integration: github-integration.html
+    slack-integration: slack-integration.html
     analytics: analytics.html
   guides:
     command-line: command-line.html

source/guides/dashboard/github-integration.md

@@ -24,8 +24,8 @@ Before you can enable GitHub integration for your Cypress projects, you must fir
 2. Select the organization you wish to integrate with a GitHub account or GitHub organization.
   {% imgTag /img/dashboard/select-cypress-organization.png "Select an organization" width-600 %}
 3. Visit the selected organization's **Integrations** page via the side navigation.
-  {% imgTag /img/dashboard/github-integration/install-github-integration-with-cypress-from-org-settings.png "Install Cypress GitHub App from Integrations" %}
-4. Click the **Install the Cypress GitHub App** button.
+  {% imgTag /img/dashboard/navigate-to-organization-integrations.png "Install Cypress GitHub from Integrations" %}
+4. Click the **Install GitHub Integration** button.
 
 ## Install via project settings
 

source/guides/dashboard/introduction.md

@@ -57,6 +57,12 @@ From the Dashboard you can:
 - Integrate your Cypress tests with your GitHub workflow via commit {% url 'status checks' github-integration#Status-checks %}
 - Integrate Cypress into GitHub via {% url 'pull requests' github-integration#Pull-request-comments %}
 
+## Integrate with Slack
+
+From the Dashboard you can:
+
+- Integrate Cypress into Slack on every recorded test run.
+
 ### See tests runs in the Test Runner
 
 Additionally we've integrated the tests run into the Cypress {% url 'Test Runner' test-runner %}. This means you can see the tests run in the *Runs* tab from within every project.

source/guides/dashboard/organizations.md

@@ -87,6 +87,10 @@ If you have any questions regarding the OSS plan, please feel free [contact us](
 
 Please see our full documentation for {% url "GitHub Integration" github-integration %}.
 
+## Slack Integration
+
+Please see our full documentation for {% url "Slack Integration" slack-integration %}.
+
 ## Enterprise SSO
 
 {% note info Paid Add-on Integration %}

source/guides/dashboard/projects.md

@@ -151,6 +151,14 @@ You can integrate your project with GitHub and edit its settings from within the
 
 See our {% url "GitHub Integration guide" github-integration %} to learn more.
 
+# Slack Integration
+
+You can integrate your project with Slack and edit its settings from within the project settings page.
+
+{% imgTag /img/dashboard/visit-project-settings.png "Visit project settings" %}
+
+See our {% url "Slack Integration guide" slack-integration %} to learn more.
+
 # Access to Runs
 
 Visit your project settings to see who has access to your project's runs.

source/guides/dashboard/slack-integration.md

@@ -0,0 +1,112 @@
+---
+title: Slack Integration
+---
+
+Slack Integration allows you to see your Cypress test results directly in your teams' Slack channels.
+
+{% imgTag /img/dashboard/cypress-slack-integration-channel-feed.png "Cypress App notification feed in Slack channel" %}
+
+# Install the Cypress Slack app
+
+{% note warning Ownership Requirements %}
+In order to install the Slack Integration, you must be an admin or owner of both your Cypress Dashboard organization and your Slack workspace.
+{% endnote %}
+
+**To install the Slack Integration:**
+
+1. Go to the Dashboard {% url "Organizations page" https://dashboard.cypress.io/organizations %} or open the organization switcher.
+1. Select the organization you wish to integrate with Slack.
+  {% imgTag /img/dashboard/select-cypress-organization.png "Select an organization" width-600 %}
+1. Visit the selected organization's **Integrations** page via the side navigation.
+  {% imgTag /img/dashboard/navigate-to-organization-integrations.png "Install Cypress Slack from Integrations" %}
+1. Click the **Install Slack Integration** button.
+1. You'll see a popup window that requests permission for Cypress to access the workspace and allows you to choose your Slack workspace and channel to associate with the installation. Once you've selected a channel and allowed access, the installation is complete! The Cypress Dashboard will post run results for all projects in your organization to the specified Slack channel.
+
+# Per-organization configuration
+
+## Add additional Slack channels
+
+You can have the Cypress Dashboard post run results to an additional channels. To add a channel:
+
+1. Navigate to the **Integrations** page for the organization with the installed Slack integration.
+1. Within the Slack integration, click **Configure**.
+1. Click **Add Slack Channel**.
+1. You'll see a popup window that allows you to choose the channel to associate with the organization. The Cypress Dashboard will post run results for all projects in your organization to the new Slack channel.
+
+## Set notification preferences
+
+By default, the Cypress Dashboard will post a Slack message to each configured channel only for failing runs. If you'd like to change these preferences:
+
+1. Navigate to the **Integrations** page for the organization with the installed Slack integration.
+1. Within the Slack integration, click **Configure**.
+1. Under **Notifications**, select your preference for each Slack channel:
+  - **All runs**: will notify on all runs (including passed)
+  - **Failed runs only**: will only notify on runs with a fail status.
+
+## Mute a channel
+
+If you want the Cypress Dashboard to temporarily stop posting Slack messages to a certain channel, you can **Mute** that channel. This allows you to easily pause and resume notifications for a specific channel without losing the configuration you’ve put in place.
+
+1. Navigate to the **Integrations** page for the organization with the installed Slack integration.
+1. Within the Slack integration, click **Configure**.
+1. Under **Actions**, select your **Mute** for each Slack channel you want muted.
+
+## Remove a Slack channel
+
+You can have the Cypress Dashboard stop posting notifications to a channel. You can remove all Slack channels if you’d prefer to disable global notifications altogether in favor of per-project notifications.
+
+1. Navigate to the **Integrations** page for the organization with the installed Slack integration.
+1. Within the Slack integration, click **Configure**.
+1. Under **Actions**, select your **Delete** for each Slack channel you want deleted.
+
+# Per-project configuration
+
+If your organization has multiple teams working on separate projects, you can tailor the Slack notifications of each project to match your teams' needs.
+
+## Add a new Slack channel
+
+You can have the Cypress Dashboard post run results for a specific project to an additional channel.
+
+1. Select your organization in the organization switcher.
+  {% imgTag /img/dashboard/select-cypress-organization.png "Select an organization" width-600 %}
+1. Select the project you wish to integrate with Slack.
+  {% imgTag /img/dashboard/select-cypress-project.png "Select a project" %}
+1. Go to the project's settings page.
+  {% imgTag /img/dashboard/visit-project-settings.png "Visit project settings" %}
+1. Scroll down to the **Slack Integration** section.
+1. Click **Add Slack Channel**.
+1. You'll see a popup window that allows you to choose the channel to associate with the project.
+
+## Set notification preferences
+
+By default, the Cypress Dashboard will post a Slack message to each configured channel only for failing runs. You cannot override the notification preferences for the global organization channels. If you'd like to change these preferences:
+
+1. Navigate to the **Integrations** page for the project with the installed Slack integration.
+1. Scroll down to the **Slack Integration** section.
+1. Under **Notifications**, select your preference for each Slack channel:
+  - **All runs**: will notify on all runs (including passed)
+  - **Failed runs only**: will only notify on runs with a fail status.
+
+## Mute a channel
+
+If you want the Cypress Dashboard to temporarily stop posting Slack messages to a certain channel, you can **Mute** that channel. This allows you to easily pause and resume notifications for a specific channel without losing the configuration you’ve put in place. You can even mute the messages for the global organization channels!
+
+1. Navigate to the **Integrations** page for the project with the installed Slack integration.
+1. Scroll down to the **Slack Integration** section.
+1. Under **Actions**, select your **Mute** for each Slack channel you want muted.
+
+## Remove a channel
+
+You can have the Cypress Dashboard stop posting notifications to a channel. You cannot delete the global notification channels from a project.
+
+1. Navigate to the **Integrations** page for the project with the installed Slack integration.
+1. Scroll down to the **Slack Integration** section.
+1. Under **Actions**, select your **Delete** for each Slack channel you want deleted.
+
+# Remove the integration
+
+You can completely remove the Slack Integration from your workspace. This will remove the @cypress bot from your workspace and will delete all of the Slack configurations you’ve set in the Cypress Dashboard. You cannot undo this, but you will be able to install the Slack Integration again in the future.
+
+1. Navigate to the **Integrations** page for the organization with the installed Slack Integration.
+1. Within the Slack Integration, click **Configure**.
+1. Click **Uninstall Slack Integration** to uninstall the Slack Integration.

themes/cypress/languages/en.yml

@@ -39,6 +39,7 @@ sidebar:
     organizations: Organizations
     users: Users
     github-integration: GitHub Integration
+    slack-integration: Slack Integration
     analytics: Analytics
     debugging: Debugging
     variables-and-aliases: Variables and Aliases

themes/cypress/languages/es.yml

@@ -39,6 +39,7 @@ sidebar:
     organizations: Organizaciones
     users: Usuarios
     github-integration: Integración con GitHub
+    slack-integration: Integración con Slack
     analytics: Analytics
     debugging: Depuración
     variables-and-aliases: Variables y alias

themes/cypress/languages/ja.yml

@@ -39,6 +39,7 @@ sidebar:
     organizations: Organizations
     users: Users
     github-integration: GitHub Integration
+    slack-integration: Slack Integration
     analytics: 分析
     debugging: デバッグする
     variables-and-aliases: 変数と別名

themes/cypress/languages/pt-br.yml

@@ -39,6 +39,7 @@ sidebar:
     organizations: Organizações
     users: Usuários
     github-integration: Integração com GitHub
+    slack-integration: Slack Integration
     analytics: Analytics
     debugging: Debugando
     variables-and-aliases: Variáveis e Aliases

themes/cypress/languages/ru.yml

@@ -39,6 +39,7 @@ sidebar:
     organizations: Организации
     users: Пользователи
     github-integration: Интеграция с GitHub
+    slack-integration: Slack Integration
     analytics: Аналитика
     debugging: Отладка
     variables-and-aliases: Переменные и Алиасы

themes/cypress/languages/zh-cn.yml

@@ -41,6 +41,7 @@ sidebar:
     organizations: 组织
     users: 成员
     github-integration: GitHub集成
+    slack-integration: Slack Integration
     analytics: 分析工具
     debugging: 调试
     variables-and-aliases: 变量和别名