Skip to content

fix: slack docs updates #2

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: base-sha/b3f46fe5803f4df535c8102021a5102b76a15fde
Choose a base branch
from
Open

fix: slack docs updates #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
12e3bd7
[fix]: adds Privacy Policy to footer
kaushalkapasi May 7, 2024
1a98a03
[fix]: update slack app docs
kaushalkapasi May 7, 2024
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
42 changes: 23 additions & 19 deletions docs/integrations/slack.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,43 +3,47 @@ title: Slack
sidebar_position: 11
---

This guide explains how to set up and use the DevCycle Slack app.
Copy link

@SourceryAI SourceryAI May 8, 2024

Choose a reason for hiding this comment

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

suggestion (code_refinement): Consistency in product naming should be maintained throughout the document.

The change from 'DevCycle Slack app' to 'DevCycle App for Slack' should be consistently applied in all instances within the document to avoid confusion.

Suggested change
This guide explains how to set up and use the DevCycle Slack app.
This guide explains how to set up and use the DevCycle App for Slack.

Copy link

@SourceryAI SourceryAI May 8, 2024

Choose a reason for hiding this comment

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

Is this comment correct?

Copy link

@SourceryAI SourceryAI May 8, 2024

Choose a reason for hiding this comment

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

Is this comment helpful?

Copy link

@SourceryAI SourceryAI May 8, 2024

Choose a reason for hiding this comment

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

Is the comment type correct?

Copy link

@SourceryAI SourceryAI May 8, 2024

Choose a reason for hiding this comment

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

Is the comment area correct?

Copy link

@SourceryAI SourceryAI May 8, 2024

Choose a reason for hiding this comment

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

What type of LLM test could this comment become?

  • 👍 - this comment is really good/important and we should always make it
  • 👎 - this comment is really bad and we should never make it
  • no reaction - don't turn this comment into an LLM test


You can use the DevCycle Slack app to keep track of and monitor feature flags within your team's Slack workspace.
This guide explains how to set up and use the DevCycle App for Slack.

You can use the DevCycle App for Slack to keep track of and monitor feature flags within your team's Slack workspace.

## Setup

1. Navigate to the Settings page in the DevCycle Dashboard, click on Integrations in the side navigation bar, and click View on the Slack integration.
1. Navigate to the Settings page in the DevCycle Dashboard, click on Integrations in the side navigation bar, and click View on the Slack integration.

![Screenshot of Setttings Page on dashboard](/apr-2024-slack1.png)

2. Click on the `Add to Slack` button and connect the DevCycle Slack app with your workspace.
2. Click on the `Add to Slack` button and connect the DevCycle App for Slack with your workspace.

![Screenshot of Integrations tab on dashboard](/apr-2024-slack2.png)

