DOC-1896 Document feature RPCN Improve troubleshooting#535
DOC-1896 Document feature RPCN Improve troubleshooting#535
Conversation
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
📝 WalkthroughWalkthroughThis pull request updates documentation across four AsciiDoc files to reflect changes in the Redpanda Connect quickstart user interface. The primary change modifies connect-quickstart.adoc to instruct users to directly edit pipeline YAML in the editor rather than use a wizard-based approach. Additional updates normalize terminology across related docs by replacing "wizard" references with "guide" where appropriate and removing references to automatic configuration generation during setup. Configuration and secret management guidance is adjusted accordingly. Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
✅ Deploy Preview for rp-cloud ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@modules/develop/pages/connect/connect-quickstart.adoc`:
- Line 78: The sentence lists two connectors (`generate` input connector and
`redpanda` output connector) but then uses singular "this connector"; change the
reference to plural (e.g., replace "this connector" with "these connectors" or
rephrase to "the YAML for the connectors appears in the editor") so the subject
and pronoun agree with `generate` and `redpanda`.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 2a7ab292-e275-4453-a192-e6cad25fa8ab
📒 Files selected for processing (4)
modules/develop/pages/connect/connect-quickstart.adocmodules/get-started/pages/whats-new-cloud.adocmodules/get-started/partials/cloud-quickstart.adocmodules/get-started/partials/get-started-serverless.adoc
|
@micheleRP Who is the eng SME for this one? |
| |=== | ||
|
|
||
| == Prerequisites | ||
| TIP: To learn more about a component, hover over its name in the left pane to link to documentation. The following screenshot shows helpful features in the user interface. |
| ==== | ||
| * Notice the `$\{REDPANDA_BROKERS}` xref:develop:connect/configuration/contextual-variables.adoc[contextual variable] in the configuration. This automatically references your cluster's bootstrap server address, so you can use it in any pipeline without hardcoding connection details. | ||
| * Notice `${secrets.KAFKA_USER_CONNECT}` and `${secrets.KAFKA_PASSWORD_CONNECT}`. These were generated when you created the `connect` user. | ||
| * Notice the `$\{REDPANDA_BROKERS}` xref:develop:connect/configuration/contextual-variables.adoc[contextual variable] in the configuration. This automatically references your cluster's bootstrap server address, so you can use it in any pipeline without hardcoding connection details. |
There was a problem hiding this comment.
we don't populate this anymore, since we're using backend default field values. Instead, we should use this as a learning opportunity to encourage users to:
a. use the slash menu to insert the redpanda brokers contextual variable
b. use the command palette to do the same
| * Notice the `$\{REDPANDA_BROKERS}` xref:develop:connect/configuration/contextual-variables.adoc[contextual variable] in the configuration. This automatically references your cluster's bootstrap server address, so you can use it in any pipeline without hardcoding connection details. | ||
| * Notice `${secrets.KAFKA_USER_CONNECT}` and `${secrets.KAFKA_PASSWORD_CONNECT}`. These were generated when you created the `connect` user. | ||
| * Notice the `$\{REDPANDA_BROKERS}` xref:develop:connect/configuration/contextual-variables.adoc[contextual variable] in the configuration. This automatically references your cluster's bootstrap server address, so you can use it in any pipeline without hardcoding connection details. | ||
| * Notice `${secrets.KAFKA_USER_CONNECT}` and `${secrets.KAFKA_PASSWORD_CONNECT}`. These reference secrets that you can create using the slash command menu in the YAML editor or the *Security* page. |
There was a problem hiding this comment.
when you add a topic/user via the left pane (purple buttons in redpanda connector) this will actually populate the fields for you. but it does require user action (interacting with those buttons in the side pane).
this is a shift from legacy functionality that populated some things with opinionated defaults. we pivoted away from that, preferring the backend being the singular source of truth for default field values.
| .. Click *Topic +* and select the existing topic `dad-jokes`. Click *Add*. | ||
| .. Click *User +* and select the existing user `connect`. |
There was a problem hiding this comment.
nit: maybe call out that these buttons are within the diagram node for the redpanda input connector.
on the frontend we call these "leaves" or the pipeline tree. (not sure if that terminology helps here, though?)
| .. Enter this name for the pipeline: `joke-generator-consumer`. | ||
| .. The **Configuration** section automatically populates the YAML with your selected components. To add the `bloblang`, `log`, and `catch` processors, replace the entire configuration with the following YAML. Bloblang is Redpanda Connect's scripting language used to add logic (for example, random ratings). | ||
| + | ||
| NOTE: This example explicitly includes several optional configuration fields for the `redpanda` input. They're shown here for demonstration purposes, so you can see a range of available settings. |
There was a problem hiding this comment.
This is really helpful. We've been getting internal feedback that it's confusing when topics and regexp_topics are both required. In fact, they're mutually exclusive and only one of the two are required.
There was a problem hiding this comment.
@eblairmckee would you please review this: https://github.com/redpanda-data/docs/pulls
There was a problem hiding this comment.
@micheleRP This link takes you to all docs PRs. Is there a specific one you want @eblairmckee to look at?
JakeSCahill
left a comment
JakeSCahill
left a comment
There was a problem hiding this comment.
Looks good. The screenshot scares me a little. How do we plan to keep that up to date? It's not a standard screenshot, so Doc Detective wouldn't help here. This is a curated combination of screens.
| |=== | ||
|
|
||
| == Prerequisites | ||
| TIP: To learn more about a component, hover over its name in the left pane to link to documentation. The following screenshot shows helpful features in the user interface. |
There was a problem hiding this comment.
Can you list out the "helpful features"? I looked at the screenshot, and see the arrows, but I have to look closely to connect the dots and understand what each arrow is pointing to. If you list these features, it makes it quicker and easier for me to make those connections in the image. thx
4 participants
Description
This pull request updates the Redpanda Connect quickstart documentation to reflect recent UI and workflow changes, focusing on a more streamlined experience using the YAML editor and slash commands. It also updates related references throughout the documentation to match the new terminology and user flow.
Redpanda Connect Quickstart and UI Workflow Updates:
/) to insert variables, secrets, topics, and users, rather than using a step-by-step wizard.Resolves https://redpandadata.atlassian.net/browse/DOC-1896
Review deadline:
Page previews
Redpanda Connect Quickstart
Serverless - Interact with your cluster
What's New (update to original listing)
Checks