Skip to content
Open
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .github/labeler.yml
Original file line number Diff line number Diff line change
Expand Up @@ -245,8 +245,8 @@ Runtime:
- any:
- changed-files:
- any-glob-to-any-file: [
'content/consul/**'
'content/nomad/**'
'content/hcp-docs/content/docs/cli/**'
'content/consul/**',
'content/nomad/**',
'content/hcp-docs/content/docs/cli/**',
Comment on lines 248 to 250
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you can just ignore the label error, it shouldn't block the pr

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, I added the fix, just in case

'content/hcp-docs/content/docs/hcp/**'
]
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
---
page_title: Add a data source - Slack
description: >-
Add Slack as a data source for Vault Radar.
---

# Add a data source - Slack

@include 'beta-feature.mdx'

Vault Radar allows you to connect to any workspace on [Slack
Cloud](#add-slack-cloud).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is "Slack Cloud" the correct term? Is it not just Slack? I know we typically have to distinguish between the two, but I think for simplicty we can drop the cloud references unless it's part of the offical brand name.


## Add Slack Cloud
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Possible alternative

Suggested change
## Add Slack Cloud
## Add a Slack Data Source


## Create a connection with Slack Cloud
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like an unnecessary rephrasing of the above heading?

Suggested change
## Create a connection with Slack Cloud


### Install the Slack App onto a workspace
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After reading the instructions, I think it makes more sense not to break this up into subsections.

The reality is that a user needs to start onboarding their data source, then add the app to their Slack workspace, then come back to onboarding their data source. And I think we want them to do that as one complete workflow and not suggest that it can be broken up into different workflows.

Thoughts?

Specifically, I'd just delete the headings: ### Install the Slack App onto a workspace and ### Scan with HCP Cloud

cc: @jonathanfrappier

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was following the other data source format. It makes sense to have one section to onboard the slack datasource


1. Select **Settings/Data Sources**.

1. Select **HCP Vault Radar Scan** and click **Continue**.

1. Under Team Collaboration, Click on the **Slack** button.
![Select Slack Datasource](/img/docs/vault-radar/slack-onboarding-flow.png)

1. Click on the **Connect to Slack** button to initiate the OAuth flow
![Initiate OAuth flow](/img/docs/vault-radar/initiate-slack-oauth-flow.png)

1. Select the workspace in the dropdown list and click **Allow**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit

Suggested change
1. Select the workspace in the dropdown list and click **Allow**
1. Select the workspace from the dropdown list and click **Allow**

![Install Slack App onto a workspace](/img/docs/vault-radar/install-slack-app-to-workspace.png)

1. Once the app is installed successfully, the UI will display the message **Authenticated to Slack**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
1. Once the app is installed successfully, the UI will display the message **Authenticated to Slack**
1. Once the app is installed successfully, the HCP Vault Radar UI will display the message **Authenticated to Slack**

![App successfully installed](/img/docs/vault-radar/slack-complete-oauth-flow.png)

### Scan with HCP Cloud

1. Once the above steps are successfully completed, the **Next** button will be enabled

1. Click on **Next** to continue the onboarding process


## Add channels to Vault Radar
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In my opinion, this is still part of the Onboarding workflow. It could be combined with the instructions in the previous section.

cc: @jonathanfrappier


1. Once you establish a connection, select either **All active channels** or **Select channels to monitor** radio button.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
1. Once you establish a connection, select either **All active channels** or **Select channels to monitor** radio button.
1. Once the Slack data source is onboarded, select either **All active channels** or **Select channels to monitor** radio button.


1. Click **Finish**. The channels will now begin scanning

<Note>

Vault Radar has a limit of 5000 channels per workspace. If you have more
then 5000 channels, Vault Radar will select the 5000 channels with the
most recent activity.

</Note>

9 changes: 9 additions & 0 deletions content/hcp-docs/data/docs-nav-data.json
Original file line number Diff line number Diff line change
Expand Up @@ -702,6 +702,15 @@
"path": "vault-radar/get-started/add-data-sources/jira/jira-data-center"
}
]
},
{
"title": "Slack <sup>Beta</sup>",
"routes": [
{
"title": "Slack Cloud",
"path": "vault-radar/get-started/add-data-sources/slack/slack-cloud"
}
]
}
]
},
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading