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(discover-split): Update Discover, Alerts, Dashboards docs #11101

Merged
merged 8 commits into from
Sep 17, 2024

Conversation

narsaynorath
Copy link
Member

In preparation for the dataset split in discover and dashboards, we need to update the docs to reflect this new change.

The changes typically involve removing event.type:error or event.type:transaction from being mentioned in search fields because after the dataset is selected, these are redundant. It also updates screenshots and calls out the dataset selector more explicitly.

In preparation for the dataset split in discover and dashboards, we need
to update the docs to reflect this new change.

The changes typically involve removing `event.type:error` or
`event.type:transaction` from being mentioned in search fields because
after the dataset is selected, these are redundant. It also updates
screenshots and calls out the dataset selector more explicitly.
Copy link

vercel bot commented Aug 14, 2024

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

Name Status Preview Comments Updated (UTC)
changelog ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 26, 2024 6:54pm
sentry-docs 🛑 Canceled (Inspect) Aug 26, 2024 6:54pm
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
develop-docs ⬜️ Ignored (Inspect) Visit Preview Aug 26, 2024 6:54pm

Copy link

codecov bot commented Aug 14, 2024

Bundle Report

Changes will decrease total bundle size by 15 bytes ⬇️

Bundle name Size Change
sentry-docs-server 8.24MB 6 bytes ⬇️
sentry-docs-edge-server 254.34kB 3 bytes ⬇️
sentry-docs-client 6.25MB 6 bytes ⬇️

Copy link
Member

@shruthilayaj shruthilayaj left a comment

Choose a reason for hiding this comment

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

I wonder if we should split up this section
https://github.com/getsentry/sentry-docs/pull/11101/files#diff-0df0e661cacec6f97cfe0bc85f38b934a830010696797fbb2f93c927627af7e5R53 into explicit Errors and Transactions?
Can we also get @lizokm or someone from docs to review this?

@narsaynorath
Copy link
Member Author

@shruthilayaj

I wonder if we should split up this section

I was thinking about that as well, I tried to split them apart but I found myself duplicating the portion about being able to query for this data in Discover. I'll look at fleshing out the meaning of the datasets more and that should make it easier to split the sections.

@narsaynorath narsaynorath requested a review from a team August 15, 2024 14:21
@lizokm
Copy link
Contributor

lizokm commented Aug 15, 2024

@narsaynorath thanks for updating. I will take a look at this tomorrow!

Copy link
Contributor

@lizokm lizokm left a comment

Choose a reason for hiding this comment

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

Thanks for making these updates!

docs/product/explore/discover-queries/query-builder.mdx Outdated Show resolved Hide resolved
docs/concepts/search/searchable-properties/events.mdx Outdated Show resolved Hide resolved
docs/product/dashboards/widget-builder/index.mdx Outdated Show resolved Hide resolved
docs/product/explore/discover-queries/query-builder.mdx Outdated Show resolved Hide resolved
docs/product/explore/discover-queries/query-builder.mdx Outdated Show resolved Hide resolved
@getsantry
Copy link
Contributor

getsantry bot commented Sep 17, 2024

This pull request has gone three weeks without activity. In another week, I will close it.

But! If you comment or otherwise update it, I will reset the clock, and if you add the label WIP, I will leave it alone unless WIP is removed ... forever!


"A weed is but an unloved flower." ― Ella Wheeler Wilcox 🥀

@getsantry getsantry bot added the Stale label Sep 17, 2024
@lizokm
Copy link
Contributor

lizokm commented Sep 17, 2024

@narsaynorath should we merge this?

@narsaynorath narsaynorath merged commit 488fb62 into master Sep 17, 2024
10 checks passed
@narsaynorath narsaynorath deleted the nar/feat/discover-split-update-docs branch September 17, 2024 19:33
@github-actions github-actions bot locked and limited conversation to collaborators Oct 3, 2024
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.

3 participants