add abstract

Author: mneedham

doc/asciidoc/consumer/index.adoc

@@ -1,6 +1,13 @@
 [[consumer]]
 == Neo4j Streams Consumer
 
+ifdef::env-docs[]
+[abstract]
+--
+This chapter describes the Neo4j Streams Consumer in the Neo4j Streams Library.
+--
+endif::env-docs[]
+
 Is the Kafka Sink that ingest the data directly into Neo4j
 
 === How it works

doc/asciidoc/docker/index.adoc

@@ -1,6 +1,13 @@
 [[docker]]
 == Execute with Docker
 
+ifdef::env-docs[]
+[abstract]
+--
+This chapter describes Docker Compose templates that can be used to test Neo4j Streams applications.
+--
+endif::env-docs[]
+
 Following you'll find a lightweight Docker Compose file that allows you to test the application in your local environment
 
 Prerequisites:

doc/asciidoc/index.adoc

@@ -4,6 +4,12 @@
 :toclevels: 2
 :sectid:
 :sectlinks:
+:img: https://github.com/neo4j-contrib/neo4j-streams/raw/gh-pages/3.4/images
+:env-docs: true
+
+ifdef::backend-html5[(C) {copyright}]
+
+License: link:{common-license-page-uri}[Creative Commons 4.0]
 
 
 [abstract]
@@ -18,13 +24,21 @@ The guide covers the following areas:
 * <<consumer>> -- Ingests events from a Kafka topic into Neo4j
 * <<procedures>> -- Procedures for consuming and producing Kafka events
 * <<docker>> -- Docker Compose files for local testing
-* <<kafka-connect>> -- Kafka Connect Sink plugin 
+* <<kafka-connect>> -- Kafka Connect Sink plugin
 
 
 [[introduction]]
 == Introduction
 
-Many user and customers want to integrate Kakfa and other streaming solutions with Neo4j.
+ifdef::env-docs[]
+[abstract]
+--
+This chapter provides an introduction to the Neo4j Streams Library, and instructions for installation.
+--
+endif::env-docs[]
+
+
+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.
 
@@ -35,8 +49,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]]
 === Installation
@@ -72,7 +85,6 @@ include::consumer/index.adoc[]
 
 include::procedures/index.adoc[]
 
-
 include::docker/index.adoc[]
 
 include::kafka-connect/index.adoc[]

doc/asciidoc/kafka-connect/index.adoc

@@ -1,6 +1,13 @@
 [[kafka-connect]]
 == Kafka Connect
 
+ifdef::env-docs[]
+[abstract]
+--
+This chapter describes Kafka Connect plugins in the Neo4j Streams Library.
+--
+endif::env-docs[]
+
 image::neo4j-loves-confluent.png[Neo4j Loves Confluent]
 
 

doc/asciidoc/procedures/index.adoc

@@ -1,6 +1,14 @@
 [[procedures]]
 == Procedures
 
+ifdef::env-docs[]
+[abstract]
+--
+This chapter describes consumer and producer procedures in the Neo4j Streams Library.
+--
+endif::env-docs[]
+
+
 The Streams project comes out with a list of procedures.
 
 === General configuration

doc/asciidoc/producer/index.adoc

@@ -1,6 +1,14 @@
 [[producer]]
 == Neo4j Streams Producer
 
+ifdef::env-docs[]
+[abstract]
+--
+This chapter describes the Neo4j Streams Producer in the Neo4j Streams Library.
+--
+endif::env-docs[]
+
+
 Is the transaction event handler events that sends data to a Kafka topic
 
 === Configuration

doc/build.gradle

@@ -32,21 +32,24 @@ plugins {
 if (!project.hasProperty('apocVersion')) { ext.apocVersion = '3.4.0.7' }
 
 ext {
+    copyrightYear = '2019'
     versionParts = apocVersion.split('-')
     branch = '3.4'
     versions = [
         'apoc' : apocVersion,
-        'apocDocs' : versionParts[0].split('\\.')[0..1].join('.'),
+        'apocDocs' : versionParts[0].split('\\.')[0..1].join('.')
     ]
     if (1 < versionParts.size()) { versions.apocDocs += '-preview' }
 
     docsBaseUri = "https://neo4j.com/docs"
     apocBaseUri = "https://neo4j-contrib.github.io/neo4j-apoc-procedures"
+    streamsBaseUri = "https://neo4j.com/labs/neo4j-streams/docs"
     crossReferenceBase = [ // We have no strategy for cross references; always link to current.
             'operations-manual' : "${docsBaseUri}/operations-manual/current",
             'developer-manual'  : "${docsBaseUri}/developer-manual/current",
             'graph-algorithms'  : "${docsBaseUri}/graph-algorithms/current",
             'apoc'              : "${apocBaseUri}/${versions.apocDocs}",
+            'streams'           : "${streamsBaseUri}/${versions.apocDocs}",
             'java-reference'    : "${docsBaseUri}/java-reference/current",
             'rest-docs'         : "${docsBaseUri}/rest-docs/current",
             'ogm-manual'        : "${docsBaseUri}/ogm-manual/current",
@@ -60,6 +63,8 @@ ext {
             'attribute-missing'  : 'skip',
             'docs-version'       : versions.apocDocs,
             'apoc-release'      : versions.apocDocs,
+            'copyright-year'     : copyrightYear,
+            'copyright'          : "${copyrightYear} Neo4j, Inc.",
             'branch'             : branch,
             'common-license-page-uri': "$docsBaseUri/license/",
         ],
@@ -175,6 +180,7 @@ html {
         "OGM_Manual=${crossReferenceBase['ogm-manual']}/",
         "Graph_Algorithms=${crossReferenceBase['graph-algorithms']}/",
         "APOC=${crossReferenceBase['apoc']}/",
+        "Neo4j_Streams=${crossReferenceBase['streams']}/",
         "Java_Reference=${crossReferenceBase['java-reference']}/",
     ].join(" ")
     def scripts = [