Skip to content

docs: De-duplicate Troubleshooting and Custom Instrumentation page titles - #19301

Open
coolguyzone wants to merge 2 commits into
masterfrom
coolguyzone/chore/de-dupe-titles
Open

docs: De-duplicate Troubleshooting and Custom Instrumentation page titles#19301
coolguyzone wants to merge 2 commits into
masterfrom
coolguyzone/chore/de-dupe-titles

Conversation

@coolguyzone

Copy link
Copy Markdown
Contributor

DESCRIBE YOUR PR

De-duplicates page titles that collide in the rendered <title> tag. Two systematic families where multiple pages on the same platform rendered an identical title (e.g. Java had four pages all showing Troubleshooting | Sentry for Java):

  • Troubleshooting family — section-specific troubleshooting pages now carry their section name (Tracing Troubleshooting, Crons Troubleshooting, Profiling Troubleshooting, Session Replay Troubleshooting, OpenTelemetry Troubleshooting, Uptime Monitoring Troubleshooting). Each platform's top-level "Troubleshooting" page is unchanged.
  • Custom Instrumentation family — the tracing/trace-propagation/custom-instrumentation pages are renamed to "Custom Trace Propagation" to distinguish them from the performance-oriented tracing/instrumentation/custom-instrumentation pages.

Covers 33 pages. Note: the site already appends | Sentry for {Platform} to platform page titles, so cross-platform repeats (e.g. "Configuration") are already unique and were intentionally left alone; this PR only targets genuine within-platform collisions.

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.
Select exactly one option. For deadlines, replace YYYY-MM-DD with the due date. You can update this information later by editing the PR description.

  • Urgent deadline (GA date, etc.): YYYY-MM-DD
  • Other deadline: YYYY-MM-DD
  • No deadline: Not urgent, can wait up to 1 week+

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've supplied a deadline.

Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

…tles

Give section-specific troubleshooting pages descriptive titles (Tracing
Troubleshooting, Crons Troubleshooting, Profiling Troubleshooting, etc.)
so their rendered <title> tags no longer collide within a platform. Each
platform's top-level "Troubleshooting" page is left unchanged.

Rename the trace-propagation "Custom Instrumentation" pages to "Custom
Trace Propagation" to distinguish them from the performance-oriented
custom-instrumentation pages.

Covers 33 pages.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@vercel

vercel Bot commented Sep 8, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
sentry-docs Ready Ready Preview Sep 8, 2026 6:47pm UTC
1 Skipped Deployment
Project Deployment Actions Updated
develop-docs Ignored Ignored Preview Sep 8, 2026 6:47pm UTC

Request Review

Following review feedback: instead of "Custom Trace Propagation" (which
mismatched the ~16 inbound links reading "custom instrumentation"), use
"Custom Instrumentation for Distributed Tracing". The inbound links read
"...set up custom instrumentation for distributed tracing", so they now
flow naturally into the page title.

Also unifies the JavaScript and Python pages (which already used "Custom
Trace Propagation") under the same name so the concept has one title
across all platforms, and updates the 3 links that used the old anchor
text. 13 pages retitled, 3 links fixed.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

@philprime philprime left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This change leads to duplication/bloat in the side menu. Do we have a solution to fix the title while keeping the menu clean?

Image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Priority: Normal Docs review has no urgent deadline

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants