DOC-1621 Shadowing in Cloud #462
Conversation
✅ Deploy Preview for rp-cloud ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughThis PR introduces documentation for the Shadowing disaster recovery feature in Redpanda Cloud. The changes update the Antora playbook to include a feature branch ( Estimated code review effort🎯 2 (Simple) | ⏱️ ~15 minutes Notes:
Possibly related PRs
Suggested reviewers
Pre-merge checks and finishing touches✅ Passed checks (5 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
Comment |
micheleRP
force-pushed
the
DOC-1621-Document-Cloud-Feature-Shadowing-Disaster-Recovery-Enterprise
branch
from
3fb9031 to
abf731c
Compare
![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/reference/pages/rpk/rpk-shadow/rpk-shadow-delete.adoc (1)
1-3: Include directive follows single-source pattern; verify tag in linked docs PR.This wrapper page correctly follows the established pattern: title + include directive with
[tag=single-source]. The actual content is pulled fromredpanda-data/docsPR #1491. Ensure the include target (ROOT:reference:rpk/rpk-shadow/rpk-shadow-delete.adoc) has the correspondingtag=single-sourcemarker defined.This reference page lacks a
:description:attribute, unlike the manage section pages (e.g.,setup.adoc,monitor.adoc). Consider adding one for consistency across the documentation set, or confirm this pattern is intentional for reference pages.
📜 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 (19)
local-antora-playbook.yml(1 hunks)modules/ROOT/nav.adoc(4 hunks)modules/get-started/pages/whats-new-cloud.adoc(1 hunks)modules/manage/pages/disaster-recovery/index.adoc(1 hunks)modules/manage/pages/disaster-recovery/shadowing/failover-runbook.adoc(1 hunks)modules/manage/pages/disaster-recovery/shadowing/failover.adoc(1 hunks)modules/manage/pages/disaster-recovery/shadowing/index.adoc(1 hunks)modules/manage/pages/disaster-recovery/shadowing/monitor.adoc(1 hunks)modules/manage/pages/disaster-recovery/shadowing/overview.adoc(1 hunks)modules/manage/pages/disaster-recovery/shadowing/setup.adoc(1 hunks)modules/reference/pages/rpk/rpk-shadow/rpk-shadow-config-generate.adoc(1 hunks)modules/reference/pages/rpk/rpk-shadow/rpk-shadow-create.adoc(1 hunks)modules/reference/pages/rpk/rpk-shadow/rpk-shadow-delete.adoc(1 hunks)modules/reference/pages/rpk/rpk-shadow/rpk-shadow-describe.adoc(1 hunks)modules/reference/pages/rpk/rpk-shadow/rpk-shadow-failover.adoc(1 hunks)modules/reference/pages/rpk/rpk-shadow/rpk-shadow-list.adoc(1 hunks)modules/reference/pages/rpk/rpk-shadow/rpk-shadow-status.adoc(1 hunks)modules/reference/pages/rpk/rpk-shadow/rpk-shadow-update.adoc(1 hunks)modules/reference/pages/rpk/rpk-shadow/rpk-shadow.adoc(1 hunks)
🧰 Additional context used
🧠 Learnings (7)
📓 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.
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-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-15T02:29:34.901Z
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-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.
Applied to files:
modules/reference/pages/rpk/rpk-shadow/rpk-shadow-status.adocmodules/reference/pages/rpk/rpk-shadow/rpk-shadow-config-generate.adocmodules/reference/pages/rpk/rpk-shadow/rpk-shadow-failover.adocmodules/reference/pages/rpk/rpk-shadow/rpk-shadow-update.adocmodules/reference/pages/rpk/rpk-shadow/rpk-shadow-list.adocmodules/reference/pages/rpk/rpk-shadow/rpk-shadow-delete.adocmodules/reference/pages/rpk/rpk-shadow/rpk-shadow-describe.adocmodules/ROOT/nav.adocmodules/reference/pages/rpk/rpk-shadow/rpk-shadow.adocmodules/manage/pages/disaster-recovery/shadowing/overview.adoc
📚 Learning: 2025-04-25T01:41:57.162Z
Learnt from: micheleRP
Repo: redpanda-data/cloud-docs PR: 267
File: modules/manage/pages/maintenance.adoc:91-92
Timestamp: 2025-04-25T01:41:57.162Z
Learning: The notification timeline for Redpanda Cloud deprecations has been deliberately removed from the documentation, even though the PR summary mentioned a 180-day advance notice period.
Applied to files:
modules/get-started/pages/whats-new-cloud.adoc
📚 Learning: 2025-04-25T01:42:09.318Z
Learnt from: micheleRP
Repo: redpanda-data/cloud-docs PR: 267
File: modules/manage/pages/maintenance.adoc:63-64
Timestamp: 2025-04-25T01:42:09.318Z
Learning: The timeline for major upgrade notifications (180 days in advance) was intentionally removed from the Redpanda Cloud maintenance documentation, even though it was mentioned in the PR objectives.
Applied to files:
modules/get-started/pages/whats-new-cloud.adoc
📚 Learning: 2025-08-07T16:36:45.111Z
Learnt from: micheleRP
Repo: redpanda-data/cloud-docs PR: 377
File: modules/networking/pages/dedicated/gcp/configure-psc-in-ui.adoc:35-71
Timestamp: 2025-08-07T16:36:45.111Z
Learning: In Redpanda Cloud documentation, NAT subnet and firewall rule creation commands for GCP Private Service Connect are producer-side infrastructure steps that only BYOC (Bring Your Own Cloud) customers need to perform, since they manage their own VPC. Dedicated cluster customers don't need these steps because Redpanda manages the infrastructure for them. The ifdef::env-byoc[] guard correctly hides these commands from Dedicated users.
Applied to files:
modules/get-started/pages/whats-new-cloud.adoc
📚 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
📚 Learning: 2025-04-29T18:43:42.666Z
Learnt from: micheleRP
Repo: redpanda-data/cloud-docs PR: 278
File: modules/manage/pages/cluster-maintenance/config-cluster.adoc:75-75
Timestamp: 2025-04-29T18:43:42.666Z
Learning: In AsciiDoc documentation used by Redpanda, empty cross-references (xrefs) without link text (like `xref:manage:rpk/intro-to-rpk.adoc[]`) automatically use the target page's title as the link text.
Applied to files:
modules/ROOT/nav.adocmodules/reference/pages/rpk/rpk-shadow/rpk-shadow.adoc
🔇 Additional comments (21)
local-antora-playbook.yml (1)
18-18: Playbook temporary branch filter for cross-repo preview rendering.The branches filter for the
https://github.com/redpanda-data/documentationcontent source now includes the feature branchDOC-1667-Document-Shadow-Link-in-Cloud. This is the expected pattern for single-sourced documentation: the cloud-docs repo includes content from the docs repo via the playbook, with the branch temporarily pointing to the feature branch for preview rendering. Per your learnings, this will be reverted tomainbefore merge.modules/get-started/pages/whats-new-cloud.adoc (1)
9-13: December 2025 Shadowing feature entry looks solid.The What's New section correctly introduces the Shadowing disaster recovery feature with a clear description of its capabilities (asynchronous offset-preserving replication, read-only mode, topic/link failover). The xref to
manage:disaster-recovery/shadowing/overview.adoccorrectly targets the new documentation structure introduced in this PR.modules/reference/pages/rpk/rpk-shadow/rpk-shadow.adoc (1)
1-3: Main rpk shadow page follows established pattern.This page follows the same single-source include pattern as the other rpk shadow reference pages. Verify the include target has the
tag=single-sourcemarker in the docs repo.modules/reference/pages/rpk/rpk-shadow/rpk-shadow-config-generate.adoc (1)
1-3: Config generate page follows consistent single-source pattern.Follows the same include pattern as other rpk shadow reference pages. Verify the include target has the
tag=single-sourcemarker.modules/reference/pages/rpk/rpk-shadow/rpk-shadow-list.adoc (1)
1-3: Rpk shadow list page consistent with reference page set.modules/manage/pages/disaster-recovery/shadowing/setup.adoc (1)
1-4: Shadowing setup page well-structured with appropriate metadata.The page includes a description attribute that provides context for navigation and indexing. The include directive follows the established single-source pattern. Verify the include target has the
tag=single-sourcemarker in the docs repo.modules/manage/pages/disaster-recovery/shadowing/monitor.adoc (1)
1-4: Monitoring page follows established manage section pattern.Correctly includes description metadata and uses the single-source include pattern. Verify the include target has the
tag=single-sourcemarker in the docs repo.modules/reference/pages/rpk/rpk-shadow/rpk-shadow-status.adoc (1)
1-3: Single-source wrapper pattern correctly applied.This file properly implements the documentation wrapper pattern for cross-repo single-sourcing. Ensure the tag marker exists in the corresponding source file in the docs repository.
modules/reference/pages/rpk/rpk-shadow/rpk-shadow-create.adoc (1)
1-3: Single-source wrapper pattern correctly applied.This file properly implements the documentation wrapper pattern for cross-repo single-sourcing. Ensure the tag marker exists in the corresponding source file in the docs repository.
modules/manage/pages/disaster-recovery/shadowing/failover-runbook.adoc (1)
1-4: Single-source wrapper with clear metadata correctly applied.This file properly implements the wrapper pattern with descriptive metadata. Ensure the tag marker exists in the corresponding source file in the docs repository.
modules/manage/pages/disaster-recovery/shadowing/index.adoc (1)
1-3: Index page structure correctly configured.The Shadowing index page properly uses
page-layout: indexand clear metadata to function as the landing page for the Shadowing section. Navigation will be driven by the nav.adoc configuration.modules/manage/pages/disaster-recovery/index.adoc (1)
1-5: Disaster Recovery index with clear feature positioning.The index page correctly introduces Shadowing as a complementary disaster recovery capability alongside high availability. Content messaging is clear and value-focused for Cloud customers.
modules/manage/pages/disaster-recovery/shadowing/overview.adoc (1)
1-4: Single-source wrapper with descriptive metadata correctly applied.This file properly implements the wrapper pattern for the Shadowing overview section. Ensure the tag marker exists in the corresponding source file in the docs repository.
modules/reference/pages/rpk/rpk-shadow/rpk-shadow-failover.adoc (1)
1-3: Single-source wrapper pattern correctly applied.This file properly implements the documentation wrapper pattern for the rpk shadow failover reference. Ensure the tag marker exists in the corresponding source file in the docs repository.
modules/manage/pages/disaster-recovery/shadowing/failover.adoc (1)
1-4: Single-source wrapper with clear operational focus correctly applied.This file properly implements the wrapper pattern for failover configuration guidance. The title and description establish an operational/procedural context. Ensure the tag marker exists in the corresponding source file in the docs repository.
modules/reference/pages/rpk/rpk-shadow/rpk-shadow-update.adoc (1)
1-3: LGTM—Single-source include pattern is correct.The file follows the established pattern for rpk reference pages, using the correct Antora cross-module include syntax with the
[tag=single-source]marker. The include directive will resolve to content in the docs repo during the Antora build process.modules/reference/pages/rpk/rpk-shadow/rpk-shadow-describe.adoc (1)
1-3: LGTM—Consistent with the rpk-shadow reference pattern.This follows the same single-source include structure as the other rpk-shadow command pages. The cross-module include to the docs repo ROOT module is properly formatted.
modules/ROOT/nav.adoc (4)
419-423: LGTM—RPK section reorganization is clear and logical.The restructuring of rpk pages under "Manage > Redpanda CLI" creates better semantic grouping and aligns with the self-managed documentation structure.
450-456: LGTM—Disaster Recovery and Shadowing hierarchy is well-structured.The new Disaster Recovery section with Shadowing subsection provides logical nesting for the feature documentation. Five child pages (overview, setup, monitor, failover, failover-runbook) cover the complete user journey.
469-469: LGTM—monitor-cloud entry is properly placed.The monitor-cloud.adoc entry is appropriately added to the Manage section.
613-621: LGTM—rpk-shadow command group structure is consistent.The eight rpk-shadow subcommands (config-generate, create, delete, describe, failover, list, status, update) follow the same nested pattern as other rpk command groups (e.g., rpk-topic, rpk-cluster). All xref entries are properly formed.
Please verify that all disaster-recovery/shadowing pages referenced in lines 450–456 and all rpk-shadow command pages referenced in lines 613–621 exist in the corresponding file additions (either in this PR or the linked docs repo PR #1491). Per the learnings, cross-repo includes resolve during the Antora build when repositories are merged, so confirm that these target files are present before merge.
Description
This pull request adds the Disaster Recovery/Shadowing section as well as the
rpk shadowcommands to the Cloud documentation.(Single sourcing in
docsrepo was done in redpanda-data/docs#1491.)nav.adocto include the new disaster recovery section and its subpages, the newrpk shadowcommands, and reorganizes the Manage folder to match the Self-Managed doc structure.Resolves https://redpandadata.atlassian.net/browse/DOC-1621
Review deadline: Dec 10
Page previews
What's New
Disaster Recovery/Shadowing
rpk shadowChecks