Skip to content

[DOCS-13091] Clean up DI prerequisites section#35086

Merged
cswatt merged 18 commits intomasterfrom
domalessi/clean-up-di-prerequisites
Mar 9, 2026
Merged

[DOCS-13091] Clean up DI prerequisites section#35086
cswatt merged 18 commits intomasterfrom
domalessi/clean-up-di-prerequisites

Conversation

@domalessi
Copy link
Copy Markdown
Contributor

@domalessi domalessi commented Mar 6, 2026

What does this PR do? What is the motivation?

Fixes DOCS-13091

Cleans up the Dynamic Instrumentation prerequisites and setup pages to reduce duplication and create a clearer information architecture.

Main DI page (_index.md):

  • Simplifies the prerequisites list by removing per-language tracer version requirements (these now live only on language-specific pages)
  • Removes hardcoded preview/GA status labels — each language page already has the correct banner
  • Simplifies the Limitations section to point to language-specific pages
  • Fixes minor style issues: removes temporal words, standardizes formatting

Language setup pages (enabling/*.md):

  • Adds a consistent Prerequisites section to each page with language-specific requirements (tracer version, runtime version, etc.) and a link back to the main DI prerequisites
  • Removes redundant "Install or upgrade your Agent" steps (covered by main page prerequisites)
  • Removes redundant tracer version Notes and install steps that duplicated the new Prerequisites section
  • Adds installation instruction links to all prerequisite tracer version bullets
  • Replaces the intro paragraph with a consistent two-sentence format: value prop + language-specific transition
  • Fixes tab ordering (code_lang_weight) to match the tile layout on the main page
  • Cleans up orphan link references

Merge instructions

Merge readiness:

  • Ready for merge

Additional notes

The goal is a two-tier structure: universal prerequisites live on the main DI page, and language-specific requirements live on each language's setup page. This avoids maintaining the same information in multiple places.

domalessi and others added 3 commits March 6, 2026 14:23
Move language-specific tracer versions and preview labels out of the
main prerequisites list. Point readers to individual language setup
pages for version requirements, supported features, and limitations.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
The main page previously listed that Go requires the Agent and app
on the same host with Linux kernel >=5.17. This info was missing
from the Go enabling page.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
domalessi and others added 15 commits March 6, 2026 14:36
- Add dd-java-agent.jar 1.34.0+ as an explicit requirement on the
  Java page (was only in a Note block before)
- Fix code_lang_weight values so tab order matches tile order:
  Java, Python, .NET, Node.js, Ruby, PHP, Go
- Add missing code_lang_weight to PHP (defaulted to 0, showed first)

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Every enabling page now has a standardized "Prerequisites" section
listing Agent version and tracer library version requirements.
Renamed "Requirements" headers to "Prerequisites" for consistency.
Fixed reference link conflicts on Node.js, Ruby, and PHP pages.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Remove duplicated Agent version and autocomplete/search lines from
language pages. Each page now links to the main Dynamic Instrumentation
prerequisites and lists only language-specific requirements.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Switch to inline links on Node.js prereqs to fix rendering
- Change "Dynamic Instrumentation prerequisites" to "general
  prerequisites" on all language pages
- Bold "Tracing library" on Ruby page to match other bullet pattern
- Remove "(instead of 7.49.0)" from Go page
- Add Go Agent version note (7.73.0+) to main page prerequisites

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Consolidate Go same-host requirement into Agent version bullet
- Switch all prereqs links back to reference-style per conventions

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Remove 9 orphan link references from _index.md ([3]-[5], [11],
  [18]-[22]) that were left behind when per-language lines were removed
- Remove orphan symdb refs from Java ([7]), Python ([6]), .NET ([8])
- Restore "(in Preview)" on autocomplete/search in prerequisites
  for consistency with line 38 and the symdb page
- Fix "ensure" → "verify" on lines flagged by Vale (pre-existing
  across _index.md and all 6 language pages)

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Tracer version requirements are now in the Prerequisites section on each
language page. Remove duplicate version notes and install steps, add
install instruction links to prereqs where missing, fix step numbering,
and update step references in intro paragraphs.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Remove the "Install or upgrade your Agent" step from all language pages
since Agent version is already covered in the main DI prerequisites.
Replace the intro paragraph with a shorter version that links to the
prerequisites section instead of hardcoding step numbers. Clean up
orphan Agent settings link references.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Replace terse intro with two sentences: what Dynamic Instrumentation
does and a transition into the language-specific setup instructions.
Remove orphan APM link references.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Consistent with the other language pages, add "See the installation
instructions for setup details" to the tracing library prerequisite
on the Java and Python pages.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@domalessi domalessi marked this pull request as ready for review March 6, 2026 23:37
@domalessi domalessi requested review from a team as code owners March 6, 2026 23:37
@cswatt cswatt merged commit 9ba54b2 into master Mar 9, 2026
23 of 25 checks passed
@cswatt cswatt deleted the domalessi/clean-up-di-prerequisites branch March 9, 2026 15:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants