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

🔧 chore: cleanup slack & msteams dev docs #12235

Merged
merged 4 commits into from
Jan 7, 2025

Conversation

iamrajjoshi
Copy link
Member

cleaned up the instructions for slack and msteams installation for development

@iamrajjoshi iamrajjoshi requested a review from a team January 2, 2025 16:15
@iamrajjoshi iamrajjoshi self-assigned this Jan 2, 2025
Copy link

vercel bot commented Jan 2, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
develop-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 6, 2025 7:12pm
2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
changelog ⬜️ Ignored (Inspect) Visit Preview Jan 6, 2025 7:12pm
sentry-docs ⬜️ Ignored (Inspect) Visit Preview Jan 6, 2025 7:12pm

@cathteng cathteng requested a review from a team January 2, 2025 16:17
Copy link
Member

@cathteng cathteng left a comment

Choose a reason for hiding this comment

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

questions

@@ -28,7 +28,7 @@ discord.client-secret: "<client secret>"
discord.bot-token: "<bot token>"
```

**NOTE**: If you're doing local Sentry development, you should use a tool like Ngrok and add `system.url-prefix: "https://<your_subdomain>.ngrok.io"` to your `~/.sentry/config.yml`. Otherwise, installing the Discord bot won't work, as it will not be able to communicate with your local Sentry instance.
**NOTE**: If you're doing local Sentry development, you should use a tool like Ngrok and use `getsentry` repo when starting your Sentry server. Otherwise, installing the Discord bot won't work, as it will not be able to communicate with your local Sentry instance.
Copy link
Member

Choose a reason for hiding this comment

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

we still need to use ngrok right? does it matter if you use getsentry or sentry if you use ngrok?

Copy link
Member Author

Choose a reason for hiding this comment

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

the getsentry repo is where the Ngrok config is more actively maintained and will have everything preconfigured and setup so u don't need to modify stuff like url-prefix which has been janky in the past. i have linked the ngrok docs i wrote under the diff here with more details

Copy link
Member Author

Choose a reason for hiding this comment

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

the getsentry repo is where the Ngrok config is more actively maintained and will have everything preconfigured and setup so u don't need to modify stuff like url-prefix which has been janky in the past.

Copy link
Member Author

Choose a reason for hiding this comment

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

i updated this since we fixed the sentry ngrok presets

@@ -21,11 +21,13 @@ slack.client-secret: <client secret>
slack.signing-secret: <signing secret>
```

**NOTE**: If you're doing local Sentry development, you should use a tool like Ngrok and add `system.url-prefix: "https://<your_subdomain>.ngrok.io"` to your `~/.sentry/config.yml`, otherwise, installing the Slack APP will complain because the redirect URI points to `localhost:8000`. Also, install the Slack integration from the ngrok subdomain or it will fail to install.
If you a Sentry employee, you can set the `slack.client-id` and `slack.client-secret` in `devlocal.py` inside `getsentry` instead.
Copy link
Member

Choose a reason for hiding this comment

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

is devlocal.py only a sentry employee thing or can anyone add it and use it for local dev?

Copy link
Member Author

Choose a reason for hiding this comment

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

its a sentry employee thing. i had to think about this for a while, whether i should mention it here, but i felt it was ok because we explain the difference between sentry and getsentry

https://develop.sentry.dev/application-architecture/sentry-vs-getsentry/

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.

Thanks for updating!

@iamrajjoshi iamrajjoshi merged commit 95b7e02 into master Jan 7, 2025
10 checks passed
@iamrajjoshi iamrajjoshi deleted the raj/cleanup-slack-dev-docs branch January 7, 2025 17:19
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.

4 participants