3. Once the DevCycle app has been added, you can now subscribe to Feature changes on a project-level or by individual Feature(s).
4. First, navigate to the Slack channel where you would like to have the Slack messages to be posted.
- To add a subscription for project-level changes, use the command `/devcycle subscribe [project-key]`. To find a project's respective key, go to your organization's [Project Settings page](https://app.devcycle.com/r/settings/projects) and copy the key under the Project name.
![Screenshot of Integrations tab on dashboard](/apr-2024-slack6.png)
- To add a subscription for individual feature changes, use the command `/devcycle subscribe [project-key] [feature-key]`.
3. Once the DevCycle app has been added, you can now subscribe to Feature changes on a project-level or by individual Feature(s).
4. First, navigate to the Slack channel where you would like to have the Slack messages to be posted.

- To add a subscription for project-level changes, use the command `/devcycle subscribe project-key`. To find a project's respective key, go to your organization's [Project Settings page](https://app.devcycle.com/r/settings/projects) and copy the key under the Project name.
![Screenshot of Integrations tab on dashboard](/apr-2024-slack6.png)
- To add a subscription for individual feature changes, use the command `/devcycle subscribe project-key [-f feature-key]`.
- To add a subscription for a project or feature changes on a specific environment, add the flag `[-e environment-key]` to the command. For example,
- All Project changes for the specified Environment: `/devcycle subscribe project-key [-e environment-key]`
- All Feature changes that impact the specified Environment: `/devcycle subscribe project-key [-f feature-key] [-e environment-key]`
Copy link

@SourceryAI SourceryAI May 8, 2024

Choose a reason for hiding this comment

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

suggestion (code_clarification): Clarify the use of environment-specific subscriptions.

The documentation should include examples or a clearer explanation of how environment keys are used and their impact on the subscription commands to ensure users can effectively utilize this feature.

Suggested change
- All Feature changes that impact the specified Environment: `/devcycle subscribe project-key [-f feature-key] [-e environment-key]`
- To add a subscription for a project or feature changes on a specific environment, add the flag `[-e environment-key]` to the command. The `environment-key` is a unique identifier for different deployment stages (e.g., development, staging, production). This allows you to receive notifications specifically tailored to changes in the selected environment. For example:
- For project changes in the production environment: `/devcycle subscribe project-key -e prod`
- For feature changes in the development environment: `/devcycle subscribe project-key -f feature-key -e dev`

Copy link

@SourceryAI SourceryAI May 8, 2024

Choose a reason for hiding this comment

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

Is this comment correct?

Copy link

@SourceryAI SourceryAI May 8, 2024

Choose a reason for hiding this comment

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

Is this comment helpful?

Copy link

@SourceryAI SourceryAI May 8, 2024

Choose a reason for hiding this comment

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

Is the comment type correct?

Copy link

@SourceryAI SourceryAI May 8, 2024

Choose a reason for hiding this comment

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

Is the comment area correct?

Copy link

@SourceryAI SourceryAI May 8, 2024

Choose a reason for hiding this comment

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

What type of LLM test could this comment become?

  • 👍 - this comment is really good/important and we should always make it
  • 👎 - this comment is really bad and we should never make it
  • no reaction - don't turn this comment into an LLM test


5. Once you've susbcribed, you're all set! Go ahead and make some changes to a Feature then check your Slack Channel for notifications.

## Example Slack Message
## Example Slack Message

![Screenshot of Slack Message](/apr-2024-slack5.png)

The `View Project [Name]` button will take you to the project that the Feature belongs to.
The `View Project [Name]` button will take you to the project that the Feature belongs to.

The `View Changes on Feature [Feature Name]` will take you to the Audit Log entry with more details about the Feature modification.
The `View Changes on Feature` will take you to the Audit Log entry with more details about the Feature modification.

## Slack Commands
- `/devcycle [ subscribe | unsubscribe | list ]`
- `/dvc [ subscribe | unsubscribe | list ]`
## Slack Commands

## Uninstall the DevCycle Slack App
- `/devcycle [ subscribe | unsubscribe | list | help ]`
- `/dvc [ subscribe | unsubscribe | list | help ]`

In the case that you connected your Slack app to the wrong workspace or would like to remove it, please follow the instructions in this [Slack Help Center article](https://slack.com/help/articles/360003125231-Remove-apps-and-custom-integrations-from-your-workspace#remove-an-app).
## Uninstall the DevCycle App for Slack

![How to Remove DevCycle Slack App](/apr-2024-slack-uninstall.png)
In the case that you connected your Slack app to the wrong workspace or would like to remove it, please follow the instructions in this [Slack Help Center article](https://slack.com/help/articles/360003125231-Remove-apps-and-custom-integrations-from-your-workspace#remove-an-app).

![How to Remove DevCycle App for Slack](/apr-2024-slack-uninstall.png)
4 changes: 4 additions & 0 deletions src/theme/Footer/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ const navigation = {
{ name: 'DevCycle', href: 'https://devcycle.com' },
{ name: 'Dashboard', href: 'https://app.devcycle.com' },
{ name: 'Blog', href: 'https://blog.devcycle.com' },
{
name: 'Privacy Policy',
href: 'https://devcycle.com/company/privacy-policy',
},
],
social: [
{
Expand Down
Binary file modified static/apr-2024-slack2.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.