From 1a25bdba05b5ce9abff4169bc9ca63f4dfcd81e4 Mon Sep 17 00:00:00 2001 From: Mark Paluch Date: Thu, 14 Aug 2025 16:37:48 +0200 Subject: [PATCH] Polishing. Refine documentation links. See #2094 --- .../modules/ROOT/partials/id-generation.adoc | 2 +- .../modules/ROOT/partials/optimistic-locking.adoc | 2 +- .../antora/resources/antora-resources/antora.yml | 15 ++++++++------- 3 files changed, 10 insertions(+), 9 deletions(-) diff --git a/src/main/antora/modules/ROOT/partials/id-generation.adoc b/src/main/antora/modules/ROOT/partials/id-generation.adoc index 52befaf7f..9011804d3 100644 --- a/src/main/antora/modules/ROOT/partials/id-generation.adoc +++ b/src/main/antora/modules/ROOT/partials/id-generation.adoc @@ -3,7 +3,7 @@ Spring Data uses identifier properties to identify entities. That is, looking these up or creating statements targeting a particular row. -The ID of an entity must be annotated with Spring Data's https://docs.spring.io/spring-data/commons/docs/current/api/org/springframework/data/annotation/Id.html[`@Id`] annotation. +The ID of an entity must be annotated with Spring Data's {spring-data-commons-javadoc-base}/org/springframework/data/annotation/Id.html[`@Id`] annotation. When your database has an auto-increment column for the ID column, the generated value gets set in the entity after inserting it into the database. diff --git a/src/main/antora/modules/ROOT/partials/optimistic-locking.adoc b/src/main/antora/modules/ROOT/partials/optimistic-locking.adoc index 5819ce417..2ba4faeb6 100644 --- a/src/main/antora/modules/ROOT/partials/optimistic-locking.adoc +++ b/src/main/antora/modules/ROOT/partials/optimistic-locking.adoc @@ -1,5 +1,5 @@ Spring Data supports optimistic locking by means of a numeric attribute that is annotated with -https://docs.spring.io/spring-data/commons/docs/current/api/org/springframework/data/annotation/Version.html[`@Version`] on the aggregate root. +{spring-data-commons-javadoc-base}/org/springframework/data/annotation/Version.html[`@Version`] on the aggregate root. Whenever Spring Data saves an aggregate with such a version attribute two things happen: * The update statement for the aggregate root will contain a where clause checking that the version stored in the database is actually unchanged. diff --git a/src/main/antora/resources/antora-resources/antora.yml b/src/main/antora/resources/antora-resources/antora.yml index b4c60f697..44ac0f3c6 100644 --- a/src/main/antora/resources/antora-resources/antora.yml +++ b/src/main/antora/resources/antora-resources/antora.yml @@ -3,20 +3,21 @@ prerelease: ${antora-component.prerelease} asciidoc: attributes: - copyright-year: ${current.year} + attribute-missing: 'warn' + chomp: 'all' version: ${project.version} + copyright-year: ${current.year} springversionshort: ${spring.short} springversion: ${spring} - attribute-missing: 'warn' commons: ${springdata.commons.docs} include-xml-namespaces: false - spring-data-commons-docs-url: https://docs.spring.io/spring-data/commons/reference - spring-data-commons-javadoc-base: https://docs.spring.io/spring-data/commons/docs/${springdata.commons}/api/ - spring-data-jdbc-javadoc: https://docs.spring.io/spring-data/jdbc/docs/${version}/api/ - spring-data-r2dbc-javadoc: https://docs.spring.io/spring-data/r2dbc/docs/${version}/api/ + spring-data-commons-docs-url: https://docs.spring.io/spring-data/commons/reference/{commons} + spring-data-commons-javadoc-base: '{spring-data-commons-docs-url}/api/java' + spring-data-jdbc-javadoc: https://docs.spring.io/spring-data/relational/reference/{version}/api/java + spring-data-r2dbc-javadoc: '{spring-data-jdbc-javadoc}' springdocsurl: https://docs.spring.io/spring-framework/reference/{springversionshort} - springjavadocurl: https://docs.spring.io/spring-framework/docs/${spring}/javadoc-api spring-framework-docs: '{springdocsurl}' + springjavadocurl: https://docs.spring.io/spring-framework/docs/${spring}/javadoc-api spring-framework-javadoc: '{springjavadocurl}' springhateoasversion: ${spring-hateoas} releasetrainversion: ${releasetrain}