Added Slack Integration with new content and screenshots - #3667
karansharmasauce wants to merge 5 commits into
Conversation
|
Deploy preview ready for 3667! |
| After connecting a Slack workspace, you can add Slack channels where Sauce Labs will send test result notifications. You can add multiple channels to the same workspace and use them as destinations when configuring alert rules. | ||
|
|
||
| :::note | ||
| Only channels available to the Sauce Labs Slack integration appear in the channel list. |
There was a problem hiding this comment.
I'd write here "Only public channels...", as we can't fetch private ones.
| @@ -0,0 +1,250 @@ | |||
| --- | |||
| id: slack | |||
| title: Slack | |||
There was a problem hiding this comment.
Could add (Beta) here and sidebar
|
|
||
| You can add multiple channels to the same connected Slack workspace. Repeat the channel setup to add additional channels to the same Slack workspace. Each channel is added separately and can be used as a destination for alert rules. | ||
|
|
||
| ``` |
There was a problem hiding this comment.
I don't think this is needed. Users will set channels as they wish and most probably already have some existing ones
| * Send a specific test result to Slack manually when investigating a failure. | ||
|
|
||
| ## Prerequisites | ||
|
|
There was a problem hiding this comment.
We will need to add here the steps for installing the Sauce Labs Slack integration form the marketplace, as the saucebot needs to be invited into the channels that the user wishes to connect.
There was a problem hiding this comment.
Add something like this here:
From the Slack Marketplace, search for a Sauce Labs integration and install it. Add the saucebot as a member into the public channel where you want to receive alerts and continue the setup inside Sauce Labs platform.
|
|
||
| <img src={useBaseUrl('/img/integrations/slack/slack-10.png')} alt="Slack Integration"/> | ||
|
|
||
| **Step 2:** Select **Remove Channel** next to the channel. The channel is removed from the list of connected channels and is no longer available as a destination for Slack alerts. |
There was a problem hiding this comment.
Alternatively, you can remove the saucebot from the channel to stop receiving alerts for it.
| Removing a channel does not disconnect the Slack workspace. Other channels connected to the same workspace remain configured. | ||
| ::: | ||
|
|
||
| ## Quick Alert Setup |
There was a problem hiding this comment.
This will change a bit as per design, I'd wait for the engineering to update and then update the flow description and images here https://www.figma.com/design/jsMAZj2fh0wf69ELk8ydgg/Slack-integration-Design-Feedback?node-id=371-8641&t=vpBWOlqzTNIFWTbf-1
|
|
||
| **Step 2:** Select the **Actions** menu in the upper-right corner of the page, then select **Send to Slack**. | ||
|
|
||
| <img src={useBaseUrl('/img/integrations/slack/slack-22.png')} alt="Slack Integration"/> |
There was a problem hiding this comment.
The visual here will also change a bit to show the Share button for slack (and later Jira) https://www.figma.com/design/jsMAZj2fh0wf69ELk8ydgg/Slack-integration-Design-Feedback?node-id=371-7436&t=vpBWOlqzTNIFWTbf-1
| | Ref. | Field | Description | | ||
| | ----- | ----- | ----- | | ||
| | **1** | **Alert Name** | Enter a descriptive name to identify the alert rule when managing your alerts. | | ||
| | **2** | **Event Types** | Select the test results that should trigger the alert. For each available automation type, choose **Don't alert** to disable notifications, **Failed tests only** to receive notifications for failed tests, or **All tests** to receive notifications for all test results. | |
There was a problem hiding this comment.
There is no Don't alert option really.
| | **3** | **Destinations** | Select one or more Slack channels where matching notifications should be sent. Only channels already added to your Slack integration are available. | | ||
| | **4** | **Tags** | Optionally select one or more existing tags to limit the alert to test results that match the selected tags. | | ||
|
|
||
| <img src={useBaseUrl('/img/integrations/slack/slack-27.png')} alt="Slack Integration"/> |
There was a problem hiding this comment.
This will need to update to include the Owner etc
|
|
||
| <img src={useBaseUrl('/img/integrations/slack/slack-27.png')} alt="Slack Integration"/> | ||
|
|
||
| :::note |
There was a problem hiding this comment.
I'd remove or heavily rephrase this, as all things can be considered optional really.
Tags are matched if test results contain them, it's just another filtering option same as owner or test status
|
|
||
| Disconnect a Slack workspace when you no longer want Sauce Labs to send notifications to that workspace. Disconnecting a workspace removes its connection from Sauce Labs and prevents the integration from sending alerts to its Slack channels. | ||
|
|
||
| On the Slack configuration page, locate the workspace you want to disconnect and select **Disconnect**. |
There was a problem hiding this comment.
Also remove slackbot integration from your Slack workspace.
marstupa
left a comment
marstupa
left a comment
There was a problem hiding this comment.
Left some change requests, but overall great start.
I think it's safe to leave it aside for a couple days until we get the update confirmation from engineering and and start the marketplace publishing process.
|
Deploy preview ready for 3667! |
|
Deploy preview ready for 3667! |
|
Deploy preview ready for 3667! |
|
|
||
| <img src={useBaseUrl('/img/integrations/slack/slack-26.png')} alt="Disconnect option in the workspace More options menu"/> | ||
|
|
||
| The workspace is disconnected from Sauce Labs, and the Slackbot integration is also disconnected from your Slack workspace. Other Slack workspaces connected to your Sauce Labs organization remain unaffected. |
There was a problem hiding this comment.
saucebot instead of slackbot, right?
There was a problem hiding this comment.
Can we pls replace this screenshot with the production version? This one has the wrong UI as it includes other integrations which are work in progress.
|
Deploy preview ready for 3667! |
This branch has not been deployed
2 participants
Description
Added a new Slack Integration documentation page covering setup and configuration. Includes newly written content along with supporting screenshots to walk users through the integration flow step by step.
Motivation and Context
The Slack Integration had no documentation, leaving users without guidance on how to connect and configure it. This adds a dedicated page so users can set it up without needing to contact support, and the screenshots make each step easier to follow.
Types of Changes