Skip to content

Commit bee3158

Browse files
committed
Use Antora links for Spring Data reference doc
Closes gh-42203
1 parent f69c68d commit bee3158

File tree

4 files changed

+25
-17
lines changed

4 files changed

+25
-17
lines changed

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

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -330,13 +330,19 @@ tasks.withType(org.asciidoctor.gradle.jvm.AbstractAsciidoctorTask) {
330330
"spring-batch-version": versionConstraints["org.springframework.batch:spring-batch-core"],
331331
"spring-batch-version-antora": toAntoraVersion(versionConstraints["org.springframework.batch:spring-batch-core"]),
332332
"spring-boot-version": project.version,
333+
"spring-data-cassandra-version-antora": toAntoraVersion(versionConstraints["org.springframework.data:spring-data-cassandra"]),
333334
"spring-data-commons-version": versionConstraints["org.springframework.data:spring-data-commons"],
334-
"spring-data-couchbase-version": versionConstraints["org.springframework.data:spring-data-couchbase"],
335+
"spring-data-couchbase-version-antora": toAntoraVersion(versionConstraints["org.springframework.data:spring-data-couchbase"]),
336+
"spring-data-elasticsearch-version-antora": toAntoraVersion(versionConstraints["org.springframework.data:spring-data-elasticsearch"]),
335337
"spring-data-jdbc-version": versionConstraints["org.springframework.data:spring-data-jdbc"],
338+
"spring-data-jdbc-version-antora": toAntoraVersion(versionConstraints["org.springframework.data:spring-data-jdbc"]),
336339
"spring-data-jpa-version": versionConstraints["org.springframework.data:spring-data-jpa"],
340+
"spring-data-jpa-version-antora": toAntoraVersion(versionConstraints["org.springframework.data:spring-data-jpa"]),
341+
"spring-data-ldap-version-antora": toAntoraVersion(versionConstraints["org.springframework.data:spring-data-ldap"]),
337342
"spring-data-mongodb-version": versionConstraints["org.springframework.data:spring-data-mongodb"],
338-
"spring-data-neo4j-version": versionConstraints["org.springframework.data:spring-data-neo4j"],
343+
"spring-data-neo4j-version-antora": toAntoraVersion(versionConstraints["org.springframework.data:spring-data-neo4j"]),
339344
"spring-data-r2dbc-version": versionConstraints["org.springframework.data:spring-data-r2dbc"],
345+
"spring-data-r2dbc-version-antora": toAntoraVersion(versionConstraints["org.springframework.data:spring-data-r2dbc"]),
340346
"spring-data-rest-version": versionConstraints["org.springframework.data:spring-data-rest-core"],
341347
"spring-framework-version": versionConstraints["org.springframework:spring-core"],
342348
"spring-framework-version-antora": toAntoraVersion(versionConstraints["org.springframework:spring-core"]),

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

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -59,25 +59,27 @@
5959
:spring-batch-docs: https://docs.spring.io/spring-batch/reference/{spring-batch-version-antora}
6060
:spring-data: https://spring.io/projects/spring-data
6161
:spring-data-cassandra: https://spring.io/projects/spring-data-cassandra
62+
:spring-data-cassandra-docs: https://docs.spring.io/spring-data/cassandra/reference/{spring-data-cassandra-version-antora}
6263
:spring-data-commons-api: https://docs.spring.io/spring-data/commons/docs/{spring-data-commons-version}/api/org/springframework/data
6364
:spring-data-couchbase: https://spring.io/projects/spring-data-couchbase
64-
:spring-data-couchbase-docs: https://docs.spring.io/spring-data/couchbase/docs/{spring-data-couchbase-version}/reference/html/
65+
:spring-data-couchbase-docs: https://docs.spring.io/spring-data/couchbase/reference/{spring-data-couchbase-version-antora}
6566
:spring-data-elasticsearch: https://spring.io/projects/spring-data-elasticsearch
66-
:spring-data-elasticsearch-docs: https://docs.spring.io/spring-data/elasticsearch/docs/current/reference/html/
67+
:spring-data-elasticsearch-docs: https://docs.spring.io/spring-data/elasticsearch/reference/{spring-data-elasticsearch-version-antora}
6768
:spring-data-envers: https://spring.io/projects/spring-data-envers
6869
:spring-data-gemfire: https://spring.io/projects/spring-data-gemfire
6970
:spring-data-geode: https://spring.io/projects/spring-data-geode
71+
:spring-data-jdbc-docs: https://docs.spring.io/spring-data/relational/reference/{spring-data-jdbc-version-antora}
7072
:spring-data-jpa: https://spring.io/projects/spring-data-jpa
7173
:spring-data-jpa-api: https://docs.spring.io/spring-data/jpa/docs/{spring-data-jpa-version}/api/org/springframework/data/jpa
72-
:spring-data-jpa-docs: https://docs.spring.io/spring-data/jpa/reference/{spring-data-jpa-version}/
73-
:spring-data-jdbc-docs: https://docs.spring.io/spring-data/jdbc/docs/{spring-data-jdbc-version}/reference/html/
74+
:spring-data-jpa-docs: https://docs.spring.io/spring-data/jpa/reference/{spring-data-jpa-version-antora}
7475
:spring-data-ldap: https://spring.io/projects/spring-data-ldap
76+
:spring-data-ldap-docs: https://docs.spring.io/spring-data/ldap/reference/{spring-data-ldap-version-antora}
7577
:spring-data-mongodb: https://spring.io/projects/spring-data-mongodb
7678
:spring-data-mongodb-api: https://docs.spring.io/spring-data/mongodb/docs/{spring-data-mongodb-version}/api/org/springframework/data/mongodb
7779
:spring-data-neo4j: https://spring.io/projects/spring-data-neo4j
78-
:spring-data-neo4j-docs: https://docs.spring.io/spring-data/neo4j/docs/{spring-data-neo4j-version}/reference/html/
80+
:spring-data-neo4j-docs: https://docs.spring.io/spring-data/neo4j/reference/{spring-data-neo4j-version-antora}
7981
:spring-data-r2dbc-api: https://docs.spring.io/spring-data/r2dbc/docs/{spring-data-r2dbc-version}/api/org/springframework/data/r2dbc
80-
:spring-data-r2dbc-docs: https://docs.spring.io/spring-data/r2dbc/docs/{spring-data-r2dbc-version}/reference/html/
82+
:spring-data-r2dbc-docs: https://docs.spring.io/spring-data/relational/reference/{spring-data-r2dbc-version-antora}
8183
:spring-data-redis: https://spring.io/projects/spring-data-redis
8284
:spring-data-rest-api: https://docs.spring.io/spring-data/rest/docs/{spring-data-rest-version}/api/org/springframework/data/rest
8385
:spring-framework: https://spring.io/projects/spring-framework

spring-boot-project/spring-boot-docs/src/docs/asciidoc/data/nosql.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -259,7 +259,7 @@ Each will be called in order with the `ConfigBuilder` that is used to build the
259259
[[data.nosql.neo4j.repositories]]
260260
==== Spring Data Neo4j Repositories
261261
Spring Data includes repository support for Neo4j.
262-
For complete details of Spring Data Neo4j, see the {spring-data-neo4j-docs}[reference documentation].
262+
For complete details of Spring Data Neo4j, see the {spring-data-neo4j-docs}/[reference documentation].
263263

264264
Spring Data Neo4j shares the common infrastructure with Spring Data JPA as many other Spring Data modules do.
265265
You could take the JPA example from earlier and define `City` as Spring Data Neo4j `@Node` rather than JPA `@Entity` and the repository abstraction works in the same way, as shown in the following example:
@@ -386,7 +386,7 @@ Repositories and documents are found through scanning.
386386
By default, the <<using#using.auto-configuration.packages,auto-configuration packages>> are scanned.
387387
You can customize the locations to look for repositories and documents by using `@EnableElasticsearchRepositories` and `@EntityScan` respectively.
388388

389-
TIP: For complete details of Spring Data Elasticsearch, see the {spring-data-elasticsearch-docs}[reference documentation].
389+
TIP: For complete details of Spring Data Elasticsearch, see the {spring-data-elasticsearch-docs}/[reference documentation].
390390

391391
Spring Boot supports both classic and reactive Elasticsearch repositories, using the `ElasticsearchRestTemplate` or `ReactiveElasticsearchTemplate` beans.
392392
Most likely those beans are auto-configured by Spring Boot given the required dependencies are present.
@@ -501,7 +501,7 @@ Repositories and entities are found through scanning.
501501
By default, the <<using#using.auto-configuration.packages,auto-configuration packages>> are scanned.
502502
You can customize the locations to look for repositories and entities by using `@EnableCassandraRepositories` and `@EntityScan` respectively.
503503

504-
TIP: For complete details of Spring Data Cassandra, see the https://docs.spring.io/spring-data/cassandra/docs/[reference documentation].
504+
TIP: For complete details of Spring Data Cassandra, see the {spring-data-cassandra-docs}/[reference documentation].
505505

506506

507507

@@ -555,7 +555,7 @@ Repositories and documents are found through scanning.
555555
By default, the <<using#using.auto-configuration.packages,auto-configuration packages>> are scanned.
556556
You can customize the locations to look for repositories and documents by using `@EnableCouchbaseRepositories` and `@EntityScan` respectively.
557557

558-
For complete details of Spring Data Couchbase, see the {spring-data-couchbase-docs}[reference documentation].
558+
For complete details of Spring Data Couchbase, see the {spring-data-couchbase-docs}/[reference documentation].
559559

560560
You can inject an auto-configured `CouchbaseTemplate` instance as you would with any other Spring Bean, provided a `CouchbaseClientFactory` bean is available.
561561
This happens when a `Cluster` is available, as described above, and a bucket name has been specified:
@@ -625,7 +625,7 @@ Repositories and documents are found through scanning.
625625
By default, the <<using#using.auto-configuration.packages,auto-configuration packages>> are scanned.
626626
You can customize the locations to look for repositories and documents by using `@EnableLdapRepositories` and `@EntityScan` respectively.
627627

628-
For complete details of Spring Data LDAP, see the https://docs.spring.io/spring-data/ldap/docs/1.0.x/reference/html/[reference documentation].
628+
For complete details of Spring Data LDAP, see the {spring-data-ldap-docs}/[reference documentation].
629629

630630
You can also inject an auto-configured `LdapTemplate` instance as you would with any other Spring Bean, as shown in the following example:
631631

spring-boot-project/spring-boot-docs/src/docs/asciidoc/data/sql.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -248,7 +248,7 @@ For JPA components (such as converters) that are created as Spring beans, use `O
248248
====
249249

250250
TIP: We have barely scratched the surface of Spring Data JPA.
251-
For complete details, see the {spring-data-jpa-docs}[Spring Data JPA reference documentation].
251+
For complete details, see the {spring-data-jpa-docs}/[Spring Data JPA reference documentation].
252252

253253

254254

@@ -260,7 +260,7 @@ To use Spring Data Envers, make sure your repository extends from `RevisionRepos
260260

261261
include::code:CountryRepository[]
262262

263-
NOTE: For more details, check the {spring-data-jpa-docs}/#envers[Spring Data Envers reference documentation].
263+
NOTE: For more details, check the {spring-data-jpa-docs}/envers.html[Spring Data Envers reference documentation].
264264

265265

266266

@@ -312,7 +312,7 @@ Spring Boot will auto-configure Spring Data's JDBC repositories when the necessa
312312
They can be added to your project with a single dependency on `spring-boot-starter-data-jdbc`.
313313
If necessary, you can take control of Spring Data JDBC's configuration by adding the `@EnableJdbcRepositories` annotation or an `AbstractJdbcConfiguration` subclass to your application.
314314

315-
TIP: For complete details of Spring Data JDBC, see the {spring-data-jdbc-docs}[reference documentation].
315+
TIP: For complete details of Spring Data JDBC, see the {spring-data-jdbc-docs}/[reference documentation].
316316

317317

318318

@@ -522,4 +522,4 @@ The following example shows a typical Spring Data repository interface definitio
522522

523523
include::code:CityRepository[]
524524

525-
TIP: We have barely scratched the surface of Spring Data R2DBC. For complete details, see the {spring-data-r2dbc-docs}[Spring Data R2DBC reference documentation].
525+
TIP: We have barely scratched the surface of Spring Data R2DBC. For complete details, see the {spring-data-r2dbc-docs}/[Spring Data R2DBC reference documentation].

0 commit comments

Comments
 (0)