stephanie-anderson commented 1 year ago

Description

We want to define a structure for documenting SDK features across all SDKs (.yaml or .json based). The base structure of what features are supported in general should live in a central place. Each of the SDKs should provide a list with the features it supports. On a release this info should be merged and persisted by our release-registry.

An example of a currently gathered SDK version information can be found here: https://github.com/getsentry/sentry-release-registry/blob/master/packages/npm/%40sentry/nextjs/6.10.0.json Maybe these files can be used for this purpose as well.

Benefits

We would then be able to check, which features were supported by a specific version of an SDK.
We could use that data in our docs and on the /for SDK marketing pages
- That way we don't have to maintain the information manually (and not in a uniformed way + not only for the latest SDK version)
We can also use and connect this data with other insights in our business intelligence tools
- That way we wouldn't have to look in event data for that information (and only a fraction of that is actually derivable from that)
- This also means that together with other data (Redash, data source: stats-scraper) we can analyze, how many users (downloads of a package) already have access to a specific feature (feature availability/rollout percentage).

### Things to consolidate
- [ ] Implement https://github.com/getsentry/sentry-release-registry/issues/39
- [ ] Implement https://github.com/getsentry/sentry-java/pull/1527/files
- [ ] Implement https://www.notion.so/sentry/DACI-SDK-Feature-Registry-68ba4a3df1d7400da715f625081be866
- [ ] Implement https://docs.google.com/spreadsheets/d/1TzLYBTzFFKnPaR4IqGt-u6ypYU2iaxIGQG--4mdi618/edit#gid=337502117
- [ ] Implement mentioned features of https://github.com/getsentry/sentry-javascript/issues/9055
- [ ] Implement this spreadsheet (BI team): https://docs.google.com/spreadsheets/d/1Uvi3ZOINV2BdgVYCCPY_AzaWpk5PJrFl0E8GL31drJ8/edit#gid=0
- [ ] Implement this spreadsheet (BI team): https://docs.google.com/spreadsheets/d/1UxZLsVsYjzqRzaQ23XdAvNuVZOLS3a7YLopdgjeA_C0/edit?pli=1#gid=0

### PRs
- [ ] https://github.com/getsentry/sentry-release-registry/pull/135
- [ ] https://github.com/getsentry/sentry-release-registry/pull/133
- [ ] https://github.com/getsentry/sentry-release-registry/pull/134
- [ ] https://github.com/getsentry/sentry-release-registry/pull/140

Slack-Channel

proj-sdk-feature-matrix

Notion Document(s)

No response

Stakeholder(s)

Support, Sales, Marketing, Product, Docs, SDK Teams themselves

Team(s)

Mobile, Web Backend, Web Frontend, (Processing, if Rust should be tracked as well)

bruno-garcia commented 1 year ago