Skip to content

Commit d6daf87

Browse files
committed
Update Antora reference documentation links
This commit updates the base URLs for reference documentations when the relevant Spring project is now being published with Antora. This commit updates the following projects: * Spring Framework * Spring Integration * Spring for GraphQL * Spring Security, including Authorization Server * Spring Batch * Spring Data JPA Closes gh-37428
1 parent e5faa54 commit d6daf87

File tree

3 files changed

+17
-17
lines changed

3 files changed

+17
-17
lines changed

spring-boot-project/spring-boot-docs/build.gradle

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -313,17 +313,17 @@ tasks.withType(org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask) {
313313
}
314314
doFirst {
315315
def versionConstraints = dependencyVersions.versionConstraints
316-
def securityVersion = versionConstraints["org.springframework.security:spring-security-core"]
317-
if (securityVersion.endsWith("-SNAPSHOT")) {
318-
securityVersion = securityVersion.substring(0, securityVersion.length() - "-SNAPSHOT".length())
316+
def toAntoraVersion = version -> {
317+
def formatted = version.split("\\.").take(2).join('.')
318+
return version.endsWith("-SNAPSHOT") ? formatted + "-SNAPSHOT" : formatted
319319
}
320320
attributes "hibernate-version": versionConstraints["org.hibernate.orm:hibernate-core"].split("\\.").take(2).join('.'),
321321
"jetty-version": versionConstraints["org.eclipse.jetty:jetty-server"],
322322
"jooq-version": versionConstraints["org.jooq:jooq"],
323323
"lettuce-version": versionConstraints["io.lettuce:lettuce-core"],
324324
"native-build-tools-version": nativeBuildToolsVersion,
325325
"spring-amqp-version": versionConstraints["org.springframework.amqp:spring-amqp"],
326-
"spring-batch-version": versionConstraints["org.springframework.batch:spring-batch-core"],
326+
"spring-batch-version": toAntoraVersion(versionConstraints["org.springframework.batch:spring-batch-core"]),
327327
"spring-boot-version": project.version,
328328
"spring-data-commons-version": versionConstraints["org.springframework.data:spring-data-commons"],
329329
"spring-data-couchbase-version": versionConstraints["org.springframework.data:spring-data-couchbase"],
@@ -334,13 +334,13 @@ tasks.withType(org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask) {
334334
"spring-data-neo4j-version": versionConstraints["org.springframework.data:spring-data-neo4j"],
335335
"spring-data-r2dbc-version": versionConstraints["org.springframework.data:spring-data-r2dbc"],
336336
"spring-data-rest-version": versionConstraints["org.springframework.data:spring-data-rest-core"],
337-
"spring-framework-version": versionConstraints["org.springframework:spring-core"],
338-
"spring-graphql-version": versionConstraints["org.springframework.graphql:spring-graphql"],
339-
"spring-integration-version": versionConstraints["org.springframework.integration:spring-integration-core"],
337+
"spring-framework-version": toAntoraVersion(versionConstraints["org.springframework:spring-core"]),
338+
"spring-graphql-version": toAntoraVersion(versionConstraints["org.springframework.graphql:spring-graphql"]),
339+
"spring-integration-version": toAntoraVersion(versionConstraints["org.springframework.integration:spring-integration-core"]),
340340
"spring-kafka-version": versionConstraints["org.springframework.kafka:spring-kafka"],
341341
"spring-pulsar-version": versionConstraints["org.springframework.pulsar:spring-pulsar"],
342-
"spring-security-version": securityVersion,
343-
"spring-authorization-server-version": versionConstraints["org.springframework.security:spring-security-oauth2-authorization-server"],
342+
"spring-security-version": toAntoraVersion(versionConstraints["org.springframework.security:spring-security-core"]),
343+
"spring-authorization-server-version": toAntoraVersion(versionConstraints["org.springframework.security:spring-security-oauth2-authorization-server"]),
344344
"spring-webservices-version": versionConstraints["org.springframework.ws:spring-ws-core"],
345345
"tomcat-version": tomcatVersion.split("\\.").take(2).join('.'),
346346
"remote-spring-application-output": runRemoteSpringApplicationExample.outputs.files.singleFile,

spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/metrics.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -870,7 +870,7 @@ See the {spring-batch-docs}monitoring-and-metrics.html[Spring Batch reference do
870870
[[actuator.metrics.supported.spring-graphql]]
871871
==== Spring GraphQL Metrics
872872

873-
See the {spring-graphql-docs}[Spring GraphQL reference documentation].
873+
See the {spring-graphql-docs}/observability.html[Spring GraphQL reference documentation].
874874

875875

876876

@@ -951,7 +951,7 @@ Auto-configuration enables the instrumentation of all available RabbitMQ connect
951951

952952
[[actuator.metrics.supported.spring-integration]]
953953
==== Spring Integration Metrics
954-
Spring Integration automatically provides {spring-integration-docs}system-management.html#micrometer-integration[Micrometer support] whenever a `MeterRegistry` bean is available.
954+
Spring Integration automatically provides {spring-integration-docs}metrics.html#micrometer-integration[Micrometer support] whenever a `MeterRegistry` bean is available.
955955
Metrics are published under the `spring.integration.` meter name.
956956

957957

spring-boot-project/spring-boot-docs/src/docs/asciidoc/attributes.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@
5656
:spring-amqp-api: https://docs.spring.io/spring-amqp/docs/{spring-amqp-version}/api/org/springframework/amqp
5757
:spring-batch: https://spring.io/projects/spring-batch
5858
:spring-batch-api: https://docs.spring.io/spring-batch/docs/{spring-batch-version}/api/org/springframework/batch
59-
:spring-batch-docs: https://docs.spring.io/spring-batch/docs/{spring-batch-version}/reference/html/
59+
:spring-batch-docs: https://docs.spring.io/spring-batch/reference/{spring-batch-version}/
6060
:spring-data: https://spring.io/projects/spring-data
6161
:spring-data-cassandra: https://spring.io/projects/spring-data-cassandra
6262
:spring-data-commons-api: https://docs.spring.io/spring-data/commons/docs/{spring-data-commons-version}/api/org/springframework/data
@@ -70,7 +70,7 @@
7070
:spring-data-geode: https://spring.io/projects/spring-data-geode
7171
:spring-data-jpa: https://spring.io/projects/spring-data-jpa
7272
:spring-data-jpa-api: https://docs.spring.io/spring-data/jpa/docs/{spring-data-jpa-version}/api/org/springframework/data/jpa
73-
:spring-data-jpa-docs: https://docs.spring.io/spring-data/jpa/docs/{spring-data-jpa-version}/reference/html
73+
:spring-data-jpa-docs: https://docs.spring.io/spring-data/jpa/reference/{spring-data-jpa-version}/
7474
:spring-data-jdbc-docs: https://docs.spring.io/spring-data/jdbc/docs/{spring-data-jdbc-version}/reference/html/
7575
:spring-data-ldap: https://spring.io/projects/spring-data-ldap
7676
:spring-data-mongodb: https://spring.io/projects/spring-data-mongodb
@@ -83,19 +83,19 @@
8383
:spring-data-rest-api: https://docs.spring.io/spring-data/rest/docs/{spring-data-rest-version}/api/org/springframework/data/rest
8484
:spring-framework: https://spring.io/projects/spring-framework
8585
:spring-framework-api: https://docs.spring.io/spring-framework/docs/{spring-framework-version}/javadoc-api/org/springframework
86-
:spring-framework-docs: https://docs.spring.io/spring-framework/docs/{spring-framework-version}/reference/html
86+
:spring-framework-docs: https://docs.spring.io/spring-framework/reference/{spring-framework-version}
8787
:spring-graphql: https://spring.io/projects/spring-graphql
8888
:spring-graphql-api: https://docs.spring.io/spring-graphql/docs/{spring-graphql-version}/api/
89-
:spring-graphql-docs: https://docs.spring.io/spring-graphql/docs/{spring-graphql-version}/reference/html/
89+
:spring-graphql-docs: https://docs.spring.io/spring-graphql/reference/{spring-graphql-version}/
9090
:spring-integration: https://spring.io/projects/spring-integration
91-
:spring-integration-docs: https://docs.spring.io/spring-integration/docs/{spring-integration-version}/reference/html/
91+
:spring-integration-docs: https://docs.spring.io/spring-integration/reference/{spring-integration-version}/
9292
:spring-kafka-docs: https://docs.spring.io/spring-kafka/docs/{spring-kafka-version}/reference/html/
9393
:spring-pulsar-docs: https://docs.spring.io/spring-pulsar/docs/{spring-pulsar-version}/reference/html/
9494
:spring-restdocs: https://spring.io/projects/spring-restdocs
9595
:spring-security: https://spring.io/projects/spring-security
9696
:spring-security-docs: https://docs.spring.io/spring-security/reference/{spring-security-version}
9797
:spring-authorization-server: https://spring.io/projects/spring-authorization-server
98-
:spring-authorization-server-docs: https://docs.spring.io/spring-authorization-server/docs/{spring-authorization-server-version}/reference/html
98+
:spring-authorization-server-docs: https://docs.spring.io/spring-authorization-server/reference/{spring-authorization-server-version}/
9999
:spring-session: https://spring.io/projects/spring-session
100100
:spring-webservices-docs: https://docs.spring.io/spring-ws/docs/{spring-webservices-version}/reference/html/
101101
:ant-docs: https://ant.apache.org/manual

0 commit comments

Comments
 (0)