DOC-1087 Use single source tag across all Iceberg docs #419
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for rp-cloud ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
|
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 📝 WalkthroughWalkthrough
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
Pre-merge checks and finishing touches❌ Failed checks (3 warnings)
✅ Passed checks (2 passed)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
local-antora-playbook.yml (2)
18-18: Quote all branch globs for YAML robustness.Unquoted items with special chars can be parsed oddly by some YAML parsers. Quote them all.
- branches: ['DOC-1087-iceberg-docs-additional-clarifying-edits-from-25', v/*, shared, site-search] + branches: ['DOC-1087-iceberg-docs-additional-clarifying-edits-from-25', 'v/*', 'shared', 'site-search']
1-12: PR hygiene: fix placeholder “Resolves …/” and add preview links.Replace the placeholder with the actual issue and include working preview URLs before approval.
modules/manage/pages/iceberg/use-iceberg-catalogs.adoc (1)
5-5: Switch to single‑source looks good; verify navigation.You removed “Next steps” in this flow (per PR summary). Consider adding a “Related topics” xref block so users can jump to “Query Iceberg topics.”
modules/manage/pages/iceberg/query-iceberg-topics.adoc (1)
5-5: Ensure refresh guidance is included.Within the single‑source tag, include a note that some engines require refreshing the snapshot/metadata (for example via ALTER TABLE) to see new data.
📜 Review details
Configuration used: CodeRabbit 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.
📒 Files selected for processing (4)
local-antora-playbook.yml(1 hunks)modules/manage/pages/iceberg/about-iceberg-topics.adoc(1 hunks)modules/manage/pages/iceberg/query-iceberg-topics.adoc(1 hunks)modules/manage/pages/iceberg/use-iceberg-catalogs.adoc(1 hunks)
🧰 Additional context used
🧠 Learnings (3)
📓 Common learnings
Learnt from: micheleRP
PR: redpanda-data/cloud-docs#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.
Learnt from: micheleRP
PR: redpanda-data/cloud-docs#390
File: modules/manage/pages/schema-reg/schema-reg-authorization.adoc:4-4
Timestamp: 2025-08-15T02:29:34.901Z
Learning: In Redpanda Cloud documentation PRs, when CodeRabbit flags missing Asciidoctor tag markers for include directives, the fix may be implemented in the corresponding ROOT module file that contains the actual content being included, rather than in the file where the include directive appears.
📚 Learning: 2025-08-07T17:02:36.016Z
Learnt from: micheleRP
PR: redpanda-data/cloud-docs#377
File: modules/manage/pages/iceberg/iceberg-topics-aws-glue.adoc:1-6
Timestamp: 2025-08-07T17:02:36.016Z
Learning: In the Redpanda Cloud documentation system, self-includes like `include::ROOT:manage:iceberg/iceberg-topics-aws-glue.adoc[tag=single-source]` within the same file path work correctly and do not cause Asciidoctor include file loop errors. The module path resolution allows this pattern to function as intended.
Applied to files:
modules/manage/pages/iceberg/use-iceberg-catalogs.adocmodules/manage/pages/iceberg/about-iceberg-topics.adoc
📚 Learning: 2025-08-15T04:45:28.695Z
Learnt from: micheleRP
PR: redpanda-data/cloud-docs#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 (7)
local-antora-playbook.yml (2)
18-18: Preview-branch entry is temporary—revert before merge.Per our single‑sourcing workflow, ensure this extra branch is removed (or the playbook restored to main) before merging to main.
18-18: Verified: tag=single-source present in docs branch DOC-1087-iceberg-docs-additional-clarifying-edits-from-25tag::single-source and end::single-source found in:
- modules/manage/pages/iceberg/about-iceberg-topics.adoc (lines 6, 463)
- modules/manage/pages/iceberg/query-iceberg-topics.adoc (lines 5, 194)
- modules/manage/pages/iceberg/use-iceberg-catalogs.adoc (lines 5, 329)
No action required.
modules/manage/pages/iceberg/about-iceberg-topics.adoc (2)
3-3: LGTM on categories.Matches site taxonomy usage.
5-5: Confirm single‑source content covers DOC‑1087 clarifications.Ensure the tagged block includes: trust file use case, schema limits for record keys, snapshot behavior and refresh notes, Spark config correctness, custom partitioning best practices, Iceberg vs Kafka partitioning, and cluster flags (iceberg_latest_schema_cache_ttl_ms, iceberg_rest_catalog_warehouse). If any are outside the tag, they won’t render here.
modules/manage/pages/iceberg/use-iceberg-catalogs.adoc (2)
3-3: LGTM on categories.
5-5: Verify tag presence and completeness in upstream.Confirm the single‑source tag includes catalog‑specific flags and any engine/catalog nuances called out in DOC‑1087.
modules/manage/pages/iceberg/query-iceberg-topics.adoc (1)
3-3: LGTM on categories.
paulohtb6
reviewed
Sep 22, 2025
local-antora-playbook.yml
Outdated
| branches: HEAD | ||
| - url: https://github.com/redpanda-data/documentation | ||
| branches: [main, v/*, shared, site-search] | ||
| branches: ['DOC-1087-iceberg-docs-additional-clarifying-edits-from-25', v/*, shared, site-search] |
paulohtb6
approved these changes
Sep 22, 2025
kbatuigas
commented
Sep 23, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR updates Iceberg docs in Cloud to use the single-source tag instead of partials.
Related: redpanda-data/docs#1362
Resolves https://github.com/redpanda-data/documentation-private/issues/
Review deadline:
Page previews
Checks