Skip to content

Conversation

@AbhiPrasad
Copy link
Member

High level goals

  • Remove the dropdown in https://docs.sentry.io/product/performance/getting-started/ (because users get very confused) in favour of a list of links. Doing this also means that the getting started pages are all unified (error getting started and performance getting started for each SDK).

  • Each link in that list should reference performance specific documentation under that SDK platform

  • Make sure that all the pages have links at the bottom so that users can easily navigate between different sections

  • Make sure performance set up is unified across languages

Roughly:

  1. Install SDK
  2. Edit init to add tracesSampleRate
  3. Auto instrumentation -> link to auto instrumentation framework or specific docs
  4. Manual instrumentation
  5. Use cases and examples
  6. Special options (SDK specific behaviour)
  • Explore where performance documentation should live. I think we can experiment and as long as the links are stable (or redirect), we can move stuff around afterwards.

This also came up because if we add Angular to the getting started dropdown, it replaces Browser JavaScript as the first thing rendered, which I don't think is ideal.

WIP:

  • Have Vue, React left, also want to add Gatsby tracing docs + unify Angular tracing docs.

@vercel
Copy link

vercel bot commented Aug 28, 2020

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/r4nqc9f2g/sentry.dev
✅ Preview: https://sentry-docs-git-abhi-performance-sdks.sentry.dev

Copy link
Contributor

@PeloWriter PeloWriter left a comment

Choose a reason for hiding this comment

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

Minor edits. Thank you.

@HazAT HazAT closed this Sep 3, 2020
@HazAT HazAT deleted the abhi/performance-sdks branch September 3, 2020 14:47
@github-actions github-actions bot locked and limited conversation to collaborators Dec 16, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants