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.

Sign up for GitHub

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

Jump to bottom

feat(python): Update docs for SDK 2.0 #9182

Merged
merged 39 commits into from
Apr 25, 2024
Merged

feat(python): Update docs for SDK 2.0 #9182

merged 39 commits into from
Apr 25, 2024

Conversation

sentrivana
Copy link
Contributor

@sentrivana sentrivana commented Feb 20, 2024 •
edited
Loading

Pre-merge checklist

If you work at Sentry, you're able to merge your own PR without review, but please don't unless there's a good reason.

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs
  • PR was reviewed and approved by a member of the Sentry docs team

Description of changes

We'll be releasing the 2.0 version of the Python SDK soon. Updating the docs to reflect this:

  • update supported versions of frameworks and Python on integration pages
  • add a note about getting support for older (now dropped) Python/framework versions to each affected integration page
  • add a note about migrating from 1.x to 2.x to the Python landing page
  • update the list of auto-enabling integrations
  • remove previously deprecated -- and now removed -- configuration options
  • warn about newly deprecated options (profiler)
  • remove mentions of Hub

Fixes getsentry/sentry-python#2665

NOT READY TO BE MERGED: Release not out yet.

@vercel Vercel
Copy link

vercel bot commented Feb 20, 2024 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 25, 2024 9:43am
1 Ignored Deployment
Name Status Preview Comments Updated (UTC)
sentry-docs-next ⬜️ Ignored (Inspect) Visit Preview Apr 25, 2024 9:43am

vivianyentran
vivianyentran reviewed Feb 20, 2024
View reviewed changes
Copy link
Contributor

@vivianyentran vivianyentran left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added some initial comments! Will plan to take another look when this is no longer just a draft :)

docs/platforms/python/index.mdx Outdated Show resolved Hide resolved
docs/platforms/python/index.mdx Show resolved Hide resolved
docs/platforms/python/integrations/tornado/index.mdx Outdated Show resolved Hide resolved
docs/platforms/python/profiling/index.mdx Outdated Show resolved Hide resolved
This was referenced Feb 21, 2024
Merged
Merged
@codecov Codecov
Copy link

codecov bot commented Mar 5, 2024 •
edited
Loading

Bundle Report

Changes will increase total bundle size by 250 bytes ⬆️

Bundle name Size Change
sentry-docs-server 7.12MB 229 bytes ⬆️
sentry-docs-edge-server 427.92kB 27 bytes ⬆️
sentry-docs-client 5.76MB 6 bytes ⬇️

@sentrivana
Copy link
Contributor Author

@vivianyentran If nothing unexpected happens we should be ready for a 2.0 release early next week -- would appreciate another look at this before then if you have time.

vivianyentran
vivianyentran approved these changes Apr 16, 2024
View reviewed changes
Copy link
Contributor

@vivianyentran vivianyentran left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added some small nit-picky comments but otherwise looks good! Thanks so much for updating these docs for the new version!

docs/platforms/python/enriching-events/scopes/index.mdx Outdated Show resolved Hide resolved
docs/platforms/python/enriching-events/scopes/index.mdx Outdated Show resolved Hide resolved
docs/platforms/python/enriching-events/scopes/index.mdx Outdated Show resolved Hide resolved
docs/platforms/python/enriching-events/scopes/index.mdx Outdated Show resolved Hide resolved
docs/platforms/python/enriching-events/scopes/index.mdx Outdated Show resolved Hide resolved
docs/platforms/python/migration/1.x-to-2.x.mdx Outdated Show resolved Hide resolved
docs/platforms/python/migration/1.x-to-2.x.mdx Outdated Show resolved Hide resolved
docs/platforms/python/migration/1.x-to-2.x.mdx Outdated Show resolved Hide resolved
docs/platforms/python/migration/1.x-to-2.x.mdx Outdated Show resolved Hide resolved
docs/platforms/python/migration/1.x-to-2.x.mdx Outdated Show resolved Hide resolved
@sentrivana sentrivana merged commit e640c7f into master Apr 25, 2024
6 checks passed
@sentrivana sentrivana deleted the ivana/python-sdk-2.0 branch April 25, 2024 09:50
@github-actions github-actions bot locked and limited conversation to collaborators May 11, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@szokeasaurusrex szokeasaurusrex szokeasaurusrex left review comments

@vivianyentran vivianyentran vivianyentran approved these changes

@antonpirker antonpirker Awaiting requested review from antonpirker

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Prepare docs for SDK 2.0
3 participants
@sentrivana @szokeasaurusrex @vivianyentran