You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We already migrated the general onboarding docs from sentry-docs to sentry.
No we want to do the same for the product specific ones.
Currently they load the content from sentry-docs and display it in a sidebar.
The platforms that are supported for each product are allow-listed for each one:
Performance docs are enabled for javascript & javascript-react
Replay docs are enabled for every platform in replayPlatforms.
So there is a slight miss-match between supported products per platform in the onboarding & supported platform per product in the product specific docs.
Proposal
Update the steps() functions so they always build the whole content. Atm for some platforms a part of the content is being injected.
Ensure the functions share a common interface that allows for switching single features on / off.
(e.g. only render performance content)
Support experimental & beta profiling platforms in those functions.
Adapt product specific docs to load the content via the relevant step() function and render it using their own layout.
Open questions
How should we handle multi-snippet docs?
e.g. display the selector, store the onboarding selection or just display the default choice for each platform
Should we extend the supported platforms for the performance docs?
Should platforms with experimental profiling display it in the onboarding docs?
Further todos
clicking on “set up profiling” does not pre-fill the currently selected project in the profiling docs -> we should fix that.
Background
We already migrated the general onboarding docs from
sentry-docs
tosentry
.No we want to do the same for the product specific ones.
Currently they load the content from
sentry-docs
and display it in a sidebar.The platforms that are supported for each product are allow-listed for each one:
javascript
&javascript-react
So there is a slight miss-match between supported products per platform in the onboarding & supported platform per product in the product specific docs.
Proposal
steps()
functions so they always build the whole content. Atm for some platforms a part of the content is being injected.(e.g. only render performance content)
step()
function and render it using their own layout.Open questions
Further todos
This issue is a result of this spike #53861
Phase 1
Phase 2
The text was updated successfully, but these errors were encountered: