From 4e15838b7d069fc45837aa5cdf309d54c95d144b Mon Sep 17 00:00:00 2001 From: Marcin Grzejszczak Date: Fri, 8 Sep 2023 16:32:25 +0200 Subject: [PATCH] Fix cross references --- .../ROOT/pages/appendix-task-repository-schema.adoc | 6 +++--- docs/modules/ROOT/pages/batch.adoc | 4 ++-- docs/modules/ROOT/pages/features.adoc | 2 +- docs/modules/ROOT/pages/getting-started.adoc | 2 +- docs/modules/ROOT/pages/preface.adoc | 10 +++++----- 5 files changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/modules/ROOT/pages/appendix-task-repository-schema.adoc b/docs/modules/ROOT/pages/appendix-task-repository-schema.adoc index ffd91a7f..f5882b43 100644 --- a/docs/modules/ROOT/pages/appendix-task-repository-schema.adoc +++ b/docs/modules/ROOT/pages/appendix-task-repository-schema.adoc @@ -35,9 +35,9 @@ Spring Cloud Task Framework at app startup establishes the next available id as |LAST_UPDATED |TRUE | TIMESTAMP | X | Spring Cloud Task Framework at app startup establishes the value. Or if the record is created outside of task then the value must be populated at record creation time. -|EXTERNAL_EXECUTION_ID |FALSE | VARCHAR | 250 | If the `spring.cloud.task.external-execution-id` property is set then Spring Cloud Task Framework at app startup will set this to the value specified. More information can be found <> +|EXTERNAL_EXECUTION_ID |FALSE | VARCHAR | 250 | If the `spring.cloud.task.external-execution-id` property is set then Spring Cloud Task Framework at app startup will set this to the value specified. More information can be found xref:features.adoc#features-external_task_id[here] -|PARENT_TASK_EXECUTION_ID |FALSE |BIGINT | X | If the `spring.cloud.task.parent-execution-id` property is set then Spring Cloud Task Framework at app startup will set this to the value specified. More information can be found <> +|PARENT_TASK_EXECUTION_ID |FALSE |BIGINT | X | If the `spring.cloud.task.parent-execution-id` property is set then Spring Cloud Task Framework at app startup will set this to the value specified. More information can be found xref:features.adoc#features-parent_task_id[here] |========================================================= @@ -66,7 +66,7 @@ Used to link the task execution to the batch execution. .TASK_LOCK -Used for the `single-instance-enabled` feature discussed <>. +Used for the `single-instance-enabled` feature discussed xref:features.adoc#features-single-instance-enabled[here]. [width="80%", cols="1,1,1,1,10", options="header"] |========================================================= |Column Name |Required |Type | Field Length |Notes diff --git a/docs/modules/ROOT/pages/batch.adoc b/docs/modules/ROOT/pages/batch.adoc index 58b5e322..0347d753 100644 --- a/docs/modules/ROOT/pages/batch.adoc +++ b/docs/modules/ROOT/pages/batch.adoc @@ -192,12 +192,12 @@ Otherwise, an exception is thrown. == Batch Informational Messages Spring Cloud Task provides the ability for batch jobs to emit informational messages. The -"`<>`" section covers this feature in detail. +"`xref:stream.adoc#stream-integration-batch-events[Spring Batch Events]`" section covers this feature in detail. [[batch-failures-and-tasks]] == Batch Job Exit Codes -As discussed <>, Spring Cloud Task +As discussed xref:features.adoc#features-lifecycle-exit-codes[earlier], Spring Cloud Task applications support the ability to record the exit code of a task execution. However, in cases where you run a Spring Batch Job within a task, regardless of how the Batch Job Execution completes, the result of the task is always zero when using the default diff --git a/docs/modules/ROOT/pages/features.adoc b/docs/modules/ROOT/pages/features.adoc index cb1fe188..1fc9af7c 100644 --- a/docs/modules/ROOT/pages/features.adoc +++ b/docs/modules/ROOT/pages/features.adoc @@ -98,7 +98,7 @@ boot application. === Mapping Exit Codes When a task completes, it tries to return an exit code to the OS. If we take a look -at our <>, we can see that we are +at our xref:getting-started.adoc#getting-started-developing-first-task[original example], we can see that we are not controlling that aspect of our application. So, if an exception is thrown, the JVM returns a code that may or may not be of any use to you in debugging. diff --git a/docs/modules/ROOT/pages/getting-started.adoc b/docs/modules/ROOT/pages/getting-started.adoc index ea82d698..5142bb34 100755 --- a/docs/modules/ROOT/pages/getting-started.adoc +++ b/docs/modules/ROOT/pages/getting-started.adoc @@ -137,7 +137,7 @@ In our demo, the `TaskRepository` uses an embedded H2 database to record the res of a task. This H2 embedded database is not a practical solution for a production environment, since the H2 DB goes away once the task ends. However, for a quick getting-started experience, we can use this in our example as well as echoing to the logs what is being updated -in that repository. In the <> section (later in this +in that repository. In the xref:features.adoc#features-configuration[Configuration] section (later in this documentation), we cover how to customize the configuration of the pieces provided by Spring Cloud Task. diff --git a/docs/modules/ROOT/pages/preface.adoc b/docs/modules/ROOT/pages/preface.adoc index c63ee560..83fdf449 100644 --- a/docs/modules/ROOT/pages/preface.adoc +++ b/docs/modules/ROOT/pages/preface.adoc @@ -33,14 +33,14 @@ involved]. [[task-documentation-first-steps]] == First Steps If you are just getting started with Spring Cloud Task or with 'Spring' in general, we -suggesting reading the <> chapter. +suggesting reading the xref:getting-started.adoc[Getting started] chapter. To get started from scratch, read the following sections: -* <> -* <> + +* xref:getting-started.adoc#getting-started-introducing-spring-cloud-task[Introducing Spring Cloud Task] +* xref:getting-started.adoc#getting-started-system-requirements[System Requirements] + To follow the tutorial, read -<> + +xref:getting-started.adoc#getting-started-developing-first-task[Developing Your First Spring Cloud Task Application] + To run your example, read -<> +xref:getting-started.adoc#getting-started-running-the-example[Running the Example]