RADAR-6702 | Add slack cloud data source onboarding doc #1413
Conversation
|
Thank you for your submission! We require that all contributors sign our Contributor License Agreement ("CLA") before we can accept the contribution. Read and sign the agreement Learn more about why HashiCorp requires a CLA and what the CLA includes Have you signed the CLA already but the status is still pending? Recheck it. |
Vercel Previews Deployed
|
| 'content/consul/**', | ||
| 'content/nomad/**', | ||
| 'content/hcp-docs/content/docs/cli/**', |
There was a problem hiding this comment.
I think you can just ignore the label error, it shouldn't block the pr
There was a problem hiding this comment.
Sure, I added the fix, just in case
Broken Link CheckerNo broken links found! 🎉 |
| @include 'beta-feature.mdx' | ||
|
|
||
| Vault Radar allows you to connect to any workspace on [Slack | ||
| Cloud](#add-slack-cloud). |
There was a problem hiding this comment.
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.
| Vault Radar allows you to connect to any workspace on [Slack | ||
| Cloud](#add-slack-cloud). | ||
|
|
||
| ## Add Slack Cloud |
There was a problem hiding this comment.
Possible alternative
| ## Add Slack Cloud | |
| ## Add a Slack Data Source |
|
|
||
| ## Add Slack Cloud | ||
|
|
||
| ## Create a connection with Slack Cloud |
There was a problem hiding this comment.
Seems like an unnecessary rephrasing of the above heading?
| ## Create a connection with Slack Cloud |
| 1. Click on the **Connect to Slack** button to initiate the OAuth flow | ||
|  | ||
|
|
||
| 1. Select the workspace in the dropdown list and click **Allow** |
There was a problem hiding this comment.
nit
| 1. Select the workspace in the dropdown list and click **Allow** | |
| 1. Select the workspace from the dropdown list and click **Allow** |
| 1. Select the workspace in the dropdown list and click **Allow** | ||
|  | ||
|
|
||
| 1. Once the app is installed successfully, the UI will display the message **Authenticated to Slack** |
There was a problem hiding this comment.
| 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** |
|
|
||
| ## Create a connection with Slack Cloud | ||
|
|
||
| ### Install the Slack App onto a workspace |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
I was following the other data source format. It makes sense to have one section to onboard the slack datasource
|
|
||
| ## Add channels to Vault Radar | ||
|
|
||
| 1. Once you establish a connection, select either **All active channels** or **Select channels to monitor** radio button. |
There was a problem hiding this comment.
| 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 on **Next** to continue the onboarding process | ||
|
|
||
|
|
||
| ## Add channels to Vault Radar |
There was a problem hiding this comment.
In my opinion, this is still part of the Onboarding workflow. It could be combined with the instructions in the previous section.
JoshAtHC
left a comment
JoshAtHC
left a comment
There was a problem hiding this comment.
LGTM, up to you on whether you want to include the changes made to the labeler.yml or let the owners sort it out
I would leave the changes, it's not a functional issue, a more syntax one |
2 participants
Please go to the
Previewtab and select the appropriate template: