From 16f0cc2df9a3a807020761b56f6341fe4407412a Mon Sep 17 00:00:00 2001 From: Stephanie Anderson Date: Thu, 31 Oct 2024 15:50:05 +0100 Subject: [PATCH 1/3] Bundle docs for specific SDKs in a common folder --- develop-docs/sdk/platform-specifics/index.mdx | 7 ++++++ .../javascript-sdks/browser-tracing.mdx | 0 .../javascript-sdks/bundle-size.mdx | 0 .../javascript-sdks/debug-ids.mdx | 0 .../javascript-sdks/index.mdx | 0 .../javascript-sdks/page-based-traces.png | Bin .../javascript-sdks/pageload-span.png | Bin .../native-sdks/index.mdx | 0 .../native-sdks/signal-handlers.mdx | 0 .../serverless-sdks/aws-lambda-lifecycle.png | Bin .../serverless-sdks/aws-lambda.mdx | 4 ++-- .../serverless-sdks/index.mdx | 2 +- redirects.js | 22 ++++++++++++++---- 13 files changed, 27 insertions(+), 8 deletions(-) create mode 100644 develop-docs/sdk/platform-specifics/index.mdx rename develop-docs/sdk/{ => platform-specifics}/javascript-sdks/browser-tracing.mdx (100%) rename develop-docs/sdk/{ => platform-specifics}/javascript-sdks/bundle-size.mdx (100%) rename develop-docs/sdk/{ => platform-specifics}/javascript-sdks/debug-ids.mdx (100%) rename develop-docs/sdk/{ => platform-specifics}/javascript-sdks/index.mdx (100%) rename develop-docs/sdk/{ => platform-specifics}/javascript-sdks/page-based-traces.png (100%) rename develop-docs/sdk/{ => platform-specifics}/javascript-sdks/pageload-span.png (100%) rename develop-docs/sdk/{ => platform-specifics}/native-sdks/index.mdx (100%) rename develop-docs/sdk/{ => platform-specifics}/native-sdks/signal-handlers.mdx (100%) rename develop-docs/sdk/{ => platform-specifics}/serverless-sdks/aws-lambda-lifecycle.png (100%) rename develop-docs/sdk/{ => platform-specifics}/serverless-sdks/aws-lambda.mdx (97%) rename develop-docs/sdk/{ => platform-specifics}/serverless-sdks/index.mdx (69%) diff --git a/develop-docs/sdk/platform-specifics/index.mdx b/develop-docs/sdk/platform-specifics/index.mdx new file mode 100644 index 0000000000000..09d30eace879e --- /dev/null +++ b/develop-docs/sdk/platform-specifics/index.mdx @@ -0,0 +1,7 @@ +--- +title: Platform Specifics +description: Read more about the specifics when it comes to certain SDKs. +sidebar_order: 99 +--- + + diff --git a/develop-docs/sdk/javascript-sdks/browser-tracing.mdx b/develop-docs/sdk/platform-specifics/javascript-sdks/browser-tracing.mdx similarity index 100% rename from develop-docs/sdk/javascript-sdks/browser-tracing.mdx rename to develop-docs/sdk/platform-specifics/javascript-sdks/browser-tracing.mdx diff --git a/develop-docs/sdk/javascript-sdks/bundle-size.mdx b/develop-docs/sdk/platform-specifics/javascript-sdks/bundle-size.mdx similarity index 100% rename from develop-docs/sdk/javascript-sdks/bundle-size.mdx rename to develop-docs/sdk/platform-specifics/javascript-sdks/bundle-size.mdx diff --git a/develop-docs/sdk/javascript-sdks/debug-ids.mdx b/develop-docs/sdk/platform-specifics/javascript-sdks/debug-ids.mdx similarity index 100% rename from develop-docs/sdk/javascript-sdks/debug-ids.mdx rename to develop-docs/sdk/platform-specifics/javascript-sdks/debug-ids.mdx diff --git a/develop-docs/sdk/javascript-sdks/index.mdx b/develop-docs/sdk/platform-specifics/javascript-sdks/index.mdx similarity index 100% rename from develop-docs/sdk/javascript-sdks/index.mdx rename to develop-docs/sdk/platform-specifics/javascript-sdks/index.mdx diff --git a/develop-docs/sdk/javascript-sdks/page-based-traces.png b/develop-docs/sdk/platform-specifics/javascript-sdks/page-based-traces.png similarity index 100% rename from develop-docs/sdk/javascript-sdks/page-based-traces.png rename to develop-docs/sdk/platform-specifics/javascript-sdks/page-based-traces.png diff --git a/develop-docs/sdk/javascript-sdks/pageload-span.png b/develop-docs/sdk/platform-specifics/javascript-sdks/pageload-span.png similarity index 100% rename from develop-docs/sdk/javascript-sdks/pageload-span.png rename to develop-docs/sdk/platform-specifics/javascript-sdks/pageload-span.png diff --git a/develop-docs/sdk/native-sdks/index.mdx b/develop-docs/sdk/platform-specifics/native-sdks/index.mdx similarity index 100% rename from develop-docs/sdk/native-sdks/index.mdx rename to develop-docs/sdk/platform-specifics/native-sdks/index.mdx diff --git a/develop-docs/sdk/native-sdks/signal-handlers.mdx b/develop-docs/sdk/platform-specifics/native-sdks/signal-handlers.mdx similarity index 100% rename from develop-docs/sdk/native-sdks/signal-handlers.mdx rename to develop-docs/sdk/platform-specifics/native-sdks/signal-handlers.mdx diff --git a/develop-docs/sdk/serverless-sdks/aws-lambda-lifecycle.png b/develop-docs/sdk/platform-specifics/serverless-sdks/aws-lambda-lifecycle.png similarity index 100% rename from develop-docs/sdk/serverless-sdks/aws-lambda-lifecycle.png rename to develop-docs/sdk/platform-specifics/serverless-sdks/aws-lambda-lifecycle.png diff --git a/develop-docs/sdk/serverless-sdks/aws-lambda.mdx b/develop-docs/sdk/platform-specifics/serverless-sdks/aws-lambda.mdx similarity index 97% rename from develop-docs/sdk/serverless-sdks/aws-lambda.mdx rename to develop-docs/sdk/platform-specifics/serverless-sdks/aws-lambda.mdx index 14f63e4609566..8ddb7a925a6f4 100644 --- a/develop-docs/sdk/serverless-sdks/aws-lambda.mdx +++ b/develop-docs/sdk/platform-specifics/serverless-sdks/aws-lambda.mdx @@ -6,8 +6,8 @@ sidebar_order: 10 Lambda functions can be written in numerous programming languages (Javascript, Python, Ruby, Java, Go, ...). Sentry is currently supporting automatic instrumentation of Lambda functions written in Javascript and Python. -See the [Sentry Documentation](https://docs.sentry.io/product/integrations/cloud-monitoring/) -on how to set up serverless instrumentation. + +See the [Sentry Documentation](https://docs.sentry.io/product/integrations/cloud-monitoring/) on how to set up serverless instrumentation. ## A short primer into AWS Lambda functions, and layers. diff --git a/develop-docs/sdk/serverless-sdks/index.mdx b/develop-docs/sdk/platform-specifics/serverless-sdks/index.mdx similarity index 69% rename from develop-docs/sdk/serverless-sdks/index.mdx rename to develop-docs/sdk/platform-specifics/serverless-sdks/index.mdx index 1aa43270a09a1..c47f10abddf72 100644 --- a/develop-docs/sdk/serverless-sdks/index.mdx +++ b/develop-docs/sdk/platform-specifics/serverless-sdks/index.mdx @@ -4,4 +4,4 @@ description: Information specific to developing serverless SDKs. sidebar_order: 9 --- -- [AWS Lambda](/sdk/serverless-sdks/aws-lambda/) + diff --git a/redirects.js b/redirects.js index 03390a9e47897..3cf638033fa60 100644 --- a/redirects.js +++ b/redirects.js @@ -32,7 +32,7 @@ const developerDocsRedirects = [ }, { source: '/sdk/basics/:path*', - destination: '/sdk/development-process/basics/:path*', + destination: '/sdk/processes/basics/:path*', }, { source: '/sdk/data-handling/:path*', @@ -80,19 +80,31 @@ const developerDocsRedirects = [ }, { source: '/sdk/serverless/:path*', - destination: '/sdk/serverless-sdks/:path*', + destination: '/sdk/platform-specifics/serverless-sdks/:path*', + }, + { + source: '/sdk/serverless-sdks/:path*', + destination: '/sdk/platform-specifics/serverless-sdks/:path*', + }, + { + source: '/sdk/native-sdks/:path*', + destination: '/sdk/platform-specifics/native-sdks/:path*', + }, + { + source: '/sdk/javascript-sdks/:path*', + destination: '/sdk/platform-specifics/javascript-sdks/:path*', }, { source: '/sdk/signal-handlers/:path*', - destination: '/sdk/native-sdks/signal-handlers/:path*', + destination: '/sdk/platform-specifics/native-sdks/signal-handlers/:path*', }, { source: '/sdk/store/:path*', destination: '/sdk/miscellaneous/store/:path*', }, { - source: '/sdk/processes/:path*', - destination: '/sdk/development-process/:path*', + source: '/sdk/development-process/:path*', + destination: '/sdk/processes/:path*', }, { source: '/application/ab-testing/', From ef18f4a431d1f606c0b2faf2514c877a2b56a54a Mon Sep 17 00:00:00 2001 From: Stephanie Anderson Date: Thu, 31 Oct 2024 15:56:00 +0100 Subject: [PATCH 2/3] docs(sdks): restructure content; update page description style --- develop-docs/sdk/expected-features/index.mdx | 10 ++++++---- develop-docs/sdk/index.mdx | 15 +-------------- develop-docs/sdk/miscellaneous/index.mdx | 2 +- develop-docs/sdk/overview.mdx | 3 +-- develop-docs/sdk/philosophy.mdx | 2 +- .../{development-process => processes}/basics.mdx | 9 +++------ .../{development-process => processes}/index.mdx | 2 +- .../releases.mdx | 0 .../triaging.mdx | 0 src/components/docPage/type.scss | 6 +++++- 10 files changed, 19 insertions(+), 30 deletions(-) rename develop-docs/sdk/{development-process => processes}/basics.mdx (81%) rename develop-docs/sdk/{development-process => processes}/index.mdx (85%) rename develop-docs/sdk/{development-process => processes}/releases.mdx (100%) rename develop-docs/sdk/{development-process => processes}/triaging.mdx (100%) diff --git a/develop-docs/sdk/expected-features/index.mdx b/develop-docs/sdk/expected-features/index.mdx index b15050d959162..9b88e052a951e 100644 --- a/develop-docs/sdk/expected-features/index.mdx +++ b/develop-docs/sdk/expected-features/index.mdx @@ -1,11 +1,13 @@ --- -title: Expected Features +title: Features +description: The following is a description of features that are commonly expected in Sentry SDKs. sidebar_order: 4 --- -The following is a description of features that are commonly expected in Sentry SDKs. Make sure to also -have read the unified API design documentation -which explains the common API design. + + Make sure to also have read the unified API documentation + which explains the common API design. + ## Background Sending diff --git a/develop-docs/sdk/index.mdx b/develop-docs/sdk/index.mdx index ca0e378a5761d..93b3d77e6e6a2 100644 --- a/develop-docs/sdk/index.mdx +++ b/develop-docs/sdk/index.mdx @@ -3,17 +3,4 @@ title: SDK Development sidebar_order: 60 --- -The following is a guide for implementing a Sentry SDK. - -It covers the protocol for event submission as well as guidelines for how clients should -typically look and behave. - -- Overview -- Philosophy and Design Principles -- Development Process -- Expected Features -- Telemetry -- Data Model -- Javascript SDKs -- Native SDKs -- Serverless SDKs + diff --git a/develop-docs/sdk/miscellaneous/index.mdx b/develop-docs/sdk/miscellaneous/index.mdx index ab3e7d57d45c7..8cee6e7fdfb6e 100644 --- a/develop-docs/sdk/miscellaneous/index.mdx +++ b/develop-docs/sdk/miscellaneous/index.mdx @@ -1,6 +1,6 @@ --- title: Miscellaneous -sidebar_order: 10 +sidebar_order: 100 --- diff --git a/develop-docs/sdk/overview.mdx b/develop-docs/sdk/overview.mdx index 6a1f1a8aff52d..e9c015acbf5b9 100644 --- a/develop-docs/sdk/overview.mdx +++ b/develop-docs/sdk/overview.mdx @@ -1,10 +1,9 @@ --- title: Overview +description: The following is a guide for implementing a new Sentry SDK. It covers the protocol for event submission as well as guidelines for how clients should typically look and behave. sidebar_order: 1 --- -The following is a guide for implementing a new Sentry SDK. It covers the protocol for event submission as well as guidelines for how clients should typically look and behave. - ## Writing an SDK At its core an SDK is a set of utilities for capturing data about an exceptional state in an application. Given this data, it then builds and sends a JSON payload to the Sentry server. diff --git a/develop-docs/sdk/philosophy.mdx b/develop-docs/sdk/philosophy.mdx index c5ea0f9c84471..598b1c62f2e28 100644 --- a/develop-docs/sdk/philosophy.mdx +++ b/develop-docs/sdk/philosophy.mdx @@ -1,9 +1,9 @@ --- title: Philosophy +description: This document sets some general guidance for how to approach SDK development at Sentry. It should aid both internal and external developers to understand what motivations go into the design of the SDKs and why we're deciding in certain ways. sidebar_order: 2 --- -This document sets some general guidance for how to approach SDK development at Sentry. It should aid both internal and external developers to understand what motivations go into the design of the SDKs and why we're deciding in certain ways. ## Trust is #1 diff --git a/develop-docs/sdk/development-process/basics.mdx b/develop-docs/sdk/processes/basics.mdx similarity index 81% rename from develop-docs/sdk/development-process/basics.mdx rename to develop-docs/sdk/processes/basics.mdx index 146afc45f4c47..8b2b60f5c1735 100644 --- a/develop-docs/sdk/development-process/basics.mdx +++ b/develop-docs/sdk/processes/basics.mdx @@ -1,12 +1,9 @@ --- title: Basics -description: How to get started with SDK development. +description: So you want to develop an SDK? Before you get started here are some basics that are worth following to have a better experience. sidebar_order: 1 --- -So you want to develop an SDK? Before you get started here are some basics that are -worth following to have a better experience. - ## Run a Local Relay You do not need a local Sentry for SDK development but you will want to run a local @@ -35,9 +32,9 @@ When sending events just substitute `orgXXX.ingest.sentry.io` with `localhost:30 whichever port you ended up chosing. Also note that a local relay will out of the box be available via HTTP only so don't try to send HTTPS requests there. -## Join the SDK chat on Discord +## Join us on Discord -You can reach out to Sentry open source contributors and talk with other SDK maintainers in the [Sentry Discord server](https://discord.gg/sentry). Make sure to say hi in the `#sdk-chat`. +You can reach out to Sentry open source contributors and talk with other SDK maintainers on the [Sentry Discord server](https://discord.gg/sentry). ## Consult Existing SDKs diff --git a/develop-docs/sdk/development-process/index.mdx b/develop-docs/sdk/processes/index.mdx similarity index 85% rename from develop-docs/sdk/development-process/index.mdx rename to develop-docs/sdk/processes/index.mdx index 940c33ea5d71a..d5ccd6814648b 100644 --- a/develop-docs/sdk/development-process/index.mdx +++ b/develop-docs/sdk/processes/index.mdx @@ -1,5 +1,5 @@ --- -title: Development Process +title: Processes description: In this section, we aim to highlight some key processes that are essential for SDK development at Sentry. sidebar_order: 3 --- diff --git a/develop-docs/sdk/development-process/releases.mdx b/develop-docs/sdk/processes/releases.mdx similarity index 100% rename from develop-docs/sdk/development-process/releases.mdx rename to develop-docs/sdk/processes/releases.mdx diff --git a/develop-docs/sdk/development-process/triaging.mdx b/develop-docs/sdk/processes/triaging.mdx similarity index 100% rename from develop-docs/sdk/development-process/triaging.mdx rename to develop-docs/sdk/processes/triaging.mdx diff --git a/src/components/docPage/type.scss b/src/components/docPage/type.scss index a6c5931c442cf..387a079287593 100644 --- a/src/components/docPage/type.scss +++ b/src/components/docPage/type.scss @@ -1,6 +1,10 @@ // dark mode .dark .prose { --heading-color: var(--gray-12); + + hgroup h2 { + color: var(--desatPurple12); + } } .prose { @@ -68,7 +72,7 @@ hgroup h2 { font-weight: 300; font-size: 1.3rem; - color: var(--foreground-secondary); + color: var(--desatPurple2); line-height: 2rem; margin-bottom: 1.75rem; } From 76c23f3be1c3b8df8b6c5fbafb8721c5b7c1cda7 Mon Sep 17 00:00:00 2001 From: Stephanie Anderson Date: Thu, 31 Oct 2024 16:54:35 +0100 Subject: [PATCH 3/3] Update develop-docs/sdk/philosophy.mdx Co-authored-by: Charly Gomez --- develop-docs/sdk/philosophy.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/develop-docs/sdk/philosophy.mdx b/develop-docs/sdk/philosophy.mdx index 598b1c62f2e28..3f195ffb9ef60 100644 --- a/develop-docs/sdk/philosophy.mdx +++ b/develop-docs/sdk/philosophy.mdx @@ -1,6 +1,6 @@ --- title: Philosophy -description: This document sets some general guidance for how to approach SDK development at Sentry. It should aid both internal and external developers to understand what motivations go into the design of the SDKs and why we're deciding in certain ways. +description: This document provides general guidance for SDK development at Sentry. It aims to help both internal and external developers understand the motivations behind SDK design decisions and our decision-making process. sidebar_order: 2 ---