Skip to content
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
2 changes: 1 addition & 1 deletion develop-docs/frontend/design-tenets.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Why minimize content refreshes?
- Less rendering / data fetching for the browser
- Assists user navigation by preserving sense of state ("where am I?")

<Alert level="error">
<Alert level="warning">
Note: while there are a few good examples of this in action in the app, we are actually pretty inconsistent applying this design principle.
</Alert>

Expand Down
56 changes: 49 additions & 7 deletions docs/contributing/pages/components.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,20 +8,62 @@ sidebar_order: 40

Render an alert callout.

<Alert title="Important">
This is an alert
<Alert title="Watch out!">
This is an info alert. Use these for information that's critical to know; it's important for users to read, but won't cause a catastrophic problem if they don't read it. These include versions that introduce breaking changes or feature limitations. Use infrequently.
</Alert>

```markdown {tabTitle:Example}
<Alert title="Important">
This is an alert
<Alert level="warning" title="Important">
This is a warning alert. Use these for items that MUST be well understood before proceeding. These highlight information that could cause users to make catastrophic errors that break their applications in ways that are very difficult to fix or create liabilities for them, such as information needed to avoid leaking PII. These should be used very rarely.
</Alert>

<Alert level="success" title="Tip">
This is a success alert. Use these when.... TODO?
</Alert>

<Alert>
This is an alert without title.
</Alert>

<Alert>
This is a multi-line alert without title. Use these for information that's critical to know; it's important for users to read, but won't cause a catastrophic problem if they don't read it. These include versions that introduce breaking changes or feature limitations. Use infrequently.
</Alert>

<Alert title="List">
<ul>
<li>Item 1</li>
<li>Item 2</li>
</ul>
</Alert>


```markdown {tabTitle:Info}
<Alert title="Watch out!">
This is an info alert.
</Alert>
```

```markdown {tabTitle:Warning}
<Alert level="warning" title="Important">
This is a warning alert.
</Alert>
```

```markdown {tabTitle:Success}
<Alert level="success" title="Tip">
This is a success alert.
</Alert>
```

```markdown {tabTitle:No Title}
<Alert>
This is an alert without title.
</Alert>
```

Attributes:

- `title` (string) - optional
- `level` (string: `'info' | 'warning') - optional, defaults to `'info'`
- `level` (string: `'info' | 'warning' | 'success') - optional, defaults to `'info'`

Use this for these types of content:

Expand All @@ -30,7 +72,7 @@ Use this for these types of content:
- **Warning:** Use these for items that MUST be well understood before proceeding. These highlight information that could cause users to make catastrophic errors that break their applications in ways that are very difficult to fix or create liabilities for them, such as information needed to avoid leaking PII. These should be used very rarely.
- Use with the title "Important"; do not use the title "Warning"

An Alert component with no level setting will render as a Note component.
You can also omit the title of the alert.

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Sentry uses _breadcrumbs_ to create a trail of events that happened prior to an

This page provides an overview of manual breadcrumb recording and customization. Learn more about the information that displays on the **Issue Details** page and how you can filter breadcrumbs to quickly resolve issues in [Using Breadcrumbs](/product/error-monitoring/breadcrumbs).

<Alert level="" title="Learn about SDK usage">
<Alert title="Learn about SDK usage">

Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/data-model/event-payloads/breadcrumbs/).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Sentry uses _breadcrumbs_ to create a trail of events that happened prior to an

This page provides an overview of manual breadcrumb recording and customization. Learn more about the information that displays on the **Issue Details** page and how you can filter breadcrumbs to quickly resolve issues in [Using Breadcrumbs](/product/error-monitoring/breadcrumbs).

<Alert level="" title="Learn about SDK usage">
<Alert title="Learn about SDK usage">

Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/data-model/event-payloads/breadcrumbs/).

Expand Down
2 changes: 1 addition & 1 deletion docs/platforms/dart/enriching-events/breadcrumbs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Sentry uses _breadcrumbs_ to create a trail of events that happened prior to an

This page provides an overview of manual breadcrumb recording and customization. Learn more about the information that displays on the **Issue Details** page and how you can filter breadcrumbs to quickly resolve issues in [Using Breadcrumbs](/product/error-monitoring/breadcrumbs).

<Alert level="" title="Learn about SDK usage">
<Alert title="Learn about SDK usage">

Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/data-model/event-payloads/breadcrumbs/).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Sentry uses _breadcrumbs_ to create a trail of events that happened prior to an

This page provides an overview of manual breadcrumb recording and customization. Learn more about the information that displays on the **Issue Details** page and how you can filter breadcrumbs to quickly resolve issues in [Using Breadcrumbs](/product/error-monitoring/breadcrumbs).

<Alert level="" title="Learn about SDK usage">
<Alert title="Learn about SDK usage">

Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/data-model/event-payloads/breadcrumbs/).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_order: 20
description: "Review an advanced example of configuration for NLog."
---

<Alert level="" title="NLog Layouts">
<Alert title="NLog Layouts">

For more information on how to dynamically set event data via `NLog.config`, see NLog's [layout renderer documentation](https://nlog-project.org/config/?tab=layout-renderers).

Expand Down
2 changes: 1 addition & 1 deletion docs/platforms/dotnet/guides/nlog/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Messages logged from assemblies with the name starting with `Sentry` will not ge

## Configure

<Alert level="" title="NLog Layouts">
<Alert title="NLog Layouts">

For more information on how to dynamically set event data via `NLog.config`, see NLog's [layout renderer documentation](https://nlog-project.org/config/?tab=layout-renderers).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Sentry uses _breadcrumbs_ to create a trail of events that happened prior to an

This page provides an overview of manual breadcrumb recording and customization. Learn more about the information that displays on the **Issue Details** page and how you can filter breadcrumbs to quickly resolve issues in [Using Breadcrumbs](/product/error-monitoring/breadcrumbs).

<Alert level="" title="Learn about SDK usage">
<Alert title="Learn about SDK usage">

Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/data-model/event-payloads/breadcrumbs/).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Sentry uses _breadcrumbs_ to create a trail of events that happened prior to an

This page provides an overview of manual breadcrumb recording and customization. Learn more about the information that displays on the **Issue Details** page and how you can filter breadcrumbs to quickly resolve issues in [Using Breadcrumbs](/product/error-monitoring/breadcrumbs).

<Alert level="" title="Learn about SDK usage">
<Alert title="Learn about SDK usage">

Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/data-model/event-payloads/breadcrumbs/).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Sentry uses _breadcrumbs_ to create a trail of events that happened prior to an

This page provides an overview of manual breadcrumb recording and customization. Learn more about the information that displays on the **Issue Details** page and how you can filter breadcrumbs to quickly resolve issues in [Using Breadcrumbs](/product/error-monitoring/breadcrumbs).

<Alert level="" title="Learn about SDK usage">
<Alert title="Learn about SDK usage">

Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/data-model/event-payloads/breadcrumbs/).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Sentry uses _breadcrumbs_ to create a trail of events that happened prior to an

This page provides an overview of manual breadcrumb recording and customization. Learn more about the information that displays on the **Issue Details** page and how you can filter breadcrumbs to quickly resolve issues in [Using Breadcrumbs](/product/error-monitoring/breadcrumbs).

<Alert level="" title="Learn about SDK usage">
<Alert title="Learn about SDK usage">

Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/data-model/event-payloads/breadcrumbs/).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Sentry uses _breadcrumbs_ to create a trail of events that happened prior to an

This page provides an overview of manual breadcrumb recording and customization. Learn more about the information that displays on the **Issue Details** page and how you can filter breadcrumbs to quickly resolve issues in [Using Breadcrumbs](/product/error-monitoring/breadcrumbs).

<Alert level="" title="Learn about SDK usage">
<Alert title="Learn about SDK usage">

Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/data-model/event-payloads/breadcrumbs/).

Expand Down
2 changes: 1 addition & 1 deletion docs/platforms/javascript/common/user-feedback/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ By default, this will insert the widget into the bottom right corner of your web

On SDK version 8.0.0 and above, users can send screenshots with their feedback. If you're self-hosting, you also need release 24.4.2 and above. You can configure this using the `enableScreenshot` option, by default it is set to `true`. Screenshots aren't supported on mobile devices, so the screenshot button will be hidden automatically in this case.

<Alert level="">
<Alert>
Screenshots use your [attachments
quota](/pricing/quotas/manage-attachments-quota). All plans come with 1GB of
attachments, which is approxiamately 2500 screenshots.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Sentry uses _breadcrumbs_ to create a trail of events that happened prior to an

This page provides an overview of manual breadcrumb recording and customization. Learn more about the information that displays on the **Issue Details** page and how you can filter breadcrumbs to quickly resolve issues in [Using Breadcrumbs](/product/error-monitoring/breadcrumbs).

<Alert level="" title="Learn about SDK usage">
<Alert title="Learn about SDK usage">

Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/data-model/event-payloads/breadcrumbs/).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Sentry uses _breadcrumbs_ to create a trail of events that happened prior to an

This page provides an overview of manual breadcrumb recording and customization. Learn more about the information that displays on the **Issue Details** page and how you can filter breadcrumbs to quickly resolve issues in [Using Breadcrumbs](/product/error-monitoring/breadcrumbs).

<Alert level="" title="Learn about SDK usage">
<Alert title="Learn about SDK usage">

Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/data-model/event-payloads/breadcrumbs/).

Expand Down
2 changes: 1 addition & 1 deletion docs/platforms/native/guides/minidumps/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ and can later be uploaded to Sentry. A minidump typically includes:
assertion message is also included in the dump.
- Meta data about the CPU architecture and the user’s operating system.

<Alert level="" title="A Word on Data Privacy">
<Alert title="A Word on Data Privacy">

Minidumps are memory dumps of the process at the moment it crashes. As such,
they might contain sensitive information on the target system, such as
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Sentry uses _breadcrumbs_ to create a trail of events that happened prior to an

This page provides an overview of manual breadcrumb recording and customization. Learn more about the information that displays on the **Issue Details** page and how you can filter breadcrumbs to quickly resolve issues in [Using Breadcrumbs](/product/error-monitoring/breadcrumbs).

<Alert level="" title="Learn about SDK usage">
<Alert title="Learn about SDK usage">

Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/data-model/event-payloads/breadcrumbs/).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Sentry uses _breadcrumbs_ to create a trail of events that happened prior to an

This page provides an overview of manual breadcrumb recording and customization. Learn more about the information that displays on the **Issue Details** page and how you can filter breadcrumbs to quickly resolve issues in [Using Breadcrumbs](/product/error-monitoring/breadcrumbs).

<Alert level="" title="Learn about SDK usage">
<Alert title="Learn about SDK usage">

Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/data-model/event-payloads/breadcrumbs/).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Sentry uses _breadcrumbs_ to create a trail of events that happened prior to an

This page provides an overview of manual breadcrumb recording and customization. Learn more about the information that displays on the **Issue Details** page and how you can filter breadcrumbs to quickly resolve issues in [Using Breadcrumbs](/product/error-monitoring/breadcrumbs).

<Alert level="" title="Learn about SDK usage">
<Alert title="Learn about SDK usage">

Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/data-model/event-payloads/breadcrumbs/).

Expand Down
4 changes: 2 additions & 2 deletions docs/platforms/python/legacy-sdk/integrations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -875,7 +875,7 @@ logger.error('There was an error, with a stack trace!', extra={
})
```

<Alert level="" title="Note on Python version">
<Alert title="Note on Python version">

Depending on the version of Python you’re using, `extra` might not be an acceptable keyword argument for a logger’s `.exception()` method (`.debug()`, `.info()`, `.warning()`, `.error()` and `.critical()` should work fine regardless of Python version). This should be fixed as of Python 2.7.4 and 3.2. Official issue here: [bugs.python.org/issue15541](https://bugs.python.org/issue15541).

Expand Down Expand Up @@ -1200,7 +1200,7 @@ class AsyncExceptionHandler(SentryMixin, tornado.web.RequestHandler):
self.finish()
```

<Alert level="" title="Tip">
<Alert title="Tip">

The value returned by the yield is a `HTTPResponse` object.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Sentry uses _breadcrumbs_ to create a trail of events that happened prior to an

This page provides an overview of manual breadcrumb recording and customization. Learn more about the information that displays on the **Issue Details** page and how you can filter breadcrumbs to quickly resolve issues in [Using Breadcrumbs](/product/error-monitoring/breadcrumbs).

<Alert level="" title="Learn about SDK usage">
<Alert title="Learn about SDK usage">

Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/data-model/event-payloads/breadcrumbs/).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Sentry uses _breadcrumbs_ to create a trail of events that happened prior to an

This page provides an overview of manual breadcrumb recording and customization. Learn more about the information that displays on the **Issue Details** page and how you can filter breadcrumbs to quickly resolve issues in [Using Breadcrumbs](/product/error-monitoring/breadcrumbs).

<Alert level="" title="Learn about SDK usage">
<Alert title="Learn about SDK usage">

Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/data-model/event-payloads/breadcrumbs/).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Sentry uses _breadcrumbs_ to create a trail of events that happened prior to an

This page provides an overview of manual breadcrumb recording and customization. Learn more about the information that displays on the **Issue Details** page and how you can filter breadcrumbs to quickly resolve issues in [Using Breadcrumbs](/product/error-monitoring/breadcrumbs).

<Alert level="" title="Learn about SDK usage">
<Alert title="Learn about SDK usage">

Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/data-model/event-payloads/breadcrumbs/).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Sentry uses _breadcrumbs_ to create a trail of events that happened prior to an

This page provides an overview of manual breadcrumb recording and customization. Learn more about the information that displays on the **Issue Details** page and how you can filter breadcrumbs to quickly resolve issues in [Using Breadcrumbs](/product/error-monitoring/breadcrumbs).

<Alert level="" title="Learn about SDK usage">
<Alert title="Learn about SDK usage">

Developers who want to modify the breadcrumbs interface can learn more in our [developer documentation about the Breadcrumbs Interface](https://develop.sentry.dev/sdk/data-model/event-payloads/breadcrumbs/).

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<Alert level="" title="NLog Layouts">
<Alert title="NLog Layouts">

For more information on how to dynamically set event data via `NLog.config`, see NLog's [layout renderer documentation](https://nlog-project.org/config/?tab=layout-renderers).

Expand Down
Loading
Loading