Updating documentation for 3.x release

Updated versions and links in docs

* Set the baseline to Java 17
* Update links

resolves #814
This commit is contained in:
Glenn Renfro
2022-01-14 14:29:36 -05:00
parent c353d68396
commit 45d7662fbc
17 changed files with 31 additions and 96 deletions

View File

@@ -10,11 +10,11 @@ This is a task application that emits batch job events to the following channels
* item-write-events
* skip-events
Note: More information on this topic is available https://docs.spring.io/spring-cloud-task/current-SNAPSHOT/reference/htmlsingle/#stream-integration-batch-events[here].
Note: More information on this topic is available https://docs.spring.io/spring-cloud-task/docs/current/reference/html/#stream-integration-batch-events[here].
== Requirements:
* Java 8 or Above
* Java 17 or Above
== Build:
@@ -27,15 +27,15 @@ $ ./mvnw clean install
[source,shell,indent=2]
----
$ java -jar target/batch-events-1.2.1.RELEASE.jar
$ java -jar target/batch-events-3.0.0.jar
----
For example you can listen for specific job execution events on a specified channel with a Spring Cloud Stream Sink
like the log sink using the following:
For example you can listen for specific job execution events on a specified channel with a Spring Cloud Stream Sink
like the https://github.com/spring-cloud/stream-applications/tree/main/applications/sink/log-sink[log sink] using the following:
[source,shell,indent=2]
----
$ java -jar <PATH_TO_LOG_SINK_JAR>/log-sink-rabbit-1.0.2.RELEASE.jar --server.port=9090
$ java -jar <PATH_TO_LOG_SINK_JAR>/log-sink-rabbit-3.1.1.jar --server.port=9090
--spring.cloud.stream.bindings.input.destination=job-execution-events
----

View File

@@ -4,7 +4,7 @@ This is a Spring Cloud Task application that executes two simple Spring Batch Jo
== Requirements:
* Java 8 or Above
* Java 17 or Above
== Classes:
@@ -22,5 +22,5 @@ $ mvn clean package
[source,shell,indent=2]
----
$ java -jar target/batch-job-1.2.1.RELEASE.jar
$ java -jar target/batch-job-3.0.0.jar
----

View File

@@ -5,7 +5,7 @@ a data store.
== Requirements:
* Java 8 or Above
* Java 17 or Above
== Classes:
@@ -24,5 +24,5 @@ $ mvn clean package
[source,shell,indent=2]
----
$ java -jar target/jpa-sample-1.2.1.RELEASE.jar
$ java -jar target/jpa-sample-3.0.0.jar
----

View File

@@ -5,7 +5,7 @@ which one to be used for the Spring Cloud Task repository.
== Requirements:
* Java 8 or Above
* Java 17 or Above
== Classes:
@@ -27,7 +27,7 @@ $ mvn clean package
[source,shell,indent=2]
----
$ java -jar target/multiple-datasources-2.3.0-RELEASE.jar
$ java -jar target/multiple-datasources-3.0.0.jar
----
== Execute sample using 2 external databases:

View File

@@ -5,7 +5,7 @@ An example of the usage of the `DeployerPartitionHandler` and
== Requirements:
* Java 7 or Above
* Java 17 or Above
== Build:
@@ -19,7 +19,7 @@ $ ./mvnw clean install
[source,shell,indent=2]
----
$ export SPRING_APPLICATION_JSON='{"spring":{"datasource":{"url":"jdbc:mysql://localhost:3306/<your database>","username":"<your username>","password":"<your password>","driverClassName":"org.mariadb.jdbc.Driver"}}}'
$ java -jar target/partitioned-batch-job-1.2.1.RELEASE.jar
$ java -jar target/partitioned-batch-job-3.0.0.jar
----
NOTE: This example will use require a MySql RDBMS repository and currently uses the mariadb jdbc driver to connect.

View File

@@ -15,7 +15,7 @@ The profiles that are available are:
== Requirements:
* Java 8 or Above
* Java 17 or Above
== Classes:
@@ -32,7 +32,7 @@ $ mvn clean package
[source,shell,indent=2]
----
$ java -jar target/single-step-batch-job-2.3.0-SNAPSHOT.jar --spring.config.name=<property file containing batch, reader, and writer properties>
$ java -jar target/single-step-batch-job-3.0.0-SNAPSHOT.jar --spring.config.name=<property file containing batch, reader, and writer properties>
----
== Examples

View File

@@ -4,7 +4,7 @@ This is a task application that emits events on a channel named `task-events`
== Requirements:
* Java 8 or Above
* Java 17 or Above
== Build:
@@ -17,15 +17,15 @@ $ ./mvnw clean install
[source,shell,indent=2]
----
$ java -jar target/task-events-1.2.1.RELEASE.jar
$ java -jar target/task-events-3.0.0.RELEASE.jar
----
You can listen for the events on the task-events channel with a Spring Cloud Stream Sink
like the log sink using the following:
like the https://github.com/spring-cloud/stream-applications/tree/main/applications/sink/log-sink[log sink] using the following:
[source,shell,indent=2]
----
$ java -jar <PATH_TO_LOG_SINK_JAR>/log-sink-rabbit-1.0.2.RELEASE.jar --server.port=9090 --spring.cloud.stream.bindings.input.destination=task-events
$ java -jar <PATH_TO_LOG_SINK_JAR>/log-sink-rabbit-3.1.1.jar --server.port=9090 --spring.cloud.stream.bindings.input.destination=task-events
----
== Dependencies:

View File

@@ -28,7 +28,7 @@ $ ./mvnw clean install
== Requirements:
* Java 7 or Above
* Java 17 or Above
== Build:

View File

@@ -5,7 +5,7 @@ launch the task that was specified in the request.
== Requirements:
* Java 7 or Above
* Java 17 or Above
== Build:

View File

@@ -4,7 +4,7 @@ This is a Spring Cloud Task application that logs a timestamp.
== Requirements:
* Java 8 or Above
* Java 17 or Above
== Classes:
@@ -22,5 +22,5 @@ $ mvn clean package
[source,shell,indent=2]
----
$ java -jar target/timestamp-task-1.1.0.RELEASE.jar
$ java -jar target/timestamp-task-3.0.0.jar
----