Skip to content

Conversation

@JakeSCahill
Copy link
Contributor

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)

@JakeSCahill JakeSCahill requested a review from a team as a code owner December 19, 2025 08:16
@netlify
Copy link

netlify bot commented Dec 19, 2025

Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit 415aa9f
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-docs-preview/deploys/694509d72539f8000852f00f
😎 Deploy Preview https://deploy-preview-1526--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 Dec 19, 2025

📝 Walkthrough

Walkthrough

This PR reorganizes documentation structure by moving the Kubernetes shadowing monitoring content from the monitoring section to the shadowing section. The file modules/manage/pages/kubernetes/monitoring/k-monitor-shadowing.adoc is relocated to modules/manage/pages/kubernetes/shadowing/k-monitor-shadowing.adoc, with all cross-references updated accordingly across navigation, release notes, and related documentation pages. The relocated content includes minor text formatting adjustments for capitalization consistency in status indicators and descriptive labels.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10–15 minutes

  • This is a straightforward documentation reorganization with consistent cross-reference updates applied uniformly across multiple files
  • Review focus: verify all cross-references have been correctly updated to point to the new shadowing path, and confirm no references to the old monitoring path remain broken

Possibly related PRs

  • Add Shadowing docs for Kubernetes deployments #1514 — Directly related; both PRs reorganize Kubernetes shadowing monitoring documentation and update cross-references to move content into the manage:kubernetes/shadowing path
  • add shadowing metrics #1496 — Modifies the same shadowing monitoring documentation files with overlapping changes to disaster-recovery shadowing content
  • dr: adds shadowing docs #1381 — Introduces shadowing documentation structure including shadow link monitoring content that forms the basis for this reorganization

Suggested reviewers

  • david-yu
  • andrewstucki
  • paulohtb6

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Description check ⚠️ Warning The description uses the required template structure but contains incomplete/placeholder information: no actual Jira ticket URL, no review deadline specified, no page previews added, and no checks selected. Replace placeholder Jira URL with actual ticket, add review deadline, include specific page preview links from Netlify bot, and check the appropriate box (likely 'Small fix' for documentation reorganization).
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: deleting a duplicate monitoring topic for Kubernetes Shadowing as shown in the file changes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch delete-duplicate

📜 Recent review details

Configuration used: Organization 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.

📥 Commits

Reviewing files that changed from the base of the PR and between be83200 and 415aa9f.

📒 Files selected for processing (6)
  • modules/ROOT/nav.adoc (1 hunks)
  • modules/get-started/pages/release-notes/operator.adoc (1 hunks)
  • modules/manage/pages/disaster-recovery/shadowing/monitor.adoc (1 hunks)
  • modules/manage/pages/kubernetes/monitoring/k-monitor-redpanda.adoc (1 hunks)
  • modules/manage/pages/kubernetes/monitoring/k-monitor-shadowing.adoc (0 hunks)
  • modules/manage/pages/kubernetes/shadowing/k-monitor-shadowing.adoc (2 hunks)
💤 Files with no reviewable changes (1)
  • modules/manage/pages/kubernetes/monitoring/k-monitor-shadowing.adoc
🧰 Additional context used
🧠 Learnings (3)
📚 Learning: 2025-08-25T21:00:26.626Z
Learnt from: micheleRP
Repo: redpanda-data/docs PR: 1334
File: modules/manage/partials/rbac-dp.adoc:93-98
Timestamp: 2025-08-25T21:00:26.626Z
Learning: In cloud documentation (env-cloud), Security is at the top level navigation, so ACL references should use `security:authorization/rbac/acl.adoc`. In self-managed documentation, Security is nested under Manage, so ACL references use `manage:security/authorization/acl.adoc`. The different xref paths in conditional blocks reflect these different navigation structures.

Applied to files:

  • modules/ROOT/nav.adoc
📚 Learning: 2025-12-12T16:18:28.126Z
Learnt from: andrewstucki
Repo: redpanda-data/docs PR: 1514
File: modules/troubleshoot/partials/errors-and-solutions.adoc:618-632
Timestamp: 2025-12-12T16:18:28.126Z
Learning: In Redpanda ShadowLink CRD usage, do not copy CA certificates into pods via kubectl cp because they won't persist across pod restarts. Store CA certs in Kubernetes Secrets and reference them in the ShadowLink's staticConfiguration block (or inline the cert data in that block) to ensure persistence and proper secret management.

Applied to files:

  • modules/ROOT/nav.adoc
  • modules/manage/pages/kubernetes/shadowing/k-monitor-shadowing.adoc
  • modules/manage/pages/kubernetes/monitoring/k-monitor-redpanda.adoc
  • modules/manage/pages/disaster-recovery/shadowing/monitor.adoc
  • modules/get-started/pages/release-notes/operator.adoc
📚 Learning: 2025-07-16T19:33:20.420Z
Learnt from: Feediver1
Repo: redpanda-data/docs PR: 1153
File: modules/reference/pages/properties/topic-properties.adoc:45-50
Timestamp: 2025-07-16T19:33:20.420Z
Learning: In the Redpanda documentation, topic property cross-references like <<max.compaction.lag.ms>> and <<min.compaction.lag.ms>> require corresponding property definition sections with anchors like [[maxcompactionlagms]] and [[mincompactionlagms]] to prevent broken links.

Applied to files:

  • modules/manage/pages/kubernetes/monitoring/k-monitor-redpanda.adoc
⏰ 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 - redpanda-docs-preview
  • GitHub Check: Header rules - redpanda-docs-preview
  • GitHub Check: Pages changed - redpanda-docs-preview
🔇 Additional comments (6)
modules/manage/pages/kubernetes/shadowing/k-monitor-shadowing.adoc (2)

36-36: Wording improvement for clarity.

The update from "SYNCED is False" to "synced status is False" makes the sentence more natural and aligns with the normalized status indicator capitalization throughout the document.


150-152: Consistent status indicator capitalization improves readability.

The changes from uppercase state names (STATE: ACTIVE, Tasks: ACTIVE, LAG) to normalized camelCase (State: active, Tasks: active, Lag) enhance consistency and align with the Kubernetes Operator output format shown in the examples above (lines 59, 62, 64, 66).

modules/ROOT/nav.adoc (1)

141-141: Correct xref path update for new shadowing location.

The navigation entry now correctly points to manage:kubernetes/shadowing/k-monitor-shadowing.adoc. The placement under the Shadowing section is logical, consolidating Kubernetes-specific shadowing documentation in one location.

modules/manage/pages/disaster-recovery/shadowing/monitor.adoc (1)

17-17: Correct xref update for Kubernetes-specific monitoring link.

The reference to Kubernetes shadowing monitoring is now correctly updated to point to the new location. The cross-reference directs users from general shadowing monitoring to Kubernetes-specific procedures, which is the intended documentation flow.

modules/manage/pages/kubernetes/monitoring/k-monitor-redpanda.adoc (1)

20-20: Correct xref path for shadow link monitoring reference.

The suggested reading link to shadow link monitoring is now correctly updated to point to the new Kubernetes shadowing location. The cross-reference is appropriately placed as a related document for users monitoring Redpanda in Kubernetes.

modules/get-started/pages/release-notes/operator.adoc (1)

25-25: Correct xref path in release notes for shadowing monitoring.

The monitoring reference is now correctly updated to point to the new Kubernetes shadowing location. The documentation flow is logical, guiding users from setup to monitoring documentation for the ShadowLink feature.


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.

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