Skip to content
Draft
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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
10 changes: 3 additions & 7 deletions app/sitemap.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import type {MetadataRoute} from 'next';
import {DEVELOP_DOCS_INDEXABLE_ROOTS} from 'sentry-docs/developDocsConfig';
import {type DocNode, getDocsRootNode} from 'sentry-docs/docTree';
import {isDeveloperDocs} from 'sentry-docs/isDeveloperDocs';
import {ensureTrailingSlash} from 'sentry-docs/utils';

/**
* Recursively extracts all slugs (paths) from a DocNode tree.
Expand Down Expand Up @@ -50,13 +51,8 @@ export default async function sitemap(): Promise<MetadataRoute.Sitemap> {
}

function docsToSitemap(paths: string[], baseUrl: string): MetadataRoute.Sitemap {
const appendSlash = (path: string) => {
if (path === '' || path.endsWith('/')) {
return path;
}
return path + '/';
};
const toFullUrl = (path: string) => `${appendSlash(baseUrl)}${appendSlash(path)}`;
const toFullUrl = (path: string) =>
`${ensureTrailingSlash(baseUrl)}${ensureTrailingSlash(path)}`;
const toSitemapEntry = (path: string) => ({url: toFullUrl(path)});
return ['', ...paths].map(toSitemapEntry);
}
2 changes: 1 addition & 1 deletion docs/api/guides/teams-tutorial.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ APIs used in this tutorial:

- A Sentry authentication token with team:write scopes or higher and project:read scopes or higher.

> If you don't have an authentication token, follow the [Create a Sentry Authentication Token](/api/guides/create-auth-token) tutorial to create an organization token with the following permissions, or higher:
> If you don't have an authentication token, follow the [Create a Sentry Authentication Token](/api/guides/create-auth-token/) tutorial to create an organization token with the following permissions, or higher:
>
> - Organization: Read
> - Team: Write
Expand Down
2 changes: 1 addition & 1 deletion docs/api/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The current version of the Sentry's web API is considered **v0**. Our public end
- [Authentication](/api/auth/)
- [Pagination](/api/pagination/)
- [Permissions](/api/permissions/)
- [Rate Limits](/api/ratelimits)
- [Rate Limits](/api/ratelimits/)
- [Requests](/api/requests/)

### Sentry API Tutorials
Expand Down
4 changes: 2 additions & 2 deletions docs/cli/crons.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Sentry Crons allows you to monitor the uptime and performance of any scheduled,

To begin monitoring your recurring, scheduled job:

- [Install](/cli/installation) the Sentry CLI (min v2.16.1).
- [Install](/cli/installation/) the Sentry CLI (min v2.16.1).
- Create and configure your first Monitor in [Sentry](https://sentry.io/issues/alerts/new/crons/) or [via the CLI](#creating-or-updating-a-monitor-through-a-check-in-optional).

## Configuration
Expand All @@ -38,7 +38,7 @@ Alternatively, you can add it to your `~/.sentryclirc` config:
dsn = ___PUBLIC_DSN___
```

Learn more about the CLI's [configuration file](/cli/configuration#configuration-file).
Learn more about the CLI's [configuration file](/cli/configuration/#configuration-file).

## Job Monitoring

Expand Down
6 changes: 3 additions & 3 deletions docs/cli/logs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ The `sentry-cli` tool can be used to view and stream logs from your Sentry proje

To use the logs command, you need to:

- [Install](/cli/installation) the Sentry CLI
- [Authenticate](/cli/configuration) with Sentry using an auth token
- [Install](/cli/installation/) the Sentry CLI
- [Authenticate](/cli/configuration/) with Sentry using an auth token
- Have logs enabled for your project

## Configuration
Expand All @@ -30,7 +30,7 @@ Or by setting the `SENTRY_AUTH_TOKEN` environment variable:
export SENTRY_AUTH_TOKEN=___ORG_AUTH_TOKEN___
```

Learn more about the CLI's [configuration file](/cli/configuration#configuration-file).
Learn more about the CLI's [configuration file](/cli/configuration/#configuration-file).

## Basic Usage

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ Frame categorization is heavily used by our newest grouping algorithm. You can m
- `driver` - graphics drivers, and so on
- `telemetry` - crash reporting and analytics frameworks

See [our source code](https://github.com/getsentry/sentry/blob/master/src/sentry/grouping/enhancer/enhancement-configs/mobile%402021-04-02.txt) for a full list of built-in categories.
See [our source code](https://github.com/getsentry/sentry/blob/master/src/sentry/grouping/enhancer/enhancement-configs/all-platforms%402023-01-11.txt) for a full list of built-in categories.

</DefinitionList>

Expand Down Expand Up @@ -217,7 +217,7 @@ For instance, the following marks all frames that are below a specific C++ names
stack.function:myapplication::* +app
```

See [in-app frames for Apple](/platforms/apple/usage/in-app-frames) to find out how the `sentry-cocoa` SDK marks frames as in-app.
See [in-app frames for Apple](/platforms/apple/usage/in-app-frames/) to find out how the `sentry-cocoa` SDK marks frames as in-app.

#### Stack Trace Rules

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ The `class` of an element that was clicked. No leading `.` is necessary. For exa

The name of the frontend component that was clicked. For example, `MyAwesomeComponent` would match the React component `<MyAwesomeComponent>`.

Note: This property requires that your project have [React component name capturing configured](/platforms/javascript/guides/react/features/component-names).
Note: This property requires that your project have [React component name capturing configured](/platforms/javascript/guides/react/features/component-names/).

- **Type:** string

Expand Down
10 changes: 5 additions & 5 deletions docs/contributing/approach/sdk-docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ SDKs provide content that focus on 10 sections (two of which are auto-generated)
**[How to Write - Quick Start](/contributing/approach/sdk-docs/write-quick-start/)**

To update existing Getting Started guides, use:
**[How to Write - Getting Started](/contributing/approach/sdk-docs/write-getting-started)**
**[How to Write - Getting Started](/contributing/approach/sdk-docs/write-getting-started/)**

This content is used in two different areas for Sentry customers:

Expand All @@ -29,13 +29,13 @@ SDKs provide content that focus on 10 sections (two of which are auto-generated)

Covers all the ways customers can manage their implementation of the SDK. It consists of subpages (all of which can be turned on or off, as appropriate to the SDK).

**[How to Update: Configuration](/contributing/approach/sdk-docs/write-configuration)**
**[How to Update: Configuration](/contributing/approach/sdk-docs/write-configuration/)**

3) **Usage**

Covers how to capture errors and messages, with a subpage to set the Level.

**[How to Update: Usage](/contributing/approach/sdk-docs/write-usage)**
**[How to Update: Usage](/contributing/approach/sdk-docs/write-usage/)**

4) **Troubleshooting**

Expand All @@ -57,13 +57,13 @@ SDKs provide content that focus on 10 sections (two of which are auto-generated)

Covers the data sent to Sentry, as well as how to customize it.

**[How to Update: Enriching Events](/contributing/approach/sdk-docs/write-enriching-events)**
**[How to Update: Enriching Events](/contributing/approach/sdk-docs/write-enriching-events/)**

8) **Data Management** section

Covers our algorithm for grouping and how it can be modified, as well as how to scrub sensitive data using the SDK.

**[How to Update: Data Management](/contributing/approach/sdk-docs/write-data-management)**
**[How to Update: Data Management](/contributing/approach/sdk-docs/write-data-management/)**

9) (Auto-generated) **Other Guides**

Expand Down
2 changes: 1 addition & 1 deletion docs/contributing/linking.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ For instance, to use the image, `/public/product/monitors-and-alerts/alerts/issu

`![Image alt text](product/monitors-and-alerts/alerts/issue-alert.png)`

The folder structure of `docs` is duplicated in `public` so that you can still use relative paths to reference images in your content files. For more details, see [Images](/contributing/pages/images).
The folder structure of `docs` is duplicated in `public` so that you can still use relative paths to reference images in your content files. For more details, see [Images](/contributing/pages/images/).

## Email address

Expand Down
2 changes: 1 addition & 1 deletion docs/integrations/data-forwarding/grafana/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "Learn about Sentry's Grafana integration, which allows you to quer
---

<Alert level="warning">
If you make changes to your organization slug, you'll need to update your configuration for this integration. Learn more in our [troubleshooting guide](/integrations/troubleshooting).
If you make changes to your organization slug, you'll need to update your configuration for this integration. Learn more in our [troubleshooting guide](/integrations/troubleshooting/).
</Alert>

Visualize your Sentry [Issues](/product/issues/) and [Stats](/product/stats/) data in Grafana with the Sentry [data source plugin](https://grafana.com/grafana/plugins/grafana-sentry-datasource/). Once installed, you can combine Sentry data with that of other sources, like your infrastructure data through Prometheus or your business data from your data warehouse, in a single dashboard.
Expand Down
2 changes: 1 addition & 1 deletion docs/integrations/deployment/expo/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: "Learn how to integrate Sentry with Expo Application Services (EAS)

<Alert level="warning">

If you make changes to your organization slug, you'll need to update your configuration for this integration. Learn more in our [troubleshooting guide](/integrations/troubleshooting).
If you make changes to your organization slug, you'll need to update your configuration for this integration. Learn more in our [troubleshooting guide](/integrations/troubleshooting/).

</Alert>

Expand Down
2 changes: 1 addition & 1 deletion docs/integrations/deployment/vercel/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ og_image: /og-images/organization-integrations-deployment-vercel.png

<Alert level="warning">

If you make changes to your organization slug, you'll need to update your configuration for this integration. Learn more in our [troubleshooting guide](/integrations/troubleshooting).
If you make changes to your organization slug, you'll need to update your configuration for this integration. Learn more in our [troubleshooting guide](/integrations/troubleshooting/).

</Alert>

Expand Down
2 changes: 1 addition & 1 deletion docs/integrations/feature-flag/split/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ og_image: /og-images/organization-integrations-feature-flag-split.png

<Alert level="warning">

If you make changes to your organization slug, you'll need to update your configuration for this integration. Learn more in our [troubleshooting guide](/integrations/troubleshooting).
If you make changes to your organization slug, you'll need to update your configuration for this integration. Learn more in our [troubleshooting guide](/integrations/troubleshooting/).

</Alert>

Expand Down
4 changes: 2 additions & 2 deletions docs/integrations/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Sentry integrates with your favorite apps and services. Each integration offers

## Integration Platform

Sentry’s integration platform provides a way for external services to interact with Sentry. Integrations utilizing this platform are first-class actors within Sentry, and you can build them for [public](/integrations/integration-platform/public-integration) as well as [internal](/integrations/integration-platform/internal-integration) use cases.
Sentry’s integration platform provides a way for external services to interact with Sentry. Integrations utilizing this platform are first-class actors within Sentry, and you can build them for [public](/integrations/integration-platform/public-integration/) as well as [internal](/integrations/integration-platform/internal-integration/) use cases.

For more details, see the [full Integration Platform documentation](/integrations/integration-platform/).

Expand Down Expand Up @@ -96,7 +96,7 @@ For more details, see the [full Integration Platform documentation](/integration
| Integration | Link Issue to user sessions |
| ------------------------------------------------------ | --------------------------- |
| [Atlas](/integrations/session-replay/atlas/) | X |
| [BetterBugs](/integrations/session-replay/betterbugs) | X |
| [BetterBugs](/integrations/session-replay/betterbugs/) | X |
| [FullStory](/integrations/session-replay/fullstory/) | X |
| [Jam](/integrations/session-replay/jam/) | X |
| [OpenReplay](/integrations/session-replay/openreplay/) | X |
Expand Down
8 changes: 4 additions & 4 deletions docs/integrations/integration-platform/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: >-
og_image: /og-images/organization-integrations-integration-platform.png
---

Sentry’s integration platform provides a way for external services to interact with Sentry using [webhooks](/integrations/integration-platform/webhooks/), [UI components](/integrations/integration-platform/ui-components/), and the [REST API](/api). Integrations using this platform are first-class actors within Sentry.
Sentry’s integration platform provides a way for external services to interact with Sentry using [webhooks](/integrations/integration-platform/webhooks/), [UI components](/integrations/integration-platform/ui-components/), and the [REST API](/api/). Integrations using this platform are first-class actors within Sentry.

## Example App

Expand All @@ -19,7 +19,7 @@ It's a kanban application that uses many of the features available to Sentry int

## Creating an Integration

In [sentry.io](https://sentry.io), navigate to **Settings > Developer Settings**. From here, you can choose to create an [internal](/integrations/integration-platform/internal-integration) or [public](/integrations/integration-platform/public-integration) integration. Internal integrations can only be used by your organization, whereas public integrations can be published and are available for all Sentry users.
In [sentry.io](https://sentry.io), navigate to **Settings > Developer Settings**. From here, you can choose to create an [internal](/integrations/integration-platform/internal-integration/) or [public](/integrations/integration-platform/public-integration/) integration. Internal integrations can only be used by your organization, whereas public integrations can be published and are available for all Sentry users.

![Settings page that allows developer to choose between public or internal integrations.](./img/dev-settings.png)

Expand All @@ -44,7 +44,7 @@ up as a service in the action section when creating or updating an alert. The in

For your service to receive webhooks for alerts, you must have `Send a notification via <your integration>` as an action. Once that's set up, you'll start receiving webhook requests for triggered alerts. For more information about the request and payload, check out the [full Webhooks documentation](/integrations/integration-platform/webhooks/).

If you'd like users to provide more app-specific information to handle these webhooks (e.g. assignees, teams, notification channels), consider implementing the [alert action UI component](/integrations/integration-platform/ui-components/alert-action).
If you'd like users to provide more app-specific information to handle these webhooks (e.g. assignees, teams, notification channels), consider implementing the [alert action UI component](/integrations/integration-platform/ui-components/alert-action/).

## Permissions

Expand All @@ -56,7 +56,7 @@ You can't create an integration or change an existing integration to have permis

## Auth Tokens

Auth tokens are passed using an auth header, and are used to authenticate as a user account with the API. [Public integrations](/integrations/integration-platform/public-integration) require an OAuth flow for tokens. [Internal integrations](/integrations/integration-platform/internal-integration) automatically generate tokens after installation. For more information, check out the [full Authentication documentation](/api/auth/).
Auth tokens are passed using an auth header, and are used to authenticate as a user account with the API. [Public integrations](/integrations/integration-platform/public-integration/) require an OAuth flow for tokens. [Internal integrations](/integrations/integration-platform/internal-integration/) automatically generate tokens after installation. For more information, check out the [full Authentication documentation](/api/auth/).

## Learn More

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Internal integrations don't require logos or icons to be uploaded, but you can u
- File format must be PNG
- Background must be transparent (unless the logo takes up the entire space)

If the integration has a [UI component](/integrations/integration-platform/ui-components), you can also upload an icon that follows these requirements:
If the integration has a [UI component](/integrations/integration-platform/ui-components/), you can also upload an icon that follows these requirements:

- Icon size must be between 256 &times; 256px and 1024 &times; 1024px
- File must be a PNG in RGBA format
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ Public integrations require a logo image to be uploaded. The requirements for th
- File format must be PNG
- Background must be transparent (unless the logo takes up the entire space)

If the integration has a [UI component](/integrations/integration-platform/ui-components), you must also upload an icon that follows these requirements:
If the integration has a [UI component](/integrations/integration-platform/ui-components/), you must also upload an icon that follows these requirements:

- Icon size must be between 256 &times; 256px and 1024 &times; 1024px
- File must be a PNG in RGBA format
Expand Down
Loading
Loading