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

feat(integrations): Direct users to the reference implementation #5053

Merged
merged 7 commits into from
Jun 2, 2022

Conversation

leeandher
Copy link
Member

This PR adds some callouts and mentions in docs for the integration platform to direct users to check out the refrence implementation. It also adds the banner back with a link to that section of the docs.

Legal Boilerplate

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

@vercel
Copy link

vercel bot commented May 19, 2022

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

Name Status Preview Updated
sentry-docs ✅ Ready (Inspect) Visit Preview May 31, 2022 at 8:48PM (UTC)

@leeandher leeandher requested a review from a team May 19, 2022 20:14
src/components/banner.tsx Outdated Show resolved Hide resolved
Copy link
Contributor

@mgaeta mgaeta left a comment

Choose a reason for hiding this comment

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

Content is good. Grammar and clarity nits.

@leeandher leeandher requested a review from imatwawana May 23, 2022 22:04
@leeandher
Copy link
Member Author

@imatwawana The plan is to merge this along side a release of the linked repository and some in-app messaging, though there isn't a date set in stone for when this will happen. In the mean time, having this reviewed/approved will help to put all the messaging out there all at once!

Also please let me know if it's cool that I add the message to the dismissable banner, I just figured it was a good way to broadcast a message to docs users, but I'm aware it's a pretty specific feature to link out to

Copy link
Contributor

@imatwawana imatwawana left a comment

Choose a reason for hiding this comment

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

Mostly this is just style and wording fixes, but there's one larger fix that needs to be made on the heading that you've added.

@leeandher leeandher marked this pull request as ready for review May 24, 2022 17:33
src/components/banner.tsx Outdated Show resolved Hide resolved
src/components/banner.tsx Outdated Show resolved Hide resolved
src/components/banner.tsx Outdated Show resolved Hide resolved
leeandher and others added 5 commits May 31, 2022 11:27
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
Copy link
Contributor

@imatwawana imatwawana left a comment

Choose a reason for hiding this comment

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

Made some more style/tone fixes, but otherwise this looks good.

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
@leeandher leeandher merged commit c38c2ee into master Jun 2, 2022
@leeandher leeandher deleted the leander-release-ref-impl/API-2452 branch June 2, 2022 19:05
adinauer added a commit that referenced this pull request Jun 9, 2022
* Update docs to use Hint object

* Revert migration guide changes

* Change import for Hint

* Document how to manipulate attachments via hints (#5070)

* Document how to manipulate attachments via hints

* Apply suggestions from code review

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>

* Update src/includes/enriching-events/add-attachment/java.mdx

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>

* ref(frontend): Bump JS SDK to 7.0 beta 2 (#5064)

* bump to 7.0 beta 2

* update yarn.lock

* Fix manifest code snippet tag (#5069)

* fix: typos in Unity troubleshooting (#5060)

* Typo fix (#5059)

* fix references to source maps and time range change example (#5051)

* Fix typo in query builder docs (#5072)

* updated banner (#5067)

* docs(js): Add sourcemaps explain to source maps troubleshooting guide (#5076)

* feat(discover): extend list of stacking functions (#5074)

- This list is a bit outdated, and there are many more functions that
  discover supports. Updating this to include all of them, but longterm
  probably worth revisiting this section of docs
- This is so the API docs can link here

* chore: bump Sentry SDK to 7.0.0-rc.0 (#5077)

* chore(billing): GA on-demand budget for all performance plans (#5075)

* fix(alerts): Remove duplicate alert rules section (#5080)

* feat(visibility): Add a note about apdex score (#5081)

- This is cause I've heard folks confused whether a higher apdex score
  is better or not, and personally forget sometimes.

* feat(unity): Added Screenshot to Verify (#5031)

* added sample screenshot

* Update src/includes/getting-started-verify/unity.mdx

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>

* jpg -> png

Co-authored-by: Bruno Garcia <bruno@brunogarcia.com>
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>

* Add instructions to tree shake tracing code in JS SDK (#5086)

* Add docs for new attachments API (#5073)

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>

* Add React Router v6 instrumentation docs. (#5037)

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>

* Remove `ignoreSentryErrors` section in JS docs (#5036)

* Update ExtraErrorData depth description (#5021)

JavaScript SDK: Updates `ExtraErrorData` `depth` option description to not mention a workaround for the global `normalizeDepth` option.

* feat(angular): Update Angular docs for v7 release (#4963)

This PR updates our Angular SDK docs for the v7 release. It adds information about compatibility of our SDK with different Angular versions and updates information on `TraceDirective` compatibility.

* Adjust JS CDN bundle page to reflect ES5/ES6 naming changes (#4962)

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>

* ref(js): change migration guide URLs from v7 branch to master (#5087)

This small PR changes the URLs of two links to the JS SDK migration guide which previously linked to the 7.x branch version of the migration guide. It now links to master since we merged the 7.x branch

* Adust docs for dealing with baggage headers (CORS and meta tags) (#5061)

Adjust the JS SDK Performance Monitoring -> "Connect Services" page by adding information about the newly introduced baggage header and its propagation. It adds instructions on setting up CORS rules to accept the new header as well as how to add the baggage information to meta tags for server-originating traces.

* Add tree shaking guide for default integrations (#4996)

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>

* Replace deprecated severity enums with string literals (#4940)

Co-authored-by: Lukas Stracke <lukas@stracke.co.at>

* getsentry/relay@8fcff0b

* Adust docs after renaming `UserAgent` integration to `HttpContext` (#4997)

This PR adjusts docs after renaming the UserAgent integration in the Sentry JS SDK to HttpContext

* Add Prisma ORM Integration Docs. (#4961)

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>

* chore: bump Sentry SDK to 7.0.0 (#5088)

* ref(native): capture-error using high-level API. (#5085)

* feat(widget-builder): Add GA documentation - (#5065)

* Add SampleRate code sample for go (#5090)

* fix(android): Typo for UI transactions (#5096)

* ref(js): Add note about old name of HttpContext integration (#5099)

Adds a note to the HttpContext integration of the JS SDK explaining that it was called UserAgent before v7. This ensures that pre-v7 users can find correct information about their default integrations.

* ref(js): Add baggage intormation to automatic instrumentation page (#5095)

Add instructions on how to deal with the new baggage header in CORS settings. The baggage header was introduced in v7 of the JS SDK.

* feat(apple): User interaction instrumentation (#5098)

Add docs similar to user interaction instrumentation on Android.
As the implementations don't match exactly we can't create reusable docs.

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
Co-authored-by: Roman Zavarnitsyn <rom4ek93@gmail.com>

* dotnet performance clarify GetSpan (#5078)

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
Co-authored-by: Matt Johnson-Pint <mattjohnsonpint@gmail.com>
Co-authored-by: Bruno Garcia <bruno@brunogarcia.com>

* chore(unity): Fixed typo (#5050)

Co-authored-by: Bruno Garcia <bruno@brunogarcia.com>

* docs: add explanation regarding appcenter token (#5063)

* ref(integration-platform): Add URI formatting guidelines to docs (#5103)

This PR adds a blurb explaining the URI formatting guidelines for the schema they provide when specifying UI Components. Each instance of a URI attribute links back to these guidelines.

* improve enable suspect commits content (#5094)

* restructured page

* restructured page

* restructured enable suspect commits page

* fixes to improve flow

* fixing typo and clarifying language

* wording fixes

* feat(alerts): Restore duplciate alert rule docs (#5111)

* feat(integrations): Direct users to the reference implementation (#5053)

* getsentry/relay@acb94fa

* ref(android): Simplify UI transaction code sample (#5097)

Reduce the complexity of the code sample for manually adding spans
to user interaction transacrtions.

Co-authored-by: Roman Zavarnitsyn <rom4ek93@gmail.com>

* feat(unity): Added additional platforms to native support (#5109)

* improved native support docs

* Update src/includes/getting-started-primer/unity.mdx

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>

* Update src/platforms/unity/native-support/index.mdx

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>

* Update src/platforms/unity/native-support/index.mdx

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>

* Update src/platforms/unity/native-support/index.mdx

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>

* Update src/platforms/unity/native-support/index.mdx

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>

* Update src/platforms/unity/native-support/index.mdx

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>

* feat(apple): Add UI instrumentation to wizard (#5100)

* Refactor Ionic/Capacitor/Cordova Wizards (#5093)

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>

* fix(quotas): Clarify filters application scope (#5102)

Inbound data filters are applied to all events, including transactions.
See [envelope
filtering](https://github.com/getsentry/relay/blob/7c6b308bbf04e63e8e0b456489da1ddc320e2e6a/relay-server/src/actors/envelopes.rs#L1603)
and the [should_filter
check](https://github.com/getsentry/relay/blob/7c6b308bbf04e63e8e0b456489da1ddc320e2e6a/relay-filter/src/lib.rs#L38-L60) in relay.

* feat(api): Update the bump script since CI doesn't run it (#5115)

- this is so the script can be run on MacOS where the date function is
  slightly different

* chore(api): bump api sha with events doc (#5116)

Bump the SENTRY_API_SCHEMA_SHA with latest changes

* Add metric alert slack example with new chart (#5113)

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>

* Change migration guide for hints (#5068)

* Add discontinuation of AngularJS 1.x (#5123)

* feat(docs): Document flutter autoInitializeNativeSdk (#5029)

* chore(unity): Updated troubleshooting for 2022 (#5122)

* ref(native): Clarify before_send with Crashpad (#5092)


Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>

* getsentry/relay@d8f887a

* docs(dashboards): Releases in Dashboards (#5083)

Documentation for the Releases widget in Dashboard

* fix transaction quota management content (#5114)

* added inbound filters to transaction quota mgmt, removed beforeSend, and fixed inbound filter reference on quotas index page

* fixed typo

* feat(alerts): Alert wizard v3 alert config docs (#5107)

* feat(alerts): Alert wizard v3 alert config docs

* addressing comments updating screenshots

* update screenshot

* review 2

* reverting an accidental change

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>

* hid banner (#5127)

* feat(android): App permissions in App Context (#5038)

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
Co-authored-by: Katie Byers <katie.byers@sentry.io>
Co-authored-by: Manoel Aranda Neto <5731772+marandaneto@users.noreply.github.com>
Co-authored-by: Ivan Dlugos <6349682+vaind@users.noreply.github.com>
Co-authored-by: Asko Kauppi <akauppi@gmail.com>
Co-authored-by: Aru Sahni <aru@arusahni.net>
Co-authored-by: dorothymlee <89860861+dorothymlee@users.noreply.github.com>
Co-authored-by: Kamil Ogórek <kamil.ogorek@gmail.com>
Co-authored-by: William Mak <william@wmak.io>
Co-authored-by: Vladan Paunovic <vladan.paunovic.bg@gmail.com>
Co-authored-by: Alberto Leal <mail4alberto@gmail.com>
Co-authored-by: Taylan Gocmen <taylangocmen@users.noreply.github.com>
Co-authored-by: Stefan Jandl <stefan.jandl@sentry.io>
Co-authored-by: Bruno Garcia <bruno@brunogarcia.com>
Co-authored-by: Luca Forstner <luca.forstner@gmail.com>
Co-authored-by: Tim Fish <tim@timfish.uk>
Co-authored-by: Onur Temizkan <onur@narval.co.uk>
Co-authored-by: Lukas Stracke <lukas@stracke.co.at>
Co-authored-by: Joris Bayer <joris.bayer@sentry.io>
Co-authored-by: Mischan Toosarani-Hausberger <mischan@abovevacant.com>
Co-authored-by: Priscila Oliveira <priscilawebdev@gmail.com>
Co-authored-by: Neel Shah <neelshah.sa@gmail.com>
Co-authored-by: Philipp Hofmann <philipp.hofmann@sentry.io>
Co-authored-by: Roman Zavarnitsyn <rom4ek93@gmail.com>
Co-authored-by: Nicholas Meisenheimer <76002357+souredoutlook@users.noreply.github.com>
Co-authored-by: Matt Johnson-Pint <mattjohnsonpint@gmail.com>
Co-authored-by: Stefan Jandl <reg@bitfox.at>
Co-authored-by: Jérémy Barbet <jeremgraph@gmail.com>
Co-authored-by: Leander Rodrigues <leander.rodrigues@sentry.io>
Co-authored-by: LucasZF <lucas-zimerman1@hotmail.com>
Co-authored-by: Iker Barriocanal <32816711+iker-barriocanal@users.noreply.github.com>
Co-authored-by: Scott Cooper <scttcper@users.noreply.github.com>
Co-authored-by: Denis Andrašec <denrase@gmail.com>
Co-authored-by: Shruthi <shruthilaya.jaganathan@sentry.io>
@github-actions github-actions bot locked and limited conversation to collaborators Jun 18, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants