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(onboarding): Add profiling onboarding for ruby & co #88888

Merged
merged 4 commits into from
Apr 8, 2025

Conversation

priscilawebdev
Copy link
Member

@priscilawebdev priscilawebdev commented Apr 7, 2025

Add specific profiling docs for ruby, rack, and rails.

Notes:

Added docs just for Stackprof as it is what we display in our main onboarding. This made me wonder if we should provide a way to switch between Stackprof and Vernier.

Also, in the main onboarding we guide users to install gem "sentry-rails" while in the docs, we do not do the same. What is correct? cc @sl0thentr0py

closes TET-256

@github-actions github-actions bot added the Scope: Frontend Automatically applied to PRs that change frontend components label Apr 7, 2025
@priscilawebdev priscilawebdev marked this pull request as ready for review April 7, 2025 11:52
@priscilawebdev priscilawebdev requested a review from a team as a code owner April 7, 2025 11:52
@ArthurKnaus
Copy link
Member

@priscilawebdev since it is 3 times the same content, it could be in one util.

@priscilawebdev
Copy link
Member Author

@ArthurKnaus I thought about it, and for future cases like this, I’d like to avoid creating a separate file for each platform in the utils folder just to render the profiling onboarding or something similar. I was thinking we could export the function and reuse it where needed instead, keeping things co-located. What do you think?

@@ -10,6 +10,68 @@ import {t, tct} from 'sentry/locale';

type Params = DocsParams;

export function getProfilingOnboarding(): OnboardingConfig {
Copy link
Member

Choose a reason for hiding this comment

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

nit: could be a simple constant

Suggested change
export function getProfilingOnboarding(): OnboardingConfig {
export function profilingOnboarding = {

@priscilawebdev priscilawebdev enabled auto-merge (squash) April 8, 2025 08:48
@priscilawebdev priscilawebdev merged commit b518cc2 into master Apr 8, 2025
41 checks passed
@priscilawebdev priscilawebdev deleted the priscila/feat/onboarding/ruby/add-profiling branch April 8, 2025 09:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Scope: Frontend Automatically applied to PRs that change frontend components
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants