-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
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
Conversation
This pull request is being automatically deployed with Vercel (learn more). 🔍 Inspect: https://vercel.com/sentry/sentry-docs/39KV7NbHrzmNLLLK9ZB9ofbTV27o |
8f56f4d
to
d358385
Compare
31ab2c2
to
b3391e9
Compare
6814d22
to
ee30754
Compare
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
@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. |
There was a problem hiding this 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?
src/wizard/javascript/performance-onboarding/javascript/3.verify.md
Outdated
Show resolved
Hide resolved
src/wizard/javascript/performance-onboarding/react/1.install.md
Outdated
Show resolved
Hide resolved
src/wizard/javascript/performance-onboarding/react/1.install.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this 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/ |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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:
src/wizard/javascript/performance-onboarding/javascript/3.verify.md
Outdated
Show resolved
Hide resolved
af5ec4b
to
69bfa04
Compare
@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 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. |
Co-authored-by: Abhijeet Prasad <[email protected]>
…fy.md Co-authored-by: Abhijeet Prasad <[email protected]>
Co-authored-by: Abhijeet Prasad <[email protected]>
Co-authored-by: Abhijeet Prasad <[email protected]>
Co-authored-by: Isabel <[email protected]>
Co-authored-by: Isabel <[email protected]>
de9cb9c
to
8a3dd75
Compare
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:
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.