Skip to content

Update Kafka event pipeline sample project link to the new repository path#175

Open
Sachindu-Nethmin wants to merge 3 commits intowso2:mainfrom
Sachindu-Nethmin:fix/kafka-link
Open

Update Kafka event pipeline sample project link to the new repository path#175
Sachindu-Nethmin wants to merge 3 commits intowso2:mainfrom
Sachindu-Nethmin:fix/kafka-link

Conversation

@Sachindu-Nethmin
Copy link
Copy Markdown
Contributor

@Sachindu-Nethmin Sachindu-Nethmin commented Apr 24, 2026

Purpose

The GitHub link to the sample source code in the Kafka event pipeline tutorial was broken (returning a 404 error). This PR updates the link to the correct repository path in the wso2/integration-samples repository.

fixes #170

Goals

  • Resolve the broken source code link.
  • Ensure users can successfully access the complete working project for the tutorial.

Approach

Updated the source code URL in en/docs/tutorials/kafka-event-pipeline.md from wso2/integrator-samples/tree/main/kafka-event-pipeline to wso2/integration-samples/tree/main/integrator-default-profile/connectors/kafka_consumer_connector_sample.

User stories

As a developer following the "Kafka Event Processing Pipeline" tutorial, I want to be able to download and refer to the full source code on GitHub so that I can easily try out the sample locally.

Release note

Fixed the broken GitHub source code link in the Kafka Event Processing Pipeline tutorial.

Documentation

N/A (This is a documentation fix itself).

Training

N/A

Certification

N/A

Marketing

N/A

Automation tests

  • Unit tests: N/A
  • Integration tests: N/A

Security checks

Samples

Updated link to the kafka_consumer_connector_sample sample in the wso2/integration-samples repository.

Related PRs

N/A

Migrations (if applicable)

N/A

Test environment

Verified that the new link correctly redirects to the intended sample project on GitHub.

Learning

Verified the correct location of the sample project within the newly structured wso2/integration-samples repository.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 24, 2026

Note

.coderabbit.yaml has unrecognized properties

CodeRabbit is using all valid settings from your configuration. Unrecognized properties (listed below) have been ignored and may indicate typos or deprecated fields that can be removed.

⚠️ Parsing warnings (1)
Validation error: Unrecognized key(s) in object: 'path_instructions'
⚙️ Configuration instructions
  • Please see the configuration documentation for more information.
  • You can also validate your configuration using the online YAML validator.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
📝 Walkthrough

Walkthrough

This change updates a documentation reference in the Kafka event pipeline tutorial. The "Full Source Code" section previously pointed to an invalid GitHub repository path. The update corrects this reference to direct readers to the valid sample code location at wso2/integration-samples/integrator-mi-profile/KafkaConsumerAndProducer. This resolves the issue where users were unable to locate the referenced sample code.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main change: updating a broken Kafka event pipeline sample project link to the new repository path.
Linked Issues check ✅ Passed The PR successfully addresses the requirement from issue #170 by correcting the invalid sample URL in the Kafka documentation to point to the correct repository path.
Out of Scope Changes check ✅ Passed All changes are directly scoped to resolving the broken link issue; no unrelated modifications are present in the pull request.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description check ✅ Passed The PR description comprehensively follows the required template with all major sections completed including Purpose, Goals, Approach, User Stories, Release Note, and Documentation sections.

✏️ 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.


Find the complete working project on GitHub:
[wso2/integrator-samples/kafka-event-pipeline](https://github.com/wso2/integrator-samples/tree/main/kafka-event-pipeline)
[wso2/integration-samples/integrator-mi-profile/KafkaConsumerAndProducer](https://github.com/wso2/integration-samples/tree/main/integrator-mi-profile/KafkaConsumerAndProducer)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why listing MI sample here? Shouldn't it be Ballerina/Default profile sample?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Invalid sample URL in Kafka docs

2 participants