Added Kafka Connect Docs (#137)

* added Kafka Connect to Documentation, improved build kafka-connect build process

* Update README.md

* Update readme.adoc

Author: conker84

common/pom.xml

@@ -8,7 +8,7 @@
     <artifactId>neo4j-streams-common</artifactId>
     <name>Neo4j Streams - Common</name>
     <description>Neo4j Streams - Commons Package</description>
-    <version>3.4.0</version>
+    <version>${project.parent.version}</version>
     <packaging>jar</packaging>
 
     <parent>

consumer/pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>org.neo4j</groupId>
     <artifactId>neo4j-streams-consumer</artifactId>
-    <version>3.4.0</version>
+    <version>${project.parent.version}</version>
     <name>Neo4j Streams - Consumer</name>
     <description>Neo4j Streams - Kafka Consumer</description>
     <packaging>jar</packaging>
@@ -21,7 +21,7 @@
         <dependency>
             <groupId>org.neo4j</groupId>
             <artifactId>neo4j-streams-common</artifactId>
-            <version>3.4.0</version>
+            <version>${project.parent.version}</version>
         </dependency>
     </dependencies>
 

doc/asciidoc/index.adoc

@@ -7,7 +7,7 @@
 
 == Motivation
 
-Many user and customers want to integrate Kakfa and other streaming solutions with Neo4j.
+Many user and customers want to integrate Kafka and other streaming solutions with Neo4j.
 Either to ingest data into the graph from other sources.
 Or to send update events (change data capture - CDC) to the event log for later consumption.
 
@@ -18,8 +18,7 @@ The project is composed of several parts:
 * Neo4j Streams Procedure: a procedure to send a payload to a topic
 * Neo4j Streams Producer: a transaction event handler events that sends data to a Kafka topic
 * Neo4j Streams Consumer: a Neo4j application that ingest data from Kafka topics into Neo4j via templated Cypher Statements
-
-In the next releases we will add Kafka-Connect connectors as well.
+* Kafka-Connect Plugin: a plugin for the Confluent Platform that allows to ingest data into Neo4j, from Kafka topics, via Cypher queries.
 
 == Installation
 
@@ -53,4 +52,6 @@ include::consumer/index.adoc[]
 
 include::procedures/index.adoc[]
 
-include::docker/index.adoc[]
+include::docker/index.adoc[]
+
+include::kafka-connect/index.adoc[]

doc/asciidoc/kafka-connect/index.adoc

@@ -0,0 +1,20 @@
+== Kafka Connect
+
+Kafka Connect, an open source component of Apache Kafka, is a framework for connecting Kafka with external systems such as databases, key-value stores, search indexes, and file systems.
+
+The Neo4j Streams project provides a Kafka Connect plugin that can be installed into the Confluent Platform enabling:
+
+- Ingest data from Kafka topics directly into Neo4j via templated Cypher queries;
+- Stream Neo4j transaction events (*coming soon*).
+
+=== Docker compose file
+
+Inside the directory `/kafka-connect-neo4j/docker` you'll find a compose file that allows you to start the whole testing environment:
+
+.docker-compose.yml
+[source,yaml]
+----
+include::../../../kafka-connect-neo4j/docker/docker-compose.yml[]
+----
+
+include::../../../kafka-connect-neo4j/docker/readme.adoc[]

doc/pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>org.neo4j</groupId>
     <artifactId>neo4j-streams-docs</artifactId>
-    <version>3.4.0</version>
+    <version>${project.parent.version}</version>
     <name>Neo4j Streams - Docs</name>
     <description>Neo4j Streams - Documentation</description>
 

kafka-connect-neo4j/README.md

@@ -12,4 +12,4 @@ Inside the directory `<neo4j-streams>/kafka-connect-neo4j/target/component/packa
 
 # Run with docker
 
-Please refer to this file [readme.adoc](doc/readme.adoc)
+Please refer to this file [readme.adoc](docker/readme.adoc)

kafka-connect-neo4j/docker/README.md

@@ -0,0 +1,15 @@
+# Introduction
+
+Welcome to your Neo4j Kafka Connect connector!
+
+## Build it locally
+
+Build the project by running the following command:
+
+    $ mvn clean install
+
+Inside the directory `<neo4j-streams>/kafka-connect-neo4j/target/component/packages` you'll find a file named `neo4j-kafka-connect-neo4j-<VERSION>.zip`
+
+## Run with docker
+
+Please refer to this file [readme.adoc](doc/readme.adoc)