Skip to content

ref: Remove <Note> component in favor of using <Alert> #12467

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.

Sign up for GitHub

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 1 commit into from
Jan 27, 2025
Merged

ref: Remove <Note> component in favor of using <Alert> #12467

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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 develop-docs/sdk/data-model/event-payloads/stacktrace.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ A stack trace contains a list of frames, each with various bits (most optional)
describing the context of that frame. Frames should be sorted from oldest to
newest.

<Note><markdown>
<Alert>

Stack traces are always part of an exception or a thread. They cannot be
declared as a top-level event property. When adding a stack trace to an event,
Expand All @@ -16,7 +16,7 @@ follow this rule of thumb:
- If the stack trace is part of an error, exception or crash, add it to the [Exception Interface](/sdk/data-model/event-payloads/exception/).
- Otherwise, add it as a thread in the [Threads Interface](/sdk/data-model/event-payloads/threads/).

</markdown></Note>
</Alert>

## Attributes

Expand Down
16 changes: 8 additions & 8 deletions docs/cli/dif.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@ information, refer to [_Debug Information Files_](/platforms/native/data-managem

The `sentry-cli` requires an [Organization Auth Token](https://sentry.io/orgredirect/organizations/:orgslug/settings/auth-tokens/) so that Debug Information Files can be uploaded.

<Note>
<Alert>

Source maps, while also being debug information files, are handled
differently in Sentry. For more information see [Source Maps in sentry-cli](/cli/releases/#sentry-cli-sourcemaps).

</Note>
</Alert>

## Checking Files

Expand Down Expand Up @@ -97,13 +97,13 @@ application. Alternatively, files can be uploaded during the build process. See
[_Debug Information Files_](/platforms/native/data-management/debug-files/)
for more information.

<Note>
<Alert>

You need to specify the organization and project you are working with because
debug information files work on projects. For more information about this refer
to [Working with Projects](/cli/configuration/#sentry-cli-working-with-projects).

</Note>
</Alert>

A basic debug file upload can be started with:

Expand Down Expand Up @@ -183,13 +183,13 @@ plugin](https://github.com/getsentry/sentry-android-gradle-plugin) to do that. N
situations where you would upload ProGuard files manually. For instance,
when you only release some of the builds you're creating.

<Note>
<Alert>

You need to specify the organization and project you are working with
because ProGuard files work on projects. For more information about this refer to
[Working with Projects](/cli/configuration/#sentry-cli-working-with-projects).

</Note>
</Alert>

The `upload-proguard` command is the one to use for uploading ProGuard files. It
takes the path to one or more ProGuard mapping files and will upload them to
Expand Down Expand Up @@ -252,12 +252,12 @@ See the build tool plugins we currently support here:
You can also upload ProGuard files manually with `sentry-cli` for any JVM-based language like
Java or Kotlin.

<Note>
<Alert>

Before you can upload source files, you must configure the Sentry CLI with the organization and project you are uploading bundle files for. See the CLI docs on
[Working with Projects](/cli/configuration/#sentry-cli-working-with-projects) to learn how to do this.

</Note>
</Alert>

### Creating a Source Bundle

Expand Down
33 changes: 2 additions & 31 deletions docs/contributing/pages/components.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,8 +74,6 @@ Use this for these types of content:

You can also omit the title of the alert.

See also the [Note component](#note).

## Arcade embeds

Render an [Arcade](https://arcade.software) embed.
Expand Down Expand Up @@ -207,11 +205,11 @@ function foo() {

Render a heading with a configuration key in the correctly cased format for a given platform.

<Note>
<Alert>

If content is specified, it will automatically hide the content when the given `platform` is not selected in context.

</Note>
</Alert>

```markdown {tabTitle:Example}
<ConfigKey name="send-default-pii" notSupported={["javascript"]}>
Expand All @@ -228,33 +226,6 @@ Attributes:
- `supported` (string[])
- `notSupported` (string[])

## Note

Render a note.

<Note>

Something important, but maybe not _that_ important.

</Note>

```markdown {tabTitle:Example}
<Note>

Something important, but maybe not _that_ important.

</Note>
```

Use this for these types of content:

- **Prerequisite(s):** Use these to list things that are required to finish. Place them prior to the procedure/process that follows so a user doesn't start and stop.
- **Note:** to document information that's relevant to the topic, but isn't part of the larger point of the content. This might include a piece of information that should be highlighted, but isn't necessarily more important than other information. These include calling out early adopter features or providing clarification. Use sparingly.

Don't use a title with this type of note.

See also the [Alert component](#alert).

## PageGrid

Render all `next_steps` of this document or default child pages, including their `description` if available.
Expand Down
12 changes: 6 additions & 6 deletions docs/platforms/android/configuration/app-not-respond.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@ The new implementation (v2) uses the same data source as Google Play Console. Th

While the original Watchdog approach (v1) reports many false positives and is based on heuristics, it still has some advantages over v2, like capturing screenshots and transactions with profiles at the time of ANR.

<Note>
<Alert>

We're considering SDK support for both approaches working alongside each other on Android 11 and up. Please upvote [this GitHub discussion](https://github.com/getsentry/sentry-java/discussions/2716) and share your feedback if you have a case for v1 and v2 working together.

</Note>
</Alert>

Both ANR detection implementations are controlled by the same flag:

Expand All @@ -37,11 +37,11 @@ Whenever the main UI thread of the application is blocked for more than five sec

The integration reports ANR events with `mechanism:ANR`.

<Note>
<Alert>

Sentry does not report the ANR if the application is in debug mode.

</Note>
</Alert>

You can also specify how long the thread should be blocked before the ANR is reported. Provide the duration in the attribute `io.sentry.anr.timeout-interval-millis` in your `AndroidManifest.xml`:

Expand All @@ -58,11 +58,11 @@ and asynchronously sends ANR events to Sentry for each ANR in the history, enric

The integration reports ANR events with `mechanism:AppExitInfo`.

<Note>
<Alert>

If [ApplicationExitInfo#getTraceInputStream](<https://developer.android.com/reference/android/app/ApplicationExitInfo#getTraceInputStream()>) returns `null`, the SDK will no longer report an ANR event, since these events won't be actionable without it.

</Note>
</Alert>

![ANR](./img/app-not-respond.png)

Expand Down
20 changes: 10 additions & 10 deletions docs/platforms/android/configuration/gradle.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,11 @@ plugins {
}
```

<Note>
<Alert>

The `io.sentry.android.gradle` >= `3.0.0` requires [Android Gradle Plugin >= 7.0.0](https://developer.android.com/studio/releases/gradle-plugin#7-0-0). For older versions of the Android Gradle Plugin, use `io.sentry.android.gradle:2.+`.

</Note>
</Alert>

### Configure

Expand Down Expand Up @@ -383,11 +383,11 @@ defaults.org=___ORG_SLUG___
auth.token=___ORG_AUTH_TOKEN___
```

<Note>
<Alert>

You can find your authentication token [on the Organization Auth Tokens](https://sentry.io/orgredirect/organizations/:orgslug/settings/auth-tokens/) settings page. For more information about the available configuration options, check out the [full sentry-cli documentation](/cli/configuration/#configuration-values).

</Note>
</Alert>

## Native Debug Symbols and Sources

Expand All @@ -405,11 +405,11 @@ defaults.org=___ORG_SLUG___
auth.token=___ORG_AUTH_TOKEN___
```

<Note>
<Alert>

You can find your authentication token [on the Sentry API page](https://sentry.io/api/). For more information about the available configuration options, check out the [full sentry-cli documentation](/cli/configuration/#configuration-values).

</Note>
</Alert>

## Java/Kotlin Source Context

Expand All @@ -435,11 +435,11 @@ The plugin uses the [bytecode manipulation](https://www.infoq.com/articles/Livin
that starts and finishes a [span](/concepts/key-terms/tracing/trace-view/#product-walkthrough-trace-view-page) for common operations that can cause performance bottlenecks.
This way potentially heavy operations are automatically measured without the need to manually instrument them.

<Note>
<Alert>

For this data to be captured, you must enable [tracing](/platforms/android/tracing/).

</Note>
</Alert>

The plugin supports the following features for auto-instrumentation:

Expand Down Expand Up @@ -486,11 +486,11 @@ enum class InstrumentationFeature {

Check [Integrations](/platforms/android/integrations/) page for more detailed explanation of each instrumentation feature.

<Note>
<Alert>

To learn more about the internals of auto-instrumentation, check out this [blog post](https://blog.sentry.io/2021/12/14/bytecode-transformations-the-android-gradle-plugin).

</Note>
</Alert>

## Auto-Installation

Expand Down
4 changes: 2 additions & 2 deletions docs/platforms/android/configuration/manual-init.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ dependencies {
}
```

<Note>
<Alert>

The [NDK integration](/platforms/android/using-ndk/) comes packaged with the SDK and requires API level 16, though other levels are supported. If you're using multiple Sentry dependencies, you can add a [bill of materials](/platforms/android/configuration/bill-of-materials) to avoid specifying the version of each dependency.

</Note>
</Alert>

## Manual Initialization

Expand Down
8 changes: 4 additions & 4 deletions docs/platforms/android/configuration/options.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,11 +95,11 @@ Grouping in Sentry is different for events with stack traces and without. As a r

If this flag is enabled, certain personally identifiable information (PII) is added by active integrations. By default, no such data is sent.

<Note>
<Alert>

If you are using Sentry in your mobile app, read our [frequently asked questions about mobile data privacy](/security-legal-pii/security/mobile-privacy/) to assist with Apple App Store and Google Play app privacy details.

</Note>
</Alert>

This option is turned off by default.

Expand Down Expand Up @@ -170,11 +170,11 @@ The default is `3000`.

_(New in version 6.0.0)_

<Note>
<Alert>

This only affects [user interaction transactions](/platforms/android/tracing/instrumentation/automatic-instrumentation/#user-interaction-instrumentation).

</Note>
</Alert>

</ConfigKey>

Expand Down
8 changes: 4 additions & 4 deletions docs/platforms/android/configuration/releases.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,11 @@ The value can be arbitrary, but we recommend either of these naming strategies:
- `build` is the number that identifies an iteration of your app (`CFBundleVersion` on iOS, `versionCode` on Android)
- **Commit SHA**: If you use a version control system like Git, we recommend using the identifying hash (for example, the commit SHA, `da39a3ee5e6b4b0d3255bfef95601890afd80709`). You can let Sentry CLI automatically determine this hash for supported version control systems. Learn more in our [Sentry CLI](/cli/releases/#creating-releases) documentation.

<Note>
<Alert>

Releases are global per organization; prefix them with something project-specific for easy differentiation.

</Note>
</Alert>

The behavior of a few features depends on whether a project is using semantic or time-based versioning.

Expand Down Expand Up @@ -64,11 +64,11 @@ After configuring your SDK, you can install a repository integration or manually

Monitor the [health of releases](/product/releases/health/) by observing user adoption, usage of the application, percentage of [crashes](/product/releases/health/#crash), and [session data](/product/releases/health/#session). Release health will provide insight into the impact of crashes and bugs as it relates to user experience, and reveal trends with each new issue through the [Release Details](/product/releases/release-details/) graphs and filters.

<Note>
<Alert>

Crash reporting and app hang detection are not available for watchOS.

</Note>
</Alert>

In order to monitor release health, the SDK sends session data.

Expand Down
4 changes: 2 additions & 2 deletions docs/platforms/android/configuration/sampling.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ To send a representative sample of your errors to Sentry, set the <PlatformIdent

The error sample rate defaults to `1`, meaning all errors are sent to Sentry.

<Note>
<Alert>

Changing the error sample rate requires re-deployment. In addition, setting an SDK sample rate limits visibility into the source of events. Setting a rate limit for your project (which only drops events when volume is high) may better suit your needs.

</Note>
</Alert>

## Sampling Transaction Events

Expand Down
8 changes: 4 additions & 4 deletions docs/platforms/android/configuration/shared-environments.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,17 @@ description: "Learn how to use the Sentry SDK within a shared environment, e.g.
sidebar_order: 2000
---

<Note>
<Alert>

Using the Sentry SDK within another SDK is [discouraged](https://docs.sentry.io/platforms/). This can lead to unexpected behaviour and potential data leakage. If you need to use Sentry within another SDK, please follow the best practices outlined below.

</Note>
</Alert>

<Note>
<Alert>

When setting up Sentry inside a library, the consuming app could use the Sentry SDK as well, thus you should **not use `Sentry.init()`**, as this will pollute the global state.

</Note>
</Alert>

In order to not conflict with other Sentry instances, you should use the `Scopes` API to create a new instance of Sentry.
The Scopes API works the same way as the global Sentry instance, but it is not global and can be used within your component. If you want to capture uncaught exceptions, you can use the `UncaughtExceptionHandlerIntegration` to capture them. As this will capture all uncaught exceptions within an app, you should use the `BeforeSendCallback` to only accept events that are relevant for your SDK.
Expand Down
4 changes: 2 additions & 2 deletions docs/platforms/android/data-management/debug-files/file-formats/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,11 +180,11 @@ while removing all debug information from the release binary.

## ProGuard Mappings

<Note>
<Alert>

The recommended method for [Android users is to use the Gradle plugin](/platforms/android/configuration/gradle/).

</Note>
</Alert>

ProGuard mapping files allow Sentry to resolve obfuscated Java classpaths and
method names into their original form. In that sense, they act as debug
Expand Down
4 changes: 2 additions & 2 deletions docs/platforms/android/data-management/debug-files/identifiers/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,14 @@ compute a _Debug Identifier_ for each uploaded file. This identifier is
associated with executables and libraries as well as debug companions to ensure
that they can be uniquely located via one common mechanism.

<Note>
<Alert>

Debug information does not have to be associated with releases. The unique debug
identifier ensures that Sentry can choose the right files for every crash
report. However, it is still recommended to configure releases in the client to
benefit from other features.

</Note>
</Alert>

For native events, the issue details page displays a list of _Loaded Images_.
This list contains the executable and all loaded dynamic libraries including
Expand Down
Loading
Loading