Skip to content

fix(v/25.2): align playbook with streaming component (finish #1703 rename)#1768

Merged
david-yu merged 2 commits into
v/25.2from
fix-v25.2-playbook-root-to-streaming
Jun 25, 2026
Merged

fix(v/25.2): align playbook with streaming component (finish #1703 rename)#1768
david-yu merged 2 commits into
v/25.2from
fix-v25.2-playbook-root-to-streaming

Conversation

@Feediver1

@Feediver1 Feediver1 commented Jun 24, 2026

Copy link
Copy Markdown
Contributor

What

Aligns local-antora-playbook.yml on v/25.2 with the component names actually published today, finishing two half-applied per-branch renames.

Setting Before After Severity
site.start_page 25.2@ROOT:get-started:intro-to-events.adoc 25.2@streaming:... Fatal (deploy fails)
archive-attachments source component: 'ROOT' component: 'streaming' latent
replace-attributes components - 'ROOT' - 'streaming' latent
generate-index-data docker_labs component: redpanda-labs component: labs latent
replace-attributes components - 'redpanda-labs' - 'labs' latent

Why

Two component renames were applied to v/25.2's antora.yml / content sources over time but never reflected in the playbook:

  1. ROOT → streaming (PR Rename ROOT to streaming component (v25.2) #1703, 2026-05-26): antora.yml became name: streaming, but the playbook still pointed at ROOT. site.start_page aimed at the now-nonexistent ROOT component, 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.

  2. redpanda-labs → labs: 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 redpanda-labs in 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

  • Netlify preview builds clean. Because v/25.2 has a backlog of merged-but-never-cleanly-built PRs, don't trust a green SUCCESS alone — grep the deploy log for ERROR (asciidoctor) to confirm no remaining build errors surface once the start page resolves.

🤖 Generated with Claude Code

… 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>
@Feediver1 Feediver1 requested a review from a team as a code owner June 24, 2026 22:23
@netlify

netlify Bot commented Jun 24, 2026

Copy link
Copy Markdown

Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit 305c767
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-docs-preview/deploys/6a3c5de62730c7a378373c69
😎 Deploy Preview https://deploy-preview-1768--redpanda-docs-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai

coderabbitai Bot commented Jun 24, 2026

Copy link
Copy Markdown
Contributor

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: da0c084a-f7f4-49b4-8125-abdd4d50ce5a

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix-v25.2-playbook-root-to-streaming

Comment @coderabbitai help to get the list of available commands.

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 micheleRP left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@david-yu david-yu merged commit 2afba70 into v/25.2 Jun 25, 2026
7 checks passed
@david-yu david-yu deleted the fix-v25.2-playbook-root-to-streaming branch June 25, 2026 04:18
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.

3 participants