wso2 / wso2/docs-mi

Multiple documents for configuring Kafka Inbound

Open
#587 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Area/Connectors Effort/DeepFocus Type/Bug Version/4.3.0
Dominant language
CSS
Stars
15
Forks
118
Avg merge
8d 4h
Merged PRs (30d)
32

Description

Description

In our documentation we have 2 configuration documents[1][2] for Kafka Inbound endpoint. One under Connectors -> Kafka Inbound and Inbound endpoints -> Kafka. In [1], we have mentioned about setting the protocol as Kafka, however in the example pointed in that doc, it mention to use the Inbound connector from the store and configure it in the same way as [2]. Furthermore, the Kafka Inbound implementation in MI[3] related to [1] is comparatively old. Hence IMO, it's better to deprecate it and move forward with Kafka Inbound connector[2]

[1] - https://mi.docs.wso2.com/en/latest/reference/synapse-properties/inbound-endpoints/polling-inbound-endpoints/kafka-inbound-endpoint-properties/

[2] - https://mi.docs.wso2.com/en/latest/reference/connectors/kafka-connector/kafka-inbound-endpoint-config/

[3] - https://github.com/wso2/micro-integrator/blob/master/components/mediation/inbound-endpoints/org.wso2.micro.integrator.inbound.endpoint/src/main/java/org/wso2/carbon/inbound/endpoint/inboundfactory/InboundRequestProcessorFactoryImpl.java#L83

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Compare the two documented entry points: the Kafka inbound endpoint properties page and the Kafka connector inbound endpoint configuration page. Review the linked InboundRequestProcessorFactoryImpl.java implementation for context, then update the documentation so the older Kafka inbound endpoint is deprecated and users are directed to the Kafka Inbound connector configuration.

Written by the indexing model from the issue text.

Assessment

Tech stack
kafka
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.