Skip to content

Commit 50bf00e

Browse files
committed
Various docs fixes
* Remove unused from now on assets * Fix `nav.adoc` order * Fix some typos in the docs * Fix links to SF docs on Antora * Modify Gradle build files according to tasks registration recommendations * Fix `antora.yml` removing `jvmargs` option since this cause the build failure on Windows
1 parent eb6ddfe commit 50bf00e

27 files changed

+75
-118
lines changed

build.gradle

+14-10
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ plugins {
2121
id 'org.ajoberstar.grgit' version '4.1.1'
2222
id 'io.spring.dependency-management' version '1.1.2'
2323
id 'com.jfrog.artifactory' version '4.33.1' apply false
24-
id 'org.jetbrains.dokka' version "1.8.20"
24+
id 'org.jetbrains.dokka' version '1.8.20'
2525
id 'org.antora' version '1.0.0'
2626
id 'io.spring.antora.generate-antora-yml' version '0.0.1'
2727
}
@@ -288,7 +288,7 @@ configure(javaProjects) { subproject ->
288288
ext.xLintArg = '-Xlint:all,-options,-processing'
289289
[compileJava, compileTestJava]*.options*.compilerArgs = [xLintArg, '-parameters']
290290

291-
task updateCopyrights {
291+
tasks.register('updateCopyrights') {
292292
onlyIf { !isCI }
293293
inputs.files(modifiedFiles.map(files -> files.filter { f -> f.path.contains(subproject.name) }))
294294
outputs.dir('build/classes')
@@ -338,7 +338,7 @@ configure(javaProjects) { subproject ->
338338
}
339339
}
340340

341-
task testAll(type: Test, dependsOn: ['check'])
341+
tasks.register('testAll', Test) { dependsOn['check'] }
342342

343343
gradle.taskGraph.whenReady { graph ->
344344
if (graph.hasTask(testAll)) {
@@ -390,7 +390,7 @@ configure(javaProjects) { subproject ->
390390
}
391391
}
392392

393-
task checkClasspathForConflicts {
393+
tasks.register('checkClasspathForConflicts') {
394394
onlyIf { isCI }
395395
inputs.files(configurations.runtimeClasspath)
396396

@@ -1170,7 +1170,7 @@ sonar {
11701170
}
11711171
}
11721172

1173-
task api(type: Javadoc) {
1173+
tasks.register('api', Javadoc) {
11741174
group = 'Documentation'
11751175
description = 'Generates aggregated Javadoc API documentation.'
11761176
title = "${rootProject.description} ${version} API"
@@ -1196,14 +1196,14 @@ task api(type: Javadoc) {
11961196
}
11971197

11981198
dokkaHtmlMultiModule {
1199-
dependsOn api
1199+
dependsOn 'api'
12001200
moduleName.set('spring-integration')
12011201
outputDirectory.set(file("$buildDir/kdoc"))
12021202
}
12031203

12041204
apply from: "${rootDir}/gradle/docs.gradle"
12051205

1206-
task schemaZip(type: Zip) {
1206+
tasks.register('schemaZip', Zip) {
12071207
group = 'Distribution'
12081208
archiveClassifier = 'schema'
12091209
description = "Builds -${archiveClassifier} archive containing all " +
@@ -1238,7 +1238,8 @@ task schemaZip(type: Zip) {
12381238
}
12391239
}
12401240

1241-
task docsZip(type: Zip, dependsOn: [dokkaHtmlMultiModule]) {
1241+
tasks.register('docsZip', Zip) {
1242+
dependsOn 'dokkaHtmlMultiModule'
12421243
group = 'Distribution'
12431244
archiveClassifier = 'docs'
12441245
description = "Builds -${archiveClassifier} archive containing api and reference " +
@@ -1257,7 +1258,9 @@ task docsZip(type: Zip, dependsOn: [dokkaHtmlMultiModule]) {
12571258
}
12581259
}
12591260

1260-
task distZip(type: Zip, dependsOn: [docsZip, schemaZip]) {
1261+
tasks.register('distZip', Zip) {
1262+
dependsOn 'docsZip'
1263+
dependsOn 'schemaZip'
12611264
group = 'Distribution'
12621265
archiveClassifier = 'dist'
12631266
description = "Builds -${archiveClassifier} archive, containing all jars and docs, " +
@@ -1299,7 +1302,8 @@ task distZip(type: Zip, dependsOn: [docsZip, schemaZip]) {
12991302
}
13001303
}
13011304

1302-
task dist(dependsOn: assemble) {
1305+
tasks.register('dist') {
1306+
dependsOn assemble
13031307
group = 'Distribution'
13041308
description = 'Builds -dist, -docs and -schema distribution archives.'
13051309
}

gradle/docs.gradle

+5-5
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,12 @@ tasks.named("generateAntoraYml") {
2323
baseAntoraYmlFile = file('src/reference/antora/antora.yml')
2424
}
2525

26-
tasks.create(name: 'createAntoraPartials', type: Sync) {
27-
from { tasks.filterMetricsDocsContent.outputs }
26+
tasks.register('createAntoraPartials', Sync) {
27+
from tasks.filterMetricsDocsContent.outputs
2828
into layout.buildDirectory.dir('generated-antora-resources/modules/ROOT/partials')
2929
}
3030

31-
tasks.create('generateAntoraResources') {
31+
tasks.register('generateAntoraResources') {
3232
dependsOn 'createAntoraPartials'
3333
dependsOn 'generateAntoraYml'
3434
}
@@ -44,15 +44,15 @@ dependencies {
4444
def observationInputDir = file('spring-integration-core/src/main/java/org/springframework/integration/support/management/observation').absolutePath
4545
def generatedDocsDir = file("$buildDir/reference/generated").absolutePath
4646

47-
task generateObservabilityDocs(type: JavaExec) {
47+
tasks.register('generateObservabilityDocs', JavaExec) {
4848
inputs.dir(observationInputDir)
4949
outputs.dir(generatedDocsDir)
5050
classpath configurations.micrometerDocs
5151
args observationInputDir, /.+/, generatedDocsDir
5252
mainClass = 'io.micrometer.docs.DocsGeneratorCommand'
5353
}
5454

55-
task filterMetricsDocsContent(type: Copy) {
55+
tasks.register('filterMetricsDocsContent', Copy) {
5656
dependsOn generateObservabilityDocs
5757
from generatedDocsDir
5858
include '_*.adoc'

src/reference/antora/antora.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ nav:
66
ext:
77
collector:
88
run:
9-
command: gradlew -q "-Dorg.gradle.jvmargs=-Xmx3g -XX:+HeapDumpOnOutOfMemoryError" :generateAntoraResources
9+
command: gradlew :generateAntoraResources
1010
local: true
1111
scan:
1212
dir: build/generated-antora-resources
Binary file not shown.

src/reference/antora/modules/ROOT/assets/images/epub-cover.svg

-14
This file was deleted.

src/reference/antora/modules/ROOT/nav.adoc

+18-18
Original file line numberDiff line numberDiff line change
@@ -159,6 +159,23 @@
159159
** xref:http/header-mapping.adoc[]
160160
** xref:http/int-graph-controller.adoc[]
161161
** xref:http/samples.adoc[]
162+
* xref:ip.adoc[]
163+
** xref:ip/intro.adoc[]
164+
** xref:ip/udp-adapters.adoc[]
165+
** xref:ip/tcp-connection-factories.adoc[]
166+
** xref:ip/testing-connections.adoc[]
167+
** xref:ip/interceptors.adoc[]
168+
** xref:ip/tcp-events.adoc[]
169+
** xref:ip/tcp-adapters.adoc[]
170+
** xref:ip/tcp-gateways.adoc[]
171+
** xref:ip/correlation.adoc[]
172+
** xref:ip/note-nio.adoc[]
173+
** xref:ip/ssl-tls.adoc[]
174+
** xref:ip/tcp-advanced-techniques.adoc[]
175+
** xref:ip/endpoint-reference.adoc[]
176+
** xref:ip/msg-headers.adoc[]
177+
** xref:ip/annotation.adoc[]
178+
** xref:ip/dsl.adoc[]
162179
* xref:jdbc.adoc[]
163180
** xref:jdbc/inbound-channel-adapter.adoc[]
164181
** xref:jdbc/outbound-channel-adapter.adoc[]
@@ -203,23 +220,6 @@
203220
* xref:stomp.adoc[]
204221
* xref:stream.adoc[]
205222
* xref:syslog.adoc[]
206-
* xref:ip.adoc[]
207-
** xref:ip/intro.adoc[]
208-
** xref:ip/udp-adapters.adoc[]
209-
** xref:ip/tcp-connection-factories.adoc[]
210-
** xref:ip/testing-connections.adoc[]
211-
** xref:ip/interceptors.adoc[]
212-
** xref:ip/tcp-events.adoc[]
213-
** xref:ip/tcp-adapters.adoc[]
214-
** xref:ip/tcp-gateways.adoc[]
215-
** xref:ip/correlation.adoc[]
216-
** xref:ip/note-nio.adoc[]
217-
** xref:ip/ssl-tls.adoc[]
218-
** xref:ip/tcp-advanced-techniques.adoc[]
219-
** xref:ip/endpoint-reference.adoc[]
220-
** xref:ip/msg-headers.adoc[]
221-
** xref:ip/annotation.adoc[]
222-
** xref:ip/dsl.adoc[]
223223
* xref:webflux.adoc[]
224224
* xref:web-sockets.adoc[]
225225
* xref:ws.adoc[]
@@ -235,6 +235,7 @@
235235
** xref:xml/validating-filter.adoc[]
236236
* xref:xmpp.adoc[]
237237
* xref:zeromq.adoc[]
238+
* xref:zip.adoc[]
238239
* xref:zookeeper.adoc[]
239240
* xref:error-handling.adoc[]
240241
* xref:spel.adoc[]
@@ -268,4 +269,3 @@
268269
** xref:changes-2.1-2.2.adoc[]
269270
** xref:changes-2.0-2.1.adoc[]
270271
** xref:changes-1.0-2.0.adoc[]
271-
* xref:zip.adoc[]

src/reference/antora/modules/ROOT/pages/event.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
= Spring `ApplicationEvent` Support
33

44
Spring Integration provides support for inbound and outbound `ApplicationEvents`, as defined by the underlying Spring Framework.
5-
For more information about Spring's support for events and listeners, see the https://docs.spring.io/spring/docs/current/spring-framework-reference/core.html#context-functionality-events[Spring Reference Manual].
5+
For more information about Spring's support for events and listeners, see the https://docs.spring.io/spring-framework/reference/core/beans/context-introduction.html#context-functionality-events[Spring Reference Manual].
66

77
You need to include this dependency into your project:
88

src/reference/antora/modules/ROOT/pages/index.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ xref:spel.adoc[Spring Expression Language (SpEL)] :: Details about SpEL support
7070
xref:message-publishing.adoc[Message Publishing] :: The Publisher annotation etc.
7171
xref:jms.adoc#jms-ob-transactions[Transaction Support] :: Overview of transactions support in Spring Integration
7272
xref:security.adoc[Security in Spring Integration] :: Securing Spring Integration flows
73-
xref:kafka.adoc#kafka-inbound-gateway-configurartion[Configuration] :: Messaging annotations, task scheduler, global properties, message mapping
73+
xref:kafka.adoc#kafka-inbound-gateway-configuration[Configuration] :: Messaging annotations, task scheduler, global properties, message mapping
7474
xref:testing.adoc[Testing support] :: Test utilities, Integration mocks and testing framework
7575
xref:samples.adoc#samples-impl[Spring Integration Samples] :: The samples dedicated project
7676
xref:resources.adoc[Additional Resources] :: Other resources related to project

src/reference/antora/modules/ROOT/pages/jms.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ The outbound channel adapter uses the `JmsTemplate` to convert and send a JMS me
3535

3636
By using `JmsTemplate` and the `MessageListener` container, Spring Integration relies on Spring's JMS support.
3737
This is important to understand, since most of the attributes exposed on these adapters configure the underlying `JmsTemplate` and `MessageListener` container.
38-
For more details about `JmsTemplate` and the `MessageListener` container, see the https://docs.spring.io/spring/docs/current/spring-framework-reference/html/jms.html[Spring JMS documentation].
38+
For more details about `JmsTemplate` and the `MessageListener` container, see the https://docs.spring.io/spring-framework/reference/integration/jms.html[Spring JMS documentation].
3939

4040
Whereas the JMS channel adapters are intended for unidirectional messaging (send-only or receive-only), Spring Integration also provides inbound and outbound JMS Gateways for request and reply operations.
4141
The inbound gateway relies on one of Spring's `MessageListener` container implementations for message-driven reception.
@@ -886,7 +886,7 @@ If configured properly, the JMS-backed message channel also supports transaction
886886
In other words, a producer would not actually write to a transactional JMS-backed channel if its send operation is part of a transaction that rolls back.
887887
Likewise, a consumer would not physically remove a JMS message from the channel if the reception of that message is part of a transaction that rolls back.
888888
Note that the producer and consumer transactions are separate in such a scenario.
889-
This is significantly different than the propagation of a transactional context across a simple, synchronous `<channel/>` element that has no `<queue/>` child element.
889+
This is significantly different from the propagation of a transactional context across a simple, synchronous `<channel/>` element that has no `<queue/>` child element.
890890

891891
Since the preceding example above references a JMS Queue instance, it acts as a point-to-point channel.
892892
If, on the other hand, you need publish-subscribe behavior, you can use a separate element and reference a JMS Topic instead.

src/reference/antora/modules/ROOT/pages/kafka.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -566,7 +566,7 @@ public IntegrationFlow outboundGateFlow() {
566566

567567
The inbound gateway is for request/reply operations.
568568

569-
[[kafka-inbound-gateway-configurartion]]
569+
[[kafka-inbound-gateway-configuration]]
570570
=== Configuration
571571

572572
The following example shows how to configure an inbound gateway:

src/reference/antora/modules/ROOT/pages/message-publishing.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -269,10 +269,10 @@ The following example shows how to an asynchronous `publishing-interceptor`:
269269
----
270270
<int:service-activator input-channel="inputChannel" output-channel="outputChannel" ref="sampleservice"/>
271271
272-
<bean id="sampleservice" class="test.SampleService"/>
272+
<bean id="sampleService" class="test.SampleService"/>
273273
274274
<aop:config>
275-
<aop:advisor advice-ref="interceptor" pointcut="bean(sampleservice)" />
275+
<aop:advisor advice-ref="interceptor" pointcut="bean(sampleService)" />
276276
</aop:config>
277277
278278
<int:publishing-interceptor id="interceptor" >

0 commit comments

Comments
 (0)