Skip to content

Consolidate DDOT Collector install pages into a single Cdocs page#35247

Draft
brett0000FF wants to merge 2 commits intomasterfrom
brett.blue/consolidate-ddot-install-page
Draft

Consolidate DDOT Collector install pages into a single Cdocs page#35247
brett0000FF wants to merge 2 commits intomasterfrom
brett.blue/consolidate-ddot-install-page

Conversation

@brett0000FF
Copy link
Contributor

What does this PR do? What is the motivation?

Consolidates the 5 separate DDOT Collector install pages (Kubernetes DaemonSet, Kubernetes Gateway, Linux, ECS Fargate, EKS Fargate) into a single Markdoc (Cdocs) page with a Deployment content filter dropdown.

Motivation:

  • Eliminates ~40% duplicated content across the install pages (shared requirements, instrumentation examples, observability screenshots)
  • Gives readers a single URL with a clean filter dropdown instead of navigating between separate pages
  • Makes future updates to shared sections a one-place edit
  • Matches the pattern already established by api_support.mdoc.md

Changes:

  • Added deployment trait to customization_config/en/traits/general.yaml
  • Added 4 new options (kubernetes_daemonset, kubernetes_gateway, ecs_fargate, eks_fargate) to customization_config/en/options/general.yaml
  • Added ddot_collector_deployment_options option group to customization_config/en/option_groups/opentelemetry.yaml
  • Created Markdoc partials for otel-network-requirements and otel-infraattributes-prereq
  • Created consolidated install.mdoc.md with deployment-specific {% if %} blocks
  • Updated nav config and _index.md redirect
  • Deleted the 5 individual install pages
  • All old URLs have aliases for proper redirects

Validation:

  • cdocs build compiles all 27 Markdoc files with zero errors
  • vale shows only pre-existing warnings (no new issues)

Merge instructions

Merge readiness:

  • Ready for merge

Additional notes

The Kubernetes pages use Markdoc {% tabs %} for Helm vs Operator within the {% if %} blocks. The linux option already existed in general.yaml, so only 4 new options were needed.

Replace 5 separate Hugo multi-code-lang install pages with a single
Markdoc page using a Deployment content filter. This eliminates ~40%
duplicated content and gives readers a single URL with a dropdown
for Kubernetes (DaemonSet), Kubernetes (Gateway), Linux, ECS Fargate,
and EKS Fargate deployments.

- Add deployment trait, 4 new options, and option group to Cdocs config
- Create Markdoc partials for network requirements and infraattributes
- Create consolidated install.mdoc.md with deployment-specific filters
- Update nav config and _index.md redirect
- Include aliases from all old URLs for proper redirects
@github-actions github-actions bot added Architecture Everything related to the Doc backend cdocs labels Mar 12, 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 cdocs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant