Skip to content
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

ref(insights): move performance docs under insights #12720

Merged
merged 12 commits into from
Feb 25, 2025
Merged

ref(insights): move performance docs under insights #12720

merged 12 commits into from
Feb 25, 2025

Conversation

DominikB2014
Copy link
Contributor

@DominikB2014 DominikB2014 commented Feb 13, 2025 •
edited
Loading

Work for getsentry/sentry#84021

We are removing the performance link from the sidebar, all performance pages will fall under insights.

This PR isn't to be merged for a few days until the performance link is removed, but we should have doc changes ready.

This PR updates the docs to reflect the layout of the product.
image

  1. Most of /product/performance is moved to /product/insights/overview
  2. The exception to the above is the setup, retention priorities and performance overhead as these pages are more generic to insights
  3. Adds redirect for old perf pages -> insights
  4. Updates links for old perf pages to use insights links
  5. Some features are getting removed like web vitals in the transaction summary, information about those features have been removed
  6. The old perf page is moved under getting started with sentry
  7. Remove setup page
  8. Product/performance redirects to getting started/performance

@DominikB2014 DominikB2014 requested a review from a team February 13, 2025 22:19
@vercel Vercel
Copy link

vercel bot commented Feb 13, 2025 •
edited
Loading

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

Name Status Preview Comments Updated (UTC)
develop-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Feb 25, 2025 7:18pm
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Feb 25, 2025 7:18pm
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
changelog ⬜️ Ignored (Inspect) Visit Preview Feb 25, 2025 7:18pm

@codecov Codecov
Copy link

codecov bot commented Feb 13, 2025 •
edited
Loading

Bundle Report

Changes will increase total bundle size by 386 bytes (0.0%) ⬆️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sentry-docs-server-cjs 10.19MB -327 bytes (-0.0%) ⬇️
sentry-docs-edge-server-array-push 365.27kB 719 bytes (0.2%) ⬆️
sentry-docs-client-array-push 9.38MB -6 bytes (-0.0%) ⬇️

Affected Assets, Files, and Routes:

view changes for bundle: sentry-docs-edge-server-array-push

Assets Changed:

Asset Name Size Change Total Size Change (%)
src/middleware.js 719 bytes 205.18kB 0.35%
view changes for bundle: sentry-docs-client-array-push

Assets Changed:

Asset Name Size Change Total Size Change (%)
static/chunks/pages/_app-*.js -3 bytes 868.04kB -0.0%
static/chunks/4028-*.js -3 bytes 393.29kB -0.0%
static/_gVmJUbjPVnGOcmz8yk_9/_buildManifest.js (New) 578 bytes 578 bytes 100.0% 🚀
static/_gVmJUbjPVnGOcmz8yk_9/_ssgManifest.js (New) 77 bytes 77 bytes 100.0% 🚀
static/U9vmFvOpah-*.js (Deleted) -578 bytes 0 bytes -100.0% 🗑️
static/U9vmFvOpah-*.js (Deleted) -77 bytes 0 bytes -100.0% 🗑️
view changes for bundle: sentry-docs-server-cjs

Assets Changed:

Asset Name Size Change Total Size Change (%)
1729.js -3 bytes 1.46MB -0.0%
../instrumentation.js -3 bytes 791.26kB -0.0%
9523.js -3 bytes 767.46kB -0.0%
../app/[[...path]]/page.js.nft.json -106 bytes 382.2kB -0.03%
../app/platform-redirect/page.js.nft.json -106 bytes 382.12kB -0.03%
../app/sitemap.xml/route.js.nft.json -106 bytes 380.09kB -0.03%

gggritso
gggritso reviewed Feb 14, 2025
View reviewed changes
Copy link
Member

@gggritso gggritso left a comment

Choose a reason for hiding this comment

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

👀 the changes look fine to me, but it should really be up to a PM to decide if things still make sense!

