Skip to content

Add Vercel Integration Docs #1854

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

Merged
merged 12 commits into from
Jul 21, 2020
Merged

Add Vercel Integration Docs #1854

merged 12 commits into from
Jul 21, 2020

Conversation

ceorourke
Copy link
Member

@ceorourke ceorourke commented Jul 6, 2020

Add documentation for the Vercel integration.

screencapture-0-0-0-0-9001-workflow-integrations-global-integrations-2020-07-15-13_19_41

@ceorourke ceorourke requested review from MimiDumpling and a team July 6, 2020 21:37
@scefali
Copy link
Contributor

scefali commented Jul 6, 2020

@ceorourke Wondering if it makes more sense to have the docs send them directly to https://vercel.com/integrations/sentry/add since that's where we send them anyways. It will reduce the number of steps by two.

@ceorourke
Copy link
Member Author

@ceorourke Wondering if it makes more sense to have the docs send them directly to https://vercel.com/integrations/sentry/add since that's where we send them anyways. It will reduce the number of steps by two.

@scefali what do you think about showing both? I'm not sure if users go to the docs first or the integration directory first.

@scefali
Copy link
Contributor

scefali commented Jul 6, 2020

@ceorourke Hmmm...I think having two sets of instructions would be confusing. My thought is that if they are already in the integration directory, they will end up finding the Vercel integration and going to the marketplace link that we show. However, if they are trying to install it while looking at the docs there's a good chance they wouldn't even have Sentry open. I'm OK with leaving it as is to be consistent with the others if you'd prefer it.

@ceorourke
Copy link
Member Author

ceorourke commented Jul 6, 2020

Also, do not merge until API-1076 is completed.

Copy link
Contributor

@MimiDumpling MimiDumpling 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 the docs!

@ceorourke ceorourke requested a review from scefali July 7, 2020 23:10
@ceorourke ceorourke requested a review from scefali July 15, 2020 20:22
* If you have not already done so, [instrument your code with Sentry]({%- link _documentation/error-reporting/quickstart.md -%}).
* Ensure you have [installed a repository integration]({%- link _documentation/workflow/releases/index.md -%}#install-repo-integration) and added the relevant repository.
* Add the [Sentry Webpack Plugin](https://github.com/getsentry/sentry-webpack-plugin) to your configuration. For NextJS, use `next.config.js`.

Copy link
Contributor

Choose a reason for hiding this comment

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

@ceorourke Why is there an extra line 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.

I wanted to make them visually separate because the first 3 bullet points address the case where you're brand new to using sentry and sentry-webpack-plugin but have a Vercel project whereas the final one addresses the case where you already have sentry and sentry-webpack-plugin integrated. I was trying to keep it not long winded, but would it be more clear if I added some bold text indicating which situation you may fall into?

Copy link
Contributor

@scefali scefali left a comment

Choose a reason for hiding this comment

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

LGTM except for that one extra line

@ceorourke ceorourke force-pushed the ceorourke/API-1046 branch from 37293e4 to 090c42b Compare July 21, 2020 01:33
@ceorourke ceorourke merged commit 5a12151 into master Jul 21, 2020
@ceorourke ceorourke deleted the ceorourke/API-1046 branch July 21, 2020 19:02
@github-actions github-actions bot locked and limited conversation to collaborators Dec 16, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants