Skip to content

Iceberg: single source docs #1692#577

Open
kbatuigas wants to merge 2 commits intomainfrom
DOC-2128-migrate-iceberg-catalog
Open

Iceberg: single source docs #1692#577
kbatuigas wants to merge 2 commits intomainfrom
DOC-2128-migrate-iceberg-catalog

Conversation

@kbatuigas
Copy link
Copy Markdown
Contributor

Description

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)

@kbatuigas kbatuigas requested a review from a team as a code owner May 7, 2026 21:40
@netlify
Copy link
Copy Markdown

netlify Bot commented May 7, 2026

Deploy Preview for rp-cloud ready!

Name Link
🔨 Latest commit c586040
🔍 Latest deploy log https://app.netlify.com/projects/rp-cloud/deploys/69fd06b509d00800086d1bf5
😎 Deploy Preview https://deploy-preview-577--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
Copy Markdown
Contributor

coderabbitai Bot commented May 7, 2026

Review Change Stack

📝 Walkthrough

Walkthrough

This PR modifies three documentation-related files to prepare Iceberg catalog migration content. The Antora playbook configuration is updated to include a feature branch (DOC-2128) instead of main for the local content source. The navigation file reorders Iceberg entries to list the query-iceberg-topics page before migrate-to-iceberg-topics. A new AsciiDoc page scaffold is created for Iceberg catalog migration with metadata attributes and content includes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Suggested reviewers

  • mattschumpert
  • paulohtb6
  • micheleRP
🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The PR description uses the template structure but lacks critical details: the issue number is a placeholder, page previews are missing, and no checklist items are selected. Replace the placeholder issue number with the actual GitHub issue number and add the Netlify preview link. Select the appropriate checklist item(s) to indicate the type of change.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title 'Iceberg: single source docs #1692' clearly summarizes the main change - implementing single-sourced documentation for Iceberg catalog migration.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch DOC-2128-migrate-iceberg-catalog

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

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

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 in local-antora-playbook.yml currently includes the
temporary feature branch name
(DOC-2128-document-procedure-to-migrate-from-the-object-stor) instead of the
stable branch; update the branches array under the branches key to replace that
feature branch with main (keeping the other entries like v/*, shared,
site-search intact) so local pulls after merge will point to the stable main
branch and not a soon-to-be-deleted feature branch.
🪄 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: c087369a-365d-49b1-9cf9-8a90a123640f

📥 Commits

Reviewing files that changed from the base of the PR and between ae3deed and c586040.

📒 Files selected for processing (3)
  • local-antora-playbook.yml
  • modules/ROOT/nav.adoc
  • modules/manage/pages/iceberg/migrate-iceberg-catalog.adoc

Comment thread local-antora-playbook.yml
branches: HEAD
- url: https://github.com/redpanda-data/documentation
branches: [main, v/*, shared, site-search]
branches: [DOC-2128-document-procedure-to-migrate-from-the-object-stor, v/*, shared, site-search]
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.

⚠️ Potential issue | 🟠 Major | ⚖️ Poor tradeoff

Revert the temporary feature branch to main before merging.

Replacing main with DOC-2128-document-procedure-to-migrate-from-the-object-stor in the local playbook means anyone who pulls main after this PR merges will be missing all stable content from redpanda-data/documentation (main) and will get a broken or empty local build once that feature branch is eventually deleted.

🔧 Proposed fix
-    branches: [DOC-2128-document-procedure-to-migrate-from-the-object-stor, 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 in
local-antora-playbook.yml currently includes the temporary feature branch name
(DOC-2128-document-procedure-to-migrate-from-the-object-stor) instead of the
stable branch; update the branches array under the branches key to replace that
feature branch with main (keeping the other entries like v/*, shared,
site-search intact) so local pulls after merge will point to the stable main
branch and not a soon-to-be-deleted feature branch.

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.

1 participant