From 58796b7adc562fb4cc0e8c9f1be5eb61cab7ff76 Mon Sep 17 00:00:00 2001 From: Soby Chacko Date: Fri, 8 May 2020 13:55:18 -0400 Subject: [PATCH] Docs cleanup --- README.adoc | 53 ++++++++++++++++++- .../stream-applications-docs/README.md | 2 - .../src/main/asciidoc/index.adoc | 4 +- .../src/main/asciidoc/processors.adoc | 8 +-- .../src/main/asciidoc/sinks.adoc | 14 ++--- .../src/main/asciidoc/sources.adoc | 9 ++-- .../consumer/cassandra-consumer/.toDelete | 0 7 files changed, 69 insertions(+), 21 deletions(-) delete mode 100644 applications/stream-applications-build/stream-applications-docs/README.md delete mode 100644 functions/consumer/cassandra-consumer/.toDelete diff --git a/README.adoc b/README.adoc index a202629f..13ddd9e4 100644 --- a/README.adoc +++ b/README.adoc @@ -1 +1,52 @@ -== Stream applications \ No newline at end of file +== Stream applications + +This repository provides a collection of components that help with various data integration use cases. +It provides standalone Java functions that can be reusable in end-user applications. +Using these functions as a baseline, it already provides various out of the box Spring Cloud Stream applications that can be run standalone or to used on Spring Cloud Data Flow. +There are four major components in this repo. + +* Standalone Java Functions as java.util.function.Function/Consumer/Supplier +* Core components for out of the applications +* Out of the box Spring Cloud Stream applications as Source/Sink/Processor +* An aggregator for the out of the box applications. + +See the README files provided at the top of each of these components to learn more. + +=== Build + +You can build everything from the root of the repository. + +`./mvnw clean install` + +==== Building functions + +`./mvnw clean install -f functions` + +==== Building core for Stream Applications + +`./mvnw clean install -f applicaitons/stream-applications-core` + +Most likely, you might be interested in building a subset of the available components. +Let's assume that you want to build JDBC Source app based on Kafka Binder in Spring Cloud Stream and Log Sink based on Rabbit binder. +Here is what you need to do. +Assuming that you built both functions and stream-applications-core as above. + +``` +./mvnw clean package -f applications/source/jdbc-source +cd applications/source/jdbc-source/apps/jdbc-source-kafka +./mvnw clean package +``` + +This will generate the Kafka binder based uber jar in the target folder. + +Similarly for the log sink, do the following. + +``` +./mvnw clean package -f applications/sink/log-sink +cd applications/sink/log-sink/apps/log-sink-rabbit +./mvnw clean package +``` + +=== Code of Conduct + +Please see our https://github.com/spring-projects/.github/blob/master/CODE_OF_CONDUCT.md[Code of Conduct] \ No newline at end of file diff --git a/applications/stream-applications-build/stream-applications-docs/README.md b/applications/stream-applications-build/stream-applications-docs/README.md deleted file mode 100644 index 9ce4320c..00000000 --- a/applications/stream-applications-build/stream-applications-docs/README.md +++ /dev/null @@ -1,2 +0,0 @@ -# docs -app starter docs aggregator diff --git a/applications/stream-applications-build/stream-applications-docs/src/main/asciidoc/index.adoc b/applications/stream-applications-build/stream-applications-docs/src/main/asciidoc/index.adoc index 0dd752a2..af0ed286 100644 --- a/applications/stream-applications-build/stream-applications-docs/src/main/asciidoc/index.adoc +++ b/applications/stream-applications-build/stream-applications-docs/src/main/asciidoc/index.adoc @@ -9,11 +9,11 @@ Sabby Anandan; Artem Bilan; Marius Bogoevici; Eric Bottard; Mark Fisher; Ilayape :hide-uri-scheme: :docinfo: shared -:stream-apps-root: https://raw.githubusercontent.com/spring-cloud-stream-app-starters +:stream-apps-root: https://raw.githubusercontent.com/spring-cloud/stream-applications :branch: master -:stream-apps-asciidoc: https://raw.githubusercontent.com/spring-cloud-stream-app-starters/app-starters-release/master/spring-cloud-stream-app-starters-docs/src/main/asciidoc +:stream-apps-asciidoc: https://raw.githubusercontent.com/spring-cloud/stream-applications/master/applications/stream-applications-build/stream-applications-docs/src/main/asciidoc :scst-core-version: 3.0.3.RELEASE diff --git a/applications/stream-applications-build/stream-applications-docs/src/main/asciidoc/processors.adoc b/applications/stream-applications-build/stream-applications-docs/src/main/asciidoc/processors.adoc index a11c52da..76080ceb 100644 --- a/applications/stream-applications-build/stream-applications-docs/src/main/asciidoc/processors.adoc +++ b/applications/stream-applications-build/stream-applications-docs/src/main/asciidoc/processors.adoc @@ -1,14 +1,14 @@ -[[spring-cloud-stream-modules-processors]] +[[processors]] == Processors :leveloffset: +2 [[spring-cloud-stream-modules-filter]] -include::{stream-apps-root}/stream-applications/{branch}/processor/filter-processor/README.adoc[tags=ref-doc] +include::{stream-apps-root}/applications/{branch}/processor/filter-processor/README.adoc[tags=ref-doc] [[spring-cloud-stream-modules-splitter]] -include::{stream-apps-root}/stream-applications/{branch}/processor/splitter-processor/README.adoc[tags=ref-doc] +include::{stream-apps-root}/applications/{branch}/processor/splitter-processor/README.adoc[tags=ref-doc] [[spring-cloud-stream-modules-transform]] -include::{stream-apps-root}/stream-applications/{branch}/processor/transform-processor/README.adoc[tags=ref-doc] +include::{stream-apps-root}/applications/{branch}/processor/transform-processor/README.adoc[tags=ref-doc] :leveloffset: -2 diff --git a/applications/stream-applications-build/stream-applications-docs/src/main/asciidoc/sinks.adoc b/applications/stream-applications-build/stream-applications-docs/src/main/asciidoc/sinks.adoc index 17572625..b84bb4fe 100644 --- a/applications/stream-applications-build/stream-applications-docs/src/main/asciidoc/sinks.adoc +++ b/applications/stream-applications-build/stream-applications-docs/src/main/asciidoc/sinks.adoc @@ -1,19 +1,19 @@ -[[spring-cloud-stream-modules-sinks]] +[[sinks]] == Sinks :leveloffset: +2 [[spring-cloud-stream-modules-cassandra-sink]] -include::{stream-apps-root}/stream-applications/{branch}/sink/cassandra-sink/README.adoc[tags=ref-doc] +include::{stream-apps-root}/applications/{branch}/sink/cassandra-sink/README.adoc[tags=ref-doc] [[spring-cloud-stream-modules-counter-sink]] -include::{stream-apps-root}/stream-applications/{branch}/sink/counter-sink/README.adoc[tags=ref-doc] +include::{stream-apps-root}/applications/{branch}/sink/counter-sink/README.adoc[tags=ref-doc] [[spring-cloud-stream-modules-jdbc-sink]] -include::{stream-apps-root}/stream-applications/{branch}/sink/jdbc-sink/README.adoc[tags=ref-doc] +include::{stream-apps-root}/applications/{branch}/sink/jdbc-sink/README.adoc[tags=ref-doc] [[spring-cloud-stream-modules-log-sink]] -include::{stream-apps-root}/stream-applications/{branch}/sink/log-sink/README.adoc[tags=ref-doc] +include::{stream-apps-root}/applications/{branch}/sink/log-sink/README.adoc[tags=ref-doc] [[spring-cloud-stream-modules-mongodb-sink]] -include::{stream-apps-root}/stream-applications/{branch}/sink/mongodb-sink/README.adoc[tags=ref-doc] +include::{stream-apps-root}/applications/{branch}/sink/mongodb-sink/README.adoc[tags=ref-doc] [[spring-cloud-stream-modules-rabbit-sink]] -include::{stream-apps-root}/stream-applications/{branch}/sink/rabbit-sink/README.adoc[tags=ref-doc] +include::{stream-apps-root}/applications/{branch}/sink/rabbit-sink/README.adoc[tags=ref-doc] :leveloffset: -2 diff --git a/applications/stream-applications-build/stream-applications-docs/src/main/asciidoc/sources.adoc b/applications/stream-applications-build/stream-applications-docs/src/main/asciidoc/sources.adoc index 8743618c..100488a7 100644 --- a/applications/stream-applications-build/stream-applications-docs/src/main/asciidoc/sources.adoc +++ b/applications/stream-applications-build/stream-applications-docs/src/main/asciidoc/sources.adoc @@ -3,18 +3,17 @@ :leveloffset: +2 - [[spring-cloud-stream-modules-http-source]] -include::{stream-apps-root}/stream-applications/{branch}/source/http-source/README.adoc[tags=ref-doc] +include::{stream-apps-root}/applications/{branch}/source/http-source/README.adoc[tags=ref-doc] [[spring-cloud-stream-modules-jdbc-source]] -include::{stream-apps-root}/stream-applications/{branch}/source/jdbc-source/README.adoc[tags=ref-doc] +include::{stream-apps-root}/applications/{branch}/source/jdbc-source/README.adoc[tags=ref-doc] [[spring-cloud-stream-modules-mongodb-source]] -include::{stream-apps-root}/stream-applications/{branch}/source/mongodb-source/README.adoc[tags=ref-doc] +include::{stream-apps-root}/applications/{branch}/source/mongodb-source/README.adoc[tags=ref-doc] [[spring-cloud-stream-modules-time-source]] -include::{stream-apps-root}/stream-applications/{branch}/source/time-source/README.adoc[tags=ref-doc] +include::{stream-apps-root}/applications/{branch}/source/time-source/README.adoc[tags=ref-doc] :leveloffset: -2 diff --git a/functions/consumer/cassandra-consumer/.toDelete b/functions/consumer/cassandra-consumer/.toDelete deleted file mode 100644 index e69de29b..00000000