docs: fix misleading shadow linking troubleshooting check (DOC-2231)#1802
Open
JakeSCahill wants to merge 1 commit into
Open
docs: fix misleading shadow linking troubleshooting check (DOC-2231)#1802JakeSCahill wants to merge 1 commit into
JakeSCahill wants to merge 1 commit into
Conversation
…adow cluster The prerequisites already state that only the shadow cluster needs enable_shadow_linking, but the troubleshooting section told users to verify it on both clusters. LLM assistants latch onto this as a debugging gotcha even when irrelevant (DOC-2231).
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughUpdates Helm troubleshooting guidance for shadow linking. The documentation now states that Estimated code review effort: 1 (Trivial) | ~2 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 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 |
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.
The troubleshooting section on k-shadow-linking told users to verify
enable_shadow_linkingon both clusters, but only the shadow (target) cluster requires it — the prerequisites partial on the same page already says so. The mismatch misleads readers and LLM assistants using the Docs MCP treat it as a debugging gotcha even when irrelevant (DOC-2231).Now the check targets the shadow cluster only, with a sentence explaining that the source cluster needs the property only when it also acts as the shadow cluster of another link (bi-directional topologies).
Beta counterpart PR follows. Fixes DOC-2231.