I think the Insights overview page does a good job of explaining that it's about performance and tracing, but users might find it strange that generic-looking links like "our performance product" became "our insights product" (or similar, I'm just making up an example), since "Insights" is Sentry jargon

@DominikB2014
Copy link
Contributor Author

DominikB2014 commented Feb 14, 2025 •
edited
Loading

👀 the changes look fine to me, but it should really be up to a PM to decide if things still make sense!

@gggritso yup makes sense! These are changes that I spoke to @bcoe about already, he'll review these changes as well. We might tweak things to account for your feedback

@DominikB2014 DominikB2014 requested a review from bcoe February 18, 2025 20:17
coolguyzone
coolguyzone approved these changes Feb 18, 2025
View reviewed changes
Copy link
Contributor

@coolguyzone coolguyzone left a comment

Choose a reason for hiding this comment

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

I found one broken link addressed in comments, everything else looks good!

bcoe
bcoe requested changes Feb 19, 2025
View reviewed changes
Copy link
Member

@bcoe bcoe left a comment

Choose a reason for hiding this comment

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

Will was worried about the healthy amount of traffic we receive to the Performance page and wanted to consider keeping a placeholder.

He will setup a meeting later in the week to discuss with the docs team, let's hold on landing this until that time.

@DominikB2014
Copy link
Contributor Author

Will was worried about the healthy amount of traffic we receive to the Performance page and wanted to consider keeping a placeholder.

@bcoe sounds good, i'll put this PR under draft until we figure out exactly how we should proceed

@DominikB2014 DominikB2014 marked this pull request as draft February 19, 2025 16:41
@DominikB2014 DominikB2014 requested a review from bcoe February 24, 2025 17:47
@DominikB2014 DominikB2014 marked this pull request as ready for review February 25, 2025 14:57
bcoe
bcoe approved these changes Feb 25, 2025
View reviewed changes
Copy link
Member

@bcoe bcoe left a comment

Choose a reason for hiding this comment

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

:shipit:

@DominikB2014 DominikB2014 enabled auto-merge (squash) February 25, 2025 15:28
@DominikB2014 DominikB2014 enabled auto-merge (squash) February 25, 2025 17:51
@DominikB2014 DominikB2014 merged commit 306af92 into master Feb 25, 2025
13 checks passed
@DominikB2014 DominikB2014 deleted the DominikB2014/revamp-insights-docs branch February 25, 2025 19:34
codyde added a commit that referenced this pull request Feb 27, 2025
@codyde
Merge branch 'master' into codyde/javascript-tracing-refactor
3216205 
* master: (45 commits)
  feat: Mention that the cookie-sync extension works for previews (#12858)
  ref(flags): update unleashIntegration param (#12795)
  ref(sveltekit): Adjust Cloudflare setup to only use SvelteKit SDK (#12801)
  docs(python): Clarify how to init SDK in `async` app (#12854)
  move content about error capturing to "Capturing Errors and Events" from "Manual Setup" (Next.js) (#12786)
  docs(span-links): Add develop docs for span links (#12829)
  feat(java): add Reactor integration docs (#12686)
  Add Quarkus to community maintained SDKs (#12834)
  Adding unsupported hot reload (#12683)
  Fix broken links (#12844)
  feat(python): Clarification regarding start_transaction (#12835)
  docs(flutter): Fix event serverName reset in samples (#12832)
  ref(insights): move performance docs under insights (#12720)
  Bump API schema to 2e61347a (#12836)
  fix(apple): Usages of sendDefaultPii (#12833)
  Add `sendDefaultPii: true` to React Native init code snippets (#12812)
  Only show Browser vs React Native source maps alert for browser sdks (#12816)
  Add Data Collected page for React Native (#12811)
  Fix React Native Onboarding Option Buttons (#12813)
  Add Hono guide (#12710)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gggritso gggritso gggritso left review comments

@bcoe bcoe bcoe approved these changes

@coolguyzone coolguyzone coolguyzone approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@DominikB2014 @bcoe @gggritso @coolguyzone