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 3f4b333bd0c5..fe3be5507daa 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 @@ -1090,7 +1090,7 @@ Long task timers require a separate metric name and can be stacked with a short [[actuator.metrics.supported.redis]] ==== Redis Metrics Auto-configuration registers a `MicrometerCommandLatencyRecorder` for the auto-configured `LettuceConnectionFactory`. -For more details refer to the {lettuce-docs}#command.latency.metrics.micrometer[Micrometer Metrics section] of the Lettuce documentation. +For more detail, see the {lettuce-docs}#command.latency.metrics.micrometer[Micrometer Metrics section] of the Lettuce documentation. diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/build-tool-plugins/gradle.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/build-tool-plugins/gradle.adoc index 0281939c142f..eaa35cfc3fc9 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/build-tool-plugins/gradle.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/build-tool-plugins/gradle.adoc @@ -2,7 +2,7 @@ == Spring Boot Gradle Plugin The Spring Boot Gradle Plugin provides Spring Boot support in Gradle, letting you package executable jar or war archives, run Spring Boot applications, and use the dependency management provided by `spring-boot-dependencies`. It requires Gradle 6.8, 6.9, or 7.x. -Please refer to the plugin's documentation to learn more: +See the plugin's documentation to learn more: * Reference ({spring-boot-gradle-plugin-docs}[HTML] and {spring-boot-gradle-plugin-pdfdocs}[PDF]) * {spring-boot-gradle-plugin-api}[API] diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/build-tool-plugins/maven.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/build-tool-plugins/maven.adoc index 452f039101df..b79474ed0cd1 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/build-tool-plugins/maven.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/build-tool-plugins/maven.adoc @@ -3,7 +3,7 @@ The Spring Boot Maven Plugin provides Spring Boot support in Maven, letting you package executable jar or war archives and run an application "`in-place`". To use it, you must use Maven 3.2 (or later). -Please refer to the plugin's documentation to learn more: +See the plugin's documentation to learn more: * Reference ({spring-boot-maven-plugin-docs}[HTML] and {spring-boot-maven-plugin-pdfdocs}[PDF]) * {spring-boot-maven-plugin-api}[API] diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/container-images/cloud-native-buildpacks.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/container-images/cloud-native-buildpacks.adoc index af3ff3bddf64..94ee0ad12adb 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/container-images/cloud-native-buildpacks.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/container-images/cloud-native-buildpacks.adoc @@ -10,7 +10,7 @@ With Cloud Native Buildpacks, you can create Docker compatible images that you c Spring Boot includes buildpack support directly for both Maven and Gradle. This means you can just type a single command and quickly get a sensible image into your locally running Docker daemon. -Refer to the individual plugin documentation on how to use buildpacks with {spring-boot-maven-plugin-docs}#build-image[Maven] and {spring-boot-gradle-plugin-docs}#build-image[Gradle]. +See the individual plugin documentation on how to use buildpacks with {spring-boot-maven-plugin-docs}#build-image[Maven] and {spring-boot-gradle-plugin-docs}#build-image[Gradle]. NOTE: The https://github.com/paketo-buildpacks/spring-boot[Paketo Spring Boot buildpack] has also been updated to support the `layers.idx` file so any customization that is applied to it will be reflected in the image created by the buildpack. diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/container-images/efficient-images.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/container-images/efficient-images.adoc index 42f099733aaa..744089d3fb3a 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/container-images/efficient-images.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/container-images/efficient-images.adoc @@ -72,5 +72,5 @@ Application code is more likely to change between builds so it is isolated in a Spring Boot also supports layering for war files with the help of a `layers.idx`. -For Maven, refer to the {spring-boot-maven-plugin-docs}#repackage-layers[packaging layered jar or war section] for more details on adding a layer index to the archive. -For Gradle, refer to the {spring-boot-gradle-plugin-docs}#packaging-layered-archives[packaging layered jar or war section] of the Gradle plugin documentation. +For Maven, see the {spring-boot-maven-plugin-docs}#repackage-layers[packaging layered jar or war section] for more details on adding a layer index to the archive. +For Gradle, see the {spring-boot-gradle-plugin-docs}#packaging-layered-archives[packaging layered jar or war section] of the Gradle plugin documentation. diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/data/nosql.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/data/nosql.adoc index 18982ebb689c..eb6465204986 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/data/nosql.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/data/nosql.adoc @@ -13,7 +13,7 @@ Spring Data provides additional projects that help you access a variety of NoSQL Spring Boot provides auto-configuration for Redis, MongoDB, Neo4j, Solr, Elasticsearch, Cassandra, Couchbase, LDAP and InfluxDB. You can make use of the other projects, but you must configure them yourself. -Refer to the appropriate reference documentation at {spring-data}. +See the appropriate reference documentation at {spring-data}. @@ -143,7 +143,7 @@ include::{docs-java}/data/nosql/mongodb/repositories/CityRepository.java[] TIP: You can customize document scanning locations by using the `@EntityScan` annotation. -TIP: For complete details of Spring Data MongoDB, including its rich object mapping technologies, refer to its {spring-data-mongodb}[reference documentation]. +TIP: For complete details of Spring Data MongoDB, including its rich object mapping technologies, see its {spring-data-mongodb}[reference documentation]. @@ -208,7 +208,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, refer to 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: @@ -360,7 +360,7 @@ As with the JPA repositories discussed earlier, the basic principle is that quer In fact, both Spring Data JPA and Spring Data Elasticsearch share the same common infrastructure. You could take the JPA example from earlier and, assuming that `City` is now an Elasticsearch `@Document` class rather than a JPA `@Entity`, it works in the same way. -TIP: For complete details of Spring Data Elasticsearch, refer to 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. @@ -449,7 +449,7 @@ If you add your own `@Bean` of type `CassandraTemplate`, it replaces the default Spring Data includes basic repository support for Cassandra. Currently, this is more limited than the JPA repositories discussed earlier and needs to annotate finder methods with `@Query`. -TIP: For complete details of Spring Data Cassandra, refer to the https://docs.spring.io/spring-data/cassandra/docs/[reference documentation]. +TIP: For complete details of Spring Data Cassandra, see the https://docs.spring.io/spring-data/cassandra/docs/[reference documentation]. @@ -499,7 +499,7 @@ To take more control, one or more `ClusterEnvironmentBuilderCustomizer` beans ca [[data.nosql.couchbase.repositories]] ==== Spring Data Couchbase Repositories Spring Data includes repository support for Couchbase. -For complete details of Spring Data Couchbase, refer to 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: @@ -570,7 +570,7 @@ Make sure to flag your customized `ContextSource` as `@Primary` so that the auto [[data.nosql.ldap.repositories]] ==== Spring Data LDAP Repositories Spring Data includes repository support for LDAP. -For complete details of Spring Data LDAP, refer to 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 https://docs.spring.io/spring-data/ldap/docs/1.0.x/reference/html/[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: diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/data/sql.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/data/sql.adoc index 973d75b7efaa..c451577396f0 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/data/sql.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/data/sql.adoc @@ -91,7 +91,7 @@ In other words, if you set `spring.datasource.driver-class-name=com.mysql.jdbc.D See {spring-boot-autoconfigure-module-code}/jdbc/DataSourceProperties.java[`DataSourceProperties`] for more of the supported options. These are the standard options that work regardless of <>. It is also possible to fine-tune implementation-specific settings by using their respective prefix (`+spring.datasource.hikari.*+`, `+spring.datasource.tomcat.*+`, `+spring.datasource.dbcp2.*+`, and `+spring.datasource.oracleucp.*+`). -Refer to the documentation of the connection pool implementation you are using for more details. +See the documentation of the connection pool implementation you are using for more details. For instance, if you use the {tomcat-docs}/jdbc-pool.html#Common_Attributes[Tomcat connection pool], you could customize many additional settings, as shown in the following example: @@ -311,7 +311,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 a `JdbcConfiguration` subclass to your application. -TIP: For complete details of Spring Data JDBC, please refer to the {spring-data-jdbc-docs}[reference documentation]. +TIP: For complete details of Spring Data JDBC, see the {spring-data-jdbc-docs}[reference documentation]. diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/deployment/cloud.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/deployment/cloud.adoc index 02be7a6bf9bf..78375e229694 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/deployment/cloud.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/deployment/cloud.adoc @@ -214,7 +214,7 @@ Which will result in the following: ---- Your application should now be up and running on Heroku. -For more details, refer to https://devcenter.heroku.com/articles/deploying-spring-boot-apps-to-heroku[Deploying Spring Boot Applications to Heroku]. +For more details, see https://devcenter.heroku.com/articles/deploying-spring-boot-apps-to-heroku[Deploying Spring Boot Applications to Heroku]. diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/deployment/installing.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/deployment/installing.adoc index ab42be1f6edf..eccc9e23e402 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/deployment/installing.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/deployment/installing.adoc @@ -179,7 +179,7 @@ To flag the application to start automatically on system boot, use the following $ systemctl enable myapp.service ---- -Refer to `man systemctl` for more details. +Run `man systemctl` for more details. diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/howto/data-access.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/howto/data-access.adoc index 70ab7614f26a..aba533688468 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/howto/data-access.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/howto/data-access.adoc @@ -280,7 +280,7 @@ include::{docs-java}/howto/dataaccess/configurehibernatesecondlevelcaching/MyHib This customizer will configure Hibernate to use the same `CacheManager` as the one that the application uses. It is also possible to use separate `CacheManager` instances. -For details, refer to {hibernate-docs}#caching-provider-jcache[the Hibernate user guide]. +For details, see {hibernate-docs}#caching-provider-jcache[the Hibernate user guide]. @@ -400,6 +400,6 @@ include::{docs-java}/howto/dataaccess/configureacomponentthatisusedbyjpa/Elastic [[howto.data-access.configure-jooq-with-multiple-datasources]] === Configure jOOQ with Two DataSources If you need to use jOOQ with multiple data sources, you should create your own `DSLContext` for each one. -Refer to {spring-boot-autoconfigure-module-code}/jooq/JooqAutoConfiguration.java[JooqAutoConfiguration] for more details. +See {spring-boot-autoconfigure-module-code}/jooq/JooqAutoConfiguration.java[JooqAutoConfiguration] for more details. TIP: In particular, `JooqExceptionTranslator` and `SpringTransactionProvider` can be reused to provide similar features to what the auto-configuration does with a single `DataSource`. diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/howto/testing.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/howto/testing.adoc index 4f2f8610b938..ef00e0c74f40 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/howto/testing.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/howto/testing.adoc @@ -17,7 +17,7 @@ include::{docs-java}/howto/testing/withspringsecurity/MySecurityTests.java[] Spring Security provides comprehensive integration with Spring MVC Test and this can also be used when testing controllers using the `@WebMvcTest` slice and `MockMvc`. -For additional details on Spring Security's testing support, refer to Spring Security's {spring-security-docs}/servlet/test/index.html[reference documentation]. +For additional details on Spring Security's testing support, see Spring Security's {spring-security-docs}/servlet/test/index.html[reference documentation]. diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/messaging/jms.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/messaging/jms.adoc index 04256be513d7..7ef7bf19a726 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/messaging/jms.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/messaging/jms.adoc @@ -38,7 +38,7 @@ The embedded broker will also be disabled if you configure the broker URL, as sh password: "secret" ---- -If you want to take full control over the embedded broker, refer to https://activemq.apache.org/how-do-i-embed-a-broker-inside-a-connection.html[the ActiveMQ documentation] for further information. +If you want to take full control over the embedded broker, see https://activemq.apache.org/how-do-i-embed-a-broker-inside-a-connection.html[the ActiveMQ documentation] for further information. By default, a `CachingConnectionFactory` wraps the native `ConnectionFactory` with sensible settings that you can control by external configuration properties in `+spring.jms.*+`: diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/messaging/kafka.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/messaging/kafka.adoc index ebed69d8d909..046725756546 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/messaging/kafka.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/messaging/kafka.adoc @@ -85,7 +85,7 @@ You can customize this behavior using the configprop:spring.kafka.streams.auto-s === Additional Kafka Properties The properties supported by auto configuration are shown in <>. Note that, for the most part, these properties (hyphenated or camelCase) map directly to the Apache Kafka dotted properties. -Refer to the Apache Kafka documentation for details. +See the Apache Kafka documentation for details. The first few of these properties apply to all components (producers, consumers, admins, and streams) but can be specified at the component level if you wish to use different values. Apache Kafka designates properties with an importance of HIGH, MEDIUM, or LOW. diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/using/build-systems.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/using/build-systems.adoc index 621b4bd79839..d1881e4bfec7 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/using/build-systems.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/using/build-systems.adoc @@ -24,7 +24,7 @@ We **highly** recommend that you not specify its version. [[using.build-systems.maven]] === Maven -To learn about using Spring Boot with Maven, please refer to the documentation for Spring Boot's Maven plugin: +To learn about using Spring Boot with Maven, see the documentation for Spring Boot's Maven plugin: * Reference ({spring-boot-maven-plugin-docs}[HTML] and {spring-boot-maven-plugin-pdfdocs}[PDF]) * {spring-boot-maven-plugin-api}[API] @@ -33,7 +33,7 @@ To learn about using Spring Boot with Maven, please refer to the documentation f [[using.build-systems.gradle]] === Gradle -To learn about using Spring Boot with Gradle, please refer to the documentation for Spring Boot's Gradle plugin: +To learn about using Spring Boot with Gradle, see the documentation for Spring Boot's Gradle plugin: * Reference ({spring-boot-gradle-plugin-docs}[HTML] and {spring-boot-gradle-plugin-pdfdocs}[PDF]) * {spring-boot-gradle-plugin-api}[API] diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/using/running-your-application.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/using/running-your-application.adoc index 27ca9d405c24..16419169b889 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/using/running-your-application.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/using/running-your-application.adoc @@ -5,7 +5,7 @@ The sample applies to debugging Spring Boot applications. You do not need any special IDE plugins or extensions. NOTE: This section only covers jar-based packaging. -If you choose to package your application as a war file, you should refer to your server and IDE documentation. +If you choose to package your application as a war file, see your server and IDE documentation. diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/web/graceful-shutdown.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/web/graceful-shutdown.adoc index 50ec2534a7f6..a7a544d5265e 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/web/graceful-shutdown.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/web/graceful-shutdown.adoc @@ -27,4 +27,4 @@ spring: ---- IMPORTANT: Using graceful shutdown with your IDE may not work properly if it does not send a proper `SIGTERM` signal. -Refer to the documentation of your IDE for more details. +See the documentation of your IDE for more details.