[jira] [Closed] (KAFKA-4315) Kafka Connect documentation problems

["Seweryn Habdank-Wojewodzki (JIRA)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/KAFKA-4315?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Seweryn Habdank-Wojewodzki closed KAFKA-4315.
---------------------------------------------

> Kafka Connect documentation problems
> ------------------------------------
>
>                 Key: KAFKA-4315
>                 URL: https://issues.apache.org/jira/browse/KAFKA-4315
>             Project: Kafka
>          Issue Type: Bug
>            Reporter: Seweryn Habdank-Wojewodzki
>
> On the base of documentation of the Kafka Connect - http://kafka.apache.org/documentation#connect, I had tried to build example in Java. It was not possible. 
> The code pieces available on the webpage are taken out of any context and they are not compiling. 
> Also it seems they are taken completely from other code software parts, so even putting them together shows, that they are not building any reasonable example. And they tend to be very complex. where I would expect that the API examples are driving "Hello World" like code.
> Also there are weak connections between examples from the Kafka documentation and Kafka Connect tools code parts available in the Kafka source.
> Finally I would be nice to have a kind of statement in the Kafka documentation which parts of API are stable and which are unstable or experimental.
> I saw much (~20) of such a remarks in the Kafka code - I mean that API is unstable. This note is very important, as we will plan additional effort to prepare some facades for unstable code.
> In my opinion it is nothing wrong in experimental API, but all those matters when documented shall be well documented. The current status of the main Kafka documentation makes impression that Kafka Connect is well tested and consistent and stable feature set, but it is not. What leads to confusion on the effort management.



--
This message was sent by Atlassian JIRA
(v6.4.14#64029)