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

Fix some of the onboarding issues in SDK docs #11574

Merged
merged 1 commit into from
Oct 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/platforms/android/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,6 @@ In addition to capturing errors, you can monitor interactions between multiple s

Select which Sentry features you'd like to install in addition to Error Monitoring to get the corresponding installation and configuration instructions below.

## Install

<OnboardingOptionButtons
options={[
'error-monitoring',
Expand All @@ -36,6 +34,8 @@ Select which Sentry features you'd like to install in addition to Error Monitori
]}
/>

## Install

Sentry captures data by using an SDK within your application's runtime. These are platform-specific and allow Sentry to have a deep understanding of how your application works.

In addition to capturing errors, you can monitor interactions between multiple services or applications by [enabling tracing](https://docs.sentry.io/concepts/key-terms/tracing/). You can also collect and analyze performance profiles from real users with [profiling](https://docs.sentry.io/product/explore/profiling/). To enable tracing and/or profiling, click the corresponding checkmarks to get the code snippets.
Expand Down
42 changes: 4 additions & 38 deletions docs/platforms/javascript/common/index.mdx
Original file line number Diff line number Diff line change
@@ -1,15 +1,5 @@
<PlatformContent includePath="getting-started-primer" />

<PlatformSection notSupported={["javascript.capacitor", "javascript.cordova", "javascript.solid", "javascript.solidstart"]}>

<Note>
We've released version 8 of the JavaScript SDKs. If you're using version 7.x,
we recommend upgrading to the latest version. Check out the [Migration
docs](./migration/v7-to-v8/) to learn how to make the switch.
</Note>

</PlatformSection>

<PlatformSection noGuides>

<Alert level="info" title="Using a framework?">
Expand All @@ -26,33 +16,13 @@ Check out the other SDKs we support in the left-hand dropdown.

## Prerequisites

- A [Sentry account](https://sentry.io/signup/) and [Project](/product/projects/).

</PlatformSection>

Don't have a Sentry account? Sign up for [Sentry for free](https://sentry.io/signup/), then return to this page.

<PlatformSection noGuides>

If you prefer to follow video instructions, see [How to Install the Sentry JavaScript SDK in 60 Seconds](https://vimeo.com/899367471).

</PlatformSection>

<PlatformSection supported={["javascript.react"]}>

If you prefer to follow video instructions, see [How to Install the Sentry React SDK in 60 Seconds](https://vimeo.com/899368791).

</PlatformSection>

<PlatformSection supported={["javascript.nextjs"]}>

If you prefer to follow video instructions, see [How to Install the Sentry Next.js SDK in 60 Seconds](https://vimeo.com/899368048).
* You need a Sentry [account](https://sentry.io/signup/) and [project](/product/projects/)

</PlatformSection>

<PlatformSection notSupported={["javascript.deno"]}>

<PlatformSection notSupported={["javascript", "javascript.astro", "javascript.cordova", "javascript.nextjs", "javascript.nuxt", "javascript.remix", "javascript.solidstart", "javascript.sveltekit", "javascript.bun"]}>
<PlatformSection notSupported={["javascript", "javascript.astro", "javascript.cordova", "javascript.nextjs", "javascript.nuxt", "javascript.remix", "javascript.solidstart", "javascript.sveltekit", "javascript.bun", "javascript.cloudflare"]}>

## Features

Expand All @@ -66,13 +36,11 @@ Select which Sentry features you'd like to install in addition to Error Monitori

<PlatformCategorySection notSupported={["server"]}>
<PlatformSection notSupported={["javascript", "javascript.cordova"]}>
<OnboardingOptionButtons
options={["error-monitoring", "performance", "session-replay"]}
/>
<OnboardingOptionButtons options={["error-monitoring", "performance", "session-replay"]} />
</PlatformSection>
</PlatformCategorySection>

<PlatformSection notSupported={["javascript", "javascript.astro", "javascript.cordova", "javascript.nextjs", "javascript.nuxt", "javascript.remix", "javascript.sveltekit", "javascript.bun", "javascript.capacitor", "javascript.ember", "javascript.angular", "javascript.react", "javascript.solid", "javascript.solidstart", "javascript.svelte", "javascript.vue"]}>
<PlatformSection notSupported={["javascript", "javascript.astro", "javascript.cordova", "javascript.nextjs", "javascript.nuxt", "javascript.remix", "javascript.sveltekit", "javascript.bun", "javascript.capacitor", "javascript.ember", "javascript.angular", "javascript.react", "javascript.solid", "javascript.solidstart", "javascript.svelte", "javascript.vue", "javascript.cloudflare"]}>

In addition to capturing errors, you can monitor interactions between multiple services or applications by [enabling tracing](/concepts/key-terms/tracing/). You can also collect and analyze performance profiles from real users with [profiling](/product/explore/profiling/).

Expand Down Expand Up @@ -124,8 +92,6 @@ Sentry supports multiple versions of React Router. To learn how to configure the

## Use

{" "}

<PlatformContent includePath="getting-started-use" />

</PlatformSection>
Expand Down
2 changes: 1 addition & 1 deletion docs/platforms/python/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ showIntegrationsInSearch: true

## Prerequisites

* You need a [Sentry account](https://sentry.io/signup/) and project
* You need a Sentry [account](https://sentry.io/signup/) and [project](/product/projects/)
* Read one of our dedicated guides if you use any of the <PlatformLink to="/integrations/#web-frameworks">frameworks</PlatformLink> we support

## Features
Expand Down
13 changes: 4 additions & 9 deletions docs/platforms/ruby/common/index.mdx
Original file line number Diff line number Diff line change
@@ -1,26 +1,21 @@
<PlatformContent includePath="getting-started-primer" />

On this page, we get you up and running with Sentry's SDK.

<PlatformContent includePath="alert-using-a-framework" noGuides />

Don't already have an account and Sentry project established? Head over to [sentry.io](https://sentry.io/signup/), then return to this page.
## Prerequisites

If you prefer to follow video instructions, see [How to Install the Sentry Ruby SDK in 60 Seconds](https://vimeo.com/899369197).
* You need a Sentry [account](https://sentry.io/signup/) and [project](/product/projects/)
* Ruby 2.4+ and any of the most recent JRuby versions

## Features

In addition to capturing errors, you can monitor interactions between multiple services or applications by [enabling tracing](/concepts/key-terms/tracing/). You can also collect and analyze performance profiles from real users with [profiling](/product/explore/profiling/).

Select which Sentry features you'd like to install in addition to Error Monitoring to get the corresponding installation and configuration instructions below.

## Install

<OnboardingOptionButtons
options={["error-monitoring", "performance", "profiling"]}
/>

Sentry captures data by using an SDK within your application’s runtime.
## Install

<PlatformContent includePath="getting-started-install" />

Expand Down
9 changes: 4 additions & 5 deletions platform-includes/getting-started-primer/javascript.astro.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,9 @@ This page walks you through adding Sentry to your Astro project, configuring it,

Before we get started, make sure you have the following:

- A Sentry account.
- Don't have an account yet? Head over to [sentry.io](https://sentry.io/signup/), then return to this page.
- An Astro project that uses Astro `3.0.0` or newer.
- A Node runtime:
* You need a Sentry [account](https://sentry.io/signup/) and [project](/product/projects/)
* An Astro project that uses Astro `3.0.0` or newer.
* A Node runtime:
- This SDK currently only works on Node runtimes (e.g. Node adapter, Vercel with Lambda functions).
Non-Node runtimes, like Vercel's Edge runtime or Cloudflare Pages, are currently not supported.
- If you're using Astro's Netflify adapter (`@astrojs/netlify`), you need version `5.0.0` or newer.
* If you're using Astro's Netflify adapter (`@astrojs/netlify`), you need version `5.0.0` or newer.
7 changes: 0 additions & 7 deletions platform-includes/getting-started-primer/ruby.mdx

This file was deleted.

Loading