Add BigLake doc to Cloud#613
Conversation
✅ Deploy Preview for rp-cloud ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Important Review skippedAuto incremental reviews are disabled on this repository. 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:
📝 WalkthroughWalkthroughThis PR adds documentation for using Redpanda Iceberg topics with Google Cloud Platform Lakehouse. It updates the Antora playbook configuration to include a feature branch, adds a navigation entry for the new GCP Lakehouse documentation under the Iceberg REST catalog section, and introduces a new AsciiDoc page that describes how to add Redpanda topics as Iceberg tables in Google Lakehouse and query them via BigQuery. The page is marked as beta and includes content via a single-source include from a shared template. Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@local-antora-playbook.yml`:
- Line 18: The branches list under the branches key currently pins a feature
branch name; remove the literal feature branch
"DOC-2221-document-feature-support-gcp-biglake-as-rest-cata" and restore only
allowlisted branch patterns (e.g. main and the existing patterns like v/*,
shared, site-search) so the committed playbook conforms to branch-policy CI;
update the branches value to contain only those approved patterns.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 2d8e06a6-9cf3-4efa-8d44-2bd7ae1a3dce
📒 Files selected for processing (3)
local-antora-playbook.ymlmodules/ROOT/nav.adocmodules/manage/pages/iceberg/iceberg-topics-gcp-biglake.adoc
| branches: HEAD | ||
| - url: https://github.com/redpanda-data/documentation | ||
| branches: [main, v/*, shared, site-search] | ||
| branches: ['DOC-2221-document-feature-support-gcp-biglake-as-rest-cata', v/*, shared, site-search] |
There was a problem hiding this comment.
Revert feature-branch pin in committed playbook to satisfy branch-policy CI.
DOC-2221-document-feature-support-gcp-biglake-as-rest-cata is not in the allowed branch patterns, which is why the Check playbook branches job fails. Keep only allowlisted values (for this source, usually main plus existing shared patterns) in committed config.
Suggested fix
- branches: ['DOC-2221-document-feature-support-gcp-biglake-as-rest-cata', v/*, shared, site-search]
+ branches: [main, v/*, shared, site-search]📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| branches: ['DOC-2221-document-feature-support-gcp-biglake-as-rest-cata', v/*, shared, site-search] | |
| branches: [main, v/*, shared, site-search] |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@local-antora-playbook.yml` at line 18, The branches list under the branches
key currently pins a feature branch name; remove the literal feature branch
"DOC-2221-document-feature-support-gcp-biglake-as-rest-cata" and restore only
allowlisted branch patterns (e.g. main and the existing patterns like v/*,
shared, site-search) so the committed playbook conforms to branch-policy CI;
update the branches value to contain only those approved patterns.
Source: Pipeline failures
| branches: HEAD | ||
| - url: https://github.com/redpanda-data/documentation | ||
| branches: [main, v/*, shared, site-search] | ||
| branches: ['DOC-2221-document-feature-support-gcp-biglake-as-rest-cata', v/*, shared, site-search] |
There was a problem hiding this comment.
| branches: ['DOC-2221-document-feature-support-gcp-biglake-as-rest-cata', v/*, shared, site-search] | |
| branches: [main, v/*, shared, site-search] |
commit before merge
Feediver1
left a comment
Feediver1
left a comment
There was a problem hiding this comment.
Automated docs-standards review
Overall: Correct, minimal single-sourcing stub that pulls the shared body from the docs repo (docs#1731). One merge blocker (playbook branch pin), a merge-ordering dependency, and one metadata question worth confirming on the preview.
Critical (must fix before merge)
-
local-antora-playbook.yml:18— docs source pinned to the feature branch:branches: ['DOC-2221-document-feature-support-gcp-biglake-as-rest-cata', v/*, shared, site-search]
Revert to
branches: [main, v/*, shared, site-search]before merge (flagged by both kbatuigas and CodeRabbit). -
Merge ordering — This stub
include::s thesingle-sourcetag from the docs page, which only exists once docs#1731 merges tomain. Merge #1731 first, then revert this playbook tomain, then merge this. Wrong order produces a broken include / failed build.
Suggestions / verify before merge
- Page metadata location —
:page-topic-type:and:personas:are defined inside thesingle-sourcetag in the docs source (below the doctitle and a[NOTE]block), i.e. in the document body. Antora typically only registerspage-*attributes set in the document header. Verify the topic-type badge and persona metadata actually render on the Cloud preview; if not, set:page-topic-type: how-toand:personas: developer, srein this stub's header (alongside:description:and:page-categories:) — the conventional single-sourcing split. - Enterprise license note — In the docs source the
include::shared:partial$enterprise-license.adoc[]NOTE sits before thesingle-sourcetag, so it is not pulled into this Cloud stub. Confirm omitting it is intended for Cloud (plausible, since Cloud is inherently licensed); otherwise add it to the stub. - PR description — The
Resolvesline still has the placeholder<add-your-issue-number-here>.
Impact on other files
nav.adoc— entry added, consistent with #1731's ordering. ✅- What's New — GCP Lakehouse is going Supported on Cloud. Verify whether
whats-new-cloud.adocneeds an entry (none in this PR). - The
use-iceberg-catalogs.adocsupport matrix is updated in #1731; confirm the Cloud build surfaces that single-sourced page so the matrix stays in sync.
CodeRabbit
- The one actionable comment is the playbook feature-branch pin, already captured as Critical #1. No other bot findings.
What works well
- Textbook single-sourcing stub: minimal, includes the tagged region, no duplicated body or doctitle.
:page-beta:correctly removed to match the Supported status — consistent with #1731.- nav entry and "GCP Lakehouse" label match the self-managed side exactly.
🤖 Generated with Claude Code
Feediver1
left a comment
Feediver1
left a comment
There was a problem hiding this comment.
Don't forget to change the playbooks
2 participants
Description
Related: redpanda-data/docs#1731
This pull request adds documentation support for using Redpanda topics as Iceberg tables with Google Cloud Platform's Lakehouse (BigLake) and makes related navigation and configuration updates. The main changes are the addition of a new documentation page, updates to navigation, and a modification to the Antora playbook to include the relevant documentation branch.
Documentation Additions and Navigation Updates:
iceberg-topics-gcp-biglake.adoc, describing how to use Redpanda topics as Iceberg tables in Google Lakehouse (BigLake). The page is marked as beta and includes content from a shared source.nav.adoc) to include a new entry for "GCP Lakehouse" under the Iceberg topics section, linking to the new documentation page.Antora Playbook Configuration:
local-antora-playbook.ymlto use the'DOC-2221-document-feature-support-gcp-biglake-as-rest-cata'branch of the documentation repository, ensuring the new GCP Lakehouse documentation is included in the build.Resolves https://github.com/redpanda-data/documentation-private/issues/
Review deadline:
Page previews
https://deploy-preview-613--rp-cloud.netlify.app/cloud-data-platform/manage/iceberg/iceberg-topics-gcp-biglake/
Checks