DOC-6745 RDI: remove redundancies and restructure#3489
Open
andy-stark-redis wants to merge 3 commits into
Open
DOC-6745 RDI: remove redundancies and restructure#3489andy-stark-redis wants to merge 3 commits into
andy-stark-redis wants to merge 3 commits into
Conversation
Contributor
Contributor
🛡️ Jit Security Scan Results✅ No security findings were detected in this PR
Security scan by Jit
|
|
|
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
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.
NOTE: not finished - this is just to get early feedback from the Bugbot.
Note
Low Risk
Documentation-only edits (moves, link updates, and prerequisite consolidation) with no product or runtime behavior changes.
Overview
Restructures Redis Data Integration docs to cut duplication and put pipeline behavior next to pipeline setup.
Reliability topics (at-least-once delivery, checkpointing, backpressure) move from Architecture into a new Pipeline features section on Data pipelines. FAQ, troubleshooting, and the RDI overview now link to
data-pipelines#backpressure-mechanisminstead of the architecture anchor.The overview Supported source databases section drops the embedded version table in favor of a short list and a link to Prepare source databases. Architecture keeps a Debezium Server pointer there too and removes its own copy of those feature sections and the supported-sources embed.
Install on K8s and Install on VMs use a Prerequisites layout: RDI DB, hardware/OS, and K8s version requirements point at requirements summary (
reqsummary) instead of repeatingembed-mdblocks. Source CDC prep is listed under “Before you run RDI,” and redundant end-of-page “Prepare your source database” / embedded K8s version sections are removed.Reviewed by Cursor Bugbot for commit c6fda42. Bugbot is set up for automated code reviews on this repo. Configure here.