feat: Update setup docs for JS SDKs #6836
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
AbhiPrasad
approved these changes
May 4, 2023
mydea
force-pushed
the
fn/browser-js-improvements
branch
from
e55bfd0
to
c7d4cab
Compare
|
Seems like this will close #5351? |
shanamatthews
approved these changes
May 4, 2023
There was a problem hiding this comment.
Thanks so much for these cleanups @mydea !
This looks really good. Just left some small suggestions for cleanup and questions.
FYI, we are starting to add linting on the docs code snippets, so whitespace fixes should start happening automatically soon.
src/platform-includes/performance/configure-sample-rate/javascript.mdx
Outdated
Show resolved
Hide resolved
src/platforms/javascript/common/configuration/sentry-testkit/index.mdx
Outdated
Show resolved
Hide resolved
Lms24
approved these changes
May 5, 2023
src/platform-includes/performance/enable-automatic-instrumentation/javascript.mdx
Show resolved
Hide resolved
mydea
force-pushed
the
fn/browser-js-improvements
branch
from
c7d4cab
to
0dcf4b6
Compare
mydea
changed the title
mydea
commented
May 5, 2023
| @@ -1,13 +1,16 @@ | |||
| To use this SDK, initialize Sentry in your Remix entry points for both the client and server. | |||
|
|
|||
| ```typescript {filename: entry.client.tsx} | |||
| Create two files in the root directory of your project, `entry.client.tsx` and `entry.server.tsx` (if they don't exist yet). In these files, add your initialization code for the client-side SDK and server-side SDK, respectively. | |||
There was a problem hiding this comment.
@AbhiPrasad could you sanity check this?
mydea
commented
May 5, 2023
mydea
commented
May 5, 2023
| @@ -26,17 +26,25 @@ If you're updating your Sentry SDK to the latest version, check out our [migrati | |||
|
|
|||
| Create three files in the root directory of your project, `sentry.client.config.js`, `sentry.server.config.js` and `sentry.edge.config.js`. In these files, add your initialization code for the client-side SDK and server-side SDK, respectively. We've included some examples below. | |||
|
|
|||
| For each configuration: | |||
| The three configuration types are mostly the same, except that some configuration, like the one for Session Replay, only works in `sentry.client.config.js`. | |||
There was a problem hiding this comment.
@lforst could you sanity check this?
src/platform-includes/getting-started-config/javascript.remix.mdx
Outdated
Show resolved
Hide resolved
lforst
reviewed
May 6, 2023
|
|
||
| ```javascript {filename:sentry.(client|server|edge).js} | ||
| ```javascript {tabTitle:Client} {filename:sentry.client.config.(js|ts)} |
lforst
approved these changes
May 6, 2023
There was a problem hiding this comment.
I have one slight worry but let's see what happens first: Adding replay has a giant bundle size impact but we don't tell people here. They might be shocked when looking at their graphs at first. In the Next.js wizard I added a comment in the code saying like "if you don't plan on using the replay feature you can remove the integration".
Just a thought - we don't have to do this now but we could if we get a lot of issues complaining about bundle size again.
style(lint): Auto commit lint changes style(lint): Auto commit lint changes style(lint): Auto commit lint changes style(lint): Auto commit lint changes style(lint): Auto commit lint changes style(lint): Auto commit lint changes style(lint): Auto commit lint changes style(lint): Auto commit lint changes style(lint): Auto commit lint changes style(lint): Auto commit lint changes style(lint): Auto commit lint changes style(lint): Auto commit lint changes
mydea
force-pushed
the
fn/browser-js-improvements
branch
from
8ef6226
to
b1ad4db
Compare
mydea
force-pushed
the
fn/browser-js-improvements
branch
from
21bf873
to
c4f1c83
Compare
Lms24
pushed a commit
that referenced
this pull request
May 8, 2023
--------- Co-authored-by: Shana Matthews <[email protected]>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I took a bit of time to go through the browser JS docs pages, and just cleaned them up a bit/aligned them a bit in minor ways that I noticed.
Major things I did:
<PlatformIdentifier>, I updated those (that I found)Closes #5351