DOC-2289: Emphasize required setup steps for remote read replicas (BYOVPC)#628
Open
micheleRP wants to merge 1 commit into
Open
DOC-2289: Emphasize required setup steps for remote read replicas (BYOVPC)#628micheleRP wants to merge 1 commit into
micheleRP wants to merge 1 commit into
Conversation
…OVPC) Restructure the BYOC remote read replicas page so the required setup steps stand out. Adds an up-front required-steps callout, renames the linking section, explains why linking matters, and warns that creating the topic alone does not link the clusters. Adds section anchors and updates the cross-region xref to use one. Ref: DOC-2289 (Zendesk 7005, customer escalation) Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
✅ Deploy Preview for rp-cloud 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)
📝 WalkthroughWalkthroughThis documentation-only change updates the remote read replicas BYOC page. It adds an IMPORTANT callout listing prerequisite steps (BYOVPC storage permissions, cluster linking via Estimated code review effort: 1 (Trivial) | ~5 minutes Changes
Related PRs: None identified. Suggested labels: documentation Suggested reviewers: None identified. 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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.
What
Restructures the BYOC remote read replicas (RRR) page to make the required setup steps stand out, so users stop skipping the cluster-linking step.
Ref: DOC-2289 (Zendesk 7005, customer escalation)
Why
A customer creating an RRR topic in a BYOVPC deployment hit
UNKNOWN_SERVER_ERROR: Unable to perform requested topic operation. Two required steps were documented but not prominent, so they were missed:read_replica_cluster_ids. The customer created the topic but never linked, and it was silently missed (caught only by an engineer reviewing the thread, not by alerting).Changes
All in
modules/get-started/pages/cluster-types/byoc/remote-read-replicas.adoc:IMPORTANTcallout before Prerequisites listing the three required steps up front, including "Creating the topic alone does not link the clusters."WARNINGthat creating the topic does not link the clusters.byovpc-storage-permissions,link-clusters,create-remote-read-replica-topic) and updated the cross-region xref to use the new anchor.Open question (asked in DOC-2289, pending reply)
Does source-cluster deletion protection trigger on the RRR topic existing or on the
read_replica_cluster_idslink? The new WARNING attributes it to the link; the existing NOTE attributes it to the topic. These will be reconciled once Sarah/engineering confirms, in a follow-up commit on this PR.Not included (deferred)
Discoverability / navigation changes for BYOVPC content (ask #2 in the ticket) are held pending scope confirmation from the reporter.
Preview pages
🤖 Generated with Claude Code