Skip to content

feat(perf): Update onPostBuild step to generate performance on-boarding docs #4888

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

Merged
merged 13 commits into from
May 17, 2022

Conversation

dashed
Copy link
Member

@dashed dashed commented Mar 30, 2022

This pull request extends the wizard onboarding documentation generation such that we generate Performance onboarding documentation content as sub-steps.

We aim to provide Performance onboarding content for JavaScript and React projects. They'll be shown in the product like this:

Screen Shot 2022-05-13 at 3 10 10 PM


Related to #3226

I intentionally did not provide any meta-documentation for how to write and contribute content to the Performance onboarding checklist at @imatwawana 's wishes; since we're only providing content for JavaScript and React platforms in the short-term to validate this feature.

@dashed dashed self-assigned this Mar 30, 2022
@vercel
Copy link

vercel bot commented Mar 30, 2022

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/39KV7NbHrzmNLLLK9ZB9ofbTV27o
✅ Preview: https://sentry-docs-git-performance-onboarding.sentry.dev

@vercel
Copy link

vercel bot commented Apr 21, 2022

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

Name Status Preview Updated
sentry-docs ✅ Ready (Inspect) Visit Preview May 17, 2022 at 7:29PM (UTC)

@dashed
Copy link
Member Author

dashed commented Apr 26, 2022

@AbhiPrasad @lobsterkatie I've added you both as reviewers. Can either/both of you take a look at the Performance onboarding documentation content I've added in this PR, and see if I'm on the right track?

These content will be displayed into the product in the form of a checklist; similar to how we serve wizard onboarding docs.

Copy link
Member

@AbhiPrasad AbhiPrasad left a comment

Choose a reason for hiding this comment

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

Can we add a note to src/wizard in a markdown file explaining how this all works?

Copy link
Contributor

@imatwawana imatwawana left a comment

Choose a reason for hiding this comment

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

I've fixed some minor wording issues, but I've also left some questions.

@@ -0,0 +1,18 @@
---
name: JavaScript
doc_link: https://docs.sentry.io/platforms/javascript/performance/
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm not sure if this is correct. The enable tracing snippet on the performance page is slightly different. This identical snippet is found at:
https://docs.sentry.io/platforms/javascript/#install

This applies to all of these files.

Copy link
Member Author

Choose a reason for hiding this comment

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

@imatwawana I plan to use the doc_link attribute to place a link to the Performance setup pages on the Performance onboarding checklist.

Although the content is slightly different here, I wanted to provide the complete setup instructions without assuming the user has installed any dependencies beforehand.

type: language
---

#### Install
Copy link
Contributor

Choose a reason for hiding this comment

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

Is there a specific reason we're using heading level 4 here? Is there a reason it isn't level 2? This applies to all of these files.

Copy link
Member Author

Choose a reason for hiding this comment

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

@imatwawana This was intentional so that we have the "right" header sizing that fits well with the inserted checkboxes:

Screen Shot 2022-05-13 at 2 53 51 PM

@dashed
Copy link
Member Author

dashed commented May 13, 2022

@imatwawana @AbhiPrasad Can either of you take a look at this pull request again? I'm fairly happy with the changes so far that I'd like to land this into master branch.

This change should have no impact to either the primary Sentry documentation website, or the Sentry product.

The product feature that will consume the changes introduced in this pull request is being developed in getsentry/sentry#33852. Thus, this pull request is a dependency of the developing Performance onboarding checklist feature.

@dashed dashed requested a review from imatwawana May 13, 2022 20:52
@dashed dashed force-pushed the performance-onboarding branch from de9cb9c to 8a3dd75 Compare May 17, 2022 19:08
@dashed dashed merged commit ac25237 into master May 17, 2022
@dashed dashed deleted the performance-onboarding branch May 17, 2022 19:50
@github-actions github-actions bot locked and limited conversation to collaborators Jun 2, 2022
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