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

docs(readme): Update Sentry docs #184

Closed
wants to merge 1 commit into from
Closed

docs(readme): Update Sentry docs #184

wants to merge 1 commit into from

Conversation

tigattack
Copy link
Member

@tigattack tigattack commented Nov 7, 2021

Initial Checklist

  • Has @tigattack / @issy been added as a reviewer?
  • If applicable, have the relevant project(s), milestone(s), and label(s) been applied?
  • If applicable, have you added details of the cog to the readme as per README.md?

Details

Does this resolve an issue?
No

Changes

Features / Fixes

N/A.

Breaking Changes

N/A.

Additional

Update Sentry docs - Added requirement.

@tigattack tigattack requested a review from issy November 7, 2021 17:58
@tigattack tigattack self-assigned this Nov 7, 2021
@tigattack tigattack added the documentation Improvements or additions to documentation label Nov 7, 2021
@tigattack tigattack marked this pull request as ready for review November 7, 2021 17:59
@@ -242,6 +242,8 @@ Send unhandled errors and performance metrics to sentry.

Configure Sentry DSN using `[p]set api sentry dsn,https://fooo@bar.baz/9`, then load the Cog `[p]load sentry`.

Requires `pip install -U sentry_sdk`.
Copy link
Member

Choose a reason for hiding this comment

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

We shouldn't need to specify this in the documentation. The pip requirements are defined in the info.json file for the cog, and should be installed automagically when you run [p]cog install <cog_name>
Feel free to correct me if there's an issue with sentry_sdk not installing when the cog is installed.

Copy link
Member Author

@tigattack tigattack Nov 7, 2021

Choose a reason for hiding this comment

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

Did not know that was a feature. Dope.
I think it's just typo'd in sentry/info.json#L13 then. I'll kill this and fix that.

Thanks Issy.

@tigattack tigattack closed this Nov 7, 2021
@tigattack tigattack deleted the docs/readme branch November 7, 2021 18:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants