-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
[v9] Update docs for v9 #12588
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
[v9] Update docs for v9 #12588
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
Bundle ReportChanges will increase total bundle size by 417 bytes (0.0%) ⬆️. This is within the configured threshold ✅ Detailed changes
Affected Assets, Files, and Routes:view changes for bundle: sentry-docs-server-cjsAssets Changed:
view changes for bundle: sentry-docs-client-array-pushAssets Changed:
|
coolguyzone
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good!
Co-authored-by: Alex Krawiec <[email protected]>
Co-authored-by: Alex Krawiec <[email protected]>
|
|
||
| {/* TODO(v9): Remove this page and all references to it */} | ||
|
|
||
| <Alert title="Deprecation Notice"> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should we do <Alert level="warning" ... here?
| --- | ||
| title: Manual Setup | ||
| sidebar_order: 1 | ||
| description: "Learn how to set up the SDK manually." |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
noIndex ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
what's the rationale for when we create versioned vs unversioned docs? Oh I gess duplicating "Getting Started" is just super painful given the inheritance stuff?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
correct - platform includes + versioned docs is still kinda a bit iffy
Lms24
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks!
| description: "Allows you to inspect the contents of a processed event and hint object that gets passed to beforeSend or beforeSendTransaction. (deprecated)" | ||
| --- | ||
|
|
||
| {/* TODO(v9): Remove this page and all references to it */} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
l: remove this comment (or the page :D)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I intentionally kept those because it makes sense to keep these for a while until v9 has enough adoption. We can remove them at any point in the medium term future.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
sounds good, no objections!
not sure if this works currently but maybe we also need to be able to show a page only for version 8 (while it doesn't exist for latest/newer versions)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Lms24 that does not work yet, currently we would need to add a placeholder that this feature is not available on latest or something like that
| defaultIntegrations: (integrations) => { | ||
| return integrations.filter( | ||
| (integration) => integration.name !== "BrowserSession" | ||
| ); | ||
| }, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@lforst I've had a customer try this but it didn't seems to be correct?
They are using @sentry/[email protected] and have tried this but indicated that it didn't work (as the types suggested to him: defaultIntegrations?: false | Integration[];).
Is this still correct?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Whoops I am an idiot. Should be integrations: ...
DESCRIBE YOUR PR
This updates most of the places of the docs to contain the most relevant information after v9 was released.
To be merged at about the same time as v9 is released.
Resolves getsentry/sentry-javascript#14258
IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.