docs(byoc-logs): align install + intro + agent pages with chart and code#36986
Merged
Conversation
Five small public-doc fixes surfaced by an audit of the BYOC Logs doc
tree against the cloudprem helm chart and the pomsky storage layer.
Each fix is independently verifiable.
* `introduction/_index.md` — expand the object-store list in the
architecture summary from three backends (S3, Azure Blob, MinIO) to
the six actually supported by the chart and quickwit-storage
(`storage_resolver.rs:89-115`): S3, Azure Blob, GCS, MinIO, Ceph,
any S3-compatible storage. Matches what `install/_index.md` already
lists.
* `introduction/_index.md` — extend the install tagline from
"AWS, Azure, or custom Kubernetes" to "AWS, GCP, Azure, or custom
Kubernetes". GCP/GKE has a full install sub-page and was missing
from the intro link copy only.
* `install/_index.md` — clarify the self-managed-Kubernetes
parenthetical: "(Nginx controller)" -> "(NGINX Ingress Controller
or AWS Load Balancer Controller)". The cloudprem helm chart
(`values.yaml:1003-1015`) supports both, and NGINX is the
controller our own AKS install page prescribes for AKS, not for
self-managed K8s specifically.
* `ingest/agent.md` — fix two broken `further_reading` links:
- `ingest_logs/observability_pipelines` -> `ingest/observability_pipelines`
(typo, target page exists).
- `ingest_logs/rest_api` -> `ingest/api` (typo AND the page is named
`api.md`, not `rest_api.md`; existing target verified 200).
Audit evidence with full claim-by-claim verification:
DataDog/claude-marketplace#2216 (comment)
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Contributor
Preview links (active after the
|
OliviaShoup
approved these changes
May 27, 2026
OliviaShoup
left a comment
OliviaShoup
left a comment
Contributor
There was a problem hiding this comment.
thanks for the PR! 🚀
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Five small public-doc fixes for
docs.datadoghq.com/byoc-logs/, all surfaced by an audit of the BYOC Logs doc tree against the cloudprem helm chart and the pomsky storage layer. Each is independently verifiable against the code/chart.Audit evidence (with claim-by-claim verification):
Changes
introduction/_index.md(S3, Azure Blob, MinIO)to all six backends actually supported.introduction/_index.mdAWS, Azure, or custom KubernetestoAWS, GCP, Azure, or custom Kubernetes— GCP/GKE has a full install sub-page and was missing here only.install/_index.md(Nginx controller)→(NGINX Ingress Controller or AWS Load Balancer Controller). The cloudprem chart supports both, and NGINX is what our AKS sub-page actually prescribes for AKS, not for self-managed.ingest/agent.mdfurther_readinglinks fixed:ingest_logs/observability_pipelines→ingest/observability_pipelines(typo, existing target), andingest_logs/rest_api→ingest/api(typo + the page is namedapi.mdnotrest_api.md; target verified 200).The companion chart change (Chart.yaml
kubeVersion: ">= 1.25.0-0"to actually enforce the K8s 1.25+ prereq stated here) is in DataDog/helm-charts#2686.Test plan
make hugo-server(or the equivalent local Hugo serve) loadsbyoc-logs/introduction/,byoc-logs/install/, andbyoc-logs/ingest/agent/without errors.ingest/agentpage — both now resolve to existing target pages.🤖 Generated with Claude Code