Skip to content

ref(angular): Update Angular SDK docs for @sentry/angular-ivy #6356

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

Merged
merged 5 commits into from
Feb 28, 2023

Conversation

Lms24
Copy link
Member

@Lms24 Lms24 commented Feb 24, 2023

To ensure first-class compatibility with Angular's "new" rendering engine, Ivy, we needed to create a new SDK package that's compiled differently than the original @sentry/angular package. This new SDK is compatible with Angular 12 and newer and hence we're going to make it the default SDK in the docs going forward.

This PR

  • Updates the Angular version <-> Sentry SDK compatibility description with a table
    • I added entries for Angular 1/AngularJS (this came up recently in a Slack convo) and Angular 2-9 with a message that we do not support these versions anymore in v7 of the SDKs. Happy to make changes here if reviewers think this shouldn't be promoted.
  • Updates imports and code snippets with versions for Angular 12+ (ivy) and Angular 10/11
  • Updates the SDK onboarding wizard docs (+ Replay onboarding)
  • Adds an Angular-specific verify code snippet which was missing before
  • Adds file names to all angular code snippets (this came up in Add Angular-SDK-specific source map upload instructions  #6326 and it was easiest to just do it in this PR)
  • streamlines the Angular "Getting started" page and fixes a few typos/wording issues

ref: getsentry/sentry-javascript#7265

@Lms24 Lms24 requested review from a team, mydea and AbhiPrasad and removed request for a team February 24, 2023 11:12
@vercel
Copy link

vercel bot commented Feb 24, 2023

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

Name Status Preview Comments Updated
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add your feedback Feb 28, 2023 at 10:48AM (UTC)

@Lms24 Lms24 changed the title ref(angular): Update Angular SDK docs with @sentry/angular-ivy ref(angular): Update Angular SDK docs for @sentry/angular-ivy Feb 24, 2023
- update version compatibility table
- different tabs for angular 12+ and 10/11
- update verify include w/ NG-specific example
- add filenames to all code examples
- streamline getting started
- fix a few wording issues/typos
@Lms24 Lms24 force-pushed the lms/angular-ivy-docs branch from d7c5bdf to 6712083 Compare February 24, 2023 11:15
Comment on lines 15 to 24
```bash
# Using yarn
# Using yarn (Angular 12+)
yarn add @sentry/angular-ivy @sentry/tracing
# Using yarn (Angular 10 and 11)
yarn add @sentry/angular @sentry/tracing

# Using npm
# Using npm (Angular 12+)
npm install --save @sentry/angular-ivy @sentry/tracing
# Using npm (Angular 10 and 11)
npm install --save @sentry/angular @sentry/tracing
Copy link
Member Author

Choose a reason for hiding this comment

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

I know this is ugly but afaik we can't use tabs in the onboarding wizard :(

@Lms24 Lms24 self-assigned this Feb 24, 2023
Copy link
Contributor

@lizokm lizokm 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 suggestions.

@Lms24 Lms24 merged commit 556e41c into master Feb 28, 2023
@Lms24 Lms24 deleted the lms/angular-ivy-docs branch February 28, 2023 10:51
@github-actions github-actions bot locked and limited conversation to collaborators Mar 16, 2023
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.

4 participants