Skip to content

Add library config registry pages with categorized sections#35264

Draft
genesor wants to merge 3 commits intomasterfrom
ben.db/registry-configs
Draft

Add library config registry pages with categorized sections#35264
genesor wants to merge 3 commits intomasterfrom
ben.db/registry-configs

Conversation

@genesor
Copy link
Member

@genesor genesor commented Mar 13, 2026

What does this PR do? What is the motivation?

Adds library configuration registry pages that display environment variables from the Feature Parity Registry API, grouped by product category with collapsible sections.

  • Categorized configs: 20 categories (General, Tracing Core, Profiling, AppSec, etc.) rendered as collapsible <details> sections
  • Integration kinds: The Trace Integrations category shows a "kinds" reference (e.g., DD_TRACE_<INTEGRATION>_ENABLED) with the list of integrations supporting each kind
  • Per-integration sections: Nested collapsible sections for each integration (800+ for Java)
  • Deep-link anchors: Every section and config entry has a unique anchor ID with a copy-link button for sharing direct URLs
  • Version normalization: from_version normalized to vX.Y.Z format, hidden for initial tracking versions
  • Generation scripts: Python scripts in scripts/registry/ fetch from the registry API and produce per-language JSON data files

This PR is still in progress. We're exploring the possibilities of what we can do and how to display results using the registry data.

TODO:

  • CI Automation + PRs
  • Product pages partial templates reading either from a key prefix or a product label
  • New page layout + linkage to previous pages

Merge instructions

Merge readiness:

  • Ready for merge

Additional notes

The Python scripts in scripts/registry/ must be run in order:

  1. registry_generate_categories.py (produces categories.json + full categories reference)
  2. registry_extract_configurations_by_language.py (produces per-language JSON with category fields)

See scripts/registry/README.md for details.

genesor added 3 commits March 13, 2026 11:57
- Add categories.json and per-language JSON data with category fields
- Render configs in collapsible sections grouped by category
- Integration category shows kinds reference + per-integration details
- Every section and config entry has a deep-link anchor with copy-link
- Add content pages for all supported languages
local/bin/ is gitignored so the Python scripts were not tracked.
Moved to scripts/registry/ and updated relative paths accordingly.
- Normalize all from_version to vX.Y.Z format (handle missing v prefix,
  2-part versions, datadog-opentelemetry- prefix)
- Hide "Since" for versions at or below the initial tracking threshold
- Remove version filtering in template, show all configs (TODO comment)
- Add total config count display per language
@github-actions github-actions bot added the Architecture Everything related to the Doc backend label Mar 13, 2026
@github-actions
Copy link
Contributor

@genesor genesor changed the title [DOCS-XXXXX] Add library config registry pages with categorized sections Add library config registry pages with categorized sections Mar 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Architecture Everything related to the Doc backend

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant