Migrate spring-boot-docs to Antora

See gh-33766
This commit is contained in:
Phillip Webb
2024-03-19 21:48:08 -07:00
parent 8ee20c8dae
commit 8dd89c1ac7
202 changed files with 6844 additions and 6593 deletions

View File

@@ -0,0 +1,48 @@
[appendix]
[[appendix.application-properties]]
= Common Application Properties
Various properties can be specified inside your `application.properties` file, inside your `application.yaml` file, or as command line switches.
This appendix provides a list of common Spring Boot properties and references to the underlying classes that consume them.
TIP: Spring Boot provides various conversion mechanism with advanced value formatting, make sure to review xref:reference:features/external-config.adoc#features.external-config.typesafe-configuration-properties.conversion[the properties conversion section].
NOTE: Property contributions can come from additional jar files on your classpath, so you should not consider this an exhaustive list.
Also, you can define your own properties.
include::partial$configuration-properties/core.adoc[]
include::partial$configuration-properties/cache.adoc[]
include::partial$configuration-properties/mail.adoc[]
include::partial$configuration-properties/json.adoc[]
include::partial$configuration-properties/data.adoc[]
include::partial$configuration-properties/transaction.adoc[]
include::partial$configuration-properties/data-migration.adoc[]
include::partial$configuration-properties/integration.adoc[]
include::partial$configuration-properties/web.adoc[]
include::partial$configuration-properties/templating.adoc[]
include::partial$configuration-properties/server.adoc[]
include::partial$configuration-properties/security.adoc[]
include::partial$configuration-properties/rsocket.adoc[]
include::partial$configuration-properties/actuator.adoc[]
include::partial$configuration-properties/devtools.adoc[]
include::partial$configuration-properties/docker-compose.adoc[]
include::partial$configuration-properties/testcontainers.adoc[]
include::partial$configuration-properties/testing.adoc[]

View File

@@ -0,0 +1,6 @@
[[appendix.auto-configuration-classes.actuator]]
= spring-boot-actuator-autoconfigure
The following auto-configuration classes are from the `spring-boot-actuator-autoconfigure` module:
include::partial$/auto-configuration-classes/spring-boot-actuator-autoconfigure.adoc[]

View File

@@ -0,0 +1,6 @@
[[appendix.auto-configuration-classes.core]]
= spring-boot-autoconfigure
The following auto-configuration classes are from the `spring-boot-autoconfigure` module:
include::partial$/auto-configuration-classes/spring-boot-autoconfigure.adoc[]

View File

@@ -0,0 +1,7 @@
[appendix]
[[appendix.auto-configuration-classes]]
= Auto-configuration Classes
This appendix contains details of all of the auto-configuration classes provided by Spring Boot, with links to documentation and source code.
Remember to also look at the conditions report in your application for more details of which features are switched on.
(To do so, start the app with `--debug` or `-Ddebug` or, in an Actuator application, use the `conditions` endpoint).

View File

@@ -0,0 +1,7 @@
[[appendix.dependency-versions.coordinates]]
= Managed Dependency Coordinates
The following table provides details of all of the dependency versions that are provided by Spring Boot in its CLI (Command Line Interface), Maven dependency management, and Gradle plugin.
When you declare a dependency on one of these artifacts without declaring a version, the version listed in the table is used.
include::partial$dependency-versions/documented-coordinates.adoc[]

View File

@@ -0,0 +1,5 @@
[appendix]
[[appendix.dependency-versions]]
= Dependency Versions
This appendix provides details of the dependencies that are managed by Spring Boot.

View File

@@ -0,0 +1,8 @@
[[appendix.dependency-versions.properties]]
= Version Properties
The following table provides all properties that can be used to override the versions managed by Spring Boot.
Browse the {code-spring-boot}/spring-boot-project/spring-boot-dependencies/build.gradle[`spring-boot-dependencies` build.gradle] for a complete list of dependencies.
You can learn how to customize these versions in your application in the xref:build-tool-plugin:index.adoc[Build Tool Plugins documentation].
include::partial$dependency-versions/documented-properties.adoc[]

View File

@@ -0,0 +1,5 @@
[appendix]
[[appendix.test-auto-configuration]]
= Test Auto-configuration Annotations
This appendix describes the `@...Test` auto-configuration annotations that Spring Boot provides to test slices of your application.

View File

@@ -0,0 +1,6 @@
[[appendix.test-auto-configuration.slices]]
= Test Slices
The following table lists the various `@...Test` annotations that can be used to test slices of your application and the auto-configuration that they import by default:
include::partial$slices/documented-slices.adoc[]

View File

@@ -0,0 +1,13 @@
* Appendix
** xref:appendix:application-properties/index.adoc[]
** xref:appendix:auto-configuration-classes/index.adoc[]
*** xref:appendix:auto-configuration-classes/core.adoc[]
*** xref:appendix:auto-configuration-classes/actuator.adoc[]
** xref:appendix:test-auto-configuration/index.adoc[]
*** xref:appendix:test-auto-configuration/slices.adoc[]
** xref:appendix:dependency-versions/index.adoc[]
*** xref:appendix:dependency-versions/coordinates.adoc[]
*** xref:appendix:dependency-versions/properties.adoc[]