Skip to content

Conversation

@paulohtb6
Copy link
Collaborator

Description

Resolves https://redpandadata.atlassian.net/browse/
Review deadline:

Page previews

Checks

  • New feature
  • Content gap
  • Support Follow-up
  • Small fix (typos, links, copyedits, etc)

@paulohtb6 paulohtb6 requested a review from a team as a code owner November 3, 2025 20:04
@netlify
Copy link

netlify bot commented Nov 3, 2025

Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit 65fa7f9
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-docs-preview/deploys/69090f30aff4980008acf55d
😎 Deploy Preview https://deploy-preview-1438--redpanda-docs-preview.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
Contributor

coderabbitai bot commented Nov 3, 2025

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

📝 Walkthrough

Walkthrough

This pull request updates the Redpanda documentation site to version 25.3 beta, introducing comprehensive documentation for the Shadowing disaster-recovery feature and new Admin API v2 (ConnectRPC) endpoints. The changes include version and metadata updates to antora.yml and local-antora-playbook.yml, significant navigation restructuring in ROOT/nav.adoc to introduce a Disaster Recovery section, and multiple new documentation pages covering Shadowing setup, monitoring, failover, and runbooks. Additionally, the PR reorganizes cross-references throughout the documentation, updates Linux Console deployment instructions, and replaces legacy documentation on Iceberg topics with Shadowing disaster-recovery guidance. Schema Registry documentation is expanded to cover import mode, and cluster properties are updated to reference reconfigured client-connection documentation.

Sequence Diagram(s)

sequenceDiagram
    participant User as Documentation Reader
    participant Nav as Navigation
    participant DR as Disaster Recovery<br/>(New Section)
    participant Shadowing as Shadowing<br/>Pages

    User->>Nav: Browse deployment docs
    Nav->>DR: Route to Disaster Recovery
    DR->>Shadowing: Access Shadowing overview
    Shadowing->>Shadowing: Follow: Overview → Setup<br/>→ Monitor → Failover
    Shadowing-->>User: Emergency?<br/>→ Failover Runbook
    
    Note over DR,Shadowing: New v25.3 architecture:<br/>Moved from cluster-maintenance<br/>to dedicated DR section
Loading
sequenceDiagram
    participant User as Admin
    participant rpk as rpk CLI
    participant AdminAPI as Admin API<br/>(v1 & v2)
    participant Cluster as Redpanda Cluster

    User->>AdminAPI: New: ConnectRPC (v2)<br/>Port 9644 (shared)
    User->>AdminAPI: Legacy: REST v1<br/>Port 9644 (shared)
    AdminAPI->>Cluster: List connections /Monitor<br/>Shadowing status
    Cluster-->>AdminAPI: Client/Shadow metrics
    AdminAPI-->>User: Display health data
    
    Note over AdminAPI: Both endpoints<br/>coexist on 9644
Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20-25 minutes

Key areas requiring attention:

  • modules/ROOT/nav.adoc: Extensive restructuring with multiple entries reorganized, removed, and added; verify navigation hierarchy logic and cross-reference validity (High Availability, Disaster Recovery, Admin API sections)
  • Navigation cross-references: Multiple updates from configure-availability.adoc to configure-client-connections.adoc and from manage: to deploy:redpanda/manual/ paths; spot-check 3-4 references for accuracy
  • New Shadowing documentation: Five new files (overview.adoc, setup.adoc, monitor.adoc, failover.adoc, failover-runbook.adoc) should be reviewed for content completeness, command examples validity, and cross-reference accuracy
  • antora.yml and local-antora-playbook.yml: Verify version bumps, beta flags, and branch array ordering align with release workflow
  • Schema Registry import mode documentation: Confirms the three-mode system (READONLY, READWRITE, IMPORT) and command examples are accurate

Possibly related PRs

Suggested reviewers

  • mattschumpert
  • micheleRP
  • JakeSCahill
  • Feediver1

Pre-merge checks and finishing touches

❌ Failed checks (1 warning, 1 inconclusive)
Check name Status Explanation Resolution
Description check ⚠️ Warning The PR description uses the template structure but is largely incomplete with placeholder text and no actual details about the changes, objectives, or page previews. Replace template placeholders with actual JIRA ticket link, review deadline if applicable, specific page previews using Netlify links, and check the appropriate box describing the change type.
Title check ❓ Inconclusive The title 'Fix version' is vague and generic, failing to convey specific information about what version was fixed or what changes were made. Revise the title to be more specific and descriptive, such as 'Bump version to 25.3 and update beta release configuration' or 'Update documentation for version 25.3 release.'

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@paulohtb6 paulohtb6 changed the base branch from main to beta November 3, 2025 20:09
@paulohtb6 paulohtb6 merged commit bb933cf into beta Nov 3, 2025
4 of 5 checks passed
@paulohtb6 paulohtb6 deleted the fix-version branch November 3, 2025 20:23
paulohtb6 added a commit that referenced this pull request Nov 19, 2025
@coderabbitai coderabbitai bot mentioned this pull request Nov 19, 2025
4 tasks
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.

2 participants