Skip to content

Commit e4de63c

Browse files
cppwfsfmbenhassine
authored andcommitted
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
1 parent 3a9e6e6 commit e4de63c

20 files changed

+28
-18
lines changed

spring-batch-docs/src/main/asciidoc/appendix.adoc

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
1-
:batch-asciidoc: ./
21
:toc: left
32
:toclevels: 4
43

54
[[listOfReadersAndWriters]]
5+
include::attributes.adoc[]
6+
67
[appendix]
78
== List of ItemReaders and ItemWriters
89

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
:batch-asciidoc: ./

spring-batch-docs/src/main/asciidoc/common-patterns.adoc

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
1-
:batch-asciidoc: ./
21
:toc: left
32
:toclevels: 4
43

54
[[commonPatterns]]
5+
include::attributes.adoc[]
6+
67
== Common Batch Patterns
78

89
ifndef::onlyonetoggle[]

spring-batch-docs/src/main/asciidoc/domain.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
:batch-asciidoc: ./
21
:toc: left
32
:toclevels: 4
43

54
[[domainLanguageOfBatch]]
65
== The Domain Language of Batch
76

7+
include::attributes.adoc[]
88
ifndef::onlyonetoggle[]
99
include::toggle.adoc[]
1010
endif::onlyonetoggle[]
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
= Spring Batch - Reference Documentation
22

3-
:batch-asciidoc: https://docs.spring.io/spring-batch/docs/current/reference/html/
3+
include::../attributes.adoc[]

spring-batch-docs/src/main/asciidoc/job.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
:batch-asciidoc: ./
21
:toc: left
32
:toclevels: 4
43

54
[[configureJob]]
65
== Configuring and Running a Job
76

7+
include::attributes.adoc[]
88
ifndef::onlyonetoggle[]
99
include::toggle.adoc[]
1010
endif::onlyonetoggle[]

spring-batch-docs/src/main/asciidoc/monitoring-and-metrics.adoc

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
1-
:batch-asciidoc: ./
21
:toc: left
32
:toclevels: 4
43

54
[[monitoring-and-metrics]]
65
== Monitoring and metrics
76

7+
include::attributes.adoc[]
8+
89
Since version 4.2, Spring Batch provides support for batch monitoring and metrics
910
based on link:$$https://micrometer.io/$$[Micrometer]. This section describes
1011
which metrics are provided out-of-the-box and how to contribute custom metrics.

spring-batch-docs/src/main/asciidoc/processor.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
:batch-asciidoc: ./
21
:toc: left
32
:toclevels: 4
43

54
[[itemProcessor]]
65
== Item processing
76

7+
include::attributes.adoc[]
88
ifndef::onlyonetoggle[]
99
include::toggle.adoc[]
1010
endif::onlyonetoggle[]

spring-batch-docs/src/main/asciidoc/readersAndWriters.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
:batch-asciidoc: ./
21
:toc: left
32
:toclevels: 4
43

54
[[readersAndWriters]]
65
== ItemReaders and ItemWriters
76

7+
include::attributes.adoc[]
88
ifndef::onlyonetoggle[]
99
include::toggle.adoc[]
1010
endif::onlyonetoggle[]

spring-batch-docs/src/main/asciidoc/repeat.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
:batch-asciidoc: ./
21
:toc: left
32
:toclevels: 4
43

54
[[repeat]]
65

76
== Repeat
87

8+
include::attributes.adoc[]
99
ifndef::onlyonetoggle[]
1010
include::toggle.adoc[]
1111
endif::onlyonetoggle[]

spring-batch-docs/src/main/asciidoc/retry.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
:batch-asciidoc: ./
21
:toc: left
32
:toclevels: 4
43

54
[[retry]]
65

76
== Retry
7+
include::attributes.adoc[]
88

99
To make processing more robust and less prone to failure, it sometimes helps to
1010
automatically retry a failed operation in case it might succeed on a subsequent attempt.

spring-batch-docs/src/main/asciidoc/scalability.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
:batch-asciidoc: ./
21
:toc: left
32
:toclevels: 4
43

54
[[scalability]]
65

76
== Scaling and Parallel Processing
87

8+
include::attributes.adoc[]
99
ifndef::onlyonetoggle[]
1010
include::toggle.adoc[]
1111
endif::onlyonetoggle[]

spring-batch-docs/src/main/asciidoc/schema-appendix.adoc

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
1-
:batch-asciidoc: ./
21
:toc: left
32
:toclevels: 4
43

54
[[metaDataSchema]]
65
[appendix]
76
== Meta-Data Schema
87

8+
include::attributes.adoc[]
9+
910
[[metaDataSchemaOverview]]
1011
=== Overview
1112

spring-batch-docs/src/main/asciidoc/spring-batch-architecture.adoc

+2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
[[springBatchArchitecture]]
22
=== Spring Batch Architecture
33

4+
include::attributes.adoc[]
5+
46
Spring Batch is designed with extensibility and a diverse group of end users in mind. The
57
following image shows the layered architecture that supports the extensibility and ease of
68
use for end-user developers.

spring-batch-docs/src/main/asciidoc/spring-batch-integration.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
:batch-asciidoc: ./
21
:toc: left
32
:toclevels: 4
43

54
[[springBatchIntegration]]
65
== Spring Batch Integration
76

7+
include::attributes.adoc[]
88
ifndef::onlyonetoggle[]
99
include::toggle.adoc[]
1010
endif::onlyonetoggle[]

spring-batch-docs/src/main/asciidoc/spring-batch-intro.adoc

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
:batch-asciidoc: ./
21
:toc: left
32
:toclevels: 4
43

4+
include::attributes.adoc[]
5+
56
ifdef::backend-html5[]
67
This documentation is also available
78
as link:index.html[multiple HTML files] and as link:../pdf/spring-batch-reference.pdf[PDF]

spring-batch-docs/src/main/asciidoc/step.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
:batch-asciidoc: ./
21
:toc: left
32
:toclevels: 4
43

54
[[configureStep]]
65
== Configuring a `Step`
76

7+
include::attributes.adoc[]
88
ifndef::onlyonetoggle[]
99
include::toggle.adoc[]
1010
endif::onlyonetoggle[]

spring-batch-docs/src/main/asciidoc/testing.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
:batch-asciidoc: ./
21
:toc: left
32
:toclevels: 4
43

54
[[testing]]
65
== Unit Testing
76

7+
include::attributes.adoc[]
88
ifndef::onlyonetoggle[]
99
include::toggle.adoc[]
1010
endif::onlyonetoggle[]

spring-batch-docs/src/main/asciidoc/transaction-appendix.adoc

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
1-
:batch-asciidoc: ./
21
:toc: left
32
:toclevels: 4
43

54
[[transactions]]
65
[appendix]
76
== Batch Processing and Transactions
87

8+
include::attributes.adoc[]
9+
910
[[transactionsNoRetry]]
1011
=== Simple Batching with No Retry
1112

spring-batch-docs/src/main/asciidoc/whatsnew.adoc

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
:batch-asciidoc: ./
21
:toc: left
32
:toclevels: 4
43

@@ -9,6 +8,8 @@ please refer to the link:$$https://github.com/spring-projects/spring-batch/wiki/
98
[[whatsNew]]
109
== What's New in Spring Batch 5.0
1110

11+
include::attributes.adoc[]
12+
1213
Spring Batch 5.0 has the following major themes:
1314

1415
* Java 17 Requirement

0 commit comments

Comments
 (0)