From 9ec31d8fd75abb366b7846a73b8853c978260eae Mon Sep 17 00:00:00 2001 From: Oleg Zhurakousky Date: Mon, 28 Oct 2019 16:01:54 +0100 Subject: [PATCH] Polishing docs --- README.adoc | 21 ++++++++++++------- docs/src/main/asciidoc/preface.adoc | 21 ++++++++++++------- .../main/asciidoc/spring-cloud-stream.adoc | 2 +- 3 files changed, 27 insertions(+), 17 deletions(-) diff --git a/README.adoc b/README.adoc index 33ed7c838..cb773172f 100644 --- a/README.adoc +++ b/README.adoc @@ -178,10 +178,13 @@ Now you have a working (albeit very basic) Spring Cloud Stream application. [[spring-cloud-stream-preface-new-features]] === New Features and Components -TBD -- Routing Function [Details to follow] -- Multiple bindings with functions [Details to follow] -- Functions with multiple inputs/outputs + +- *Routing Function* - see <> for more details. +- *Multiple bindings with functions* (multiple message handlers) - see <> for more details. +- *Functions with multiple inputs/outputs* (single function that can subscribe or target multiple destinations) - see <> for more details. +- *Native support for reactive programming* - since v3.0.0 we no longer distribute spring-cloud-stream-reactive modules and instead +relying on native reactive support provided by spring cloud function. For backward +compatibility you can still bring `spring-cloud-stream-reactive` from previous versions. [[spring-cloud-stream-preface-notable-enhancements]] @@ -191,10 +194,12 @@ TBD [[spring-cloud-stream-preface-notable-deprecations]] === Notable Deprecations -- Reactive module in favor of native support via spring-cloud-function. [Details to follow] -- Test support module with MessageCollector [Details to follow] -- @StreamMessageConverter [Details to follow] -- Original content type - removed +- Reactive module (`spring-cloud-stream-reactive`) is discontinued and no longer distributed in favor of native support via spring-cloud-function. +For backward +compatibility you can still bring `spring-cloud-stream-reactive` from previous versions. +- We've deprecated `spring-cloud-stream-test-support` with MessageCollector in favor of a new test binder. See <> for more details. +- @StreamMessageConverter - deprecated as it is no longer required. +- The reliance on the `original-content-type` has been removed after it's been deprecated in v2.0. = Appendices [appendix] diff --git a/docs/src/main/asciidoc/preface.adoc b/docs/src/main/asciidoc/preface.adoc index 5b91eafa8..7ee97f3b5 100644 --- a/docs/src/main/asciidoc/preface.adoc +++ b/docs/src/main/asciidoc/preface.adoc @@ -158,10 +158,13 @@ Now you have a working (albeit very basic) Spring Cloud Stream application. [[spring-cloud-stream-preface-new-features]] === New Features and Components -TBD -- Routing Function [Details to follow] -- Multiple bindings with functions [Details to follow] -- Functions with multiple inputs/outputs + +- *Routing Function* - see <> for more details. +- *Multiple bindings with functions* (multiple message handlers) - see <> for more details. +- *Functions with multiple inputs/outputs* (single function that can subscribe or target multiple destinations) - see <> for more details. +- *Native support for reactive programming* - since v3.0.0 we no longer distribute spring-cloud-stream-reactive modules and instead +relying on native reactive support provided by spring cloud function. For backward +compatibility you can still bring `spring-cloud-stream-reactive` from previous versions. [[spring-cloud-stream-preface-notable-enhancements]] @@ -171,7 +174,9 @@ TBD [[spring-cloud-stream-preface-notable-deprecations]] === Notable Deprecations -- Reactive module in favor of native support via spring-cloud-function. [Details to follow] -- Test support module with MessageCollector [Details to follow] -- @StreamMessageConverter [Details to follow] -- Original content type - removed +- Reactive module (`spring-cloud-stream-reactive`) is discontinued and no longer distributed in favor of native support via spring-cloud-function. +For backward +compatibility you can still bring `spring-cloud-stream-reactive` from previous versions. +- We've deprecated `spring-cloud-stream-test-support` with MessageCollector in favor of a new test binder. See <> for more details. +- @StreamMessageConverter - deprecated as it is no longer required. +- The reliance on the `original-content-type` has been removed after it's been deprecated in v2.0. diff --git a/docs/src/main/asciidoc/spring-cloud-stream.adoc b/docs/src/main/asciidoc/spring-cloud-stream.adoc index 06792f8ed..29ea169ae 100644 --- a/docs/src/main/asciidoc/spring-cloud-stream.adoc +++ b/docs/src/main/asciidoc/spring-cloud-stream.adoc @@ -568,7 +568,7 @@ Default: 1L. For example `--spring.cloud.stream.poller.fixed-delay=2000` sets the poller interval to poll every two seconds. -===== Content-based routing with functions +===== Routing with functions Routing with functions can be achieved by relying on `RoutingFunction` available in Spring Cloud Function 3.0. All you need to do is enable it via `--spring.cloud.stream.function.routing.enabled=true` application property. Once enabled `RoutingFunction` will be bound to input destination receiving all the messages and route them to other functions based on the provided instruction.