Spring/spring-boot
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Use Antora links for Spring Data reference doc

Browse Source 
Closes gh-42203
This commit is contained in:
Stéphane Nicoll
2024-09-11 06:45:38 +02:00
parent f69c68d4d3
commit bee3158d91
4 changed files with 25 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
spring-boot-project/spring-boot-docs/src/docs/asciidoc/attributes.adoc
View File

@@ -59,25 +59,27 @@
:spring-batch-docs: https://docs.spring.io/spring-batch/reference/{spring-batch-version-antora}
:spring-data: https://spring.io/projects/spring-data
:spring-data-cassandra: https://spring.io/projects/spring-data-cassandra
:spring-data-cassandra-docs: https://docs.spring.io/spring-data/cassandra/reference/{spring-data-cassandra-version-antora}
:spring-data-commons-api: https://docs.spring.io/spring-data/commons/docs/{spring-data-commons-version}/api/org/springframework/data
:spring-data-couchbase: https://spring.io/projects/spring-data-couchbase
:spring-data-couchbase-docs: https://docs.spring.io/spring-data/couchbase/docs/{spring-data-couchbase-version}/reference/html/
:spring-data-couchbase-docs: https://docs.spring.io/spring-data/couchbase/reference/{spring-data-couchbase-version-antora}
:spring-data-elasticsearch: https://spring.io/projects/spring-data-elasticsearch
:spring-data-elasticsearch-docs: https://docs.spring.io/spring-data/elasticsearch/docs/current/reference/html/
:spring-data-elasticsearch-docs: https://docs.spring.io/spring-data/elasticsearch/reference/{spring-data-elasticsearch-version-antora}
:spring-data-envers: https://spring.io/projects/spring-data-envers
:spring-data-gemfire: https://spring.io/projects/spring-data-gemfire
:spring-data-geode: https://spring.io/projects/spring-data-geode
:spring-data-jdbc-docs: https://docs.spring.io/spring-data/relational/reference/{spring-data-jdbc-version-antora}
: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/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-jpa-docs: https://docs.spring.io/spring-data/jpa/reference/{spring-data-jpa-version-antora}
:spring-data-ldap: https://spring.io/projects/spring-data-ldap
:spring-data-ldap-docs: https://docs.spring.io/spring-data/ldap/reference/{spring-data-ldap-version-antora}
:spring-data-mongodb: https://spring.io/projects/spring-data-mongodb
:spring-data-mongodb-api: https://docs.spring.io/spring-data/mongodb/docs/{spring-data-mongodb-version}/api/org/springframework/data/mongodb
:spring-data-neo4j: https://spring.io/projects/spring-data-neo4j
:spring-data-neo4j-docs: https://docs.spring.io/spring-data/neo4j/docs/{spring-data-neo4j-version}/reference/html/
:spring-data-neo4j-docs: https://docs.spring.io/spring-data/neo4j/reference/{spring-data-neo4j-version-antora}
:spring-data-r2dbc-api: https://docs.spring.io/spring-data/r2dbc/docs/{spring-data-r2dbc-version}/api/org/springframework/data/r2dbc
:spring-data-r2dbc-docs: https://docs.spring.io/spring-data/r2dbc/docs/{spring-data-r2dbc-version}/reference/html/
:spring-data-r2dbc-docs: https://docs.spring.io/spring-data/relational/reference/{spring-data-r2dbc-version-antora}
:spring-data-redis: https://spring.io/projects/spring-data-redis
: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

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

