fixes #90: Create a separate directory for the procedures documentation

Author: conker84

doc/asciidoc/index.adoc

@@ -13,17 +13,17 @@ The project is composed by 2 parts:
 == Installation
 
 Build locally
-// todo release
 
 ----
 mvn clean install
 ----
 
-1. Copy `<producer/consumer dir>/target/neo4j-kafka-*.jar` into `$NEO4J_HOME/plugins`
+1. Copy `<project_dir>/target/neo4j-streams-<VERSION>.jar` into `$NEO4J_HOME/plugins`
 2. Restart Neo4j
 
 
 include::producer/index.adoc[]
 
+include::consumer/index.adoc[]
 
-include::consumer/index.adoc[]
+include::procedures/index.adoc[]

doc/asciidoc/procedures/index.adoc

@@ -0,0 +1,45 @@
+== Procedures
+
+The Streams project comes out with a list of procedures.
+
+=== General configuration
+
+You can enable/disable the procedures by changing this variable inside the `neo4j.conf`
+
+.neo4j.conf
+----
+streams.procedures.enable=<true/false, default=true>
+----
+
+=== streams.publish
+
+This procedure allows custom message streaming from Neo4j to the configured environment by using the underlying configured Producer.
+
+Uses:
+
+`CALL streams.publish('my-topic', 'Hello World from Neo4j!')`
+
+The message retrieved from the Consumer is the following:
+
+`{"payload":"Hello world from Neo4j!"}`
+
+Input Parameters:
+
+[cols="3*",options="header"]
+|===
+|Variable Name
+|Type
+|Description
+|`topic`
+|String
+|The topic where you want to publish the data
+
+|`payload`
+|Object
+|The data that you want to stream
+
+|===
+
+You can send any kind of data in the payload, nodes, relationships, paths, lists, maps, scalar values and nested versions thereof.
+
+In case of nodes or relationships if the topic is defined in the patterns provided by the configuration their properties will be filtered in according with the configuration.

doc/asciidoc/producer/configuration.adoc

@@ -19,7 +19,6 @@ kafka.transaction.id=
 streams.source.topic.nodes.<TOPIC_NAME>=<PATTERN>
 streams.source.topic.relationships.<TOPIC_NAME>=<PATTERN>
 streams.source.enable=<true/false, default=true>
-streams.procedures.enable=<true/false, default=true>
 ----
 
 Note: To use the Kafka transactions please set `kafka.transaction.id` and `kafka.acks` properly

doc/asciidoc/producer/index.adoc

@@ -10,43 +10,6 @@ include::configuration.adoc[]
 
 include::patterns.adoc[]
 
-=== Procedures
-
-The producer comes out with a list of procedures.
-
-==== streams.publish
-
-This procedure allows custom message streaming from Neo4j to the configured environment
-
-Uses:
-
-`CALL streams.publish('my-topic', 'Hello World from Neo4j!')`
-
-The message retrieved from the Consumer is the following:
-
-`{"payload":"Hello world from Neo4j!"}`
-
-Input Parameters:
-
-[cols="3*",options="header"]
-|===
-|Variable Name
-|Type
-|Description
-|`topic`
-|String
-|The topic where you want to publish the data
-
-|`payload`
-|Object
-|The data that you want to stream
-
-|===
-
-You can send any kind of data in the payload, nodes, relationships, paths, lists, maps, scalar values and nested versions thereof.
-
-In case of nodes or relationships if the topic is defined in the patterns provided by the configuration their properties will be filtered in according with the configuration.
-
 === Transaction Event Handler
 
 The transaction event handler is the core of the Stream Producer and allows to stream database changes.

readme.adoc

@@ -28,6 +28,10 @@ mvn clean install
 
 ### link:doc/asciidoc/consumer/configuration.adoc[Configuration]
 
+== Streams Procedures
+
+### link:doc/asciidoc/procedures/index.adoc[Procedures]
+
 == Docker
 
 ### link:doc/asciidoc/docker/index.adoc[Docker]