Merge branch 'master' into docs/span-metrics-examples

Author: codyde

.github/workflows/lint-404s.yml

@@ -7,7 +7,7 @@ on:
     branches: [master]
 
 jobs:
-  index:
+  lint-404:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
@@ -36,14 +36,13 @@ jobs:
             ${{ github.workspace }}/node_modules
             ${{ github.workspace }}/.next/cache
             ${{ github.workspace }}/.eslintcache
-          key: node-${{ runner.os }}-${{ hashFiles('**/yarn.lock') }}
+          key: node-${{ runner.os }}-${{ steps.setup-node.outputs.node-version }}-${{ hashFiles('**/yarn.lock') }}
           restore-keys: |
-            node-${{ runner.os }}-
+            node-${{ runner.os }}-${{ steps.setup-node.outputs.node-version }}-
 
       - run: yarn install --frozen-lockfile
-        if: steps.cache.outputs.cache-hit != 'true'
 
-      - run: yarn build
+      - run: yarn next build
         if: steps.filter.outputs.docs == 'true'
         env:
           SENTRY_DSN: https://[email protected]/0

.github/workflows/test.yml

@@ -1,4 +1,4 @@
-name: Lint, and Test
+name: CI
 
 on:
   push:
@@ -11,7 +11,7 @@ jobs:
     name: Lint
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4.1.1
+      - uses: actions/checkout@v5
 
       - name: Internal github app token
         id: token
@@ -62,11 +62,19 @@ jobs:
         with:
           github-token: ${{ steps.token.outputs.token }}
 
+  job_typos:
+    name: Check Typos
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - name: Check spelling with typos
+        uses: crate-ci/typos@master
+
   job_test:
     name: Test
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4.1.1
+      - uses: actions/checkout@v5
       - name: Set up Node
         uses: actions/setup-node@v4
         with:

.pre-commit-config.yaml

@@ -22,11 +22,15 @@ repos:
       - id: debug-statements
       - id: flake8
       - id: fix-encoding-pragma
-        args: ["--remove"]
+        args: ['--remove']
   - repo: https://github.com/getsentry/pre-commit-hooks
     rev: f3237d2d65af81d435c49dee3593dc8f03d23c2d
     hooks:
       - id: prettier
         entry: node_modules/.bin/prettier
       - id: eslint
         entry: node_modules/.bin/eslint
+  - repo: https://github.com/crate-ci/typos
+    rev: v1.39.0
+    hooks:
+      - id: typos

_typos.toml

@@ -0,0 +1,75 @@
+[default]
+# Regex patterns to ignore
+extend-ignore-re = [
+  "\\bUE\\b",     # Unreal Engine abbreviation
+  "\\bUE_LOG\\b", # Unreal Engine logging macro
+  "\\bue4\\b",    # Unreal Engine 4
+  "\\bue5\\b",    # Unreal Engine 5
+  "\\bue\\d+\\b", # Any UE version (ue5, ue6, etc.)
+]
+
+[files]
+# Files and patterns to exclude from spell checking
+extend-exclude = [
+  # Design and binary files
+  "*.excalidraw", # Diagram files contain random IDs
+  "*.png",
+  "*.jpg",
+  "*.jpeg",
+  "*.gif",
+  "*.svg",
+  "*.webp",
+
+  # Data and configuration files
+  "*.json",            # JSON files have many false positives
+  "*.lock",            # Package lock files
+  "yarn.lock",         # Yarn lock file
+  "package-lock.json", # NPM lock file
+
+  # Documentation assets
+  "public/_platforms/*.json", # Platform metadata
+  "public/pdfs/*.pdf",        # PDFs can't be edited programmatically
+
+  # Build artifacts and dependencies
+  ".next/**",        # Next.js build output
+  "node_modules/**", # Dependencies
+  "dist/**",         # Distribution builds
+  "build/**",        # Build output
+]
+
+[default.extend-words]
+# Technical terms and product names that are spelled correctly
+# .NET ecosystem
+Paket = "Paket" # .NET package manager (legitimate tool)
+paket = "paket" # .NET package manager CLI command
+
+# Platform-specific terms
+ITMS = "ITMS" # Apple error code prefix (legitimate)
+SEH = "SEH"   # Structured Exception Handling (Windows API)
+EDE = "EDE"   # Cipher name component (3DES_EDE_CBC_SHA)
+UE = "UE"     # Unreal Engine abbreviation
+UE4 = "UE4"   # Unreal Engine 4
+UE5 = "UE5"   # Unreal Engine 5
+
+# Cloud/Infrastructure
+nodejs_als = "nodejs_als" # Cloudflare compatibility flag (correct spelling)
+als = "als"               # Part of nodejs_als flag
+
+# Common abbreviations in tech docs
+DSN = "DSN"   # Data Source Name (Sentry)
+DSNs = "DSNs" # Plural
+SDK = "SDK"   # Software Development Kit
+SDKs = "SDKs" # Plural
+API = "API"   # Application Programming Interface
+APIs = "APIs" # Plural
+MCP = "MCP"   # Model Context Protocol
+NPM = "NPM"   # Node Package Manager
+
+# Code identifiers that are intentionally "misspelled" or match external systems
+# Note: These should ONLY include cases where the spelling is intentional
+# (e.g., matching an external API/constant name we don't control)
+childs = "childs"                       # Intentional variable name in mdx-deflist.ts
+aso = "aso"                             # Intentional variable name in utils.ts (short for "a sidebar order")
+MIGRATED_GETTING_STARTD_DOCS = "MIGRATED_GETTING_STARTD_DOCS" # Matches actual constant in Sentry backend (external)
+STARTD = "STARTD"                       # Part of MIGRATED_GETTING_STARTD_DOCS - needed because typos parses words in markdown text
+ERRO = "ERRO"                           # Special case - Part of "ERRORs" in legacy-sdk/integrations.mdx (logging level context)

