From f54bda822106bdda1f32761ae132cc08bc3f0c72 Mon Sep 17 00:00:00 2001 From: Marcin Grzejszczak Date: Fri, 8 Sep 2023 16:32:25 +0200 Subject: [PATCH] Insert explicit ids for headers --- docs/modules/ROOT/pages/README.adoc | 6 ++++++ docs/modules/ROOT/pages/_configprops.adoc | 2 +- .../modules/ROOT/pages/appendix-task-repository-schema.adoc | 2 ++ docs/modules/ROOT/pages/batch-starter.adoc | 1 + docs/modules/ROOT/pages/batch.adoc | 2 ++ docs/modules/ROOT/pages/features.adoc | 3 +++ docs/modules/ROOT/pages/getting-started.adoc | 1 + docs/modules/ROOT/pages/preface.adoc | 1 + docs/modules/ROOT/pages/spring-cloud-task.adoc | 1 + docs/modules/ROOT/pages/stream.adoc | 3 +++ 10 files changed, 21 insertions(+), 1 deletion(-) diff --git a/docs/modules/ROOT/pages/README.adoc b/docs/modules/ROOT/pages/README.adoc index 2cb3623d..02130ce2 100644 --- a/docs/modules/ROOT/pages/README.adoc +++ b/docs/modules/ROOT/pages/README.adoc @@ -1,3 +1,4 @@ +[[spring-cloud-task]] = Spring Cloud Task Is a project centered around the idea of processing on demand. A user is able to develop @@ -5,10 +6,12 @@ a “task” that can be deployed, executed and removed on demand, yet the resul process persists beyond the life of the task for future reporting. +[[requirements:]] == Requirements: * Java 17 or Above +[[build-main-project:]] == Build Main Project: [source,shell,indent=2] @@ -16,6 +19,7 @@ process persists beyond the life of the task for future reporting. $ ./mvnw clean install ---- +[[example:]] == Example: [source,java,indent=2] @@ -43,9 +47,11 @@ public class MyApp { } ---- +[[code-of-conduct]] == Code of Conduct This project adheres to the Contributor Covenant link:CODE_OF_CONDUCT.adoc[code of conduct]. By participating, you are expected to uphold this code. Please report unacceptable behavior to spring-code-of-conduct@pivotal.io. +[[building-the-project]] == Building the Project This project requires that you invoke the Javadoc engine from the Maven command line. You can do so by appending `javadoc:aggregate` to the rest of your Maven command. diff --git a/docs/modules/ROOT/pages/_configprops.adoc b/docs/modules/ROOT/pages/_configprops.adoc index 9bf11375..418205de 100644 --- a/docs/modules/ROOT/pages/_configprops.adoc +++ b/docs/modules/ROOT/pages/_configprops.adoc @@ -41,4 +41,4 @@ |spring.cloud.task.single-instance-lock-ttl | | Declares the maximum amount of time (in millis) that a task execution can hold a lock to prevent another task from executing with a specific task name when the single-instance-enabled is set to true. Default time is: Integer.MAX_VALUE. |spring.cloud.task.table-prefix | `+++TASK_+++` | The prefix to append to the table names created by Spring Cloud Task. -|=== \ No newline at end of file +|=== diff --git a/docs/modules/ROOT/pages/appendix-task-repository-schema.adoc b/docs/modules/ROOT/pages/appendix-task-repository-schema.adoc index ce8096b3..6bbc90c0 100644 --- a/docs/modules/ROOT/pages/appendix-task-repository-schema.adoc +++ b/docs/modules/ROOT/pages/appendix-task-repository-schema.adoc @@ -8,6 +8,7 @@ This appendix provides an ERD for the database schema used in the task repositor image::task_schema.png[] +[[table-information]] === Table Information -- @@ -84,6 +85,7 @@ Used for the `single-instance-enabled` feature discussed < +[[enabling-observations-for-applicationrunner-and-commandlinerunner]] === Enabling Observations for ApplicationRunner and CommandLineRunner @@ -401,6 +403,7 @@ To Enable Task Observations for `ApplicationRunner` or `CommandLineRunner` set ` An example task application with observations enables using the `SimpleMeterRegistry` can be found https://github.com/spring-cloud/spring-cloud-task/tree/main/spring-cloud-task-samples/task-observations[here]. +[[disabling-spring-cloud-task-auto-configuration]] === Disabling Spring Cloud Task Auto Configuration In cases where Spring Cloud Task should not be autoconfigured for an implementation, you can disable Task's auto configuration. diff --git a/docs/modules/ROOT/pages/getting-started.adoc b/docs/modules/ROOT/pages/getting-started.adoc index f59cde28..ea82d698 100755 --- a/docs/modules/ROOT/pages/getting-started.adoc +++ b/docs/modules/ROOT/pages/getting-started.adoc @@ -23,6 +23,7 @@ environment. You need to have Java installed (Java 17 or better). To build, you need to have Maven installed as well. +[[database-requirements]] === Database Requirements Spring Cloud Task uses a relational database to store the results of an executed task. diff --git a/docs/modules/ROOT/pages/preface.adoc b/docs/modules/ROOT/pages/preface.adoc index 0c47f351..c63ee560 100644 --- a/docs/modules/ROOT/pages/preface.adoc +++ b/docs/modules/ROOT/pages/preface.adoc @@ -7,6 +7,7 @@ This section provides a brief overview of the Spring Cloud Task reference docume Think of it as a map for the rest of the document. You can read this reference guide in a linear fashion or you can skip sections if something does not interest you. +[[about-the-documentation]] == About the documentation The Spring Cloud Task reference guide is available in {spring-cloud-task-docs}[html] and {spring-cloud-task-docs}/index.pdf[pdf]. The latest copy is available at diff --git a/docs/modules/ROOT/pages/spring-cloud-task.adoc b/docs/modules/ROOT/pages/spring-cloud-task.adoc index 99c6585c..bb100b2b 100644 --- a/docs/modules/ROOT/pages/spring-cloud-task.adoc +++ b/docs/modules/ROOT/pages/spring-cloud-task.adoc @@ -1,3 +1,4 @@ +[[spring-cloud-task-reference-guide]] = Spring Cloud Task Reference Guide Michael Minella, Glenn Renfro, Jay Bryant diff --git a/docs/modules/ROOT/pages/stream.adoc b/docs/modules/ROOT/pages/stream.adoc index 28da2750..558af79f 100644 --- a/docs/modules/ROOT/pages/stream.adoc +++ b/docs/modules/ROOT/pages/stream.adoc @@ -162,6 +162,7 @@ NOTE: A sample batch event application can be found in the samples module of the Spring Cloud Task Project, https://github.com/spring-cloud/spring-cloud-task/tree/master/spring-cloud-task-samples/batch-events[here]. +[[sending-batch-events-to-different-channels]] === Sending Batch Events to Different Channels One of the options that Spring Cloud Task offers for batch events is the ability to alter @@ -174,6 +175,7 @@ following configuration: `spring.cloud.task.batch.events.step-execution-events-binding-name=my-step-execution-events` +[[disabling-batch-events]] === Disabling Batch Events To disable the listener functionality for all batch events, use the following configuration: @@ -197,6 +199,7 @@ spring.cloud.task.batch.events.item-write.enabled=false spring.cloud.task.batch.events.skip.enabled=false ---- +[[emit-order-for-batch-events]] === Emit Order for Batch Events By default, batch events have `Ordered.LOWEST_PRECEDENCE`. To change this value (for example, to 5 ), use the following configuration: