diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc index c203fb228..fc3f6e2d3 100644 --- a/docs/modules/ROOT/nav.adoc +++ b/docs/modules/ROOT/nav.adoc @@ -1,100 +1,108 @@ * xref:index.adoc[] * xref:spring-cloud-stream.adoc[] -** xref:spring-cloud-stream/overview-application-model.adoc[] -** xref:spring-cloud-stream/overview-binder-abstraction.adoc[] -** xref:spring-cloud-stream/overview-persistent-publish-subscribe-support.adoc[] -** xref:spring-cloud-stream/consumer-groups.adoc[] -** xref:spring-cloud-stream/consumer-types.adoc[] -** xref:spring-cloud-stream/partitioning.adoc[] -** xref:spring-cloud-stream/destination-binders.adoc[] -** xref:spring-cloud-stream/bindings.adoc[] -** xref:spring-cloud-stream/producing-and-consuming-messages.adoc[] -** xref:spring-cloud-stream/event-routing.adoc[] -** xref:spring-cloud-stream/post-processing-after-sending-message.adoc[] -** xref:spring-cloud-stream/overview-error-handling.adoc[] -** xref:spring-cloud-stream/producers-and-consumers.adoc[] -** xref:spring-cloud-stream/overview-binder-api.adoc[] -** xref:spring-cloud-stream/binder-detection.adoc[] -** xref:spring-cloud-stream/multiple-binders.adoc[] -** xref:spring-cloud-stream/multiple-systems.adoc[] -** xref:spring-cloud-stream/binder-customizer.adoc[] -** xref:spring-cloud-stream/binding_visualization_control.adoc[] -** xref:spring-cloud-stream/binder-configuration-properties.adoc[] -** xref:spring-cloud-stream/overview-custom-binder-impl.adoc[] -** xref:spring-cloud-stream/binding-service-properties.adoc[] -** xref:spring-cloud-stream/binding-properties.adoc[] -** xref:spring-cloud-stream/mechanics.adoc[] -** xref:spring-cloud-stream/provided-messageconverters.adoc[] -** xref:spring-cloud-stream/overview-user-defined-message-converters.adoc[] -** xref:spring-cloud-stream/overview-connecting-multiple-application-instances.adoc[] -** xref:spring-cloud-stream/overview-instance-index-instance-count.adoc[] -** xref:spring-cloud-stream/overview-partitioning.adoc[] -** xref:spring-cloud-stream/spring_integration_test_binder.adoc[] -** xref:spring-cloud-stream/deploying-applications-on-cloudfoundry.adoc[] -* xref:preface.adoc[] -* xref:binders.adoc[] -* xref:README.adoc[] -* xref:configprops.adoc[] -* xref:intro.adoc[] -** xref:kafka/kafka-reactive.adoc[] -** xref:kafka/kafka-streams.adoc[] -*** xref:kafka/streams/usage.adoc[] -*** xref:kafka/streams/overview.adoc[] -*** xref:kafka/streams/programming-model.adoc[] -*** xref:kafka/streams/ancillaries-to-the-programming-model.adoc[] -*** xref:kafka/streams/record-serialization-and-deserialization.adoc[] -*** xref:kafka/streams/error-handling.adoc[] -*** xref:kafka/streams/retrying-critical-business-logic.adoc[] -*** xref:kafka/streams/state-store.adoc[] -*** xref:kafka/streams/interactive-queries.adoc[] -*** xref:kafka/streams/health-indicator.adoc[] -*** xref:kafka/streams/accessing-metrics.adoc[] -*** xref:kafka/streams/mixing-high-level-dsl-and-low-level-processor-api.adoc[] -*** xref:kafka/streams/partition-support-on-the-outbound.adoc[] -*** xref:kafka/streams/streamsbuilderfactorybean-customizer.adoc[] -*** xref:kafka/streams/timestamp-extractor.adoc[] -*** xref:kafka/streams/multi-binders-with-based-binders-and-regular-binder.adoc[] -*** xref:kafka/streams/state-cleanup.adoc[] -*** xref:kafka/streams/topology-visualization.adoc[] -*** xref:kafka/streams/event-type-based-routing-in-applications.adoc[] -*** xref:kafka/streams/binding-visualization-and-control-in-binder.adoc[] -*** xref:kafka/streams/manually-starting-processors.adoc[] -*** xref:kafka/streams/manually-starting-processors-selectively.adoc[] -*** xref:kafka/streams/tracing-using-spring-cloud-sleuth.adoc[] -*** xref:kafka/streams/configuration-options.adoc[] -** xref:kafka/kafka_dlq.adoc[] -** xref:kafka/kafka_overview.adoc[] -*** xref:kafka/kafka_overview/usage.adoc[] -*** xref:kafka/kafka_overview/overview.adoc[] -*** xref:kafka/kafka_overview/configuration-options.adoc[] -*** xref:kafka/kafka_overview/transactional-binder.adoc[] -*** xref:kafka/kafka_overview/error-channels.adoc[] -*** xref:kafka/kafka_overview/metrics.adoc[] -*** xref:kafka/kafka_overview/tombstones.adoc[] -*** xref:kafka/kafka_overview/rebalance-listener.adoc[] -*** xref:kafka/kafka_overview/retry-and-dlq-processing.adoc[] -*** xref:kafka/kafka_overview/consumer-producer-config-customizer.adoc[] -*** xref:kafka/kafka_overview/admin-client-config-customization.adoc[] -*** xref:kafka/kafka_overview/custom-binder-health-indicator.adoc[] -*** xref:kafka/kafka_overview/custom-binder-health-indicator-example.adoc[] -** xref:kafka/kafka_partitions.adoc[] -** xref:kafka/kafka_tips.adoc[] -** xref:kafka/spring-cloud-stream-binder-kafka.adoc[] -** xref:pulsar/pulsar_binder.adoc[] -** xref:pulsar/spring-cloud-stream-binder-pulsar.adoc[] -** xref:rabbit/rabbit_dlq.adoc[] -** xref:rabbit/rabbit_overview.adoc[] -*** xref:rabbit/rabbit_overview/binder-properties.adoc[] -*** xref:rabbit/rabbit_overview/rabbitmq-consumer-properties.adoc[] -*** xref:rabbit/rabbit_overview/rabbitmq-stream-consumer.adoc[] -*** xref:rabbit/rabbit_overview/advanced-listener-container-configuration.adoc[] -***** xref:rabbit/rabbit_overview/advanced-queue/exchange/binding-configuration.adoc[] -*** xref:rabbit/rabbit_overview/receiving-batch.adoc[] -*** xref:rabbit/rabbit_overview/prod-props.adoc[] -*** xref:rabbit/rabbit_overview/publisher-confirms.adoc[] -*** xref:rabbit/rabbit_overview/rabbitmq-stream-producer.adoc[] -*** xref:rabbit/rabbit_overview/putting-it-all-together.adoc[] -** xref:rabbit/rabbit_partitions.adoc[] -** xref:rabbit/spring-cloud-stream-binder-rabbit.adoc[] -* xref:sagan-index.adoc[] -** xref:schema-registry/spring-cloud-stream-schema-registry.adoc[] +** Main Concepts and Abstractions +*** xref:spring-cloud-stream/overview-application-model.adoc[Spring Cloud Stream's application model] +*** xref:spring-cloud-stream/overview-binder-abstraction.adoc[The Binder Abstraction] +*** xref:spring-cloud-stream/overview-persistent-publish-subscribe-support.adoc[Persistent publish-subscribe support] +*** xref:spring-cloud-stream/consumer-groups.adoc[Consumer group support] +*** xref:spring-cloud-stream/overview-partitioning.adoc[Partitioning support] +*** xref:spring-cloud-stream/overview-binder-api.adoc[A pluggable Binder SPI] + +#** xref:spring-cloud-stream/overview-application-model.adoc[] +#** xref:spring-cloud-stream/overview-binder-abstraction.adoc[] +#** xref:spring-cloud-stream/overview-persistent-publish-subscribe-support.adoc[] +#** xref:spring-cloud-stream/consumer-groups.adoc[] +#** xref:spring-cloud-stream/consumer-types.adoc[] +#** xref:spring-cloud-stream/partitioning.adoc[] +#** xref:spring-cloud-stream/destination-binders.adoc[] +#** xref:spring-cloud-stream/bindings.adoc[] +#** xref:spring-cloud-stream/producing-and-consuming-messages.adoc[] +#** xref:spring-cloud-stream/event-routing.adoc[] +#** xref:spring-cloud-stream/post-processing-after-sending-message.adoc[] +#** xref:spring-cloud-stream/overview-error-handling.adoc[] +#** xref:spring-cloud-stream/producers-and-consumers.adoc[] +#** xref:spring-cloud-stream/overview-binder-api.adoc[] +#** xref:spring-cloud-stream/binder-detection.adoc[] +#** xref:spring-cloud-stream/multiple-binders.adoc[] +#** xref:spring-cloud-stream/multiple-systems.adoc[] +#** xref:spring-cloud-stream/binder-customizer.adoc[] +#** xref:spring-cloud-stream/binding_visualization_control.adoc[] +#** xref:spring-cloud-stream/binder-configuration-properties.adoc[] +#** xref:spring-cloud-stream/overview-custom-binder-impl.adoc[] +#** xref:spring-cloud-stream/binding-service-properties.adoc[] +#** xref:spring-cloud-stream/binding-properties.adoc[] +#** xref:spring-cloud-stream/mechanics.adoc[] +#** xref:spring-cloud-stream/provided-messageconverters.adoc[] +#** xref:spring-cloud-stream/overview-user-defined-message-converters.adoc[] +#** xref:spring-cloud-stream/overview-connecting-multiple-application-instances.adoc[] +#** xref:spring-cloud-stream/overview-instance-index-instance-count.adoc[] +#** xref:spring-cloud-stream/overview-partitioning.adoc[] +#** xref:spring-cloud-stream/spring_integration_test_binder.adoc[] +#** xref:spring-cloud-stream/deploying-applications-on-cloudfoundry.adoc[] +#* xref:preface.adoc[] +#* xref:binders.adoc[] +#* xref:README.adoc[] +#* xref:configprops.adoc[] +#* xref:intro.adoc[] +#** xref:kafka/kafka-reactive.adoc[] +#** xref:kafka/kafka-streams.adoc[] +#*** xref:kafka/streams/usage.adoc[] +#*** xref:kafka/streams/overview.adoc[] +#*** xref:kafka/streams/programming-model.adoc[] +#*** xref:kafka/streams/ancillaries-to-the-programming-model.adoc[] +#*** xref:kafka/streams/record-serialization-and-deserialization.adoc[] +#*** xref:kafka/streams/error-handling.adoc[] +#*** xref:kafka/streams/retrying-critical-business-logic.adoc[] +#*** xref:kafka/streams/state-store.adoc[] +#*** xref:kafka/streams/interactive-queries.adoc[] +#*** xref:kafka/streams/health-indicator.adoc[] +#*** xref:kafka/streams/accessing-metrics.adoc[] +#*** xref:kafka/streams/mixing-high-level-dsl-and-low-level-processor-api.adoc[] +#*** xref:kafka/streams/partition-support-on-the-outbound.adoc[] +#*** xref:kafka/streams/streamsbuilderfactorybean-customizer.adoc[] +#*** xref:kafka/streams/timestamp-extractor.adoc[] +#*** xref:kafka/streams/multi-binders-with-based-binders-and-regular-binder.adoc[] +#*** xref:kafka/streams/state-cleanup.adoc[] +#*** xref:kafka/streams/topology-visualization.adoc[] +#*** xref:kafka/streams/event-type-based-routing-in-applications.adoc[] +#*** xref:kafka/streams/binding-visualization-and-control-in-binder.adoc[] +#*** xref:kafka/streams/manually-starting-processors.adoc[] +#*** xref:kafka/streams/manually-starting-processors-selectively.adoc[] +#*** xref:kafka/streams/tracing-using-spring-cloud-sleuth.adoc[] +#*** xref:kafka/streams/configuration-options.adoc[] +#** xref:kafka/kafka_dlq.adoc[] +#** xref:kafka/kafka_overview.adoc[] +#*** xref:kafka/kafka_overview/usage.adoc[] +#*** xref:kafka/kafka_overview/overview.adoc[] +#*** xref:kafka/kafka_overview/configuration-options.adoc[] +#*** xref:kafka/kafka_overview/transactional-binder.adoc[] +#*** xref:kafka/kafka_overview/error-channels.adoc[] +#*** xref:kafka/kafka_overview/metrics.adoc[] +#*** xref:kafka/kafka_overview/tombstones.adoc[] +#*** xref:kafka/kafka_overview/rebalance-listener.adoc[] +#*** xref:kafka/kafka_overview/retry-and-dlq-processing.adoc[] +#*** xref:kafka/kafka_overview/consumer-producer-config-customizer.adoc[] +#*** xref:kafka/kafka_overview/admin-client-config-customization.adoc[] +#*** xref:kafka/kafka_overview/custom-binder-health-indicator.adoc[] +#*** xref:kafka/kafka_overview/custom-binder-health-indicator-example.adoc[] +#** xref:kafka/kafka_partitions.adoc[] +#** xref:kafka/kafka_tips.adoc[] +#** xref:kafka/spring-cloud-stream-binder-kafka.adoc[] +#** xref:pulsar/pulsar_binder.adoc[] +#** xref:pulsar/spring-cloud-stream-binder-pulsar.adoc[] +#** xref:rabbit/rabbit_dlq.adoc[] +#** xref:rabbit/rabbit_overview.adoc[] +#*** xref:rabbit/rabbit_overview/binder-properties.adoc[] +#*** xref:rabbit/rabbit_overview/rabbitmq-consumer-properties.adoc[] +#*** xref:rabbit/rabbit_overview/rabbitmq-stream-consumer.adoc[] +#*** xref:rabbit/rabbit_overview/advanced-listener-container-configuration.adoc[] +#***** xref:rabbit/rabbit_overview/advanced-queue/exchange/binding-configuration.adoc[] +#*** xref:rabbit/rabbit_overview/receiving-batch.adoc[] +#*** xref:rabbit/rabbit_overview/prod-props.adoc[] +#*** xref:rabbit/rabbit_overview/publisher-confirms.adoc[] +#*** xref:rabbit/rabbit_overview/rabbitmq-stream-producer.adoc[] +#*** xref:rabbit/rabbit_overview/putting-it-all-together.adoc[] +#** xref:rabbit/rabbit_partitions.adoc[] +#** xref:rabbit/spring-cloud-stream-binder-rabbit.adoc[] +#* xref:sagan-index.adoc[] +#** xref:schema-registry/spring-cloud-stream-schema-registry.adoc[] diff --git a/docs/modules/ROOT/pages/index.adoc b/docs/modules/ROOT/pages/index.adoc index 4dc0d71c7..1c6352a90 100644 --- a/docs/modules/ROOT/pages/index.adoc +++ b/docs/modules/ROOT/pages/index.adoc @@ -1,8 +1,7 @@ -[[spring-cloud-stream-reference-documentation]] -= Spring Cloud Stream Reference Documentation -Sabby Anandan; Marius Bogoevici; Eric Bottard; Mark Fisher; Ilayaperumal Gopinathan; Mark Heckler; Gunnar Hillert; Mark Pollack; Patrick Peralta; Glenn Renfro; Thomas Risberg; Dave Syer; David Turanski; Janne Valkealahti; Benjamin Klein; Vinicius Carvalho; Gary Russell; Oleg Zhurakousky; Jay Bryant; Soby Chacko; Domenico Sibilio +[[Introduction]] += Introduction -:docinfo: shared +Sabby Anandan; Marius Bogoevici; Eric Bottard; Mark Fisher; Ilayaperumal Gopinathan; Mark Heckler; Gunnar Hillert; Mark Pollack; Patrick Peralta; Glenn Renfro; Thomas Risberg; Dave Syer; David Turanski; Janne Valkealahti; Benjamin Klein; Vinicius Carvalho; Gary Russell; Oleg Zhurakousky; Jay Bryant; Soby Chacko; Domenico Sibilio The reference documentation consists of the following sections: diff --git a/docs/modules/ROOT/pages/spring-cloud-stream.adoc b/docs/modules/ROOT/pages/spring-cloud-stream.adoc index d0b7e8250..11d9de194 100644 --- a/docs/modules/ROOT/pages/spring-cloud-stream.adoc +++ b/docs/modules/ROOT/pages/spring-cloud-stream.adoc @@ -1,7 +1,7 @@ -:nofooter: -:sectlinks: true - [[spring-cloud-stream-reference]] += Spring Cloud Stream Reference Documentation +:page-section-summary-toc: 1 + :doctype: book @@ -69,12 +69,5 @@ class BootTestStreamApplicationTests { == Main Concepts Spring Cloud Stream provides a number of abstractions and primitives that simplify the writing of message-driven microservice applications. -This section gives an overview of the following: - -* xref:spring-cloud-stream/overview-application-model.adoc[Spring Cloud Stream's application model] -* xref:spring-cloud-stream/overview-binder-abstraction.adoc[The Binder Abstraction] -* xref:spring-cloud-stream/overview-persistent-publish-subscribe-support.adoc[Persistent publish-subscribe support] -* xref:spring-cloud-stream/consumer-groups.adoc[Consumer group support] -* xref:spring-cloud-stream/overview-partitioning.adoc[Partitioning support] -* xref:spring-cloud-stream/overview-binder-api.adoc[A pluggable Binder SPI] +The rest of this reference manual provides additional details.