getsentry / sentry-docs

Sentry's documentation (and tools to build it)
https://docs.sentry.io
Other
336 stars 1.47k forks source link

Combine setup + configuration sections of user feedback SDK docs #9426

Open lizokm opened 8 months ago

lizokm commented 8 months ago

I find it suboptimal to split things in “Set Up” and “Configuration” because I often end up on set up (“landing page”) find some configuraiton then go list on .. Stuff’s missing? where did it go

For example: JavaScript User Feedback: https://docs.sentry.io/platforms/javascript/user-feedback/

<https://docs.sentry.io/platforms/javascript/user-feedback/#user-feedback-widget|User Feedback Widget> • https://docs.sentry.io/platforms/javascript/user-feedback/#pre-requisites|Pre-requisiteshttps://docs.sentry.io/platforms/javascript/user-feedback/#installation|Installation • <https://docs.sentry.io/platforms/javascript/user-feedback/#set-up|Set Up> <https://docs.sentry.io/platforms/javascript/user-feedback/#user-feedback-api|User Feedback API>

<https://docs.sentry.io/platforms/javascript/user-feedback/#crash-report-modal|Crash-Report Modal> • https://docs.sentry.io/platforms/javascript/user-feedback/#integration|Integration

Has these sections ^ (cramped between the top package name/version and a list of guides) In there, we see some callout to Configuration (see screenshot)

Then, separate from that, on a different Configuration page we have:

<https://docs.sentry.io/platforms/javascript/user-feedback/configuration/#user-feedback-widget|User Feedback Widget> • https://docs.sentry.io/platforms/javascript/user-feedback/configuration/#general|General • <https://docs.sentry.io/platforms/javascript/user-feedback/configuration/#user-and-form|User and Form> • <https://docs.sentry.io/platforms/javascript/user-feedback/configuration/#text-customization|Text Customization> • <https://docs.sentry.io/platforms/javascript/user-feedback/configuration/#theme-customization|Theme Customization> • <https://docs.sentry.io/platforms/javascript/user-feedback/configuration/#additional-ui-customization|Additional UI Customization> • <https://docs.sentry.io/platforms/javascript/user-feedback/configuration/#event-callbacks|Event Callbacks> • <https://docs.sentry.io/platforms/javascript/user-feedback/configuration/#bring-your-own-button|Bring Your Own Button> • <https://docs.sentry.io/platforms/javascript/user-feedback/configuration/#bring-your-own-widget|Bring Your Own Widget> <https://docs.sentry.io/platforms/javascript/user-feedback/configuration/#crash-report-modal|Crash-Report Modal>

Some Widget and Crash-Report Modal info on both pages.

Do we need to have Set Up Xyz and Configuration for all sub-headings? Or can I make a PR with a main User Feedback landing page describing the different types (Widget, API, Modal, etc). Then linking to their own page where ALL data relevant to them can be found?

Slack Message

getsantry[bot] commented 8 months ago

Assigning to @getsentry/support for routing ⏲️

getsantry[bot] commented 8 months ago

Routing to @getsentry/product-owners-docs for triage ⏲️

michellewzhang commented 8 months ago

We have a lot of links in Sentry (specifically our new user feedback in-app onboarding) linking out to these two existing pages (configuration & setup) so it would be great if the old links could somehow be auto-directed to the new links!

lizokm commented 8 months ago

Thanks for the heads up, I'll make sure to add redirects to the pages.