Docs cleanup

README.adoc

@@ -1 +1,52 @@
-== Stream applications 
+== 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]

applications/stream-applications-build/stream-applications-docs/README.md

@@ -1,2 +0,0 @@
-# docs
-app starter docs aggregator

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
 

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
 

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

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