app/[[...path]]/page.tsx

@@ -234,7 +234,7 @@ export async function generateMetadata(props: MetadataProps): Promise<Metadata>
   const domain = isDeveloperDocs
     ? 'https://develop.sentry.dev'
     : 'https://docs.sentry.io';
-  // enable og iamge preview on preview deployments
+  // enable og image preview on preview deployments
   const previewDomain = process.env.VERCEL_URL
     ? `https://${process.env.VERCEL_URL}`
     : domain;

develop-docs/application-architecture/multi-region-deployment/cross-region-rpc.mdx

@@ -59,7 +59,7 @@ Service classes act as stubs that define the interface a service will have. In t
 - `local_mode` defines which silo mode this service uses it’s ‘local implementation’. Services can have local implementations in either silo mode.
 - `get_local_implementation` is used by the RPC machinery to find the implementation service when the silo mode matches or is `MONOLITH`.
 
-RPC methods like `get_org_by_slug` must be defined as `abstractmethod` and must have either `rpc_method` or `regional_rpc_method` applied. If a method has `local_mode = REGION` it should use `regional_rpc_method` with a resolve ‘resolver’. There are several resolvers that accomodate a variety of method call signatures:
+RPC methods like `get_org_by_slug` must be defined as `abstractmethod` and must have either `rpc_method` or `regional_rpc_method` applied. If a method has `local_mode = REGION` it should use `regional_rpc_method` with a resolve ‘resolver’. There are several resolvers that accommodate a variety of method call signatures:
 
 - `ByOrganizationSlug` will extract the `organization_slug` parameter and use it to locate the region using `sentry_organizationmapping`.
 - `ByOrganizationId` will extract the `organization_id` parameter and use it to locate the organization’s region using `sentry_organizationmapping`

develop-docs/application-architecture/overview.mdx

@@ -40,7 +40,7 @@ This graph is extremely simplified mostly due to layout constraints. Missing fro
 * How Relay fetches project configs. Answer: from sentry-web
 * How Relay caches project configs. Answer: In memory, and in Redis
 * How Relay counts events and keeps track of quotas. Answer: more Redis
-* Symbolicator as auxilliary service to symbolicate-event
+* Symbolicator as auxiliary service to symbolicate-event
 * How alerting is triggered. Answer: postprocess-event, a Celery task which is responsible for alerting (spawned by a Kafka consumer in Sentry reading from eventstream)
 * Possibly more
 

develop-docs/backend/api/design.mdx

@@ -3,7 +3,7 @@ title: Design Principles
 sidebar_order: 2
 ---
 
-This document contains a set of design principles and requirements whish should be applied to all Sentry APIs. These are _requirements_ when designing public APIs (such as Sentry's Web API), but internal APIs (such as an an internal service that Sentry communicates with) should attempt to adhere to these principles as well where it makes sense.
+This document contains a set of design principles and requirements which should be applied to all Sentry APIs. These are _requirements_ when designing public APIs (such as Sentry's Web API), but internal APIs (such as an an internal service that Sentry communicates with) should attempt to adhere to these principles as well where it makes sense.
 
 In the Sentry monolith, we use [Django REST framework](https://www.django-rest-framework.org/) (DRF).
 

develop-docs/backend/api/serializers.mdx

@@ -163,7 +163,7 @@ class ModelSerializer(Serializer):
 
 **get_attrs Method**
 
-Why do this when Django Rest Framework has similar functionality? The `get_attrs` method is the reason. It allows you to do a bulk query versus multiple queries. In our example, instead of calling `ExampleTypes.objects.get(...)` multiple items, I can filter for the ones I want and assign them to the item in question using python. In the case of `attr` dictionary, the `key` is the item iteself. and the `value` is a dictionary with the name of the attribute you want to add and it's values.
+Why do this when Django Rest Framework has similar functionality? The `get_attrs` method is the reason. It allows you to do a bulk query versus multiple queries. In our example, instead of calling `ExampleTypes.objects.get(...)` multiple items, I can filter for the ones I want and assign them to the item in question using python. In the case of `attr` dictionary, the `key` is the item itself. and the `value` is a dictionary with the name of the attribute you want to add and it's values.
 
 ```python
 attrs[item] = {'attribute_name': attribute}

develop-docs/backend/application-domains/feature-flags/flagpole.mdx

@@ -84,11 +84,11 @@ Flagpole currently supports the following `operator` types:
 
 `contains`
 
-: Given a single int, string, float, or boolean value, evalutes to `True` if the context property value is a list containing the provided value.
+: Given a single int, string, float, or boolean value, evaluates to `True` if the context property value is a list containing the provided value.
 
 `not_contains`
 
-: The inverse of `contains`, evalutes to `True` if the context property value is a list which does not contain the provided value.
+: The inverse of `contains`, evaluates to `True` if the context property value is a list which does not contain the provided value.
 
 `equals`
 
@@ -114,7 +114,7 @@ Here are some common properties we surface via our Sentry and GetSentry context
 
 `sentry_region` [str]
 
-: The sentry region or single-tenant the flag check is being perfomed in.
+: The sentry region or single-tenant the flag check is being performed in.
 
 `sentry_singletenant` [bool]