Skip to content

Restructure Node SDK docs. #5710

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 9 commits into from
Nov 14, 2022
Merged

Restructure Node SDK docs. #5710

merged 9 commits into from
Nov 14, 2022

Conversation

onurtemizkan
Copy link
Collaborator

Resolves: #3605

Summary:

  • Removed references to client-side usage / snippets.
  • Restructured the sidebar to match the flow of other JavaScript docs.
  • Moved parts to platform-includes when possible.
  • Removed outdated remarks / warnings about old versions.

@vercel
Copy link

vercel bot commented Nov 2, 2022

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

A member of the Team first needs to authorize it.

@vercel
Copy link

vercel bot commented Nov 2, 2022 •
edited
Loading

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

Name Status Preview Updated
sentry-docs ✅ Ready (Inspect) Visit Preview Nov 11, 2022 at 6:38PM (UTC)

@lforst lforst self-requested a review November 3, 2022 14:13
@lobsterkatie lobsterkatie self-requested a review November 8, 2022 14:49
@lobsterkatie lobsterkatie self-assigned this Nov 8, 2022
@AbhiPrasad AbhiPrasad requested a review from lizokm November 9, 2022 12:45
AbhiPrasad
AbhiPrasad reviewed Nov 9, 2022
View reviewed changes
Copy link
Member

@AbhiPrasad AbhiPrasad left a comment

Choose a reason for hiding this comment

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

I like this re-arrange, but will defer to @lizokm for a final ✅. We can address my comment in another PR if this gets merged in.

src/platforms/common/performance/index.mdx Outdated
@@ -89,7 +90,7 @@ Learn more about how the options work in <PlatformLink to="/configuration/sampli

## Verify

<PlatformSection supported={["react-native", "java.spring", "java.spring-boot", "android", "javascript", "apple", "dart", "rust"]} >
<PlatformSection supported={["react-native", "java.spring", "java.spring-boot", "android", "javascript", "apple", "dart", "rust"]} notSupported={["node"]} >
Copy link
Member

Choose a reason for hiding this comment

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

Instead of making this notSupported, can we restructure the performance docs for Node to have the automatic-instrumentation and custom-instrumentation sections like we do in JS (https://docs.sentry.io/platforms/javascript/performance/instrumentation/) and Android (https://docs.sentry.io/platforms/android/performance/instrumentation/)

This also means we can add custom performance metric docs to Node as well following that format. We can do this in a follow-up PR though.

Copy link
Member

Choose a reason for hiding this comment

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

@onurtemizkan #5760 is blocked on this change - so let's try to include that here.

@AbhiPrasad AbhiPrasad mentioned this pull request Nov 10, 2022
Merged
imatwawana
imatwawana reviewed Nov 10, 2022
View reviewed changes
Copy link
Contributor

@imatwawana imatwawana left a comment

Choose a reason for hiding this comment

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

This probably hasn't had a good review in a long time, so I have a lot of wording edits. Most of these are trivial, but there are a few where I have questions. However, I don't understand why we've moved content that's on platform-specific pages into includes. This is increasing complexity rather than reducing it. Can someone explain?

src/platform-includes/configuration/breadcrumb-hints/node.mdx Outdated
@@ -0,0 +1,8 @@
`level` / `input`

: For breadcrumbs created from console log interceptions, this holds the original console log level and the original input data to the log function.
Copy link
Contributor

Choose a reason for hiding this comment

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

Using a comma in these descriptions (before "this") vs a period (like in the default version of this include) makes for a slightly different meaning. A period makes them two stand-alone statements, while a comma makes the second statement dependent on the first one. Which meaning are you trying to communicate?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I think these should be two stand-alone statements. Updating.

@onurtemizkan
Copy link
Collaborator Author

Updated the PR

@imatwawana:

why we've moved content that's on platform-specific pages into includes. This is increasing complexity rather than reducing it

Yes, I was trying to reduce duplication at first, but it didn't end up as I expected. Moved content back to platform specific pages.

@AbhiPrasad:

can we restructure the performance docs for Node to have the automatic-instrumentation and custom-instrumentation sections like we do in JS

Done 👍 Not sure if the steps in automatic-instrumentation page can be considered completely automatic, though.

imatwawana
imatwawana approved these changes Nov 11, 2022
View reviewed changes
Copy link
Contributor

@imatwawana imatwawana left a comment

Choose a reason for hiding this comment

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

I made a couple small formatting suggestions, but otherwise this LGTM!

@imatwawana imatwawana removed the request for review from lizokm November 11, 2022 18:24
mydea
mydea reviewed Nov 14, 2022
View reviewed changes
src/platforms/node/common/configuration/integrations/default-integrations.mdx Outdated
@@ -140,6 +125,25 @@ _Import name: `Sentry.Integrations.Modules`_

This integration fetches names of all currently installed Node modules and attaches the list to the event. Once fetched, Sentry will cache the list for later reuse.

## Modifying System Integrations
Copy link
Member

Choose a reason for hiding this comment

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

This should go below RequestData, I think!

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yes, that makes sense! And thanks for updating!

mydea
mydea approved these changes Nov 14, 2022
View reviewed changes
Copy link
Member

@mydea mydea left a comment

Choose a reason for hiding this comment

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

Left one comment that should be resolved, other than this I think this is good to go!

Lms24
Lms24 reviewed Nov 14, 2022
View reviewed changes
Copy link
Member

@Lms24 Lms24 left a comment

Choose a reason for hiding this comment

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

LGTM! 🚀

@Lms24 Lms24 merged commit e8c77a6 into getsentry:master Nov 14, 2022
@github-actions github-actions bot locked and limited conversation to collaborators Nov 30, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@AbhiPrasad AbhiPrasad AbhiPrasad left review comments

@mydea mydea mydea approved these changes

@Lms24 Lms24 Lms24 approved these changes

@imatwawana imatwawana imatwawana approved these changes

@lforst lforst Awaiting requested review from lforst

@lobsterkatie lobsterkatie Awaiting requested review from lobsterkatie

Assignees

@lobsterkatie lobsterkatie

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Node Docs Updates
6 participants
@onurtemizkan @mydea @Lms24 @AbhiPrasad @imatwawana @lobsterkatie