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

Update Slack Docs #5932

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Update Slack Docs #5932

wants to merge 6 commits into from

Conversation

emilyrohrbough
Copy link
Member

No description provided.

@@ -1,228 +1,143 @@
---
title: Integration for Slack
title: Cypress App for Slack
Copy link
Member

Choose a reason for hiding this comment

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

Is this agreed upon wording for this? I keep reading this as the 'Cypress App', as in the product that we have, and thinking that it's going to somehow integrate Cypress App into Slack somehow?

sidebar_position: 40
sidebar_label: Slack
---

The Cypress integration for Slack allows you to see your Cypress test results
directly in your teams' Slack channels.
One of our most-requested Cypress Cloud features, the Cypress app for Slack provides real-time results for your Cypress tests, all in one place—improving remote collaboration and giving wider visibility into test behavior and Application Quality.
Copy link
Member

Choose a reason for hiding this comment

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

Do we capitalize 'Application Quality'?


4. Click the **Enable** button in the Slack section.
- The Slack app can send results to one or more public or private Slack channels or directly to a specific user
Copy link
Member

Choose a reason for hiding this comment

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

Is 'Slack app' right here?

Copy link
Member Author

Choose a reason for hiding this comment

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

Slack app came from Slack's documentation: https://api.slack.com/docs/apps


## Per-organization configuration
To share Slack configuration for an organization:
Copy link
Member

Choose a reason for hiding this comment

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

Is 'share' the right word here? Did you mean 'update' or 'configure'?

4. You'll see a popup window that allows you to choose the channel to associate
with the organization. Cypress Cloud will post run results for all projects
in your organization to the new Slack channel.
To share Slack configuration for a project:
Copy link
Member

Choose a reason for hiding this comment

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

'share'?

docs/guides/cloud/integrations/slack.mdx Outdated Show resolved Hide resolved
docs/guides/cloud/integrations/slack.mdx Outdated Show resolved Hide resolved

When authorized, Cypress can:

- View information about a user’s identity
Copy link
Member

Choose a reason for hiding this comment

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

Can we be more specific here? This sounds really broad. Like, you can see the user's first name/last name? Or their entire profile?

Copy link
Member Author

Choose a reason for hiding this comment

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

This is what Slack shares when reviewing the app
Screenshot 2024-09-25 at 10 12 56 AM

- View information about a user’s identity
- Post messages to specific channels in Slack & direct message conversations
- Show previews of cloud.cypress.io URLs in messages
- View URLs from cloud.cypress.io
Copy link
Member

Choose a reason for hiding this comment

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

What? I don't understand this. We are authorized to see what data from the user's slack here? We already have urls from our own cloud account...

docs/guides/cloud/integrations/slack.mdx Show resolved Hide resolved
Co-authored-by: Jennifer Shehane <jennifer@cypress.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants