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

docs: Update readme, migration guide #2754

Merged
merged 5 commits into from
Feb 22, 2024

Conversation

sentrivana
Copy link
Contributor

@sentrivana sentrivana commented Feb 21, 2024

Small update to the migration guide and readme.

  • sort migration guide items from more important/affecting more users to less important (e.g. internal API changes)
  • add a note to migration guide about dropping support for the /store endpoint
  • update readme with a link to the migration guide on docs.sentry.io
  • remove private module changes from migration guide

@sentrivana sentrivana marked this pull request as ready for review February 21, 2024 14:40
Copy link
Member

@szokeasaurusrex szokeasaurusrex left a comment

Choose a reason for hiding this comment

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

Looks good, but please address my inline comment

Comment on lines 36 to 37
- `sentry_sdk._functools` was removed.
- A number of compatibility utilities were removed from `sentry_sdk._compat`: the constants `PY2` and `PY33`; the functions `datetime_utcnow`, `utc_from_timestamp`, `implements_str`, `contextmanager`; and the aliases `text_type`, `string_types`, `number_types`, `int_types`, `iteritems`, `binary_sequence_types`.
Copy link
Member

Choose a reason for hiding this comment

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

I realize these two items were here before and have just been reordered, but do we really need to mention them at all? They are private API, so we should be the only ones using them, anyways. I think we should remove them so that the migration guide only contains information which is important to users as they upgrade.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah I was being overly cautious including everything. Removed the _functools and _compat changes now.

@sentrivana sentrivana merged commit 888ee4c into sentry-sdk-2.0 Feb 22, 2024
103 checks passed
@sentrivana sentrivana deleted the ivana/2.0/update-readme branch February 22, 2024 09:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants