fix(v/25.2): align playbook with streaming component (finish #1703 rename)#1768
Conversation
… rename) PR #1703 renamed the docs component from ROOT to streaming in antora.yml on v/25.2, but local-antora-playbook.yml kept referencing ROOT. The `start_page: 25.2@ROOT:...` points at a component that no longer exists, which fails the Netlify deploy preview for every v/25.2 PR since 2026-05-26 (later PRs merged anyway because the preview isn't a required check). Update the three docs-component references ROOT -> streaming: - site.start_page - archive-attachments source component - replace-attributes-in-attachments components list The 'redpanda-labs' entry is left unchanged (separate labs-component axis, verify separately). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Second half-applied rename on the same branch. The redpanda-labs repo publishes its component as `name: labs` (docs/antora.yml), and main's playbook already uses `labs`. v/25.2 still referenced the old `redpanda-labs` component name in two labs-extension configs: - generate-index-data docker_labs.component - replace-attributes-in-attachments components list These are non-fatal (the configs just match no component, so the docker-labs index attribute and labs attachment replacements silently no-op on v/25.2), but they're a real correctness gap. Align both to `labs`. The content-source repo URL (github.com/redpanda-data/redpanda-labs) is unchanged - that's the repo name, not the component name. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
micheleRP
left a comment
There was a problem hiding this comment.
Review — LGTM
Correct build-infra fix; verified both renames against the live component names:
- ROOT → streaming (fatal): v/25.2 `antora.yml` is `name: streaming` (renamed in #1703), so the old `start_page: 25.2@ROOT:...` pointed at a nonexistent component and failed the Antora/Netlify build. The new target `25.2@streaming:get-started:intro-to-events.adoc` resolves (page exists on the branch). The `archive-attachments` source and `replace-attributes` component list are corrected to match.
- redpanda-labs → labs (latent): the live `redpanda-data/redpanda-labs` `docs/antora.yml` publishes `name: labs`, and `main` + the production `docs-site` playbook already use `labs`. The v/25.2 `redpanda-labs` references matched no component and silently no-op'd; aligning to `labs` is correct. The content-source URL (`github.com/redpanda-data/redpanda-labs`) is rightly left unchanged.
- All 5 edits match the PR table; no stale `ROOT` component references remain.
Agree with the testing note: since v/25.2 has a backlog of merged-but-never-cleanly-built PRs, confirm by grepping the deploy log for `ERROR (asciidoctor)` rather than trusting a green SUCCESS.
What
Aligns
local-antora-playbook.ymlonv/25.2with the component names actually published today, finishing two half-applied per-branch renames.site.start_page25.2@ROOT:get-started:intro-to-events.adoc25.2@streaming:...archive-attachmentssourcecomponent: 'ROOT'component: 'streaming'replace-attributescomponents- 'ROOT'- 'streaming'generate-index-datadocker_labscomponent: redpanda-labscomponent: labsreplace-attributescomponents- 'redpanda-labs'- 'labs'Why
Two component renames were applied to
v/25.2'santora.yml/ content sources over time but never reflected in the playbook:ROOT → streaming(PR Rename ROOT to streaming component (v25.2) #1703, 2026-05-26):antora.ymlbecamename: streaming, but the playbook still pointed atROOT.site.start_pageaimed at the now-nonexistentROOTcomponent, so Antora can't resolve the site start page and the Netlify deploy preview fails. This has broken every v/25.2 PR deploy since 2026-05-26; later PRs (DOC-2237: correct decommission + maintenance mode guidance (v/25.2 backport) #1737, Update setup scripts domain to pull Redpanda packages from the new Artifact Registry #1752) merged anyway because the preview isn't a required check. It's currently blocking David Yu's backports [v/25.2] manage/k8s: document decommission timing (--decommission-wait-interval) #1765 and [v/25.2] manage: document rpk OAUTHBEARER (OIDC) for Kafka/Admin/SR APIs #1767, neither of which touches the playbook.redpanda-labs → labs: the redpanda-labs repo publishes its component asname: labs(docs/antora.yml), andmain's playbook already useslabs. v/25.2 still referencedredpanda-labsin two labs-extension configs. Non-fatal — the configs just match no component, so the docker-labs index attribute and labs attachment replacements silently no-op on v/25.2 — but a real correctness gap.The content-source repo URL (
github.com/redpanda-data/redpanda-labs) is unchanged: that's the repo name, not the component name.Testing
ERROR (asciidoctor)to confirm no remaining build errors surface once the start page resolves.🤖 Generated with Claude Code