From 70633e8a55a4dff4fea3278157ee47f9981e3ce5 Mon Sep 17 00:00:00 2001 From: Oleg Zhurakousky Date: Tue, 13 Aug 2019 09:05:30 +0200 Subject: [PATCH] Adjusted docs with recent s-c-build updates --- README.adoc | 32 +- docs/pom.xml | 297 ++---------------- .../spring-cloud-stream-binder-rabbit.adoc | 2 - 3 files changed, 48 insertions(+), 283 deletions(-) diff --git a/README.adoc b/README.adoc index cdd361398..cfda8826a 100644 --- a/README.adoc +++ b/README.adoc @@ -142,6 +142,12 @@ acknowledgeMode:: The acknowledge mode. + Default: `AUTO`. +anonymousGroupPrefix:: +When the binding has no `group` property, an anonymous, auto-delete queue is bound to the destination exchange. +The default naming stragegy for such queues results in a queue named `anonymous.`. +Set this property to change the prefix to something other than the default. ++ +Default: `anonymous.`. autoBindDlq:: Whether to automatically declare the DLQ and bind it to the binder DLX. + @@ -201,6 +207,11 @@ Requires the delayed message exchange plugin on the broker. The `x-delayed-type` argument is set to the `exchangeType`. + Default: `false`. +dlqBindingArguments:: +Arguments applied when binding the dlq to the dead letter exchange; used with `headers` `deadLetterExchangeType` to specify headers to match on. +For example `...dlqBindingArguments.x-match=any`, `...dlqBindingArguments.someHeader=someValue`. ++ +Default: empty dlqDeadLetterExchange:: If a DLQ is declared, a DLX to assign to that queue. + @@ -253,7 +264,7 @@ If `declareExchange` is true, whether the exchange should be durable (that is, i + Default: `true`. exchangeType:: -The exchange type: `direct`, `fanout` or `topic` for non-partitioned destinations and `direct` or `topic` for partitioned destinations. +The exchange type: `direct`, `fanout`, `headers` or `topic` for non-partitioned destinations and `direct`, headers or `topic` for partitioned destinations. + Default: `topic`. exclusive:: @@ -323,6 +334,11 @@ prefix:: A prefix to be added to the name of the `destination` and queues. + Default: "". +queueBindingArguments:: +Arguments applied when binding the queue to the exchange; used with `headers` `exchangeType` to specify headers to match on. +For example `...queueBindingArguments.x-match=any`, `...queueBindingArguments.someHeader=someValue`. ++ +Default: empty queueDeclarationRetries:: The number of times to retry consuming from a queue if it is missing. Relevant only when `missingQueuesFatal` is `true`. @@ -477,6 +493,12 @@ deliveryMode:: The delivery mode. + Default: `PERSISTENT`. +dlqBindingArguments:: +Arguments applied when binding the dlq to the dead letter exchange; used with `headers` `deadLetterExchangeType` to specify headers to match on. +For example `...dlqBindingArguments.x-match=any`, `...dlqBindingArguments.someHeader=someValue`. +Applies only when `requiredGroups` are provided and then only to those groups. ++ +Default: empty dlqDeadLetterExchange:: When a DLQ is declared, a DLX to assign to that queue. Applies only if `requiredGroups` are provided and then only to those groups. @@ -527,7 +549,7 @@ If `declareExchange` is `true`, whether the exchange should be durable (survives + Default: `true`. exchangeType:: -The exchange type: `direct`, `fanout` or `topic` for non-partitioned destinations and `direct` or `topic` for partitioned destinations. +The exchange type: `direct`, `fanout`, `headers` or `topic` for non-partitioned destinations and `direct`, `headers` or `topic` for partitioned destinations. + Default: `topic`. expires:: @@ -565,6 +587,12 @@ prefix:: A prefix to be added to the name of the `destination` exchange. + Default: "". +queueBindingArguments:: +Arguments applied when binding the queue to the exchange; used with `headers` `exchangeType` to specify headers to match on. +For example `...queueBindingArguments.x-match=any`, `...queueBindingArguments.someHeader=someValue`. +Applies only when `requiredGroups` are provided and then only to those groups. ++ +Default: empty queueNameGroupOnly:: When `true`, consume from a queue with a name equal to the `group`. Otherwise the queue name is `destination.group`. diff --git a/docs/pom.xml b/docs/pom.xml index 9582d1e72..09e06b1ae 100644 --- a/docs/pom.xml +++ b/docs/pom.xml @@ -15,311 +15,50 @@ spring-cloud-stream-binder-rabbit ${basedir}/.. - 0.1.1.RELEASE - 0.1.0.RELEASE - - 1.5.0-alpha.16 + 3.4 + + + + maven-deploy-plugin + 2.8.2 + + true + + + + docs + + pl.project13.maven + git-commit-id-plugin + org.apache.maven.plugins maven-dependency-plugin - ${maven-dependency-plugin.version} - false - - - 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-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} - - - ${project.version}/ - https://cloud.spring.io/spring-cloud-static/ - + ${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 - false 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 7177950da..357a51bd7 100644 --- a/docs/src/main/asciidoc/spring-cloud-stream-binder-rabbit.adoc +++ b/docs/src/main/asciidoc/spring-cloud-stream-binder-rabbit.adoc @@ -33,8 +33,6 @@ Sabby Anandan, Marius Bogoevici, Eric Bottard, Mark Fisher, Ilayaperumal Gopinat *{spring-cloud-stream-version}* -[#index-link] -{docs-url}spring-cloud-stream/{docs-version}home.html = Reference Guide