diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 5436033d53fb5..5b79b1150bc5d 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -13,7 +13,7 @@ repos: - id: detect-private-key exclude: | (?x)^( - develop-docs/application/config.mdx| + develop-docs/application-architecture/config.mdx| develop-docs/integrations/github.mdx| develop-docs/self-hosted/sso.mdx )$ diff --git a/develop-docs/backend/api/basics.mdx b/develop-docs/api-server/api/basics.mdx similarity index 100% rename from develop-docs/backend/api/basics.mdx rename to develop-docs/api-server/api/basics.mdx diff --git a/develop-docs/backend/api/checklist.mdx b/develop-docs/api-server/api/checklist.mdx similarity index 100% rename from develop-docs/backend/api/checklist.mdx rename to develop-docs/api-server/api/checklist.mdx diff --git a/develop-docs/backend/api/concepts.mdx b/develop-docs/api-server/api/concepts.mdx similarity index 100% rename from develop-docs/backend/api/concepts.mdx rename to develop-docs/api-server/api/concepts.mdx diff --git a/develop-docs/backend/api/design.mdx b/develop-docs/api-server/api/design.mdx similarity index 100% rename from develop-docs/backend/api/design.mdx rename to develop-docs/api-server/api/design.mdx diff --git a/develop-docs/backend/api/index.mdx b/develop-docs/api-server/api/index.mdx similarity index 94% rename from develop-docs/backend/api/index.mdx rename to develop-docs/api-server/api/index.mdx index 20fb5b80ad3f5..a9691d42f540c 100644 --- a/develop-docs/backend/api/index.mdx +++ b/develop-docs/api-server/api/index.mdx @@ -1,6 +1,6 @@ --- title: API Development -sidebar_order: 1 +sidebar_order: 20 --- As a developer-facing company it's critical for us to have simple, intuitive, and consistent APIs that our users can call from their dev environment to accomplish key tasks without going to the UI. If you're creating or editing an endpoint, this doc will help you achieve Sentry standards. diff --git a/develop-docs/backend/api/public.mdx b/develop-docs/api-server/api/public.mdx similarity index 100% rename from develop-docs/backend/api/public.mdx rename to develop-docs/api-server/api/public.mdx diff --git a/develop-docs/backend/api/serializers.mdx b/develop-docs/api-server/api/serializers.mdx similarity index 100% rename from develop-docs/backend/api/serializers.mdx rename to develop-docs/api-server/api/serializers.mdx diff --git a/develop-docs/backend/ab-testing/index.mdx b/develop-docs/api-server/application-domains/ab-testing/index.mdx similarity index 99% rename from develop-docs/backend/ab-testing/index.mdx rename to develop-docs/api-server/application-domains/ab-testing/index.mdx index 3db09d9c24ce2..4c290984eaa3e 100644 --- a/develop-docs/backend/ab-testing/index.mdx +++ b/develop-docs/api-server/application-domains/ab-testing/index.mdx @@ -1,6 +1,6 @@ --- title: A/B Tests with Amplitude -sidebar_order: 190 +sidebar_order: 50 --- ## Why AB testing? diff --git a/develop-docs/backend/queue.mdx b/develop-docs/api-server/application-domains/asynchronous-workers.mdx similarity index 99% rename from develop-docs/backend/queue.mdx rename to develop-docs/api-server/application-domains/asynchronous-workers.mdx index 941852c5e5891..3cb83e5418a47 100644 --- a/develop-docs/backend/queue.mdx +++ b/develop-docs/api-server/application-domains/asynchronous-workers.mdx @@ -1,6 +1,6 @@ --- title: Asynchronous Workers -sidebar_order: 100 +sidebar_order: 70 --- Sentry comes with a built-in queue to process tasks in a more asynchronous fashion. For example when an event comes in instead of writing it to the database immediately, it sends a job to the queue so that the request can be returned right away, and the background workers handle actually saving that data. diff --git a/develop-docs/backend/database-migrations/img/post-deploy-pipeline-materials.png b/develop-docs/api-server/application-domains/database-migrations/img/post-deploy-pipeline-materials.png similarity index 100% rename from develop-docs/backend/database-migrations/img/post-deploy-pipeline-materials.png rename to develop-docs/api-server/application-domains/database-migrations/img/post-deploy-pipeline-materials.png diff --git a/develop-docs/backend/database-migrations/img/post-deploy-pipeline-tile.png b/develop-docs/api-server/application-domains/database-migrations/img/post-deploy-pipeline-tile.png similarity index 100% rename from develop-docs/backend/database-migrations/img/post-deploy-pipeline-tile.png rename to develop-docs/api-server/application-domains/database-migrations/img/post-deploy-pipeline-tile.png diff --git a/develop-docs/backend/database-migrations/img/post-deploy-pipeline-variables.png b/develop-docs/api-server/application-domains/database-migrations/img/post-deploy-pipeline-variables.png similarity index 100% rename from develop-docs/backend/database-migrations/img/post-deploy-pipeline-variables.png rename to develop-docs/api-server/application-domains/database-migrations/img/post-deploy-pipeline-variables.png diff --git a/develop-docs/backend/database-migrations/index.mdx b/develop-docs/api-server/application-domains/database-migrations/index.mdx similarity index 99% rename from develop-docs/backend/database-migrations/index.mdx rename to develop-docs/api-server/application-domains/database-migrations/index.mdx index 8ae49c63b2170..2233d884d210a 100644 --- a/develop-docs/backend/database-migrations/index.mdx +++ b/develop-docs/api-server/application-domains/database-migrations/index.mdx @@ -1,6 +1,6 @@ --- title: Database Migrations -sidebar_order: 30 +sidebar_order: 20 --- Django migrations are how we handle changes to the database in Sentry. diff --git a/develop-docs/backend/digests.mdx b/develop-docs/api-server/application-domains/digests.mdx similarity index 99% rename from develop-docs/backend/digests.mdx rename to develop-docs/api-server/application-domains/digests.mdx index abc979151d6e8..62266117a8d45 100644 --- a/develop-docs/backend/digests.mdx +++ b/develop-docs/api-server/application-domains/digests.mdx @@ -1,6 +1,6 @@ --- title: Notification Digests -sidebar_order: 140 +sidebar_order: 130 --- Sentry provides a service that will collect notifications as they occur and schedule them for delivery as aggregated “digest” notifications. diff --git a/develop-docs/backend/email.mdx b/develop-docs/api-server/application-domains/email.mdx similarity index 99% rename from develop-docs/backend/email.mdx rename to develop-docs/api-server/application-domains/email.mdx index 63e3672d7ff5c..835ae4fc4d7fb 100644 --- a/develop-docs/backend/email.mdx +++ b/develop-docs/api-server/application-domains/email.mdx @@ -1,6 +1,6 @@ --- title: Email -sidebar_order: 110 +sidebar_order: 150 --- Sentry provides support for both outbound, and incoming email. diff --git a/develop-docs/backend/feature-flags/flagpole.mdx b/develop-docs/api-server/application-domains/feature-flags/flagpole.mdx similarity index 100% rename from develop-docs/backend/feature-flags/flagpole.mdx rename to develop-docs/api-server/application-domains/feature-flags/flagpole.mdx diff --git a/develop-docs/backend/feature-flags/index.mdx b/develop-docs/api-server/application-domains/feature-flags/index.mdx similarity index 99% rename from develop-docs/backend/feature-flags/index.mdx rename to develop-docs/api-server/application-domains/feature-flags/index.mdx index 142752829ed3a..21d9a58c7c185 100644 --- a/develop-docs/backend/feature-flags/index.mdx +++ b/develop-docs/api-server/application-domains/feature-flags/index.mdx @@ -1,6 +1,6 @@ --- title: 'Feature Flags' -sidebar_order: 40 +sidebar_order: 30 --- Feature flags are declared in Sentry's codebase (look for `SENTRY_FEATURES` in diff --git a/develop-docs/backend/feature-flags/options-backed-features.mdx b/develop-docs/api-server/application-domains/feature-flags/options-backed-features.mdx similarity index 100% rename from develop-docs/backend/feature-flags/options-backed-features.mdx rename to develop-docs/api-server/application-domains/feature-flags/options-backed-features.mdx diff --git a/develop-docs/backend/grouping.mdx b/develop-docs/api-server/application-domains/grouping.mdx similarity index 99% rename from develop-docs/backend/grouping.mdx rename to develop-docs/api-server/application-domains/grouping.mdx index 96ade53555b08..c7024ee09af14 100644 --- a/develop-docs/backend/grouping.mdx +++ b/develop-docs/api-server/application-domains/grouping.mdx @@ -1,6 +1,6 @@ --- title: Grouping -sidebar_order: 60 +sidebar_order: 100 --- Sentry has an extensive grouping system ([public documentation](https://docs.sentry.io/product/sentry-basics/grouping-and-fingerprints/)) diff --git a/develop-docs/api-server/application-domains/index.mdx b/develop-docs/api-server/application-domains/index.mdx new file mode 100644 index 0000000000000..be66c776f7c5c --- /dev/null +++ b/develop-docs/api-server/application-domains/index.mdx @@ -0,0 +1,6 @@ +--- +title: Application Domains +sidebar_order: 40 +--- + + diff --git a/develop-docs/backend/kafka.mdx b/develop-docs/api-server/application-domains/kafka.mdx similarity index 95% rename from develop-docs/backend/kafka.mdx rename to develop-docs/api-server/application-domains/kafka.mdx index 50d0694c45132..0a3eb6bf9a14d 100644 --- a/develop-docs/backend/kafka.mdx +++ b/develop-docs/api-server/application-domains/kafka.mdx @@ -1,6 +1,6 @@ --- title: Kafka consumers -sidebar_order: 110 +sidebar_order: 60 --- ## Creating a new consumer in Sentry diff --git a/develop-docs/backend/metrics.mdx b/develop-docs/api-server/application-domains/metrics.mdx similarity index 99% rename from develop-docs/backend/metrics.mdx rename to develop-docs/api-server/application-domains/metrics.mdx index e885681cb2f5f..93bae8f8504bf 100644 --- a/develop-docs/backend/metrics.mdx +++ b/develop-docs/api-server/application-domains/metrics.mdx @@ -1,6 +1,6 @@ --- title: Metrics -sidebar_order: 120 +sidebar_order: 180 --- Sentry provides an abstraction called ‘metrics’ which is used for internal monitoring, generally timings and various counters. diff --git a/develop-docs/backend/nodestore.mdx b/develop-docs/api-server/application-domains/nodestore.mdx similarity index 97% rename from develop-docs/backend/nodestore.mdx rename to develop-docs/api-server/application-domains/nodestore.mdx index 7acd4617d5f6b..44e234432fafb 100644 --- a/develop-docs/backend/nodestore.mdx +++ b/develop-docs/api-server/application-domains/nodestore.mdx @@ -1,6 +1,6 @@ --- title: Node Storage -sidebar_order: 130 +sidebar_order: 120 --- Sentry provides an abstraction called ‘nodestore’ which is used for storing key/value blobs. diff --git a/develop-docs/backend/options/index.mdx b/develop-docs/api-server/application-domains/options.mdx similarity index 99% rename from develop-docs/backend/options/index.mdx rename to develop-docs/api-server/application-domains/options.mdx index 3bb67b281c309..e94bf86f759e8 100644 --- a/develop-docs/backend/options/index.mdx +++ b/develop-docs/api-server/application-domains/options.mdx @@ -1,6 +1,6 @@ --- title: Options -sidebar_order: 50 +sidebar_order: 10 --- Options are a way to store generic system-wide configuration. They serve a similar purpose to configuration files, but they are backed by a database, so it's possible to change them at runtime without a deploy. Options are stored in the database and cached, so they are performant and reliable. This makes options well-suited for rates, quotas, and limits. diff --git a/develop-docs/backend/outboxes.mdx b/develop-docs/api-server/application-domains/outboxes.mdx similarity index 99% rename from develop-docs/backend/outboxes.mdx rename to develop-docs/api-server/application-domains/outboxes.mdx index f0a353a68af40..ae7492727aa35 100644 --- a/develop-docs/backend/outboxes.mdx +++ b/develop-docs/api-server/application-domains/outboxes.mdx @@ -1,6 +1,6 @@ --- title: Outboxes -sidebar_order: 70 +sidebar_order: 110 --- Outboxes are database backed deferred units of work that drive a large portion of our system's eventual consistency workflows. They were designed with a couple of key features in mind: diff --git a/develop-docs/backend/pii/index.mdx b/develop-docs/api-server/application-domains/pii/index.mdx similarity index 100% rename from develop-docs/backend/pii/index.mdx rename to develop-docs/api-server/application-domains/pii/index.mdx diff --git a/develop-docs/backend/pii/methods.mdx b/develop-docs/api-server/application-domains/pii/methods.mdx similarity index 100% rename from develop-docs/backend/pii/methods.mdx rename to develop-docs/api-server/application-domains/pii/methods.mdx diff --git a/develop-docs/backend/pii/selectors.mdx b/develop-docs/api-server/application-domains/pii/selectors.mdx similarity index 100% rename from develop-docs/backend/pii/selectors.mdx rename to develop-docs/api-server/application-domains/pii/selectors.mdx diff --git a/develop-docs/backend/pii/types.mdx b/develop-docs/api-server/application-domains/pii/types.mdx similarity index 100% rename from develop-docs/backend/pii/types.mdx rename to develop-docs/api-server/application-domains/pii/types.mdx diff --git a/develop-docs/backend/quotas.mdx b/develop-docs/api-server/application-domains/quotas.mdx similarity index 99% rename from develop-docs/backend/quotas.mdx rename to develop-docs/api-server/application-domains/quotas.mdx index 354b1cc1d057b..1c689d8e203c5 100644 --- a/develop-docs/backend/quotas.mdx +++ b/develop-docs/api-server/application-domains/quotas.mdx @@ -1,6 +1,6 @@ --- title: Quotas -sidebar_order: 150 +sidebar_order: 160 --- With the way Sentry works you may find yourself in a situation where you’ll see too much inbound traffic without a good way to drop excess messages. There’s a few solutions to this, and you’ll likely want to employ them all if you are faced with this problem. diff --git a/develop-docs/backend/transaction-clustering/index.mdx b/develop-docs/api-server/application-domains/transaction-clustering/index.mdx similarity index 99% rename from develop-docs/backend/transaction-clustering/index.mdx rename to develop-docs/api-server/application-domains/transaction-clustering/index.mdx index 052f1b530c328..69587532d450a 100644 --- a/develop-docs/backend/transaction-clustering/index.mdx +++ b/develop-docs/api-server/application-domains/transaction-clustering/index.mdx @@ -1,6 +1,6 @@ --- title: Clustering URL Transactions -sidebar_order: 60 +sidebar_order: 90 --- Sentry attempts to scrub high-cardinality identifiers from URL transactions diff --git a/develop-docs/backend/transaction-clustering/merged.png b/develop-docs/api-server/application-domains/transaction-clustering/merged.png similarity index 100% rename from develop-docs/backend/transaction-clustering/merged.png rename to develop-docs/api-server/application-domains/transaction-clustering/merged.png diff --git a/develop-docs/backend/transaction-clustering/transaction-clustering-arch.png b/develop-docs/api-server/application-domains/transaction-clustering/transaction-clustering-arch.png similarity index 100% rename from develop-docs/backend/transaction-clustering/transaction-clustering-arch.png rename to develop-docs/api-server/application-domains/transaction-clustering/transaction-clustering-arch.png diff --git a/develop-docs/backend/transaction-clustering/transaction-clustering-arch.svg b/develop-docs/api-server/application-domains/transaction-clustering/transaction-clustering-arch.svg similarity index 100% rename from develop-docs/backend/transaction-clustering/transaction-clustering-arch.svg rename to develop-docs/api-server/application-domains/transaction-clustering/transaction-clustering-arch.svg diff --git a/develop-docs/backend/transaction-clustering/tree.png b/develop-docs/api-server/application-domains/transaction-clustering/tree.png similarity index 100% rename from develop-docs/backend/transaction-clustering/tree.png rename to develop-docs/api-server/application-domains/transaction-clustering/tree.png diff --git a/develop-docs/backend/transaction-clustering/unparameterized.png b/develop-docs/api-server/application-domains/transaction-clustering/unparameterized.png similarity index 100% rename from develop-docs/backend/transaction-clustering/unparameterized.png rename to develop-docs/api-server/application-domains/transaction-clustering/unparameterized.png diff --git a/develop-docs/backend/translations.mdx b/develop-docs/api-server/application-domains/translations.mdx similarity index 99% rename from develop-docs/backend/translations.mdx rename to develop-docs/api-server/application-domains/translations.mdx index a749bd5a8195f..a80adc75e6f31 100644 --- a/develop-docs/backend/translations.mdx +++ b/develop-docs/api-server/application-domains/translations.mdx @@ -1,6 +1,6 @@ --- title: Translations -sidebar_order: 180 +sidebar_order: 40 --- We use [**Transifex**](https://www.transifex.com/getsentry/sentry) to translate Sentry. diff --git a/develop-docs/backend/tsdb.mdx b/develop-docs/api-server/application-domains/tsdb.mdx similarity index 98% rename from develop-docs/backend/tsdb.mdx rename to develop-docs/api-server/application-domains/tsdb.mdx index 8fad662938101..67916618b4178 100644 --- a/develop-docs/backend/tsdb.mdx +++ b/develop-docs/api-server/application-domains/tsdb.mdx @@ -1,6 +1,6 @@ --- title: Time-series Storage -sidebar_order: 160 +sidebar_order: 140 --- Sentry provides a service to store time-series data. Primarily this is used to display aggregate information for events and projects, as well as calculating (in real-time) the rates of events. diff --git a/develop-docs/backend/buffers.mdx b/develop-docs/api-server/application-domains/write-buffers.mdx similarity index 98% rename from develop-docs/backend/buffers.mdx rename to develop-docs/api-server/application-domains/write-buffers.mdx index 76b346fac7974..c0fc047f240f9 100644 --- a/develop-docs/backend/buffers.mdx +++ b/develop-docs/api-server/application-domains/write-buffers.mdx @@ -1,6 +1,6 @@ --- title: Write Buffers -sidebar_order: 170 +sidebar_order: 80 --- Sentry manages database row contention by buffering writes and flushing bulk changes to the database over a period of time. This is extremely helpful if you have high concurrency, especially if they’re frequently the same event. diff --git a/develop-docs/api-server/index.mdx b/develop-docs/api-server/index.mdx new file mode 100644 index 0000000000000..a7533a14c5199 --- /dev/null +++ b/develop-docs/api-server/index.mdx @@ -0,0 +1,8 @@ +--- +title: API Server +sidebar_order: 50 +--- + +The monolith powering Sentry. The backend of our application. + + diff --git a/develop-docs/backend/issue-platform/img/issueProperties.jpg b/develop-docs/api-server/issue-platform/img/issueProperties.jpg similarity index 100% rename from develop-docs/backend/issue-platform/img/issueProperties.jpg rename to develop-docs/api-server/issue-platform/img/issueProperties.jpg diff --git a/develop-docs/backend/issue-platform/index.mdx b/develop-docs/api-server/issue-platform/index.mdx similarity index 99% rename from develop-docs/backend/issue-platform/index.mdx rename to develop-docs/api-server/issue-platform/index.mdx index c8b05fb1402a1..4e9dd9abdeb71 100644 --- a/develop-docs/backend/issue-platform/index.mdx +++ b/develop-docs/api-server/issue-platform/index.mdx @@ -1,6 +1,6 @@ --- title: Issue Platform -sidebar_order: 80 +sidebar_order: 30 --- The Issue Platform allows developers to create new issue types from arbitrary data sources. If you have data about something that you want to track via an issue, you can build it on the issue platform. For example, building profiling issues on the issue platform allowed us to turn things like “JSON decoding on the main thread” into their own issue types. diff --git a/develop-docs/backend/issue-platform-detectors/img/issuePlatformAdminDetectionSettings.png b/develop-docs/api-server/issue-platform/writing-detectors/img/issuePlatformAdminDetectionSettings.png similarity index 100% rename from develop-docs/backend/issue-platform-detectors/img/issuePlatformAdminDetectionSettings.png rename to develop-docs/api-server/issue-platform/writing-detectors/img/issuePlatformAdminDetectionSettings.png diff --git a/develop-docs/backend/issue-platform-detectors/img/issuePlatformCustomerDetectorSettings.png b/develop-docs/api-server/issue-platform/writing-detectors/img/issuePlatformCustomerDetectorSettings.png similarity index 100% rename from develop-docs/backend/issue-platform-detectors/img/issuePlatformCustomerDetectorSettings.png rename to develop-docs/api-server/issue-platform/writing-detectors/img/issuePlatformCustomerDetectorSettings.png diff --git a/develop-docs/backend/issue-platform-detectors/img/issuePlatformDbonMainThreadDetectorSetting.png b/develop-docs/api-server/issue-platform/writing-detectors/img/issuePlatformDbonMainThreadDetectorSetting.png similarity index 100% rename from develop-docs/backend/issue-platform-detectors/img/issuePlatformDbonMainThreadDetectorSetting.png rename to develop-docs/api-server/issue-platform/writing-detectors/img/issuePlatformDbonMainThreadDetectorSetting.png diff --git a/develop-docs/backend/issue-platform-detectors/img/issuePlatformFingerprinting01.png b/develop-docs/api-server/issue-platform/writing-detectors/img/issuePlatformFingerprinting01.png similarity index 100% rename from develop-docs/backend/issue-platform-detectors/img/issuePlatformFingerprinting01.png rename to develop-docs/api-server/issue-platform/writing-detectors/img/issuePlatformFingerprinting01.png diff --git a/develop-docs/backend/issue-platform-detectors/img/issuePlatformFingerprinting02.png b/develop-docs/api-server/issue-platform/writing-detectors/img/issuePlatformFingerprinting02.png similarity index 100% rename from develop-docs/backend/issue-platform-detectors/img/issuePlatformFingerprinting02.png rename to develop-docs/api-server/issue-platform/writing-detectors/img/issuePlatformFingerprinting02.png diff --git a/develop-docs/backend/issue-platform-detectors/img/issuePlatformFingerprinting03.png b/develop-docs/api-server/issue-platform/writing-detectors/img/issuePlatformFingerprinting03.png similarity index 100% rename from develop-docs/backend/issue-platform-detectors/img/issuePlatformFingerprinting03.png rename to develop-docs/api-server/issue-platform/writing-detectors/img/issuePlatformFingerprinting03.png diff --git a/develop-docs/backend/issue-platform-detectors/index.mdx b/develop-docs/api-server/issue-platform/writing-detectors/index.mdx similarity index 99% rename from develop-docs/backend/issue-platform-detectors/index.mdx rename to develop-docs/api-server/issue-platform/writing-detectors/index.mdx index f2babbd81d6b9..40ce8f5b8548a 100644 --- a/develop-docs/backend/issue-platform-detectors/index.mdx +++ b/develop-docs/api-server/issue-platform/writing-detectors/index.mdx @@ -1,6 +1,6 @@ --- -title: Issue Platform - Writing Detectors -sidebar_order: 90 +title: Writing Detectors +sidebar_order: 10 --- Issue detectors identify application issues by examining one or more datasets collected by Sentry, and report detected issue occurrences via the Issue Platform. Detectors must fingerprint issues accurately and provide actionable information to developers. diff --git a/develop-docs/application/config.mdx b/develop-docs/application-architecture/config.mdx similarity index 99% rename from develop-docs/application/config.mdx rename to develop-docs/application-architecture/config.mdx index 5f793ded7e5e6..b08b5bbba2d0a 100644 --- a/develop-docs/application/config.mdx +++ b/develop-docs/application-architecture/config.mdx @@ -1,6 +1,6 @@ --- title: Configuration -sidebar_order: 60 +sidebar_order: 30 --- This document describes configuration available to the Sentry server itself. diff --git a/develop-docs/application/dynamic-sampling/architecture.mdx b/develop-docs/application-architecture/dynamic-sampling/architecture.mdx similarity index 100% rename from develop-docs/application/dynamic-sampling/architecture.mdx rename to develop-docs/application-architecture/dynamic-sampling/architecture.mdx diff --git a/develop-docs/application/dynamic-sampling/fidelity-and-biases.mdx b/develop-docs/application-architecture/dynamic-sampling/fidelity-and-biases.mdx similarity index 100% rename from develop-docs/application/dynamic-sampling/fidelity-and-biases.mdx rename to develop-docs/application-architecture/dynamic-sampling/fidelity-and-biases.mdx diff --git a/develop-docs/application/dynamic-sampling/images/architecture.png b/develop-docs/application-architecture/dynamic-sampling/images/architecture.png similarity index 100% rename from develop-docs/application/dynamic-sampling/images/architecture.png rename to develop-docs/application-architecture/dynamic-sampling/images/architecture.png diff --git a/develop-docs/application/dynamic-sampling/images/biasesUI.png b/develop-docs/application-architecture/dynamic-sampling/images/biasesUI.png similarity index 100% rename from develop-docs/application/dynamic-sampling/images/biasesUI.png rename to develop-docs/application-architecture/dynamic-sampling/images/biasesUI.png diff --git a/develop-docs/application/dynamic-sampling/images/celeryTasks.png b/develop-docs/application-architecture/dynamic-sampling/images/celeryTasks.png similarity index 100% rename from develop-docs/application/dynamic-sampling/images/celeryTasks.png rename to develop-docs/application-architecture/dynamic-sampling/images/celeryTasks.png diff --git a/develop-docs/application/dynamic-sampling/images/clientAndDynamicSampling.png b/develop-docs/application-architecture/dynamic-sampling/images/clientAndDynamicSampling.png similarity index 100% rename from develop-docs/application/dynamic-sampling/images/clientAndDynamicSampling.png rename to develop-docs/application-architecture/dynamic-sampling/images/clientAndDynamicSampling.png diff --git a/develop-docs/application/dynamic-sampling/images/dsOverview.png b/develop-docs/application-architecture/dynamic-sampling/images/dsOverview.png similarity index 100% rename from develop-docs/application/dynamic-sampling/images/dsOverview.png rename to develop-docs/application-architecture/dynamic-sampling/images/dsOverview.png diff --git a/develop-docs/application/dynamic-sampling/images/fidelityAndPriorities.png b/develop-docs/application-architecture/dynamic-sampling/images/fidelityAndPriorities.png similarity index 100% rename from develop-docs/application/dynamic-sampling/images/fidelityAndPriorities.png rename to develop-docs/application-architecture/dynamic-sampling/images/fidelityAndPriorities.png diff --git a/develop-docs/application/dynamic-sampling/images/redisBoostedRelease.png b/develop-docs/application-architecture/dynamic-sampling/images/redisBoostedRelease.png similarity index 100% rename from develop-docs/application/dynamic-sampling/images/redisBoostedRelease.png rename to develop-docs/application-architecture/dynamic-sampling/images/redisBoostedRelease.png diff --git a/develop-docs/application/dynamic-sampling/images/sampleRateAndAdoption.png b/develop-docs/application-architecture/dynamic-sampling/images/sampleRateAndAdoption.png similarity index 100% rename from develop-docs/application/dynamic-sampling/images/sampleRateAndAdoption.png rename to develop-docs/application-architecture/dynamic-sampling/images/sampleRateAndAdoption.png diff --git a/develop-docs/application/dynamic-sampling/images/sequencing.png b/develop-docs/application-architecture/dynamic-sampling/images/sequencing.png similarity index 100% rename from develop-docs/application/dynamic-sampling/images/sequencing.png rename to develop-docs/application-architecture/dynamic-sampling/images/sequencing.png diff --git a/develop-docs/application/dynamic-sampling/images/traceSampling.png b/develop-docs/application-architecture/dynamic-sampling/images/traceSampling.png similarity index 100% rename from develop-docs/application/dynamic-sampling/images/traceSampling.png rename to develop-docs/application-architecture/dynamic-sampling/images/traceSampling.png diff --git a/develop-docs/application/dynamic-sampling/index.mdx b/develop-docs/application-architecture/dynamic-sampling/index.mdx similarity index 98% rename from develop-docs/application/dynamic-sampling/index.mdx rename to develop-docs/application-architecture/dynamic-sampling/index.mdx index 2b42712e5ea6d..9d52bdc363a23 100644 --- a/develop-docs/application/dynamic-sampling/index.mdx +++ b/develop-docs/application-architecture/dynamic-sampling/index.mdx @@ -1,7 +1,7 @@ --- title: Dynamic Sampling description: Dynamic Sampling is a feature of the ingestion pipeline that allows Sentry to automatically adjust the amount of data retained based on the value of the data. -sidebar_order: 10 +sidebar_order: 50 --- From all the data received by the SDKs, Sentry is able to extract low-granularity information through metrics, while Dynamic Sampling makes the decision of whether to keep or drop data. diff --git a/develop-docs/application/dynamic-sampling/outcomes.mdx b/develop-docs/application-architecture/dynamic-sampling/outcomes.mdx similarity index 100% rename from develop-docs/application/dynamic-sampling/outcomes.mdx rename to develop-docs/application-architecture/dynamic-sampling/outcomes.mdx diff --git a/develop-docs/application/dynamic-sampling/the-big-picture.mdx b/develop-docs/application-architecture/dynamic-sampling/the-big-picture.mdx similarity index 100% rename from develop-docs/application/dynamic-sampling/the-big-picture.mdx rename to develop-docs/application-architecture/dynamic-sampling/the-big-picture.mdx diff --git a/develop-docs/application/feedback-architecture.mdx b/develop-docs/application-architecture/feedback-architecture.mdx similarity index 99% rename from develop-docs/application/feedback-architecture.mdx rename to develop-docs/application-architecture/feedback-architecture.mdx index 2cde9c7fea727..e90e1d1ff59dd 100644 --- a/develop-docs/application/feedback-architecture.mdx +++ b/develop-docs/application-architecture/feedback-architecture.mdx @@ -1,6 +1,6 @@ --- title: User Feedback Architecture -sidebar_order: 20 +sidebar_order: 60 --- **The goal of this doc is to give engineers an in-depth understanding of User Feedback's backend.** diff --git a/develop-docs/application/index.mdx b/develop-docs/application-architecture/index.mdx similarity index 55% rename from develop-docs/application/index.mdx rename to develop-docs/application-architecture/index.mdx index 6a71b4d9473c5..faf2dd2eb6a5a 100644 --- a/develop-docs/application/index.mdx +++ b/develop-docs/application-architecture/index.mdx @@ -1,5 +1,5 @@ --- -title: Application +title: Application Architecture sidebar_order: 30 --- diff --git a/develop-docs/application/control-silo.mdx b/develop-docs/application-architecture/multi-region-deployment/control-silo.mdx similarity index 99% rename from develop-docs/application/control-silo.mdx rename to develop-docs/application-architecture/multi-region-deployment/control-silo.mdx index fb25ce57bca48..7e4b889939d90 100644 --- a/develop-docs/application/control-silo.mdx +++ b/develop-docs/application-architecture/multi-region-deployment/control-silo.mdx @@ -1,6 +1,6 @@ --- title: Control Silo -sidebar_order: 30 +sidebar_order: 10 --- Within the Control Silo are features that allow us to provide backwards compatibility for both customer API usage, and integrations diff --git a/develop-docs/application/cross-region-replication.mdx b/develop-docs/application-architecture/multi-region-deployment/cross-region-replication.mdx similarity index 99% rename from develop-docs/application/cross-region-replication.mdx rename to develop-docs/application-architecture/multi-region-deployment/cross-region-replication.mdx index 18c04f0fe1e13..316d6085ad510 100644 --- a/develop-docs/application/cross-region-replication.mdx +++ b/develop-docs/application-architecture/multi-region-deployment/cross-region-replication.mdx @@ -1,6 +1,6 @@ --- title: Cross Region Replication -sidebar_order: 40 +sidebar_order: 20 --- Our data-model includes many relations between users and the objects they create or interact with. Eventually users are deleted, and they need to be detached from the records they created, or those records need to be destroyed. Before sentry became a multi-region application, we relied on a mixture of Django callbacks, and postgres constraints to cascade deletions. However, in a multi-region state we arent't able to rely on these anymore as Users are in [Control Silo](/architecture/#silo-modes) and many of the objects they interact with are in the various Region Silos. diff --git a/develop-docs/application/cross-region-rpc.mdx b/develop-docs/application-architecture/multi-region-deployment/cross-region-rpc.mdx similarity index 99% rename from develop-docs/application/cross-region-rpc.mdx rename to develop-docs/application-architecture/multi-region-deployment/cross-region-rpc.mdx index f8ce9bfc1321a..b2cb2a3e46de7 100644 --- a/develop-docs/application/cross-region-rpc.mdx +++ b/develop-docs/application-architecture/multi-region-deployment/cross-region-rpc.mdx @@ -1,6 +1,6 @@ --- title: Cross Region RPC -sidebar_order: 50 +sidebar_order: 30 --- When Sentry is deployed in a multi-region deployment (like sentry.io) there are many scenarios and workflows where a region silo requires information that is stored in Control Silo. Similarly there are flows where Control Silo operations need to read or mutate state stored in regions. diff --git a/develop-docs/application-architecture/multi-region-deployment/index.mdx b/develop-docs/application-architecture/multi-region-deployment/index.mdx new file mode 100644 index 0000000000000..f88e14a4981ca --- /dev/null +++ b/develop-docs/application-architecture/multi-region-deployment/index.mdx @@ -0,0 +1,6 @@ +--- +title: Multi-Region Deployment +sidebar_order: 40 +--- + + diff --git a/develop-docs/application/architecture.mdx b/develop-docs/application-architecture/overview.mdx similarity index 99% rename from develop-docs/application/architecture.mdx rename to develop-docs/application-architecture/overview.mdx index d0f8f0fd40a22..cbc9aab0607e3 100644 --- a/develop-docs/application/architecture.mdx +++ b/develop-docs/application-architecture/overview.mdx @@ -1,6 +1,6 @@ --- -title: Architecture -sidebar_order: 1 +title: Overview +sidebar_order: 10 --- ## High level overview diff --git a/develop-docs/application/sentry-vs-getsentry.mdx b/develop-docs/application-architecture/sentry-vs-getsentry.mdx similarity index 99% rename from develop-docs/application/sentry-vs-getsentry.mdx rename to develop-docs/application-architecture/sentry-vs-getsentry.mdx index adb8b9d516365..9346d260f8d90 100644 --- a/develop-docs/application/sentry-vs-getsentry.mdx +++ b/develop-docs/application-architecture/sentry-vs-getsentry.mdx @@ -1,6 +1,6 @@ --- title: sentry vs. getsentry -sidebar_order: 70 +sidebar_order: 20 --- You'll find numerous references to both `sentry` and `getsentry` in our documentation. Both are [Django](https://www.djangoproject.com/) apps, but `sentry` [is open](https://github.com/getsentry/sentry) and `getsentry` is closed. What's in which? diff --git a/develop-docs/backend/index.mdx b/develop-docs/backend/index.mdx deleted file mode 100644 index 2ce3b0a37ec34..0000000000000 --- a/develop-docs/backend/index.mdx +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: Backend -sidebar_order: 50 ---- - - diff --git a/develop-docs/development/analytics.mdx b/develop-docs/development-infrastructure/analytics.mdx similarity index 99% rename from develop-docs/development/analytics.mdx rename to develop-docs/development-infrastructure/analytics.mdx index 19694332ba1fc..4877afd8d7972 100644 --- a/develop-docs/development/analytics.mdx +++ b/develop-docs/development-infrastructure/analytics.mdx @@ -1,7 +1,7 @@ --- title: Analytics description: This guide steps you through instrumenting your code with Sentry's 3rd-party analytics infrastructure. -sidebar_order: 100 +sidebar_order: 90 --- diff --git a/develop-docs/backend/development-server.mdx b/develop-docs/development-infrastructure/backend-development-server.mdx similarity index 98% rename from develop-docs/backend/development-server.mdx rename to develop-docs/development-infrastructure/backend-development-server.mdx index 21e3e69e240ed..eb838a6423d78 100644 --- a/develop-docs/backend/development-server.mdx +++ b/develop-docs/development-infrastructure/backend-development-server.mdx @@ -1,6 +1,6 @@ --- title: Backend Development Server -sidebar_order: 10 +sidebar_order: 20 --- (*see also: [Frontend Development Server](/frontend/development-server/)*) @@ -30,4 +30,3 @@ This will do literally nothing except bring up the web workers. You are now resp Use `sentry run --help` to see what you might be missing by not running devserver. To run the development server with ngrok, see [Developing with Ngrok](/development/ngrok/). - diff --git a/develop-docs/development/continuous-integration.mdx b/develop-docs/development-infrastructure/continuous-integration.mdx similarity index 99% rename from develop-docs/development/continuous-integration.mdx rename to develop-docs/development-infrastructure/continuous-integration.mdx index 2bd7d9ea2608b..c3562a091c7b5 100644 --- a/develop-docs/development/continuous-integration.mdx +++ b/develop-docs/development-infrastructure/continuous-integration.mdx @@ -1,7 +1,7 @@ --- title: Continuous Integration description: Sentry uses a variety of continuous integration services to help ensure we don't accidentally break the application. -sidebar_order: 60 +sidebar_order: 80 --- ## Deployments diff --git a/develop-docs/development/devservices.mdx b/develop-docs/development-infrastructure/devservices.mdx similarity index 98% rename from develop-docs/development/devservices.mdx rename to develop-docs/development-infrastructure/devservices.mdx index 788d121b665f0..866fb37b26686 100644 --- a/develop-docs/development/devservices.mdx +++ b/develop-docs/development-infrastructure/devservices.mdx @@ -1,6 +1,6 @@ --- title: Service Manager (devservices) -sidebar_order: 80 +sidebar_order: 40 --- Sentry provides an abstraction to Docker to run required services within development called `devservices`. diff --git a/develop-docs/development/environment/index.mdx b/develop-docs/development-infrastructure/environment/index.mdx similarity index 100% rename from develop-docs/development/environment/index.mdx rename to develop-docs/development-infrastructure/environment/index.mdx diff --git a/develop-docs/development/environment/ports.mdx b/develop-docs/development-infrastructure/environment/ports.mdx similarity index 100% rename from develop-docs/development/environment/ports.mdx rename to develop-docs/development-infrastructure/environment/ports.mdx diff --git a/develop-docs/development/environment/pycharm/img/AddConfiguration.png b/develop-docs/development-infrastructure/environment/pycharm/img/AddConfiguration.png similarity index 100% rename from develop-docs/development/environment/pycharm/img/AddConfiguration.png rename to develop-docs/development-infrastructure/environment/pycharm/img/AddConfiguration.png diff --git a/develop-docs/development/environment/pycharm/img/AddPytestConfiguration.png b/develop-docs/development-infrastructure/environment/pycharm/img/AddPytestConfiguration.png similarity index 100% rename from develop-docs/development/environment/pycharm/img/AddPytestConfiguration.png rename to develop-docs/development-infrastructure/environment/pycharm/img/AddPytestConfiguration.png diff --git a/develop-docs/development/environment/pycharm/img/DevserverLeetSetup.png b/develop-docs/development-infrastructure/environment/pycharm/img/DevserverLeetSetup.png similarity index 100% rename from develop-docs/development/environment/pycharm/img/DevserverLeetSetup.png rename to develop-docs/development-infrastructure/environment/pycharm/img/DevserverLeetSetup.png diff --git a/develop-docs/development/environment/pycharm/img/DevserverTroubleshooting.png b/develop-docs/development-infrastructure/environment/pycharm/img/DevserverTroubleshooting.png similarity index 100% rename from develop-docs/development/environment/pycharm/img/DevserverTroubleshooting.png rename to develop-docs/development-infrastructure/environment/pycharm/img/DevserverTroubleshooting.png diff --git a/develop-docs/development/environment/pycharm/img/PyCharmGetsentry.png b/develop-docs/development-infrastructure/environment/pycharm/img/PyCharmGetsentry.png similarity index 100% rename from develop-docs/development/environment/pycharm/img/PyCharmGetsentry.png rename to develop-docs/development-infrastructure/environment/pycharm/img/PyCharmGetsentry.png diff --git a/develop-docs/development/environment/pycharm/img/PyCharmPyInterpreter.png b/develop-docs/development-infrastructure/environment/pycharm/img/PyCharmPyInterpreter.png similarity index 100% rename from develop-docs/development/environment/pycharm/img/PyCharmPyInterpreter.png rename to develop-docs/development-infrastructure/environment/pycharm/img/PyCharmPyInterpreter.png diff --git a/develop-docs/development/environment/pycharm/img/PycharmRunConfigEnvVar.png b/develop-docs/development-infrastructure/environment/pycharm/img/PycharmRunConfigEnvVar.png similarity index 100% rename from develop-docs/development/environment/pycharm/img/PycharmRunConfigEnvVar.png rename to develop-docs/development-infrastructure/environment/pycharm/img/PycharmRunConfigEnvVar.png diff --git a/develop-docs/development/environment/pycharm/index.mdx b/develop-docs/development-infrastructure/environment/pycharm/index.mdx similarity index 100% rename from develop-docs/development/environment/pycharm/index.mdx rename to develop-docs/development-infrastructure/environment/pycharm/index.mdx diff --git a/develop-docs/development/environment/u2f.mdx b/develop-docs/development-infrastructure/environment/u2f.mdx similarity index 100% rename from develop-docs/development/environment/u2f.mdx rename to develop-docs/development-infrastructure/environment/u2f.mdx diff --git a/develop-docs/frontend/development-server.mdx b/develop-docs/development-infrastructure/frontend-development-server.mdx similarity index 99% rename from develop-docs/frontend/development-server.mdx rename to develop-docs/development-infrastructure/frontend-development-server.mdx index 7a2f3ba45fcdc..82968e6842231 100644 --- a/develop-docs/frontend/development-server.mdx +++ b/develop-docs/development-infrastructure/frontend-development-server.mdx @@ -1,6 +1,6 @@ --- title: Frontend Development Server -sidebar_order: 1 +sidebar_order: 30 --- (*see also: [Backend Development Server](/backend/development-server/)*) diff --git a/develop-docs/development-infrastructure/index.mdx b/develop-docs/development-infrastructure/index.mdx new file mode 100644 index 0000000000000..e8bd87961860e --- /dev/null +++ b/develop-docs/development-infrastructure/index.mdx @@ -0,0 +1,6 @@ +--- +title: Development Infrastructure +sidebar_order: 40 +--- + + diff --git a/develop-docs/development/ngrok.mdx b/develop-docs/development-infrastructure/ngrok.mdx similarity index 100% rename from develop-docs/development/ngrok.mdx rename to develop-docs/development-infrastructure/ngrok.mdx diff --git a/develop-docs/backend/python-dependencies.mdx b/develop-docs/development-infrastructure/python-dependencies.mdx similarity index 99% rename from develop-docs/backend/python-dependencies.mdx rename to develop-docs/development-infrastructure/python-dependencies.mdx index 9c14c57e0ac36..d23268bfc6256 100644 --- a/develop-docs/backend/python-dependencies.mdx +++ b/develop-docs/development-infrastructure/python-dependencies.mdx @@ -1,6 +1,6 @@ --- title: Python Dependencies -sidebar_order: 20 +sidebar_order: 100 --- Unlike our frontend JavaScript story, where we're generally very happy pulling in dependencies, we're much more conservative on diff --git a/develop-docs/development/testing.mdx b/develop-docs/development-infrastructure/testing.mdx similarity index 99% rename from develop-docs/development/testing.mdx rename to develop-docs/development-infrastructure/testing.mdx index d70dfcf60133a..3d019b0398c04 100644 --- a/develop-docs/development/testing.mdx +++ b/develop-docs/development-infrastructure/testing.mdx @@ -1,7 +1,7 @@ --- title: Testing Tips description: We run several kinds of tests at Sentry as part of our CI process. This section aims to document some of the sentry specific helpers and give guidelines on what kinds of tests you should consider including when building new features. -sidebar_order: 50 +sidebar_order: 60 --- ## Getting Setup diff --git a/develop-docs/development/workflow.mdx b/develop-docs/development-infrastructure/workflow.mdx similarity index 99% rename from develop-docs/development/workflow.mdx rename to develop-docs/development-infrastructure/workflow.mdx index 9e5ccd2510d25..756f4cc5acd5e 100644 --- a/develop-docs/development/workflow.mdx +++ b/develop-docs/development-infrastructure/workflow.mdx @@ -1,6 +1,6 @@ --- title: Workflow -sidebar_order: 40 +sidebar_order: 50 --- You may also be interested in sentry vs. getsentry. diff --git a/develop-docs/development/code-review.mdx b/develop-docs/engineering-practices/code-review.mdx similarity index 100% rename from develop-docs/development/code-review.mdx rename to develop-docs/engineering-practices/code-review.mdx diff --git a/develop-docs/development/commit-messages.mdx b/develop-docs/engineering-practices/commit-messages.mdx similarity index 100% rename from develop-docs/development/commit-messages.mdx rename to develop-docs/engineering-practices/commit-messages.mdx diff --git a/develop-docs/development/documentation.mdx b/develop-docs/engineering-practices/documentation.mdx similarity index 100% rename from develop-docs/development/documentation.mdx rename to develop-docs/engineering-practices/documentation.mdx diff --git a/develop-docs/development/index.mdx b/develop-docs/engineering-practices/index.mdx similarity index 57% rename from develop-docs/development/index.mdx rename to develop-docs/engineering-practices/index.mdx index 6b7937abd6af9..8cc6a04eb1656 100644 --- a/develop-docs/development/index.mdx +++ b/develop-docs/engineering-practices/index.mdx @@ -1,5 +1,5 @@ --- -title: Development +title: Engineering Practices sidebar_order: 20 --- diff --git a/develop-docs/development/rust.mdx b/develop-docs/engineering-practices/rust.mdx similarity index 99% rename from develop-docs/development/rust.mdx rename to develop-docs/engineering-practices/rust.mdx index 49872f78fcc9a..8118e62c79d1f 100644 --- a/develop-docs/development/rust.mdx +++ b/develop-docs/engineering-practices/rust.mdx @@ -1,7 +1,7 @@ --- title: Rust Development description: This is a document that contains a bunch of useful resources for getting started with Rust and adhering to our coding principles. -sidebar_order: 90 +sidebar_order: 40 --- ## Getting Started diff --git a/develop-docs/frontend/index.mdx b/develop-docs/frontend/index.mdx index 5c5faad62edb1..a168bbe942dcc 100644 --- a/develop-docs/frontend/index.mdx +++ b/develop-docs/frontend/index.mdx @@ -1,6 +1,6 @@ --- title: Frontend Handbook -sidebar_order: 40 +sidebar_order: 60 --- This guide covers how we write frontend code at Sentry, and is specifically focussed on the [Sentry](https://github.com/getsentry/sentry) and [Getsentry](https://github.com/getsentry/getsentry) codebases. It assumes you are using the eslint rules outlined by [eslint-config-sentry](https://github.com/getsentry/eslint-config-sentry); hence code style enforced by these linting rules will not be discussed here. diff --git a/develop-docs/relay/index.mdx b/develop-docs/ingestion/index.mdx similarity index 60% rename from develop-docs/relay/index.mdx rename to develop-docs/ingestion/index.mdx index e5a08ce7a094c..65de1b40e2f0c 100644 --- a/develop-docs/relay/index.mdx +++ b/develop-docs/ingestion/index.mdx @@ -1,12 +1,13 @@ --- -title: Relay Development -sidebar_order: 70 +title: Ingestion +sidebar_order: 90 --- -Relay is a service for event filtering, rate-limiting and processing. It can act as: +Ingestion is done by [Sentry Relay](https://github.com/getsentry/relay), a service for event filtering, rate-limiting, and processing. + +It can act as: * the store endpoint for your Sentry installation. See [Relay developer documentation](https://getsentry.github.io/relay/relay/). * an additional middle layer between your application and Sentry. See [Relay product documentation](https://docs.sentry.io/product/relay/). - diff --git a/develop-docs/relay/projectconfig-versioning.mdx b/develop-docs/ingestion/projectconfig-versioning.mdx similarity index 100% rename from develop-docs/relay/projectconfig-versioning.mdx rename to develop-docs/ingestion/projectconfig-versioning.mdx diff --git a/develop-docs/relay/transaction-span-ratelimits.mdx b/develop-docs/ingestion/transaction-span-ratelimits.mdx similarity index 100% rename from develop-docs/relay/transaction-span-ratelimits.mdx rename to develop-docs/ingestion/transaction-span-ratelimits.mdx diff --git a/develop-docs/integrations/index.mdx b/develop-docs/integrations/index.mdx index 91fff36c5fb52..6dc434f2599e2 100644 --- a/develop-docs/integrations/index.mdx +++ b/develop-docs/integrations/index.mdx @@ -1,6 +1,6 @@ --- title: Developing Integrations -sidebar_order: 90 +sidebar_order: 80 --- diff --git a/develop-docs/sdk/data-model/event-payloads/contexts.mdx b/develop-docs/sdk/data-model/event-payloads/contexts.mdx index 6c6e5ff41a221..8d21932524591 100644 --- a/develop-docs/sdk/data-model/event-payloads/contexts.mdx +++ b/develop-docs/sdk/data-model/event-payloads/contexts.mdx @@ -618,7 +618,7 @@ The following example illustrates the contexts part of the Feature Flag Context protocol documentation for details. +The Scope's flag property should expose two methods: `get/0` and `set/2`. `set/2` takes two arguments. The first argument is the name of the flag. It is of type string. The second argument is the evaluation result. It is of type boolean. `set/2` should remove all entries from the LRU-cache which match the provided flag's name and append the new evaluation result to the end of the queue. `get/0` accepts zero arguments. The `get/0` method must return a list of serialized flag evaluation results in order of evaluation. Oldest values first, newest values last. See the Feature Flag Context protocol documentation for details. ### Integrations diff --git a/develop-docs/sdk/index.mdx b/develop-docs/sdk/index.mdx index 93b3d77e6e6a2..7e7340b574444 100644 --- a/develop-docs/sdk/index.mdx +++ b/develop-docs/sdk/index.mdx @@ -1,6 +1,6 @@ --- title: SDK Development -sidebar_order: 60 +sidebar_order: 100 --- diff --git a/develop-docs/sdk/miscellaneous/scope-inheritance.excalidraw b/develop-docs/sdk/miscellaneous/scope-inheritance.excalidraw index ef833201cc2ef..303263d99286c 100644 --- a/develop-docs/sdk/miscellaneous/scope-inheritance.excalidraw +++ b/develop-docs/sdk/miscellaneous/scope-inheritance.excalidraw @@ -3004,4 +3004,4 @@ "viewBackgroundColor": "#ffffff" }, "files": {} -} \ No newline at end of file +} diff --git a/develop-docs/self-hosted/index.mdx b/develop-docs/self-hosted/index.mdx index ce425c4ad6b15..ebd91850c847b 100644 --- a/develop-docs/self-hosted/index.mdx +++ b/develop-docs/self-hosted/index.mdx @@ -1,6 +1,6 @@ --- title: Self-Hosted Sentry -sidebar_order: 100 +sidebar_order: 110 --- In addition to making its source code available publicly, Sentry offers and maintains a minimal setup that works out-of-the-box for simple use cases. This version comes with no guarantees or dedicated support. Sentry engineers will do their best to answer questions and are dedicated to making sure self-hosted is running, but that's where our involvement ends. For anything else, we expect users to rely on the [Sentry Self-Hosted community](https://discord.gg/sentry) on Discord. The self-hosted repository should serve as a blueprint for how various Sentry services connect for a complete setup. This will be useful for folks willing to maintain larger installations with custom infrastructure. diff --git a/develop-docs/services/index.mdx b/develop-docs/services/index.mdx index 6d86a306fdc12..1b64b474d219a 100644 --- a/develop-docs/services/index.mdx +++ b/develop-docs/services/index.mdx @@ -1,6 +1,8 @@ --- title: Services -sidebar_order: 80 +sidebar_order: 70 --- +Services we operate that exist outside of the API Server monolith. + diff --git a/src/components/sidebar/developDocsSidebar.tsx b/src/components/sidebar/developDocsSidebar.tsx index 9ec651fd13a77..eb865eee8a883 100644 --- a/src/components/sidebar/developDocsSidebar.tsx +++ b/src/components/sidebar/developDocsSidebar.tsx @@ -10,14 +10,15 @@ import {docNodeToNavNode, getNavNodes} from './utils'; const devDocsMenuItems: {root: string; title: string; hideChevron?: boolean}[] = [ {root: 'getting-started', title: 'Getting Started', hideChevron: true}, - {root: 'development', title: 'Development'}, - {root: 'application', title: 'Application'}, + {root: 'engineering-practices', title: 'Engineering Practices'}, + {root: 'application-architecture', title: 'Application Architecture'}, + {root: 'development-infrastructure', title: 'Development Infrastructure'}, + {root: 'api-server', title: 'API Server'}, {root: 'frontend', title: 'Frontend'}, - {root: 'backend', title: 'Backend'}, - {root: 'sdk', title: 'SDK Development'}, - {root: 'relay', title: 'Relay Development'}, {root: 'services', title: 'Services'}, {root: 'integrations', title: 'Integrations'}, + {root: 'ingestion', title: 'Ingestion'}, + {root: 'sdk', title: 'SDKs'}, {root: 'self-hosted', title: 'Self-Hosted Sentry'}, ]; diff --git a/src/middleware.ts b/src/middleware.ts index 4c124f7457e46..a5034c8efccdb 100644 --- a/src/middleware.ts +++ b/src/middleware.ts @@ -3410,7 +3410,7 @@ const DEVELOPER_DOCS_REDIRECTS: Redirect[] = [ }, { from: '/architecture/', - to: '/application/architecture/', + to: '/application-architecture/', }, { from: '/sentry-vs-getsentry/', @@ -3524,6 +3524,276 @@ const DEVELOPER_DOCS_REDIRECTS: Redirect[] = [ from: '/sdk/distributed-tracing/', to: '/sdk/telemetry/traces/distributed-tracing/', }, + // New Sidebar structure + { + from: '/development/', + to: '/development-infrastructure/', + }, + { + from: '/development/environment/', + to: '/development-infrastructure/environment/', + }, + { + from: '/development/environment/ports/', + to: '/development-infrastructure/environment/ports/', + }, + { + from: '/development/environment/u2f/', + to: '/development-infrastructure/environment/u2f/', + }, + { + from: '/development/environment/pycharm/', + to: '/development-infrastructure/environment/pycharm/', + }, + { + from: '/development/commit-messages/', + to: '/engineering-practices/commit-messages/', + }, + { + from: '/development/code-review/', + to: '/engineering-practices/code-review/', + }, + { + from: '/development/documentation/', + to: '/engineering-practices/documentation/', + }, + { + from: '/development/workflow/', + to: '/development-infrastructure/workflow/', + }, + { + from: '/development/testing/', + to: '/development-infrastructure/testing/', + }, + { + from: '/development/continuous-integration/', + to: '/development-infrastructure/continuous-integration/', + }, + { + from: '/development/ngrok/', + to: '/development-infrastructure/ngrok/', + }, + { + from: '/development/devservices/', + to: '/development-infrastructure/devservices/', + }, + { + from: '/development/rust/', + to: '/engineering-practices/rust/', + }, + { + from: '/development/analytics/', + to: '/development-infrastructure/analytics/', + }, + { + from: '/application/', + to: '/application-architecture/', + }, + { + from: '/application/architecture/', + to: '/application-architecture/overview/', + }, + { + from: '/application/dynamic-sampling/', + to: '/application-architecture/dynamic-sampling/', + }, + { + from: '/application/dynamic-sampling/the-big-picture/', + to: '/application-architecture/dynamic-sampling/the-big-picture/', + }, + { + from: '/application/dynamic-sampling/fidelity-and-biases/', + to: '/application-architecture/dynamic-sampling/fidelity-and-biases/', + }, + { + from: '/application/dynamic-sampling/architecture/', + to: '/application-architecture/dynamic-sampling/architecture/', + }, + { + from: '/application/dynamic-sampling/outcomes/', + to: '/application-architecture/dynamic-sampling/outcomes/', + }, + { + from: '/application/feedback-architecture/', + to: '/application-architecture/feedback-architecture/', + }, + { + from: '/application/control-silo/', + to: '/application-architecture/multi-region-deployment/control-silo/', + }, + { + from: '/application/cross-region-replication/', + to: '/application-architecture/multi-region-deployment/cross-region-replication/', + }, + { + from: '/application/cross-region-rpc/', + to: '/application-architecture/multi-region-deployment/cross-region-rpc/', + }, + { + from: '/application/config/', + to: '/application-architecture/config/', + }, + { + from: '/application/sentry-vs-getsentry/', + to: '/application-architecture/sentry-vs-getsentry/', + }, + + { + from: '/frontend/development-server/', + to: '/development-infrastructure/frontend-development-server/', + }, + { + from: '/backend/', + to: '/api-server/', + }, + { + from: '/backend/api/', + to: '/api-server/api/', + }, + { + from: '/backend/api/basics/', + to: '/api-server/api/basics/', + }, + { + from: '/backend/api/design/', + to: '/api-server/api/design/', + }, + { + from: '/backend/api/concepts/', + to: '/api-server/api/concepts/', + }, + { + from: '/backend/api/public/', + to: '/api-server/api/public/', + }, + { + from: '/backend/api/checklist/', + to: '/api-server/api/checklist/', + }, + { + from: '/backend/api/serializers/', + to: '/api-server/api/serializers/', + }, + { + from: '/backend/development-server/', + to: '/development-infrastructure/backend-development-server/', + }, + { + from: '/backend/python-dependencies/', + to: '/development-infrastructure/python-dependencies/', + }, + { + from: '/backend/database-migrations/', + to: '/api-server/application-domains/database-migrations/', + }, + { + from: '/backend/feature-flags/', + to: '/api-server/application-domains/feature-flags/', + }, + { + from: '/backend/feature-flags/flagpole/', + to: '/api-server/application-domains/feature-flags/flagpole/', + }, + { + from: '/backend/feature-flags/options-backed-features/', + to: '/api-server/application-domains/feature-flags/options-backed-features/', + }, + { + from: '/backend/options/', + to: '/api-server/application-domains/options/', + }, + { + from: '/backend/transaction-clustering/', + to: '/api-server/application-domains/transaction-clustering/', + }, + { + from: '/backend/grouping/', + to: '/api-server/application-domains/grouping/', + }, + { + from: '/backend/outboxes/', + to: '/api-server/application-domains/outboxes/', + }, + { + from: '/backend/issue-platform/', + to: '/api-server/issue-platform/', + }, + { + from: '/backend/issue-platform-detectors/', + to: '/api-server/issue-platform/writing-detectors/', + }, + { + from: '/backend/queue/', + to: '/api-server/application-domains/asynchronous-workers/', + }, + { + from: '/backend/email/', + to: '/api-server/application-domains/email/', + }, + { + from: '/backend/kafka/', + to: '/api-server/application-domains/kafka/', + }, + { + from: '/backend/metrics/', + to: '/api-server/application-domains/metrics/', + }, + { + from: '/backend/nodestore/', + to: '/api-server/application-domains/nodestore/', + }, + { + from: '/backend/digests/', + to: '/api-server/application-domains/digests/', + }, + { + from: '/backend/quotas/', + to: '/api-server/application-domains/quotas/', + }, + { + from: '/backend/tsdb/', + to: '/api-server/application-domains/tsdb/', + }, + { + from: '/backend/pii/', + to: '/api-server/application-domains/pii/', + }, + { + from: '/backend/pii/methods/', + to: '/api-server/application-domains/pii/methods/', + }, + { + from: '/backend/pii/types/', + to: '/api-server/application-domains/pii/types/', + }, + { + from: '/backend/pii/selectors/', + to: '/api-server/application-domains/pii/selectors/', + }, + { + from: '/backend/buffers/', + to: '/api-server/application-domains/write-buffers/', + }, + { + from: '/backend/translations/', + to: '/api-server/application-domains/translations/', + }, + { + from: '/backend/ab-testing/', + to: '/api-server/application-domains/ab-testing/', + }, + { + from: '/relay/', + to: '/ingestion/', + }, + { + from: '/relay/projectconfig-versioning/', + to: '/ingestion/projectconfig-versioning/', + }, + { + from: '/relay/transaction-span-ratelimits/', + to: '/ingestion/transaction-span-ratelimits/', + }, ]; const redirectMap = new Map(