@@ -259,7 +259,7 @@ Each will be called in order with the `ConfigBuilder` that is used to build the
[[data.nosql.neo4j.repositories]]
==== Spring Data Neo4j Repositories
Spring Data includes repository support for Neo4j.
For complete details of Spring Data Neo4j, see the {spring-data-neo4j-docs}[reference documentation].
For complete details of Spring Data Neo4j, see the {spring-data-neo4j-docs}/[reference documentation].
Spring Data Neo4j shares the common infrastructure with Spring Data JPA as many other Spring Data modules do.
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.
By default, the <<using#using.auto-configuration.packages,auto-configuration packages>> are scanned.
You can customize the locations to look for repositories and documents by using `@EnableElasticsearchRepositories` and `@EntityScan` respectively.
TIP: For complete details of Spring Data Elasticsearch, see the {spring-data-elasticsearch-docs}[reference documentation].
TIP: For complete details of Spring Data Elasticsearch, see the {spring-data-elasticsearch-docs}/[reference documentation].
Spring Boot supports both classic and reactive Elasticsearch repositories, using the `ElasticsearchRestTemplate` or `ReactiveElasticsearchTemplate` beans.
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.
By default, the <<using#using.auto-configuration.packages,auto-configuration packages>> are scanned.
You can customize the locations to look for repositories and entities by using `@EnableCassandraRepositories` and `@EntityScan` respectively.
TIP: For complete details of Spring Data Cassandra, see the https://docs.spring.io/spring-data/cassandra/docs/[reference documentation].
TIP: For complete details of Spring Data Cassandra, see the {spring-data-cassandra-docs}/[reference documentation].
@@ -555,7 +555,7 @@ Repositories and documents are found through scanning.
By default, the <<using#using.auto-configuration.packages,auto-configuration packages>> are scanned.
You can customize the locations to look for repositories and documents by using `@EnableCouchbaseRepositories` and `@EntityScan` respectively.
For complete details of Spring Data Couchbase, see the {spring-data-couchbase-docs}[reference documentation].
For complete details of Spring Data Couchbase, see the {spring-data-couchbase-docs}/[reference documentation].
You can inject an auto-configured `CouchbaseTemplate` instance as you would with any other Spring Bean, provided a `CouchbaseClientFactory` bean is available.
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.
By default, the <<using#using.auto-configuration.packages,auto-configuration packages>> are scanned.
You can customize the locations to look for repositories and documents by using `@EnableLdapRepositories` and `@EntityScan` respectively.
For complete details of Spring Data LDAP, see the https://docs.spring.io/spring-data/ldap/docs/1.0.x/reference/html/[reference documentation].
For complete details of Spring Data LDAP, see the {spring-data-ldap-docs}/[reference documentation].
You can also inject an auto-configured `LdapTemplate` instance as you would with any other Spring Bean, as shown in the following example:

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

@@ -248,7 +248,7 @@ For JPA components (such as converters) that are created as Spring beans, use `O
====
TIP: We have barely scratched the surface of Spring Data JPA.
For complete details, see the {spring-data-jpa-docs}[Spring Data JPA reference documentation].
For complete details, see the {spring-data-jpa-docs}/[Spring Data JPA reference documentation].
@@ -260,7 +260,7 @@ To use Spring Data Envers, make sure your repository extends from `RevisionRepos
include::code:CountryRepository[]
NOTE: For more details, check the {spring-data-jpa-docs}/#envers[Spring Data Envers reference documentation].
NOTE: For more details, check the {spring-data-jpa-docs}/envers.html[Spring Data Envers reference documentation].
@@ -312,7 +312,7 @@ Spring Boot will auto-configure Spring Data's JDBC repositories when the necessa
They can be added to your project with a single dependency on `spring-boot-starter-data-jdbc`.
If necessary, you can take control of Spring Data JDBC's configuration by adding the `@EnableJdbcRepositories` annotation or an `AbstractJdbcConfiguration` subclass to your application.
TIP: For complete details of Spring Data JDBC, see the {spring-data-jdbc-docs}[reference documentation].
TIP: For complete details of Spring Data JDBC, see the {spring-data-jdbc-docs}/[reference documentation].
@@ -522,4 +522,4 @@ The following example shows a typical Spring Data repository interface definitio
include::code:CityRepository[]
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].
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].