From 8b45fada8488d2ba8c077be3c0b801a311923ba4 Mon Sep 17 00:00:00 2001 From: Oleg Zhurakousky Date: Wed, 13 Mar 2019 16:28:56 +0100 Subject: [PATCH] GH-201 Migrated docs to new styles Resolves #201 --- README.adoc | 4 +- docs/pom.xml | 294 +++++++++++++++++- .../spring-cloud-stream-binder-rabbit.adoc | 2 + 3 files changed, 287 insertions(+), 13 deletions(-) diff --git a/README.adoc b/README.adoc index ddff42b6f..73a2a204f 100644 --- a/README.adoc +++ b/README.adoc @@ -657,7 +657,7 @@ Notice that the count property in the `x-death` header is a `Long`. == Error Channels Starting with version 1.3, the binder unconditionally sends exceptions to an error channel for each consumer destination and can also be configured to send async producer send failures to an error channel. -See "`<>`" for more information. +See "`<>`" for more information. RabbitMQ has two types of send failures: @@ -667,7 +667,7 @@ RabbitMQ has two types of send failures: The latter is rare. According to the RabbitMQ documentation "[A nack] will only be delivered if an internal error occurs in the Erlang process responsible for a queue.". -As well as enabling producer error channels (as described in "`<>`"), the RabbitMQ binder only sends messages to the channels if the connection factory is appropriately configured, as follows: +As well as enabling producer error channels (as described in "`<>`"), the RabbitMQ binder only sends messages to the channels if the connection factory is appropriately configured, as follows: * `ccf.setPublisherConfirms(true);` * `ccf.setPublisherReturns(true);` diff --git a/docs/pom.xml b/docs/pom.xml index e21a23e4b..af4c6fa96 100644 --- a/docs/pom.xml +++ b/docs/pom.xml @@ -15,8 +15,11 @@ spring-cloud-stream-binder-rabbit ${basedir}/.. + 0.1.0.RELEASE + 0.1.0.RELEASE + + 1.5.0-alpha.16 - docs @@ -25,21 +28,290 @@ org.apache.maven.plugins maven-dependency-plugin - - - org.asciidoctor - asciidoctor-maven-plugin + ${maven-dependency-plugin.version} false - - - com.agilejava.docbkx - docbkx-maven-plugin + + + unpack-docs + generate-resources + + unpack + + + + + org.springframework.cloud + + spring-cloud-build-docs + + ${spring-cloud-build.version} + + sources + jar + false + ${docs.resources.dir} + + + + + + + unpack-docs-resources + generate-resources + + unpack + + + + + io.spring.docresources + spring-doc-resources + ${spring-doc-resources.version} + zip + true + ${project.build.directory}/refdocs/ + + + + + org.apache.maven.plugins - maven-antrun-plugin - false + maven-resources-plugin + + + copy-asciidoc-resources + generate-resources + + copy-resources + + + ${project.build.directory}/refdocs/ + + + src/main/asciidoc + false + + ghpages.sh + + + + + + + + + org.asciidoctor + asciidoctor-maven-plugin + ${asciidoctor-maven-plugin.version} + false + + + io.spring.asciidoctor + spring-asciidoctor-extensions + ${spring-asciidoctor-extensions.version} + + + org.asciidoctor + asciidoctorj-pdf + ${asciidoctorj-pdf.version} + + + + ${project.build.directory}/refdocs/ + ${docs.main}.adoc + + ${project.version} + + + + + generate-html-documentation + prepare-package + + process-asciidoc + + + html5 + highlight.js + book + + // these attributes are required to use the doc resources + shared + css/ + spring.css + true + font + js/highlight + atom-one-dark-reasonable + true + + left + 4 + ${project.version} + true + + ${docs.main}.html + + + + generate-docbook + none + + process-asciidoc + + + + generate-index + none + + process-asciidoc + + + + + + + + org.apache.maven.plugins + maven-antrun-plugin + ${maven-antrun-plugin.version} + + + ant-contrib + ant-contrib + 1.0b3 + + + ant + ant + + + + + org.apache.ant + ant-nodeps + 1.8.1 + + + org.tigris.antelope + antelopetasks + 3.2.10 + + + org.jruby + jruby-complete + 1.7.17 + + + org.asciidoctor + asciidoctorj + 1.5.8 + + + + + readme + process-resources + + run + + + + + + + + + + + + + assert-no-unresolved-links + prepare-package + + run + + + + + + + + + + + + + + + + setup-maven-properties + validate + + run + + + true + + + + + + + + + + + + + + + + + + copy-css + none + + run + + + + generate-documentation-index + none + + run + + + + copy-generated-html + none + + run + + + + + + org.codehaus.mojo build-helper-maven-plugin diff --git a/docs/src/main/asciidoc/spring-cloud-stream-binder-rabbit.adoc b/docs/src/main/asciidoc/spring-cloud-stream-binder-rabbit.adoc index 40a6d4000..de5323901 100644 --- a/docs/src/main/asciidoc/spring-cloud-stream-binder-rabbit.adoc +++ b/docs/src/main/asciidoc/spring-cloud-stream-binder-rabbit.adoc @@ -30,6 +30,8 @@ Sabby Anandan, Marius Bogoevici, Eric Bottard, Mark Fisher, Ilayaperumal Gopinat :sc-ext: java // ====================================================================================== +*{spring-cloud-stream-version}* + = Reference Guide include::overview.adoc[]