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.

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

feat(issues): Add highlights and remove duplicate data #10042

Merged
merged 9 commits into from
May 16, 2024

Conversation

leeandher
Copy link
Member

@leeandher leeandher commented May 15, 2024

DESCRIBE YOUR PR

  • Adding a section describing the new Event Highlights page on issue details
  • Removed duplicate data from /issues/issue-details/ and /issues/issue-details/error-issues/, most images/content lives on the root page now
  • Updates screenshots of context and tags for these pages
  • Removes sections for trace details in favor of 'Contexts'
  • [Bonus] Fixed a bug where the table of contents would encode a %20 in the anchor links and not scroll due to an extra space.

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

  • GA Date: End of Week

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it.
    Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs
  • PR was reviewed and approved by a member of the Sentry docs team

EXTRA RESOURCES

Copy link

vercel bot commented May 15, 2024

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

Name Status Preview Comments Updated (UTC)
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 16, 2024 4:10pm

Copy link
Member

@armenzg armenzg left a comment

Choose a reason for hiding this comment

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

Top-quality changes.

Copy link

codecov bot commented May 15, 2024

Bundle Report

Changes will decrease total bundle size by 1.07kB ⬇️

Bundle name Size Change
sentry-docs-server 7.38MB 1.06kB ⬇️
sentry-docs-edge-server 458.69kB 3 bytes ⬇️
sentry-docs-client 6.16MB 10 bytes ⬇️

Copy link
Member Author

Choose a reason for hiding this comment

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

All of these images were removed since they duplicated the images on /issues/issues-details/. Any old images from /issues/issues-details/ were replaced with updated ones from here (e.g. Trace Navigator, etc.)

docs/product/issues/issue-details/index.mdx Show resolved Hide resolved
The trace navigator (which you'll see right below the Event ID), is a timeline view that shows any other issues that might be part of the current event's [trace](/product/sentry-basics/tracing/distributed-tracing). The trace navigator shows up to 100 additional issues and you can click on any of them to view their details. Seeing (and being able to toggle between) multiple issues connected to a single event can be helpful for figuring out what went wrong. Note that the trace navigator is only available for issues that are part of a trace and have more than one issue.

Issues in the trace navigator timeline are represented by dots of various shades of red. Here are the different types to note:
The trace navigator (which displays below the date) is an abbreviated view of the related [trace](/product/sentry-basics/tracing/distributed-tracing) for the current transaction. It displays up to six nodes, each representing different groups of the event's trace:
Copy link
Member Author

Choose a reason for hiding this comment

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

This isn't new documentation. This page had the older copy/screenshots of the Trace Navigator which were taking from /issus/issue-details/error-issues/ and then removed from there.

@@ -62,13 +79,15 @@ Click "View Full Trace" to display the [Trace View](/product/sentry-basics/traci

A _suspect commit_ is a commit that's been identified as potentially having caused the error event. If you've configured [suspect commits](/product/issues/suspect-commits/), these are displayed. This allows you to immediately investigate commits that are likely to have generated the issue. The author of the suspect commit is also suggested as an assignee for the issue.

## Tags
## Event Highlights
Copy link
Member Author

Choose a reason for hiding this comment

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

This is new copy


## Tabs
These event tags can be filtered by one of the available categories, and clicking any of the hover dropdowns will provide you with a few more search options. Sentry will display tags containing '`.`' characters as a tree structure to make things a bit more readable, but searching should always use the full tag name (e.g. `organization.slug` instead of `slug`).
Copy link
Member Author

Choose a reason for hiding this comment

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

This middle paragraph is new copy as well.

@@ -88,23 +107,34 @@ You can set your own <PlatformLink to="/enriching-events/breadcrumbs/">breadcrum

If you’ve enabled [Session Replay](/product/session-replay/), you’ll see a replay preview under Breadcrumbs if there’s one associated with the event you’re viewing. Replays can be associated with both frontend and [backend errors](/product/session-replay/getting-started#replays-for-backend-errors) (as long as distrubted tracing is set up). Clicking on the replay preview will lead you to the [Replay Details](/product/session-replay/replay-details/) page.

## Trace Details
Copy link
Member Author

Choose a reason for hiding this comment

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

Opted to remove this section since it describes one type of context when there are endless others. At best, it links out to distributed tracing (something the #Trace Navigator section already does) and mentions that there's a link.

Instead I've added the contexts section to replace it.

- [React Native](/platforms/react-native/enriching-events/screenshots/)
- [Unity](/platforms/unity/enriching-events/screenshots/)

## Contexts
Copy link
Member Author

Choose a reason for hiding this comment

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

This is all new copy

src/components/tableOfContents/index.tsx Show resolved Hide resolved
Copy link
Contributor

@vivianyentran vivianyentran left a comment

Choose a reason for hiding this comment

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

Added some copyedits but overall this is great! Love the changes you've made and your comments were really helpful context in reviewing this 🙂

docs/product/issues/issue-details/error-issues/index.mdx Outdated Show resolved Hide resolved
docs/product/issues/issue-details/error-issues/index.mdx Outdated Show resolved Hide resolved
docs/product/issues/issue-details/index.mdx Show resolved Hide resolved
docs/product/issues/issue-details/index.mdx Outdated Show resolved Hide resolved
docs/product/issues/issue-details/index.mdx Show resolved Hide resolved
docs/product/issues/issue-details/index.mdx Outdated Show resolved Hide resolved
docs/product/issues/issue-details/index.mdx Outdated Show resolved Hide resolved
docs/product/issues/issue-details/index.mdx Outdated Show resolved Hide resolved
src/components/tableOfContents/index.tsx Show resolved Hide resolved
@leeandher leeandher merged commit 7fbe5a4 into master May 16, 2024
8 checks passed
@leeandher leeandher deleted the leander/highlights-docs branch May 16, 2024 17:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants