Skip to content

Conversation

Christinarlong
Copy link
Contributor

@Christinarlong Christinarlong commented Sep 30, 2025

DESCRIBE YOUR PR

For notification platform cli tool, unfortunately users currently need to create a slack app to test their notifications via cli, so this makes a little easier with a pre-built manifest to speed up app creation. Adds a toggle :0) and a bit more info on ways to create a slack app.

Toggle & Images
image

image

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

  • Urgent deadline (GA date, etc.):
  • Other deadline:
  • [X ] None: Not urgent, can wait up to 1 week+

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it.
    Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

Copy link

vercel bot commented Sep 30, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
develop-docs Ready Ready Preview Comment Sep 30, 2025 9:21pm
1 Skipped Deployment
Project Deployment Preview Comments Updated (UTC)
sentry-docs Ignored Ignored Preview Sep 30, 2025 9:21pm

cursor[bot]

This comment was marked as outdated.

Copy link
Member

@leeandher leeandher left a comment

Choose a reason for hiding this comment

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

good call! Thank you for doing this, just some minor comments about defaulting to these docs as being for self-hosted, with notes for what employees should do differently.

"slash_commands": [
{
"command": "/{YOUR_NAME}-sentry",
"url": "https://{YOUR_DOMAIN}/extensions/slack/commands/",
Copy link
Member

Choose a reason for hiding this comment

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

The usage of YOUR_DOMAIN later on in the page don't include the protocol https:// at the start, so I'd either remove them here, or adjust them all over -- though I think removing them is consistent with other integrations.

**NOTE**: If you choose to use the manifest provided, you must still configure your sentry environment with the slack app's Client Secret, Client ID and Signing Secret as directed in [From Scratch](#from-scratch)

#### From Manifest
Make sure to replace all instances of `{YOUR_NAME}` and `{YOUR_DOMAIN}`!
Copy link
Member

Choose a reason for hiding this comment

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

All of the YOUR_NAME stuff is meant for internal sentry devs only, but these docs are also the same ones that Self-Hosted customers will use. I think it's worth having the regular, production names/commands (e.g. Sentry, Sentry, /sentry) in the JSON blob, but adding a note for employees.

Copy link
Member

Choose a reason for hiding this comment

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

Actually, looks like we do this on Line 200, maybe copy that over here (but also 🥔 if you adjust the table down there to also default to the production command)

- `/{yourname}-sentry`
+ `/sentry`

![Create](./create.png)

### Ways to Create a Slack App
There will be two options, `From a manifest` and `From scratch`, we have provided a manifest template below for convenience.
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 will be two options, `From a manifest` and `From scratch`, we have provided a manifest template below for convenience.
There will be two options: `From a manifest` and `From scratch`, we have provided a manifest template below for your convenience.


### Ways to Create a Slack App
There will be two options, `From a manifest` and `From scratch`, we have provided a manifest template below for convenience.
**NOTE**: If you choose to use the manifest provided, you must still configure your sentry environment with the slack app's Client Secret, Client ID and Signing Secret as directed in [From Scratch](#from-scratch)
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
**NOTE**: If you choose to use the manifest provided, you must still configure your sentry environment with the slack app's Client Secret, Client ID and Signing Secret as directed in [From Scratch](#from-scratch)
**NOTE**: If you choose to use the manifest provided, you must still configure your sentry environment with the slack app's Client Secret, Client ID, and Signing Secret as directed in [From Scratch](#from-scratch)

Copy link
Contributor

@coolguyzone coolguyzone left a comment

Choose a reason for hiding this comment

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

LGTM!

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.

3 participants