Skip to content

Conversation

@micheleRP
Copy link
Contributor

Description

This PR from earlier today updated the local playbook and accidentally merged with it. This reverts the playbook, so we can get clean builds on cloud-docs.

Resolves https://github.com/redpanda-data/documentation-private/issues/
Review deadline:

Page previews

Checks

  • New feature
  • Content gap
  • Support Follow-up
  • Small fix (typos, links, copyedits, etc)

@micheleRP micheleRP requested a review from a team as a code owner January 13, 2026 22:31
@netlify
Copy link

netlify bot commented Jan 13, 2026

Deploy Preview for rp-cloud ready!

Name Link
🔨 Latest commit a6fe733
🔍 Latest deploy log https://app.netlify.com/projects/rp-cloud/deploys/6966c7b91ec4130007bbc064
😎 Deploy Preview https://deploy-preview-485--rp-cloud.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
Copy link
Contributor

coderabbitai bot commented Jan 13, 2026

📝 Walkthrough

Walkthrough

This pull request modifies the local-antora-playbook.yml configuration file with two changes: updating the rp-connect-docs source to track the main branch instead of the improve-mcp-devex branch, and enabling snapshot generation for the UI bundle by adding the snapshot: true configuration under ui.bundle.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

  • cloud-docs#463: Modifies local-antora-playbook.yml to switch content sources to the main branch with a directly overlapping change.
  • cloud-docs#328: Modifies local-antora-playbook.yml to switch tracked content branches to main.

Suggested reviewers

  • JakeSCahill
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title 'fix local playbook' clearly and concisely describes the main change—reverting an accidental playbook update to fix builds.
Description check ✅ Passed The description adequately explains the context and purpose of the revert, despite some template sections being incomplete (issue link, page previews, and checkboxes).
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


📜 Recent review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

  • Jira integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 8d44b60 and a6fe733.

📒 Files selected for processing (1)
  • local-antora-playbook.yml
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: micheleRP
Repo: redpanda-data/cloud-docs PR: 390
File: modules/manage/pages/schema-reg/schema-reg-authorization.adoc:4-4
Timestamp: 2025-08-15T04:45:28.695Z
Learning: In the Redpanda documentation system, content is single-sourced across multiple repositories (cloud-docs and docs repos). Include directives in the cloud-docs repo may reference files that exist in separate PRs in the docs repo. These PRs are linked via local-antora-playbook.yml for preview rendering, and the includes resolve correctly during the Antora build process when repositories are merged. The playbook is reverted to main before merging. This cross-repository single sourcing pattern is commonly used, so missing include targets should be verified against linked PRs in other repositories before flagging as errors.
📚 Learning: 2025-08-15T04:45:28.695Z
Learnt from: micheleRP
Repo: redpanda-data/cloud-docs PR: 390
File: modules/manage/pages/schema-reg/schema-reg-authorization.adoc:4-4
Timestamp: 2025-08-15T04:45:28.695Z
Learning: In the Redpanda documentation system, content is single-sourced across multiple repositories (cloud-docs and docs repos). Include directives in the cloud-docs repo may reference files that exist in separate PRs in the docs repo. These PRs are linked via local-antora-playbook.yml for preview rendering, and the includes resolve correctly during the Antora build process when repositories are merged. The playbook is reverted to main before merging. This cross-repository single sourcing pattern is commonly used, so missing include targets should be verified against linked PRs in other repositories before flagging as errors.

Applied to files:

  • local-antora-playbook.yml
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
  • GitHub Check: Redirect rules - rp-cloud
  • GitHub Check: Header rules - rp-cloud
  • GitHub Check: Pages changed - rp-cloud
🔇 Additional comments (2)
local-antora-playbook.yml (2)

28-29: LGTM! Revert to main branch is appropriate.

Reverting the rp-connect-docs source back to tracking main instead of a feature branch is the correct approach for clean builds. Based on learnings, this aligns with the established pattern where the local playbook is modified during development for preview rendering and reverted to main before merging.


30-33: AI summary inconsistency: snapshot: true does not appear to be a new addition.

The AI-generated summary states that this PR "enabled snapshot generation for the UI bundle by adding snapshot: true," but line 33 is not marked as changed in the diff. This line appears to be pre-existing configuration rather than a new addition in this PR. The only actual change is the branch revert on line 29.


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

@micheleRP micheleRP merged commit 0935dbb into main Jan 13, 2026
5 checks passed
@micheleRP micheleRP deleted the fix-local-playbook-branch branch January 13, 2026 22:38
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