getsentry / sentry-python

The official Python SDK for Sentry.io
https://sentry.io/for/python/
MIT License
1.93k stars 509 forks source link

Streamline and align the "Getting Started" docs to fit in the new structure #2292

Closed priscilawebdev closed 8 months ago

priscilawebdev commented 1 year ago

Problem Statement

Solution Brainstorm

The task goals are as follows:

Please refer to the "Frontendend Handbook" guide in our "Sentry" main repository for assistance in adding and updating the getting started docs: Frontendend Handbook.

Project: https://github.com/getsentry/team-sdks/issues/23

antonpirker commented 1 year ago

When we go over all the "getting started guides" also make sure to check if the integration is an auto-enabling integration [1] and if yes, then remove the integration from the init snippet and add a sentence to explain that it is auto enabling.

So every integration must be updated in two places (here Flask as an example):

1: list auf auto enabling integrations can be found here: https://github.com/getsentry/sentry-python/blob/838368cc37d162b871cc19e0185820911504af2e/sentry_sdk/integrations/__init__.py#L66-L83

antonpirker commented 1 year ago

Updated now almost all "Getting Started" docs on docs.sentry.io and updated also all "Getting Started" wizards in sentry product.

The docs that I did not update (because they are special docs that need more love):

Two of our integrations are missing documentation entirely:

antonpirker commented 1 year ago

PRs that need to be merged in sentry: