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: add explainer on continuous profiling and show how to enable it #10048

Merged
merged 8 commits into from
Aug 27, 2024

Conversation

armcknight
Copy link
Member

@armcknight armcknight commented May 16, 2024

DESCRIBE YOUR PR

For getsentry/sentry-cocoa#3555

IS YOUR CHANGE URGENT?

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

  • Urgent deadline (GA date, etc.): July 31, 2024
  • None: Not urgent, can wait up to 1 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

Copy link

vercel bot commented May 16, 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 Jun 14, 2024 5:25pm

@armcknight armcknight marked this pull request as ready for review May 16, 2024 00:29
Copy link

codecov bot commented May 16, 2024

Bundle Report

Changes will decrease total bundle size by 14 bytes ⬇️

Bundle name Size Change
sentry-docs-server 7.38MB 3 bytes ⬇️
sentry-docs-edge-server 458.66kB 3 bytes ⬇️
sentry-docs-client 6.16MB 8 bytes ⬇️

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! Looks good overall!

I see that you set the deadline to tomorrow, but it sounds like this should maybe wait until the June 5 AM3 launch since you can't see continuous profiling data without being on the new plan. Is there a reason to publish this earlier?

docs/platforms/apple/common/profiling/index.mdx Outdated Show resolved Hide resolved
docs/platforms/apple/common/profiling/index.mdx Outdated Show resolved Hide resolved
docs/platforms/apple/common/profiling/index.mdx Outdated Show resolved Hide resolved
docs/platforms/apple/common/profiling/index.mdx Outdated Show resolved Hide resolved
@getsantry
Copy link
Contributor

getsantry bot commented Jun 7, 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 Jun 7, 2024
@armcknight
Copy link
Member Author

Hi @vivianyentran , thanks for the comments! This actually needs to wait even beyond the AM3 launch, since the frontend work to actually retrieve and view continuous profile data aren't done yet. I think it ships sometime next month. I'm going to set a new deadline and let's see how that one goes.

Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
@getsantry getsantry bot closed this Jun 22, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Jul 8, 2024
@armcknight armcknight reopened this Jul 29, 2024
@armcknight
Copy link
Member Author

@vivianyentran or maybe @kahest Could you point me towards the plan to migrate from platform-includes/getting-started-config/basic-config? I looked at #10290 but it looks like things were rewritten, not simply moved.

Copy link
Member

@kahest kahest left a comment

Choose a reason for hiding this comment

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

left small clarifying suggestions, otherwise LGTM, thanks for adding this 🙏

@kahest
Copy link
Member

kahest commented Jul 30, 2024

@armcknight we refactored the structure of the getting started docs (the "landing page") so that it's more streamlined from a user PoV, and also easier to write for the developer. e.g. we got rid of dozens of nested platform includes that were partly empty and/or duplicated content, that's why the file structure changed. IMO it makes total sense to add continuous profiling to the experimental features page for now (as you did), we can promote it to the features page or even the getting started docs when we think most/everybody should use this

@getsantry getsantry bot closed this Aug 13, 2024
@armcknight armcknight reopened this Aug 26, 2024
Co-authored-by: Karl Heinz Struggl <kahest@users.noreply.github.com>
@armcknight armcknight merged commit 770b5d5 into master Aug 27, 2024
10 checks passed
@armcknight armcknight deleted the armcknight/feat/continuous-profiling branch August 27, 2024 16:31
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants