fix: consolidate HA/DR nav duplication and sweep stale alias xrefs (DOC-2361) - #1880
Open
JakeSCahill wants to merge 2 commits into
Open
fix: consolidate HA/DR nav duplication and sweep stale alias xrefs (DOC-2361)#1880JakeSCahill wants to merge 2 commits into
JakeSCahill wants to merge 2 commits into
Conversation
…OC-2361) - Remove duplicate Remote Read Replicas page under tiered-storage; the kept page at manage:kubernetes/k-remote-read-replicas.adoc absorbs its aliases - Move High Availability in Kubernetes from Deploy to Manage > Kubernetes to match the Linux HA placement, with an alias for the old path - Platform-scope the two Shadowing trees: align nav labels and cross-link the disaster-recovery Shadowing index to the Kubernetes guide - Repoint all xrefs that used old deploy:deployment-option/* alias paths (and two stale manage:kubernetes/storage/* paths) at the canonical page IDs
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
📝 WalkthroughWalkthroughThe changes reorganize documentation navigation and cross-references. Kubernetes High Availability and Remote Read Replicas entries now use management locations and aliases. Kubernetes deployment links use shorter Estimated code review effort: 2 (Simple) | ~10 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
🧹 Nitpick comments (2)
modules/deploy/pages/redpanda/kubernetes/k-choose-deployment.adoc (1)
170-170: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winUse empty xref brackets for the renamed destinations.
The changed links hard-code display text. Use empty brackets so Antora reads the title from the target page or section.
modules/deploy/pages/redpanda/kubernetes/k-choose-deployment.adoc#L170-L170: changexref:manage:kubernetes/k-high-availability.adoc[High Availability in Kubernetes]toxref:manage:kubernetes/k-high-availability.adoc[].modules/deploy/pages/redpanda/kubernetes/k-production-readiness.adoc#L914-L914: changexref:manage:kubernetes/k-high-availability.adoc#multi-az-deployment[Multi-AZ deployment]toxref:manage:kubernetes/k-high-availability.adoc#multi-az-deployment[].Based on learnings, prefer empty xref brackets instead of hard-coded link text in AsciiDoc files.
🤖 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 `@modules/deploy/pages/redpanda/kubernetes/k-choose-deployment.adoc` at line 170, Replace the hard-coded xref text with empty brackets in modules/deploy/pages/redpanda/kubernetes/k-choose-deployment.adoc lines 170-170 and modules/deploy/pages/redpanda/kubernetes/k-production-readiness.adoc lines 914-914, preserving each target and anchor so Antora uses the destination title.Source: Learnings
modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-tune.adoc (1)
145-146: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winUse automatic xref titles for the changed links.
These references hard-code display text. Use empty brackets where custom text is not required.
modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-tune.adoc#L145-L146: remove the custom labels from both deployment links.modules/reference/pages/rpk/rpk-transform/rpk-transform-deploy.adoc#L115: remove the custom label from the sizing link.Based on learnings: prefer empty xref brackets so the target document supplies the link text.
🤖 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 `@modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-tune.adoc` around lines 145 - 146, Replace the custom xref labels with empty brackets for both links in modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-tune.adoc lines 145-146, and for the sizing link in modules/reference/pages/rpk/rpk-transform/rpk-transform-deploy.adoc line 115, so each target document supplies its automatic title.Source: Learnings
🤖 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.
Nitpick comments:
In `@modules/deploy/pages/redpanda/kubernetes/k-choose-deployment.adoc`:
- Line 170: Replace the hard-coded xref text with empty brackets in
modules/deploy/pages/redpanda/kubernetes/k-choose-deployment.adoc lines 170-170
and modules/deploy/pages/redpanda/kubernetes/k-production-readiness.adoc lines
914-914, preserving each target and anchor so Antora uses the destination title.
In `@modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-tune.adoc`:
- Around line 145-146: Replace the custom xref labels with empty brackets for
both links in modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-tune.adoc
lines 145-146, and for the sizing link in
modules/reference/pages/rpk/rpk-transform/rpk-transform-deploy.adoc line 115, so
each target document supplies its automatic title.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro Plus
Run ID: 5b2fea68-c58d-4430-8915-43a484c5f797
📒 Files selected for processing (36)
modules/ROOT/nav.adocmodules/deploy/pages/redpanda/kubernetes/k-choose-deployment.adocmodules/deploy/pages/redpanda/kubernetes/k-production-deployment.adocmodules/deploy/pages/redpanda/kubernetes/k-production-readiness.adocmodules/deploy/partials/high-availability.adocmodules/deploy/partials/kubernetes/guides/external-access-intro.adocmodules/home/pages/index.adocmodules/manage/pages/cluster-maintenance/decommission-brokers.adocmodules/manage/pages/cluster-maintenance/node-property-configuration.adocmodules/manage/pages/disaster-recovery/shadowing/index.adocmodules/manage/pages/kubernetes/cloud-topics/k-cloud-topics.adocmodules/manage/pages/kubernetes/k-decommission-brokers.adocmodules/manage/pages/kubernetes/k-high-availability.adocmodules/manage/pages/kubernetes/k-manage-resources.adocmodules/manage/pages/kubernetes/k-manage-topics.adocmodules/manage/pages/kubernetes/k-remote-read-replicas.adocmodules/manage/pages/kubernetes/k-resilience-testing.adocmodules/manage/pages/kubernetes/k-rolling-restart.adocmodules/manage/pages/kubernetes/k-scale-redpanda.adocmodules/manage/pages/kubernetes/k-schema-controller.adocmodules/manage/pages/kubernetes/networking/external/k-nodeport.adocmodules/manage/pages/kubernetes/networking/k-connect-to-redpanda.adocmodules/manage/pages/kubernetes/security/authentication/k-schema-registry-acls.adocmodules/manage/pages/kubernetes/security/authentication/k-user-controller.adocmodules/manage/pages/kubernetes/security/authorization/k-role-controller.adocmodules/manage/pages/kubernetes/shadowing/k-shadow-linking.adocmodules/manage/pages/kubernetes/storage/k-volume-types.adocmodules/manage/pages/kubernetes/tiered-storage/k-remote-read-replicas.adocmodules/manage/partials/data-archiving.adocmodules/manage/partials/remote-read-replicas.adocmodules/manage/partials/whole-cluster-restore.adocmodules/reference/pages/k-crd.adocmodules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-tune.adocmodules/reference/pages/rpk/rpk-transform/rpk-transform-deploy.adocmodules/troubleshoot/partials/errors-and-solutions.adocmodules/upgrade/pages/deprecated/index.adoc
💤 Files with no reviewable changes (1)
- modules/manage/pages/kubernetes/tiered-storage/k-remote-read-replicas.adoc
…tion Review against docs team standards: index pages open with an intro paragraph, not a NOTE, and the Kubernetes deployment method is the Redpanda Operator or Helm chart, matching k-shadow-linking's wording.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Resolves DOC-2361: consolidates the HA/DR nav duplication and placement debt surfaced while adding the "Choose Your Deployment" chooser (#1681).
Changes
1. Remote Read Replicas: one Kubernetes page instead of two
manage:kubernetes/tiered-storage/k-remote-read-replicas.adocandmanage:kubernetes/k-remote-read-replicas.adocwere identical stubs rendering the same partial, published at two URLs and listed twice in the nav. Deleted the tiered-storage copy and folded its URL (plus its old alias) into the kept page aspage-aliases, so both old URLs redirect. The kept page sits directly under Manage > Kubernetes, mirroring the Linux page's placement directly under Manage. All inbound xrefs already pointed at the kept page.2. High Availability: Kubernetes now matches Linux placement
Linux HA was previously moved from Deploy to Manage (its alias trail records the move), but Kubernetes HA stayed under Deploy even though both render the same
deploy/partials/high-availability.adoc. Movedk-high-availability.adoctomanage:kubernetes/with an alias for the olddeploy:redpanda/kubernetes/path, moved the nav entry to Manage > Kubernetes, and repointed all seven inbound xrefs.3. Shadowing: platform-scoped, not merged
Kept both trees deliberately: they're complementary, not duplicates.
manage:disaster-recovery/shadowing/*carries the concepts plus the Linux/rpk workflow (and is single-sourced to cloud-docs, so its files don't move), whilemanage:kubernetes/shadowing/*carries the Operator/Helm workflow and already links back for concepts. This PR aligns the nav labels (Monitor→Monitor Shadowing) and adds a cloud-safe (ifndef::env-cloud) note on the DR Shadowing index pointing Kubernetes users to the Kubernetes guide, so each tree now cross-references the other.4. Stale alias-path xref sweep
Repointed every xref that resolved only via old alias paths (
deploy:deployment-option/self-hosted/*,manage:kubernetes/storage/tiered-storage/*,deploy:redpanda/manual/remote-read-replicas.adoc) at the canonical page IDs — about 35 references across 25 files, including the home-page deploy tiles and the link attributes in the HA, Tiered Storage, and Whole Cluster Restore partials.:page-aliases:redirect definitions are untouched. One link was stale beyond its path: the ExternalDNS reference inexternal-access-intro.adocpointed at an anchor that no longer exists onk-requirements; it now targets the ExternalDNS section ink-production-deployment.Notes for reviewers
reference:k-crd.adoc,rpk-redpanda-tune.adoc,rpk-transform-deploy.adoc). The fixes hold until the next regeneration; the same alias paths need fixing in their upstream sources (operator CRD comments, rpk help text) to make them stick.k-*-helm-spec.adoc) still contain absolutedocs.redpanda.com/...deployment-option...URLs. Those are generated from chart READMEs in redpanda-operator and resolve via site redirects, so they're left for an upstream fix.🤖 Generated with Claude Code