Skip to content

Revise Automation entry point steps in Kafka documentation#163

Open
hasathcharu wants to merge 1 commit intowso2:mainfrom
hasathcharu:patch-3
Open

Revise Automation entry point steps in Kafka documentation#163
hasathcharu wants to merge 1 commit intowso2:mainfrom
hasathcharu:patch-3

Conversation

@hasathcharu
Copy link
Copy Markdown

Updated instructions for adding an Automation entry point and clarified the flow view details.

Updated instructions for adding an Automation entry point and clarified the flow view details.
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 23, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 71fe78e3-868f-4aad-b4af-c6432246fcf6

📥 Commits

Reviewing files that changed from the base of the PR and between bfb4071 and 6bc8458.

📒 Files selected for processing (1)
  • en/docs/connectors/catalog/messaging/kafka/example.md

📝 Walkthrough

This PR updates the Kafka documentation to revise the instructions for adding an Automation entry point in both Kafka Producer and Kafka Consumer examples.

Changes Made:

  • Updated UI workflow steps: Replaced the original instructions (select Automation from entry point type list, accept default name, select Save) with a revised approach that involves navigating via the left panel, selecting Automation, and using the Create New Automation dialog with the Create button while maintaining default settings.

  • Clarified automation canvas structure: The documented view of the resulting automation canvas now explicitly includes three nodes: Start, Error Handler, and End—previously only Start and Error Handler were mentioned.

These documentation updates (8 lines added, 4 lines removed) provide more accurate and detailed guidance for users configuring Automation entry points in the Kafka connector examples.

Walkthrough

The documentation update revises the UI workflow instructions for configuring Automation entry points in Kafka Producer and Kafka Consumer examples. The changes update the navigation steps to use a left panel selection and the Create New Automation dialog instead of the previous entry point type list approach. The documentation also updates the resulting automation canvas diagram to explicitly include an End node alongside the existing Start and Error Handler nodes.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description is minimal and lacks required template sections such as Purpose, Goals, Approach, User stories, Release notes, Documentation, and other standard sections. Expand the description to follow the repository template, including Purpose, Goals, Approach, and relevant sections for documentation changes.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: revising documentation steps for Automation entry point configuration in Kafka examples.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant