Add Iceberg Snowflake doc to Cloud #302
Conversation
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the 📝 WalkthroughWalkthroughThis change updates the Antora documentation playbook to source content from a specific feature branch instead of Sequence Diagram(s)sequenceDiagram
participant User
participant DocsSite
participant Antora
participant GitRepo
User->>DocsSite: Accesses documentation site
DocsSite->>Antora: Requests content build
Antora->>GitRepo: Fetches content from 'DOC-1389-Iceberg-on-Cloud-Single-source-Snowflake-doc' branch
Antora->>DocsSite: Builds site with new Iceberg/Snowflake doc and nav entry
DocsSite->>User: Serves updated documentation with new Snowflake integration page
Assessment against linked issues
Possibly related PRs
Suggested reviewers
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
✅ Deploy Preview for rp-cloud ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
modules/ROOT/nav.adoc (1)
400-400: Match nav link text to page title for consistency
The link text “Query Iceberg Topics with Snowflake” differs from the page’s title “Query Iceberg Topics using Snowflake and Open Catalog.” For coherence, consider using the full title or a closer match.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
local-antora-playbook.yml(1 hunks)modules/ROOT/nav.adoc(1 hunks)modules/manage/pages/iceberg/redpanda-topics-iceberg-snowflake-catalog.adoc(1 hunks)
🔇 Additional comments (4)
modules/ROOT/nav.adoc (1)
400-400: Approve nav entry addition
The new navigation entry under the “Iceberg” section correctly references the newly added documentation page and follows the existing indentation and syntax.local-antora-playbook.yml (1)
18-18: Verify branch list update and YAML quoting
The feature branch replacesmainin thebrancheslist. Confirm this is intentional so that all remote docs are sourced from the new branch. Also, to avoid any YAML parsing ambiguity, consider quoting patterns likev/*,api,shared, andsite-search.modules/manage/pages/iceberg/redpanda-topics-iceberg-snowflake-catalog.adoc (2)
1-4: Approve page metadata
The AsciiDoc front matter correctly sets the page title, description, categories, and beta flag.
6-6: Verify include directive and tag
Please confirm that theinclude::ROOT:manage:iceberg/redpanda-topics-iceberg-snowflake-catalog.adoc[tag=single-source]path andsingle-sourcetag align with the external source file on the feature branch.
Description
This pull request introduces updates to the documentation to include a new feature for querying Iceberg topics with Snowflake. The most important changes involve adding a new branch to the Antora playbook, updating the navigation structure, and creating a new documentation page for this feature.
See related PR: redpanda-data/docs#1131
Documentation updates:
'DOC-1389-Iceberg-on-Cloud-Single-source-Snowflake-doc'to thecontent:section inlocal-antora-playbook.ymlto include the new documentation source.modules/ROOT/nav.adocfor the pageredpanda-topics-iceberg-snowflake-catalog.adoc, titled "Query Iceberg Topics with Snowflake."redpanda-topics-iceberg-snowflake-catalog.adocundermodules/manage/pages/iceberg/. This page includes metadata, a description, and a reference to additional content for querying Iceberg topics in Snowflake using an Open Catalog integration.Resolves https://github.com/redpanda-data/documentation-private/issues/
Review deadline:
Page previews
https://deploy-preview-302--rp-cloud.netlify.app/redpanda-cloud/manage/iceberg/redpanda-topics-iceberg-snowflake-catalog/
Checks