Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation for Slack Workspace #3005

Closed
wants to merge 6 commits into from
Closed

Add documentation for Slack Workspace #3005

wants to merge 6 commits into from

Conversation

eleanorakh
Copy link
Contributor

@eleanorakh eleanorakh commented Nov 13, 2024

We're in the process of rolling out some changes to the Slack Integration. This PR addresses:

  • Adding new Slack Workspace integration
  • User @ mentions
  • Notifications in private channels
  • Adding Slack privacy policy as per their required guidelines
  • New failing state
  • Add screenshots

@github-actions github-actions bot added pipelines Pull requests that update content related to Pipelines integrations labels Nov 13, 2024
Copy link
Contributor

@dannymidnight dannymidnight left a comment

Choose a reason for hiding this comment

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

The following is no longer true with the new method:

Configuring a Slack notification service will authorize access for your desired channel. By default, notifications will be sent to all configured Slack channels.

I wonder if it's worth breaking this whole integration into a separate page?

I also wonder if we should remove the section on "Legacy slack" now that we've added yet another version!

@@ -7,7 +7,21 @@ Configuring a Slack notification service will authorize access for your desired

Setting up a Notification Service requires Buildkite organization admin access.

## Adding a notification service
## Adding notification services
There are two ways to add notification services: workspace-wide and channel-specific. We reccomend using a workspace. Using a workspace only requires a single authorization for the entire workspace, allowing you to connect channels via YAML rather than multiple notifications services. The migration to a Workspace will not impact current integration implementation.
Copy link
Contributor

Choose a reason for hiding this comment

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

I reckon it's also worth calling out that the workspace integration adds support for Slack mentions, specifically because we request an additional scope to read user email addresses.

@@ -7,7 +7,21 @@ Configuring a Slack notification service will authorize access for your desired

Setting up a Notification Service requires Buildkite organization admin access.

## Adding a notification service
## Adding notification services
There are two ways to add notification services: workspace-wide and channel-specific. We reccomend using a workspace. Using a workspace only requires a single authorization for the entire workspace, allowing you to connect channels via YAML rather than multiple notifications services. The migration to a Workspace will not impact current integration implementation.
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
There are two ways to add notification services: workspace-wide and channel-specific. We reccomend using a workspace. Using a workspace only requires a single authorization for the entire workspace, allowing you to connect channels via YAML rather than multiple notifications services. The migration to a Workspace will not impact current integration implementation.
There are two ways to add notification services: workspace-wide and channel-specific. We recommend using a workspace. Using a workspace only requires a single authorization for the entire workspace, allowing you to connect channels via YAML rather than multiple notifications services. The migration to a Workspace will not impact current integration implementation.

@eleanorakh eleanorakh closed this Nov 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
integrations pipelines Pull requests that update content related to Pipelines
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants