From 0af784aaa95f54e3ef5ba78cb92a204bf089087c Mon Sep 17 00:00:00 2001
From: Oleg Zhurakousky <ozhurakousky@pivotal.io>
Date: Wed, 13 Mar 2019 16:40:45 +0100
Subject: [PATCH] GH-559 Initial migration of docs to new style

Resolves #559
---
 README.adoc                                   |  14 +-
 docs/pom.xml                                  | 294 +++++++++++++++++-
 .../spring-cloud-stream-binder-kafka.adoc     |   2 +
 3 files changed, 298 insertions(+), 12 deletions(-)

diff --git a/README.adoc b/README.adoc
index 6f9571a7d..46dcbf141 100644
--- a/README.adoc
+++ b/README.adoc
@@ -1,4 +1,8 @@
-// Do not edit this file (e.g. go instead to src/main/asciidoc)
+////
+DO NOT EDIT THIS FILE. IT WAS GENERATED.
+Manual changes to this file will be lost when it is generated again.
+Edit the files in the src/main/asciidoc/ directory instead.
+////
 
 :jdkversion: 1.8
 :github-tag: master
@@ -338,12 +342,20 @@ Ignored if `replicas-assignments` is present.
 +
 Default: none (the binder-wide default of 1 is used).
 
+
 NOTE: The Kafka binder uses the `partitionCount` setting of the producer as a hint to create a topic with the given partition count (in conjunction with the `minPartitionCount`, the maximum of the two being the value being used).
 Exercise caution when configuring both `minPartitionCount` for a binder and `partitionCount` for an application, as the larger value is used.
 If a topic already exists with a smaller partition count and `autoAddPartitions` is disabled (the default), the binder fails to start.
 If a topic already exists with a smaller partition count and `autoAddPartitions` is enabled, new partitions are added.
 If a topic already exists with a larger number of partitions than the maximum of (`minPartitionCount` or `partitionCount`), the existing partition count is used.
 
+compression::
+Set the `compression.type` producer property.
+Supported values are `none`, `gzip`, `snappy` and `lz4`.
+If you override the `kafka-clients` jar to 2.1.0 (or later), as discussed in the https://docs.spring.io/spring-kafka/docs/2.2.x/reference/html/deps-for-21x.html[Spring for Apache Kafka documentation], and wish to use `zstd` compression, use `spring.cloud.stream.kafka.bindings.<binding-name>.producer.configuration.compression.type=zstd`.
++
+Default: `none`.
+
 ==== Usage examples
 
 In this section, we show the use of the preceding properties for specific scenarios.
diff --git a/docs/pom.xml b/docs/pom.xml
index 7f87082d9..0ae69a5c7 100644
--- a/docs/pom.xml
+++ b/docs/pom.xml
@@ -15,8 +15,11 @@
 	<properties>
 		<docs.main>spring-cloud-stream-binder-kafka</docs.main>
 		<main.basedir>${basedir}/..</main.basedir>
+		<spring-doc-resources.version>0.1.0.RELEASE</spring-doc-resources.version>
+		<spring-asciidoctor-extensions.version>0.1.0.RELEASE
+		</spring-asciidoctor-extensions.version>
+		<asciidoctorj-pdf.version>1.5.0-alpha.16</asciidoctorj-pdf.version>
 	</properties>
-
 	<profiles>
 		<profile>
 			<id>docs</id>
@@ -25,21 +28,290 @@
 					<plugin>
 						<groupId>org.apache.maven.plugins</groupId>
 						<artifactId>maven-dependency-plugin</artifactId>
-					</plugin>
-					<plugin>
-						<groupId>org.asciidoctor</groupId>
-						<artifactId>asciidoctor-maven-plugin</artifactId>
+						<version>${maven-dependency-plugin.version}</version>
 						<inherited>false</inherited>
-					</plugin>
-					<plugin>
-						<groupId>com.agilejava.docbkx</groupId>
-						<artifactId>docbkx-maven-plugin</artifactId>
+						<executions>
+							<execution>
+								<id>unpack-docs</id>
+								<phase>generate-resources</phase>
+								<goals>
+									<goal>unpack</goal>
+								</goals>
+								<configuration>
+									<artifactItems>
+										<artifactItem>
+											<groupId>org.springframework.cloud
+											</groupId>
+											<artifactId>spring-cloud-build-docs
+											</artifactId>
+											<version>${spring-cloud-build.version}
+											</version>
+											<classifier>sources</classifier>
+											<type>jar</type>
+											<overWrite>false</overWrite>
+											<outputDirectory>${docs.resources.dir}
+											</outputDirectory>
+										</artifactItem>
+									</artifactItems>
+								</configuration>
+							</execution>
+							<execution>
+								<id>unpack-docs-resources</id>
+								<phase>generate-resources</phase>
+								<goals>
+									<goal>unpack</goal>
+								</goals>
+								<configuration>
+									<artifactItems>
+										<artifactItem>
+											<groupId>io.spring.docresources</groupId>
+											<artifactId>spring-doc-resources</artifactId>
+											<version>${spring-doc-resources.version}</version>
+											<type>zip</type>
+											<overWrite>true</overWrite>
+											<outputDirectory>${project.build.directory}/refdocs/</outputDirectory>
+										</artifactItem>
+									</artifactItems>
+								</configuration>
+							</execution>
+						</executions>
 					</plugin>
 					<plugin>
 						<groupId>org.apache.maven.plugins</groupId>
-						<artifactId>maven-antrun-plugin</artifactId>
-						<inherited>false</inherited>
+						<artifactId>maven-resources-plugin</artifactId>
+						<executions>
+							<execution>
+								<id>copy-asciidoc-resources</id>
+								<phase>generate-resources</phase>
+								<goals>
+									<goal>copy-resources</goal>
+								</goals>
+								<configuration>
+									<outputDirectory>${project.build.directory}/refdocs/</outputDirectory>
+									<resources>
+										<resource>
+											<directory>src/main/asciidoc</directory>
+											<filtering>false</filtering>
+											<excludes>
+												<exclude>ghpages.sh</exclude>
+											</excludes>
+										</resource>
+									</resources>
+								</configuration>
+							</execution>
+						</executions>
 					</plugin>
+
+					<plugin>
+						<groupId>org.asciidoctor</groupId>
+						<artifactId>asciidoctor-maven-plugin</artifactId>
+						<version>${asciidoctor-maven-plugin.version}</version>
+						<inherited>false</inherited>
+						<dependencies>
+							<dependency>
+								<groupId>io.spring.asciidoctor</groupId>
+								<artifactId>spring-asciidoctor-extensions</artifactId>
+								<version>${spring-asciidoctor-extensions.version}</version>
+							</dependency>
+							<dependency>
+								<groupId>org.asciidoctor</groupId>
+								<artifactId>asciidoctorj-pdf</artifactId>
+								<version>${asciidoctorj-pdf.version}</version>
+							</dependency>
+						</dependencies>
+						<configuration>
+							<sourceDirectory>${project.build.directory}/refdocs/</sourceDirectory>
+							<sourceDocumentName>${docs.main}.adoc</sourceDocumentName>
+							<attributes>
+            						<spring-cloud-stream-version>${project.version}</spring-cloud-stream-version>
+        					</attributes>
+						</configuration>
+						<executions>
+							<execution>
+								<id>generate-html-documentation</id>
+								<phase>prepare-package</phase>
+								<goals>
+									<goal>process-asciidoc</goal>
+								</goals>
+								<configuration>
+									<backend>html5</backend>
+									<sourceHighlighter>highlight.js</sourceHighlighter>
+									<doctype>book</doctype>
+									<attributes>
+										// these attributes are required to use the doc resources
+										<docinfo>shared</docinfo>
+										<stylesdir>css/</stylesdir>
+										<stylesheet>spring.css</stylesheet>
+										<linkcss>true</linkcss>
+										<icons>font</icons>
+										<highlightjsdir>js/highlight</highlightjsdir>
+										<highlightjs-theme>atom-one-dark-reasonable</highlightjs-theme>
+										<allow-uri-read>true</allow-uri-read>
+										<nofooter />
+										<toc>left</toc>
+										<toc-levels>4</toc-levels>
+										<spring-cloud-version>${project.version}</spring-cloud-version>
+										<sectlinks>true</sectlinks>
+									</attributes>
+									<outputFile>${docs.main}.html</outputFile>
+								</configuration>
+							</execution>
+							<execution>
+								<id>generate-docbook</id>
+								<phase>none</phase>
+								<goals>
+									<goal>process-asciidoc</goal>
+								</goals>
+							</execution>
+							<execution>
+								<id>generate-index</id>
+								<phase>none</phase>
+								<goals>
+									<goal>process-asciidoc</goal>
+								</goals>
+							</execution>
+
+						</executions>
+					</plugin>
+
+					<plugin>
+						<groupId>org.apache.maven.plugins</groupId>
+						<artifactId>maven-antrun-plugin</artifactId>
+						<version>${maven-antrun-plugin.version}</version>
+						<dependencies>
+							<dependency>
+								<groupId>ant-contrib</groupId>
+								<artifactId>ant-contrib</artifactId>
+								<version>1.0b3</version>
+								<exclusions>
+									<exclusion>
+										<groupId>ant</groupId>
+										<artifactId>ant</artifactId>
+									</exclusion>
+								</exclusions>
+							</dependency>
+							<dependency>
+								<groupId>org.apache.ant</groupId>
+								<artifactId>ant-nodeps</artifactId>
+								<version>1.8.1</version>
+							</dependency>
+							<dependency>
+								<groupId>org.tigris.antelope</groupId>
+								<artifactId>antelopetasks</artifactId>
+								<version>3.2.10</version>
+							</dependency>
+							<dependency>
+								<groupId>org.jruby</groupId>
+								<artifactId>jruby-complete</artifactId>
+								<version>1.7.17</version>
+							</dependency>
+							<dependency>
+								<groupId>org.asciidoctor</groupId>
+								<artifactId>asciidoctorj</artifactId>
+								<version>1.5.8</version>
+							</dependency>
+						</dependencies>
+						<executions>
+							<execution>
+								<id>readme</id>
+								<phase>process-resources</phase>
+								<goals>
+									<goal>run</goal>
+								</goals>
+								<configuration>
+									<target>
+										<java classname="org.jruby.Main" failonerror="yes">
+											<arg
+												value="${docs.resources.dir}/ruby/generate_readme.sh" />
+											<arg value="-o" />
+											<arg value="${main.basedir}/README.adoc" />
+										</java>
+									</target>
+								</configuration>
+							</execution>
+							<execution>
+								<id>assert-no-unresolved-links</id>
+								<phase>prepare-package</phase>
+								<goals>
+									<goal>run</goal>
+								</goals>
+								<configuration>
+									<target>
+										<fileset id="unresolved.file"
+											dir="${basedir}/target/generated-docs/" includes="**/*.html">
+											<contains text="Unresolved" />
+										</fileset>
+										<fail message="[Unresolved] Found...failing">
+											<condition>
+												<resourcecount when="greater" count="0"
+													refid="unresolved.file" />
+											</condition>
+										</fail>
+									</target>
+								</configuration>
+							</execution>
+							<execution>
+								<id>setup-maven-properties</id>
+								<phase>validate</phase>
+								<goals>
+									<goal>run</goal>
+								</goals>
+								<configuration>
+									<exportAntProperties>true</exportAntProperties>
+									<target>
+										<taskdef
+											resource="net/sf/antcontrib/antcontrib.properties" />
+										<taskdef name="stringutil"
+											classname="ise.antelope.tasks.StringUtilTask" />
+										<var name="version-type" value="${project.version}" />
+										<propertyregex property="version-type"
+											override="true" input="${version-type}" regexp=".*\.(.*)"
+											replace="\1" />
+										<propertyregex property="version-type"
+											override="true" input="${version-type}" regexp="(M)\d+"
+											replace="MILESTONE" />
+										<propertyregex property="version-type"
+											override="true" input="${version-type}" regexp="(RC)\d+"
+											replace="MILESTONE" />
+										<propertyregex property="version-type"
+											override="true" input="${version-type}" regexp="BUILD-(.*)"
+											replace="SNAPSHOT" />
+										<stringutil string="${version-type}"
+											property="spring-cloud-repo">
+											<lowercase />
+										</stringutil>
+										<var name="github-tag" value="v${project.version}" />
+										<propertyregex property="github-tag"
+											override="true" input="${github-tag}" regexp=".*SNAPSHOT"
+											replace="master" />
+									</target>
+								</configuration>
+							</execution>
+							<execution>
+								<id>copy-css</id>
+								<phase>none</phase>
+								<goals>
+									<goal>run</goal>
+								</goals>
+							</execution>
+							<execution>
+								<id>generate-documentation-index</id>
+								<phase>none</phase>
+								<goals>
+									<goal>run</goal>
+								</goals>
+							</execution>
+							<execution>
+								<id>copy-generated-html</id>
+								<phase>none</phase>
+								<goals>
+									<goal>run</goal>
+								</goals>
+							</execution>
+
+						</executions>
+					</plugin>
+
 					<plugin>
 						<groupId>org.codehaus.mojo</groupId>
 						<artifactId>build-helper-maven-plugin</artifactId>
diff --git a/docs/src/main/asciidoc/spring-cloud-stream-binder-kafka.adoc b/docs/src/main/asciidoc/spring-cloud-stream-binder-kafka.adoc
index d35bac0a2..f9cde4752 100644
--- a/docs/src/main/asciidoc/spring-cloud-stream-binder-kafka.adoc
+++ b/docs/src/main/asciidoc/spring-cloud-stream-binder-kafka.adoc
@@ -31,6 +31,8 @@ Sabby Anandan, Marius Bogoevici, Eric Bottard, Mark Fisher, Ilayaperumal Gopinat
 :sc-ext: java
 // ======================================================================================
 
+*{spring-cloud-stream-version}*
+
 = Reference Guide
 include::overview.adoc[]