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
This commit is contained in:
Glenn Renfro
2023-01-03 16:16:57 -05:00
committed by Mahmoud Ben Hassine
parent 3a9e6e606c
commit e4de63c2eb
20 changed files with 28 additions and 18 deletions

View File

@@ -1,8 +1,9 @@
:batch-asciidoc: ./
:toc: left
:toclevels: 4
[[listOfReadersAndWriters]]
include::attributes.adoc[]
[appendix]
== List of ItemReaders and ItemWriters

View File

@@ -0,0 +1 @@
:batch-asciidoc: ./

View File

@@ -1,8 +1,9 @@
:batch-asciidoc: ./
:toc: left
:toclevels: 4
[[commonPatterns]]
include::attributes.adoc[]
== Common Batch Patterns
ifndef::onlyonetoggle[]

View File

@@ -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[]

View File

@@ -1,3 +1,3 @@
= Spring Batch - Reference Documentation
:batch-asciidoc: https://docs.spring.io/spring-batch/docs/current/reference/html/
include::../attributes.adoc[]

View File

@@ -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[]

View File

@@ -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.

View File

@@ -1,10 +1,10 @@
:batch-asciidoc: ./
:toc: left
:toclevels: 4
[[itemProcessor]]
== Item processing
include::attributes.adoc[]
ifndef::onlyonetoggle[]
include::toggle.adoc[]
endif::onlyonetoggle[]

View File

@@ -1,10 +1,10 @@
:batch-asciidoc: ./
:toc: left
:toclevels: 4
[[readersAndWriters]]
== ItemReaders and ItemWriters
include::attributes.adoc[]
ifndef::onlyonetoggle[]
include::toggle.adoc[]
endif::onlyonetoggle[]

View File

@@ -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[]

View File

@@ -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.

View File

@@ -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[]

View File

@@ -1,4 +1,3 @@
:batch-asciidoc: ./
:toc: left
:toclevels: 4
@@ -6,6 +5,8 @@
[appendix]
== Meta-Data Schema
include::attributes.adoc[]
[[metaDataSchemaOverview]]
=== Overview

View File

@@ -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.

View File

@@ -1,10 +1,10 @@
:batch-asciidoc: ./
:toc: left
:toclevels: 4
[[springBatchIntegration]]
== Spring Batch Integration
include::attributes.adoc[]
ifndef::onlyonetoggle[]
include::toggle.adoc[]
endif::onlyonetoggle[]

View File

@@ -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]

View File

@@ -1,10 +1,10 @@
:batch-asciidoc: ./
:toc: left
:toclevels: 4
[[configureStep]]
== Configuring a `Step`
include::attributes.adoc[]
ifndef::onlyonetoggle[]
include::toggle.adoc[]
endif::onlyonetoggle[]

View File

@@ -1,10 +1,10 @@
:batch-asciidoc: ./
:toc: left
:toclevels: 4
[[testing]]
== Unit Testing
include::attributes.adoc[]
ifndef::onlyonetoggle[]
include::toggle.adoc[]
endif::onlyonetoggle[]

View File

@@ -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

View File

@@ -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