From e4de63c2ebfaef4d5ae2540b535b2818c110eb6d Mon Sep 17 00:00:00 2001 From: Glenn Renfro Date: Tue, 3 Jan 2023 16:16:57 -0500 Subject: [PATCH] Update architecture adoc so that its batch-asciidoc variable is set * Updated all docs that had `batch-asciidoc` declared to use attributes.adoc instead. This way we can set the variable in one location and all adocs can take advantage of it. * Also made sure that `batch-asciidoc` was set to use a relative path vs. the link in the UI. This is because the PDF can't use a URL that contains the `-` character. Resolves #4268 --- spring-batch-docs/src/main/asciidoc/appendix.adoc | 3 ++- spring-batch-docs/src/main/asciidoc/attributes.adoc | 1 + spring-batch-docs/src/main/asciidoc/common-patterns.adoc | 3 ++- spring-batch-docs/src/main/asciidoc/domain.adoc | 2 +- spring-batch-docs/src/main/asciidoc/header/index-header.adoc | 2 +- spring-batch-docs/src/main/asciidoc/job.adoc | 2 +- .../src/main/asciidoc/monitoring-and-metrics.adoc | 3 ++- spring-batch-docs/src/main/asciidoc/processor.adoc | 2 +- spring-batch-docs/src/main/asciidoc/readersAndWriters.adoc | 2 +- spring-batch-docs/src/main/asciidoc/repeat.adoc | 2 +- spring-batch-docs/src/main/asciidoc/retry.adoc | 2 +- spring-batch-docs/src/main/asciidoc/scalability.adoc | 2 +- spring-batch-docs/src/main/asciidoc/schema-appendix.adoc | 3 ++- .../src/main/asciidoc/spring-batch-architecture.adoc | 2 ++ .../src/main/asciidoc/spring-batch-integration.adoc | 2 +- spring-batch-docs/src/main/asciidoc/spring-batch-intro.adoc | 3 ++- spring-batch-docs/src/main/asciidoc/step.adoc | 2 +- spring-batch-docs/src/main/asciidoc/testing.adoc | 2 +- spring-batch-docs/src/main/asciidoc/transaction-appendix.adoc | 3 ++- spring-batch-docs/src/main/asciidoc/whatsnew.adoc | 3 ++- 20 files changed, 28 insertions(+), 18 deletions(-) create mode 100644 spring-batch-docs/src/main/asciidoc/attributes.adoc diff --git a/spring-batch-docs/src/main/asciidoc/appendix.adoc b/spring-batch-docs/src/main/asciidoc/appendix.adoc index 60cc0ed67..4b3f51ef2 100644 --- a/spring-batch-docs/src/main/asciidoc/appendix.adoc +++ b/spring-batch-docs/src/main/asciidoc/appendix.adoc @@ -1,8 +1,9 @@ -:batch-asciidoc: ./ :toc: left :toclevels: 4 [[listOfReadersAndWriters]] +include::attributes.adoc[] + [appendix] == List of ItemReaders and ItemWriters diff --git a/spring-batch-docs/src/main/asciidoc/attributes.adoc b/spring-batch-docs/src/main/asciidoc/attributes.adoc new file mode 100644 index 000000000..d09e0caf3 --- /dev/null +++ b/spring-batch-docs/src/main/asciidoc/attributes.adoc @@ -0,0 +1 @@ +:batch-asciidoc: ./ diff --git a/spring-batch-docs/src/main/asciidoc/common-patterns.adoc b/spring-batch-docs/src/main/asciidoc/common-patterns.adoc index 653b84789..f82484fdd 100644 --- a/spring-batch-docs/src/main/asciidoc/common-patterns.adoc +++ b/spring-batch-docs/src/main/asciidoc/common-patterns.adoc @@ -1,8 +1,9 @@ -:batch-asciidoc: ./ :toc: left :toclevels: 4 [[commonPatterns]] +include::attributes.adoc[] + == Common Batch Patterns ifndef::onlyonetoggle[] diff --git a/spring-batch-docs/src/main/asciidoc/domain.adoc b/spring-batch-docs/src/main/asciidoc/domain.adoc index faf9f372b..98984797c 100644 --- a/spring-batch-docs/src/main/asciidoc/domain.adoc +++ b/spring-batch-docs/src/main/asciidoc/domain.adoc @@ -1,10 +1,10 @@ -:batch-asciidoc: ./ :toc: left :toclevels: 4 [[domainLanguageOfBatch]] == The Domain Language of Batch +include::attributes.adoc[] ifndef::onlyonetoggle[] include::toggle.adoc[] endif::onlyonetoggle[] diff --git a/spring-batch-docs/src/main/asciidoc/header/index-header.adoc b/spring-batch-docs/src/main/asciidoc/header/index-header.adoc index ea5c0eb17..9f29dbc0d 100644 --- a/spring-batch-docs/src/main/asciidoc/header/index-header.adoc +++ b/spring-batch-docs/src/main/asciidoc/header/index-header.adoc @@ -1,3 +1,3 @@ = Spring Batch - Reference Documentation -:batch-asciidoc: https://docs.spring.io/spring-batch/docs/current/reference/html/ +include::../attributes.adoc[] diff --git a/spring-batch-docs/src/main/asciidoc/job.adoc b/spring-batch-docs/src/main/asciidoc/job.adoc index 68fbd7b0d..0959710d0 100644 --- a/spring-batch-docs/src/main/asciidoc/job.adoc +++ b/spring-batch-docs/src/main/asciidoc/job.adoc @@ -1,10 +1,10 @@ -:batch-asciidoc: ./ :toc: left :toclevels: 4 [[configureJob]] == Configuring and Running a Job +include::attributes.adoc[] ifndef::onlyonetoggle[] include::toggle.adoc[] endif::onlyonetoggle[] diff --git a/spring-batch-docs/src/main/asciidoc/monitoring-and-metrics.adoc b/spring-batch-docs/src/main/asciidoc/monitoring-and-metrics.adoc index b1afa9b6e..e583bba09 100644 --- a/spring-batch-docs/src/main/asciidoc/monitoring-and-metrics.adoc +++ b/spring-batch-docs/src/main/asciidoc/monitoring-and-metrics.adoc @@ -1,10 +1,11 @@ -:batch-asciidoc: ./ :toc: left :toclevels: 4 [[monitoring-and-metrics]] == Monitoring and metrics +include::attributes.adoc[] + Since version 4.2, Spring Batch provides support for batch monitoring and metrics based on link:$$https://micrometer.io/$$[Micrometer]. This section describes which metrics are provided out-of-the-box and how to contribute custom metrics. diff --git a/spring-batch-docs/src/main/asciidoc/processor.adoc b/spring-batch-docs/src/main/asciidoc/processor.adoc index 8d09424e2..2ab0d39e7 100644 --- a/spring-batch-docs/src/main/asciidoc/processor.adoc +++ b/spring-batch-docs/src/main/asciidoc/processor.adoc @@ -1,10 +1,10 @@ -:batch-asciidoc: ./ :toc: left :toclevels: 4 [[itemProcessor]] == Item processing +include::attributes.adoc[] ifndef::onlyonetoggle[] include::toggle.adoc[] endif::onlyonetoggle[] diff --git a/spring-batch-docs/src/main/asciidoc/readersAndWriters.adoc b/spring-batch-docs/src/main/asciidoc/readersAndWriters.adoc index 9db545568..c6cedf18f 100644 --- a/spring-batch-docs/src/main/asciidoc/readersAndWriters.adoc +++ b/spring-batch-docs/src/main/asciidoc/readersAndWriters.adoc @@ -1,10 +1,10 @@ -:batch-asciidoc: ./ :toc: left :toclevels: 4 [[readersAndWriters]] == ItemReaders and ItemWriters +include::attributes.adoc[] ifndef::onlyonetoggle[] include::toggle.adoc[] endif::onlyonetoggle[] diff --git a/spring-batch-docs/src/main/asciidoc/repeat.adoc b/spring-batch-docs/src/main/asciidoc/repeat.adoc index 747199c2a..8759d351a 100644 --- a/spring-batch-docs/src/main/asciidoc/repeat.adoc +++ b/spring-batch-docs/src/main/asciidoc/repeat.adoc @@ -1,4 +1,3 @@ -:batch-asciidoc: ./ :toc: left :toclevels: 4 @@ -6,6 +5,7 @@ == Repeat +include::attributes.adoc[] ifndef::onlyonetoggle[] include::toggle.adoc[] endif::onlyonetoggle[] diff --git a/spring-batch-docs/src/main/asciidoc/retry.adoc b/spring-batch-docs/src/main/asciidoc/retry.adoc index 6ad502908..bf0f68eb3 100644 --- a/spring-batch-docs/src/main/asciidoc/retry.adoc +++ b/spring-batch-docs/src/main/asciidoc/retry.adoc @@ -1,10 +1,10 @@ -:batch-asciidoc: ./ :toc: left :toclevels: 4 [[retry]] == Retry +include::attributes.adoc[] To make processing more robust and less prone to failure, it sometimes helps to automatically retry a failed operation in case it might succeed on a subsequent attempt. diff --git a/spring-batch-docs/src/main/asciidoc/scalability.adoc b/spring-batch-docs/src/main/asciidoc/scalability.adoc index f3f1b4e61..763095cec 100644 --- a/spring-batch-docs/src/main/asciidoc/scalability.adoc +++ b/spring-batch-docs/src/main/asciidoc/scalability.adoc @@ -1,4 +1,3 @@ -:batch-asciidoc: ./ :toc: left :toclevels: 4 @@ -6,6 +5,7 @@ == Scaling and Parallel Processing +include::attributes.adoc[] ifndef::onlyonetoggle[] include::toggle.adoc[] endif::onlyonetoggle[] diff --git a/spring-batch-docs/src/main/asciidoc/schema-appendix.adoc b/spring-batch-docs/src/main/asciidoc/schema-appendix.adoc index ac17c2c3e..1f38ea650 100644 --- a/spring-batch-docs/src/main/asciidoc/schema-appendix.adoc +++ b/spring-batch-docs/src/main/asciidoc/schema-appendix.adoc @@ -1,4 +1,3 @@ -:batch-asciidoc: ./ :toc: left :toclevels: 4 @@ -6,6 +5,8 @@ [appendix] == Meta-Data Schema +include::attributes.adoc[] + [[metaDataSchemaOverview]] === Overview diff --git a/spring-batch-docs/src/main/asciidoc/spring-batch-architecture.adoc b/spring-batch-docs/src/main/asciidoc/spring-batch-architecture.adoc index a1074edcf..b3d31d55f 100644 --- a/spring-batch-docs/src/main/asciidoc/spring-batch-architecture.adoc +++ b/spring-batch-docs/src/main/asciidoc/spring-batch-architecture.adoc @@ -1,6 +1,8 @@ [[springBatchArchitecture]] === Spring Batch Architecture +include::attributes.adoc[] + Spring Batch is designed with extensibility and a diverse group of end users in mind. The following image shows the layered architecture that supports the extensibility and ease of use for end-user developers. diff --git a/spring-batch-docs/src/main/asciidoc/spring-batch-integration.adoc b/spring-batch-docs/src/main/asciidoc/spring-batch-integration.adoc index acee4b961..4ed9eb533 100644 --- a/spring-batch-docs/src/main/asciidoc/spring-batch-integration.adoc +++ b/spring-batch-docs/src/main/asciidoc/spring-batch-integration.adoc @@ -1,10 +1,10 @@ -:batch-asciidoc: ./ :toc: left :toclevels: 4 [[springBatchIntegration]] == Spring Batch Integration +include::attributes.adoc[] ifndef::onlyonetoggle[] include::toggle.adoc[] endif::onlyonetoggle[] diff --git a/spring-batch-docs/src/main/asciidoc/spring-batch-intro.adoc b/spring-batch-docs/src/main/asciidoc/spring-batch-intro.adoc index 1e92b1306..5959155cb 100644 --- a/spring-batch-docs/src/main/asciidoc/spring-batch-intro.adoc +++ b/spring-batch-docs/src/main/asciidoc/spring-batch-intro.adoc @@ -1,7 +1,8 @@ -:batch-asciidoc: ./ :toc: left :toclevels: 4 +include::attributes.adoc[] + ifdef::backend-html5[] This documentation is also available as link:index.html[multiple HTML files] and as link:../pdf/spring-batch-reference.pdf[PDF] diff --git a/spring-batch-docs/src/main/asciidoc/step.adoc b/spring-batch-docs/src/main/asciidoc/step.adoc index a5f9896ac..479e6dc61 100644 --- a/spring-batch-docs/src/main/asciidoc/step.adoc +++ b/spring-batch-docs/src/main/asciidoc/step.adoc @@ -1,10 +1,10 @@ -:batch-asciidoc: ./ :toc: left :toclevels: 4 [[configureStep]] == Configuring a `Step` +include::attributes.adoc[] ifndef::onlyonetoggle[] include::toggle.adoc[] endif::onlyonetoggle[] diff --git a/spring-batch-docs/src/main/asciidoc/testing.adoc b/spring-batch-docs/src/main/asciidoc/testing.adoc index b786dc56b..8ab1bf0b7 100644 --- a/spring-batch-docs/src/main/asciidoc/testing.adoc +++ b/spring-batch-docs/src/main/asciidoc/testing.adoc @@ -1,10 +1,10 @@ -:batch-asciidoc: ./ :toc: left :toclevels: 4 [[testing]] == Unit Testing +include::attributes.adoc[] ifndef::onlyonetoggle[] include::toggle.adoc[] endif::onlyonetoggle[] diff --git a/spring-batch-docs/src/main/asciidoc/transaction-appendix.adoc b/spring-batch-docs/src/main/asciidoc/transaction-appendix.adoc index 4f9aa335c..4cbd030b3 100644 --- a/spring-batch-docs/src/main/asciidoc/transaction-appendix.adoc +++ b/spring-batch-docs/src/main/asciidoc/transaction-appendix.adoc @@ -1,4 +1,3 @@ -:batch-asciidoc: ./ :toc: left :toclevels: 4 @@ -6,6 +5,8 @@ [appendix] == Batch Processing and Transactions +include::attributes.adoc[] + [[transactionsNoRetry]] === Simple Batching with No Retry diff --git a/spring-batch-docs/src/main/asciidoc/whatsnew.adoc b/spring-batch-docs/src/main/asciidoc/whatsnew.adoc index 5f6ecbb8a..370b27230 100644 --- a/spring-batch-docs/src/main/asciidoc/whatsnew.adoc +++ b/spring-batch-docs/src/main/asciidoc/whatsnew.adoc @@ -1,4 +1,3 @@ -:batch-asciidoc: ./ :toc: left :toclevels: 4 @@ -9,6 +8,8 @@ please refer to the link:$$https://github.com/spring-projects/spring-batch/wiki/ [[whatsNew]] == What's New in Spring Batch 5.0 +include::attributes.adoc[] + Spring Batch 5.0 has the following major themes: * Java 17 Requirement