DOC-1896 Document feature RPCN Improve troubleshooting

[micheleRP]

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:

• The quickstart now describes building pipelines using a YAML editor, adding connectors from the left pane, and leveraging slash commands (/) to insert variables, secrets, topics, and users, rather than using a step-by-step wizard.
• Instructions for creating both producer and consumer pipelines have been rewritten to reflect the new workflow: users add connectors from the left pane, manually replace the generated YAML with provided examples, and use slash commands for inserting resources. [1] [2]
• Added a tip explaining the use of slash commands in the YAML editor for inserting or creating variables, secrets, topics, and users.
• Updated references to secrets to clarify that they can be created using the slash command menu or the Security page.
• Updated mentions of the "wizard" to "guide" or direct instructions in various files to align with the new workflow, including in the quickstart, Serverless cluster overview, and getting started partials. [1] [2] [3]

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

• New feature
• Content gap
• Support Follow-up
• Small fix (typos, links, copyedits, etc)

[coderabbitai]

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 8826c7b5-66d6-48d0-93ba-636b06e019a2

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

• 🔍 Trigger review

📝 Walkthrough

Walkthrough

This 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

• DOC-1773 Update connect quickstart with new onboarding #443: Directly modifies connect-quickstart.adoc to update the Connect quickstart flow instructions in relation to wizard vs. direct YAML editing approaches.
• DOC-1401 RPCN Secrets navigation change in UI #386: Updates documentation for Redpanda Cloud Secrets Store UI and secret workflow changes in pipelines, including secret management in the YAML editor.
• DOC-1742 Document feature in product wizard for build your first app #444: Originally introduced the Get Started wizard referenced across these docs; removing or updating wizard references relates to changes in that flow.

Suggested reviewers

• david-yu
• kbatuigas
• paulohtb6

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Title check	⚠️ Warning	The title references DOC-1896 and mentions 'Improve troubleshooting', but the changes focus on updating Redpanda Connect quickstart documentation for UI/workflow changes using YAML editor, not troubleshooting improvements.	Update the title to accurately reflect the main change, such as 'Update Redpanda Connect quickstart to reflect YAML editor and slash commands workflow' or similar.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description check	✅ Passed	The description is comprehensive, well-structured, includes a JIRA link, page previews, and clearly explains the changes across multiple files. It follows the template with Description and Checks sections populated.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch DOC-1896-Document-feature-RPCN-Improve-troubleshooting

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[netlify]

✅ Deploy Preview for rp-cloud ready!

Name	Link
🔨 Latest commit	b090406
🔍 Latest deploy log	https://app.netlify.com/projects/rp-cloud/deploys/69bdbc3504b89000082b8e42
😎 Deploy Preview	https://deploy-preview-535--rp-cloud.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify project configuration.

[coderabbitai]

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

📥 Commits

Reviewing files that changed from the base of the PR and between d122be8 and 234654c.

📒 Files selected for processing (4)

• modules/develop/pages/connect/connect-quickstart.adoc
• modules/get-started/pages/whats-new-cloud.adoc
• modules/get-started/partials/cloud-quickstart.adoc
• modules/get-started/partials/get-started-serverless.adoc

[Feediver1]

@micheleRP Who is the eng SME for this one?