Improve RDI pipeline configuration guide - #3835
Open
ZdravkoDonev-redis wants to merge 4 commits into
Open
Conversation
Contributor
Contributor
ZdravkoDonev-redis
marked this pull request as draft
August 19, 2026 21:58
ZdravkoDonev-redis
marked this pull request as ready for review
August 20, 2026 05:52
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.
What changed
config.yamlexample and move the complete example to the endtargetWhy
The current page begins with a large configuration that mixes required and optional properties. This makes it difficult to identify the smallest working file and gives AI assistants too much room to infer unsupported configuration.
The revised page gives readers a minimal starting point, then keeps the detailed options available for reference. It also removes the suggestion that multiple target databases are supported, even though the configuration schema accepts multiple target entries.
Fact-checking
Compared the page with:
rdi_utils/src/redis_di_utils/resources/schemas/config.schema.jsoninredis-data-integrationconfig.yamlreference in this repositoryValidation
git diff --checkdocs-nav.htmlerror:can't evaluate field ByWeight in type []interface {}.Review focus
Please comment on product facts or wording that still needs an RDI owner decision. In particular, review the AI prompt constraints and the public single-target statement.
Note
Low Risk
Documentation-only changes to a single Hugo page; product behavior is unchanged, though the single-target and collector-type statements should be confirmed by an RDI owner as noted in the PR.
Overview
Restructures the RDI
config.yamlpipeline configuration page so readers start from a minimal working example and add optional settings incrementally, with prerequisites and a link to the full reference up front.Adds a copy-paste AI assistant prompt that limits answers to documented properties, enforces Flink and a single target named
target, and walks through required inputs. Sources documentation now lists collector types (cdc,flink,riotx,external) and usesuser/passwordfor connections. Targets are documented as one Redis database namedtarget(removing prior wording about multiple target connections). Processors content is split into focused subsections (Classic vs Flink tuning,target_data_type, replica wait) with Flink as the default for new pipelines; the large commented example moves to an Extended configuration example at the end. The localhost/k3s troubleshooting note is removed from this page.Reviewed by Cursor Bugbot for commit ec04e45. Bugbot is set up for automated code reviews on this repo. Configure here.