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

Migrate product specific getting-started docs #56387

Closed
8 of 9 tasks
Tracked by #53855
ArthurKnaus opened this issue Sep 18, 2023 · 0 comments
Closed
8 of 9 tasks
Tracked by #53855

Migrate product specific getting-started docs #56387

ArthurKnaus opened this issue Sep 18, 2023 · 0 comments

Comments

@ArthurKnaus
Copy link
Member

ArthurKnaus commented Sep 18, 2023

Background

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:

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

  1. Update the steps() functions so they always build the whole content. Atm for some platforms a part of the content is being injected.
  2. Ensure the functions share a common interface that allows for switching single features on / off.
    (e.g. only render performance content)
  3. Support experimental & beta profiling platforms in those functions.
  4. 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.

This issue is a result of this spike #53861

Phase 1

Preview Give feedback
  1. ArthurKnaus
  2. ArthurKnaus
  3. ArthurKnaus
  4. 79 of 79
    ArthurKnaus

Phase 2

Preview Give feedback
  1. 0 of 29
  2. 9 of 10
    ArthurKnaus
@ArthurKnaus ArthurKnaus changed the title Migrate sidebar docs Migrate product specific getting-started docs Sep 18, 2023
@github-actions github-actions bot locked and limited conversation to collaborators Dec 26, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant