Electron SDK v3 changes

[timfish]

These changes are for v3 of the Electron SDK which is currently in bata.

v3 Proposal
v3 Migration Guide

[vercel]

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/sentry/sentry-docs/BAuh6mUPJmgCXUEWFruczhoYedfg
✅ Preview: https://sentry-docs-git-fork-timfish-feat-electron-sdk-v3.sentry.dev

[imatwawana]

Hi @timfish, I removed the reviewers from this PR because it's still in draft, but I wanted to check with you. Do you want someone to review this now while it's still in draft or wait until this PR is open?

[timfish]

I'm planning to add more detail about the Electron specific integrations and transports so it may as well wait until I mark it ready for review.

[timfish]

I can't work out how to add additional pages to the Electron platform, so I'll add the integrations markdown and then we'll work that out later 😊

[imatwawana]

I can't work out how to add additional pages to the Electron platform, so I'll add the integrations markdown and then we'll work that out later 😊

Have you cloned the repo or are you working directly in GitHub? If you're doing the latter, there are certain types of files that aren't accessible. If you're interested in the nitty gritty of that, you can take a look at our contributor docs here for an explanation of this if you want to try to tackle it. But you can definitely also just add the markdown and then one of us can pull in your branch and create the structure.

[timfish]

I've cloned the full repository but couldn't work out how to add sub pages to the Electron docs. I'll take another look!

I was also put off by the contributing docs saying "Install Homebrew" which is obviously macOS only. Turns out that I could still get development running by setting the GATSBY_ALGOLIA_INDEX_PREFIX environment variable to a random string 🤷🏻‍♂️.

[lobsterkatie]

@timfish - I'm happy to help with wrangling the docs structure, but I took a look and I'm not sure exactly what part you have questions about. Is it that you're trying to emulate the structure here, where integrations are part of config and there are separate pages for default and "pluggable" integrations?

https://docs.sentry.io/platforms/javascript/configuration/integrations/

If so, you need to mimic the folder structure which exists for the JS-wide version of the page (the electron folder in your case substitutes for the common folder here):

LMK if that's not the question you had, or if you have others.

[vercel]

@timfish is attempting to deploy a commit to the Sentry Team on Vercel.

A member of the Team first needs to authorize it.

[timfish]

Thanks @lobsterkatie, I managed to work it out from your hints!

[lobsterkatie]

Thanks @lobsterkatie, I managed to work it out from your hints!

Great!

(And yeah, to answer your question, it's all down to folder structure, as you've figured out.)

[AbhiPrasad]

Looks great!

Not sure if this is possible, but we probably want to update the some other parts of the docs. In particular:

• release health (https://sentry-docs-git-fork-timfish-feat-electron-sdk-v3.sentry.dev/platforms/javascript/guides/electron/configuration/releases/#release-health) to reflect that we are tracking the main process
• basic options (https://sentry-docs-git-fork-timfish-feat-electron-sdk-v3.sentry.dev/platforms/javascript/guides/electron/configuration/options/) to add ElectronMainOptions

Maybe we also want to link to https://github.com/getsentry/sentry-electron/tree/master/examples somewhere?

[AbhiPrasad]

I think this is in a good place content wise.

note: we can’t merge this until we fully release v3 on npm.