From d6daf870748a5a997f4be3631f39d8b767637d64 Mon Sep 17 00:00:00 2001 From: Brian Clozel Date: Fri, 15 Sep 2023 15:53:27 +0200 Subject: [PATCH] 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 --- .../spring-boot-docs/build.gradle | 18 +++++++++--------- .../src/docs/asciidoc/actuator/metrics.adoc | 4 ++-- .../src/docs/asciidoc/attributes.adoc | 12 ++++++------ 3 files changed, 17 insertions(+), 17 deletions(-) diff --git a/spring-boot-project/spring-boot-docs/build.gradle b/spring-boot-project/spring-boot-docs/build.gradle index 0a92048ce5..818d34df17 100644 --- a/spring-boot-project/spring-boot-docs/build.gradle +++ b/spring-boot-project/spring-boot-docs/build.gradle @@ -313,9 +313,9 @@ tasks.withType(org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask) { } doFirst { def versionConstraints = dependencyVersions.versionConstraints - def securityVersion = versionConstraints["org.springframework.security:spring-security-core"] - if (securityVersion.endsWith("-SNAPSHOT")) { - securityVersion = securityVersion.substring(0, securityVersion.length() - "-SNAPSHOT".length()) + def toAntoraVersion = version -> { + def formatted = version.split("\\.").take(2).join('.') + return version.endsWith("-SNAPSHOT") ? formatted + "-SNAPSHOT" : formatted } attributes "hibernate-version": versionConstraints["org.hibernate.orm:hibernate-core"].split("\\.").take(2).join('.'), "jetty-version": versionConstraints["org.eclipse.jetty:jetty-server"], @@ -323,7 +323,7 @@ tasks.withType(org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask) { "lettuce-version": versionConstraints["io.lettuce:lettuce-core"], "native-build-tools-version": nativeBuildToolsVersion, "spring-amqp-version": versionConstraints["org.springframework.amqp:spring-amqp"], - "spring-batch-version": versionConstraints["org.springframework.batch:spring-batch-core"], + "spring-batch-version": toAntoraVersion(versionConstraints["org.springframework.batch:spring-batch-core"]), "spring-boot-version": project.version, "spring-data-commons-version": versionConstraints["org.springframework.data:spring-data-commons"], "spring-data-couchbase-version": versionConstraints["org.springframework.data:spring-data-couchbase"], @@ -334,13 +334,13 @@ tasks.withType(org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask) { "spring-data-neo4j-version": versionConstraints["org.springframework.data:spring-data-neo4j"], "spring-data-r2dbc-version": versionConstraints["org.springframework.data:spring-data-r2dbc"], "spring-data-rest-version": versionConstraints["org.springframework.data:spring-data-rest-core"], - "spring-framework-version": versionConstraints["org.springframework:spring-core"], - "spring-graphql-version": versionConstraints["org.springframework.graphql:spring-graphql"], - "spring-integration-version": versionConstraints["org.springframework.integration:spring-integration-core"], + "spring-framework-version": toAntoraVersion(versionConstraints["org.springframework:spring-core"]), + "spring-graphql-version": toAntoraVersion(versionConstraints["org.springframework.graphql:spring-graphql"]), + "spring-integration-version": toAntoraVersion(versionConstraints["org.springframework.integration:spring-integration-core"]), "spring-kafka-version": versionConstraints["org.springframework.kafka:spring-kafka"], "spring-pulsar-version": versionConstraints["org.springframework.pulsar:spring-pulsar"], - "spring-security-version": securityVersion, - "spring-authorization-server-version": versionConstraints["org.springframework.security:spring-security-oauth2-authorization-server"], + "spring-security-version": toAntoraVersion(versionConstraints["org.springframework.security:spring-security-core"]), + "spring-authorization-server-version": toAntoraVersion(versionConstraints["org.springframework.security:spring-security-oauth2-authorization-server"]), "spring-webservices-version": versionConstraints["org.springframework.ws:spring-ws-core"], "tomcat-version": tomcatVersion.split("\\.").take(2).join('.'), "remote-spring-application-output": runRemoteSpringApplicationExample.outputs.files.singleFile, diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/metrics.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/metrics.adoc index 96d671570b..853ca9dc4b 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/metrics.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/metrics.adoc @@ -870,7 +870,7 @@ See the {spring-batch-docs}monitoring-and-metrics.html[Spring Batch reference do [[actuator.metrics.supported.spring-graphql]] ==== Spring GraphQL Metrics -See the {spring-graphql-docs}[Spring GraphQL reference documentation]. +See the {spring-graphql-docs}/observability.html[Spring GraphQL reference documentation]. @@ -951,7 +951,7 @@ Auto-configuration enables the instrumentation of all available RabbitMQ connect [[actuator.metrics.supported.spring-integration]] ==== Spring Integration Metrics -Spring Integration automatically provides {spring-integration-docs}system-management.html#micrometer-integration[Micrometer support] whenever a `MeterRegistry` bean is available. +Spring Integration automatically provides {spring-integration-docs}metrics.html#micrometer-integration[Micrometer support] whenever a `MeterRegistry` bean is available. Metrics are published under the `spring.integration.` meter name. diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/attributes.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/attributes.adoc index f8aab54bfd..92a2374e94 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/attributes.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/attributes.adoc @@ -56,7 +56,7 @@ :spring-amqp-api: https://docs.spring.io/spring-amqp/docs/{spring-amqp-version}/api/org/springframework/amqp :spring-batch: https://spring.io/projects/spring-batch :spring-batch-api: https://docs.spring.io/spring-batch/docs/{spring-batch-version}/api/org/springframework/batch -:spring-batch-docs: https://docs.spring.io/spring-batch/docs/{spring-batch-version}/reference/html/ +:spring-batch-docs: https://docs.spring.io/spring-batch/reference/{spring-batch-version}/ :spring-data: https://spring.io/projects/spring-data :spring-data-cassandra: https://spring.io/projects/spring-data-cassandra :spring-data-commons-api: https://docs.spring.io/spring-data/commons/docs/{spring-data-commons-version}/api/org/springframework/data @@ -70,7 +70,7 @@ :spring-data-geode: https://spring.io/projects/spring-data-geode :spring-data-jpa: https://spring.io/projects/spring-data-jpa :spring-data-jpa-api: https://docs.spring.io/spring-data/jpa/docs/{spring-data-jpa-version}/api/org/springframework/data/jpa -:spring-data-jpa-docs: https://docs.spring.io/spring-data/jpa/docs/{spring-data-jpa-version}/reference/html +:spring-data-jpa-docs: https://docs.spring.io/spring-data/jpa/reference/{spring-data-jpa-version}/ :spring-data-jdbc-docs: https://docs.spring.io/spring-data/jdbc/docs/{spring-data-jdbc-version}/reference/html/ :spring-data-ldap: https://spring.io/projects/spring-data-ldap :spring-data-mongodb: https://spring.io/projects/spring-data-mongodb @@ -83,19 +83,19 @@ :spring-data-rest-api: https://docs.spring.io/spring-data/rest/docs/{spring-data-rest-version}/api/org/springframework/data/rest :spring-framework: https://spring.io/projects/spring-framework :spring-framework-api: https://docs.spring.io/spring-framework/docs/{spring-framework-version}/javadoc-api/org/springframework -:spring-framework-docs: https://docs.spring.io/spring-framework/docs/{spring-framework-version}/reference/html +:spring-framework-docs: https://docs.spring.io/spring-framework/reference/{spring-framework-version} :spring-graphql: https://spring.io/projects/spring-graphql :spring-graphql-api: https://docs.spring.io/spring-graphql/docs/{spring-graphql-version}/api/ -:spring-graphql-docs: https://docs.spring.io/spring-graphql/docs/{spring-graphql-version}/reference/html/ +:spring-graphql-docs: https://docs.spring.io/spring-graphql/reference/{spring-graphql-version}/ :spring-integration: https://spring.io/projects/spring-integration -:spring-integration-docs: https://docs.spring.io/spring-integration/docs/{spring-integration-version}/reference/html/ +:spring-integration-docs: https://docs.spring.io/spring-integration/reference/{spring-integration-version}/ :spring-kafka-docs: https://docs.spring.io/spring-kafka/docs/{spring-kafka-version}/reference/html/ :spring-pulsar-docs: https://docs.spring.io/spring-pulsar/docs/{spring-pulsar-version}/reference/html/ :spring-restdocs: https://spring.io/projects/spring-restdocs :spring-security: https://spring.io/projects/spring-security :spring-security-docs: https://docs.spring.io/spring-security/reference/{spring-security-version} :spring-authorization-server: https://spring.io/projects/spring-authorization-server -:spring-authorization-server-docs: https://docs.spring.io/spring-authorization-server/docs/{spring-authorization-server-version}/reference/html +:spring-authorization-server-docs: https://docs.spring.io/spring-authorization-server/reference/{spring-authorization-server-version}/ :spring-session: https://spring.io/projects/spring-session :spring-webservices-docs: https://docs.spring.io/spring-ws/docs/{spring-webservices-version}/reference/html/ :ant-docs: https://ant.apache.org/manual