fix DR links #1481
fix DR links #1481
Conversation
|
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 📝 WalkthroughWalkthroughThe PR updates cross-reference links across multiple disaster-recovery shadowing and high-availability documentation files to use explicit module paths (e.g., Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes
Possibly related PRs
Suggested reviewers
Pre-merge checks and finishing touches❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
Comment |
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
![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/manage/pages/disaster-recovery/shadowing/setup.adoc (1)
75-130: Add explicit anchor to main section for consistency and reliability.Line 75 defines the "Shadow Link Tasks" section heading without an explicit anchor, relying on AsciiDoc's auto-generated anchor (
shadow-link-tasks). However, subsections at lines 79, 93, and 106 all use explicit anchors ([#source-topic-sync-task], etc.). For consistency and to align with the retrieved learning about preventing broken links, consider adding an explicit anchor here.Proposed change:
+[#shadow-link-tasks] == Shadow Link TasksThis ensures the anchor is explicit and matches the name used in all cross-references throughout the documentation.
📜 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 (6)
modules/deploy/partials/high-availability.adoc(2 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/monitor.adoc(2 hunks)modules/manage/pages/disaster-recovery/shadowing/overview.adoc(1 hunks)modules/manage/pages/disaster-recovery/shadowing/setup.adoc(1 hunks)
🧰 Additional context used
🧠 Learnings (3)
📓 Common learnings
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.
📚 Learning: 2025-09-03T16:34:58.323Z
Learnt from: micheleRP
Repo: redpanda-data/docs PR: 1349
File: modules/manage/pages/cluster-maintenance/manage-throughput.adoc:0-0
Timestamp: 2025-09-03T16:34:58.323Z
Learning: For Redpanda documentation, use absolute URLs (https://docs.redpanda.com/api/...) rather than relative URLs (/api/...) when linking to API documentation. Relative API links break in Netlify previews because Bump only serves from docs.redpanda.com, causing the relative URLs to be appended to the preview URL where Bump doesn't serve content.
Applied to files:
modules/deploy/partials/high-availability.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/deploy/partials/high-availability.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 (8)
modules/deploy/partials/high-availability.adoc (1)
51-51: Link paths correctly updated to explicit module format.Lines 51 and 256 now use explicit module paths (
deploy:redpanda/manual/...), aligning with the PR objective of fixing DR links. Conditional wrapping (ifndef::env-kubernetes[]) ensures these production deployment links apply only to non-Kubernetes environments, which is appropriate.Also applies to: 256-256
modules/manage/pages/disaster-recovery/shadowing/overview.adoc (1)
38-44: Limitations section reformatted for improved readability.The prose-to-bulleted-list conversion improves scannability without altering content. Each limitation is clearly delineated, making it easier for readers to identify disaster recovery constraints at a glance.
modules/manage/pages/disaster-recovery/shadowing/setup.adoc (1)
130-130: Cross-reference path correctly updated.Line 130 properly updates the reference to Monitor Shadow Links using the explicit module path
manage:disaster-recovery/shadowing/monitor.adoc, consistent with the PR objective.modules/manage/pages/disaster-recovery/shadowing/failover.adoc (1)
100-100: Cross-reference correctly updated to explicit module path.Line 100 updates the shadow link tasks reference to use the explicit module path with anchor (
manage:disaster-recovery/shadowing/setup.adoc#shadow-link-tasks), consistent with the PR objective and aligned with other files in this PR.modules/manage/pages/disaster-recovery/shadowing/failover-runbook.adoc (2)
131-136: Partition information details enhance runbook clarity.Lines 131–136 add clear, concise definitions of partition metrics (SRC_LSO, SRC_HWM, DST_HWM, Lag), helping operators understand replication state during emergencies. The terminology aligns with standard Redpanda/Kafka conventions and directly supports the runbook's emergency procedures.
140-140: Cross-reference updated to explicit module path.Line 140 correctly updates the shadow link tasks reference to the explicit module path with anchor (
manage:disaster-recovery/shadowing/setup.adoc#shadow-link-tasks), consistent with the PR changes across all disaster recovery shadowing files.modules/manage/pages/disaster-recovery/shadowing/monitor.adoc (2)
55-55: Task status explanation now includes properly updated cross-reference.Line 55 correctly updates the shadow link tasks reference to the explicit module path. This helps readers understand task states and their meanings in the context of monitoring shadowing health.
123-123: Alert thresholds section properly references shadow link tasks.Line 123 updates the shadow link tasks reference with the explicit module path, ensuring operators can quickly access detailed task information while configuring monitoring alerts.
| * **Link unavailability**: When tasks show `LINK_UNAVAILABLE` indicating source cluster connectivity issues | ||
|
|
||
| For more information about shadow link tasks and their states, see xref:setup.adoc#shadow-link-tasks[]. | ||
| For more information about shadow link tasks and their states, see xref:manage:disaster-recovery/shadowing/setup.adoc#shadow-link-tasks[Shadow link tasks]. | ||
|
|
||
| * **Throughput drops**: When bytes/records fetched drops significantly |
There was a problem hiding this comment.
@micheleRP The cross reference interrupted the Alert Thresholds list. There is one more item in the list that is now in the wrong location (*Throughput drops:). Please fix this.
There was a problem hiding this comment.
All the updated links work. This is the only open issue in the PR that still needs fixed.
# Conflicts: # modules/manage/pages/disaster-recovery/shadowing/monitor.adoc
|
Thanks @micheleRP ! |
Description
Fixes links in the new DR section and fixes minor style issues.
Resolves https://redpandadata.atlassian.net/browse/
Review deadline:
Page previews
Checks