diff --git a/spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix.adoc b/spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix.adoc index 4c32a668f61..47c4c5bfa2d 100644 --- a/spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix.adoc +++ b/spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix.adoc @@ -1,9 +1,11 @@ [[appendix]] = Appendices -include::appendix-application-properties.adoc[] -include::appendix-configuration-metadata.adoc[] -include::appendix-auto-configuration-classes.adoc[] -include::appendix-test-auto-configuration.adoc[] -include::appendix-executable-jar-format.adoc[] -include::appendix-dependency-versions.adoc[] +include::attributes.adoc[] + +include::appendix/application-properties.adoc[] +include::appendix/configuration-metadata.adoc[] +include::appendix/auto-configuration-classes.adoc[] +include::appendix/test-auto-configuration.adoc[] +include::appendix/executable-jar-format.adoc[] +include::appendix/dependency-versions.adoc[] diff --git a/spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc b/spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix/application-properties.adoc similarity index 100% rename from spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc rename to spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix/application-properties.adoc diff --git a/spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix-auto-configuration-classes.adoc b/spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix/auto-configuration-classes.adoc similarity index 100% rename from spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix-auto-configuration-classes.adoc rename to spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix/auto-configuration-classes.adoc diff --git a/spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix-configuration-metadata.adoc b/spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix/configuration-metadata.adoc similarity index 100% rename from spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix-configuration-metadata.adoc rename to spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix/configuration-metadata.adoc diff --git a/spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix-dependency-versions.adoc b/spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix/dependency-versions.adoc similarity index 100% rename from spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix-dependency-versions.adoc rename to spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix/dependency-versions.adoc diff --git a/spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix-executable-jar-format.adoc b/spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix/executable-jar-format.adoc similarity index 100% rename from spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix-executable-jar-format.adoc rename to spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix/executable-jar-format.adoc diff --git a/spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix-test-auto-configuration.adoc b/spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix/test-auto-configuration.adoc similarity index 82% rename from spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix-test-auto-configuration.adoc rename to spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix/test-auto-configuration.adoc index 9fe14819d67..0c2df9435ea 100644 --- a/spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix-test-auto-configuration.adoc +++ b/spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix/test-auto-configuration.adoc @@ -1,6 +1,7 @@ [appendix] [[test-auto-configuration]] -== Test auto-configuration annotations +== Test Auto-configuration Annotations + 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: diff --git a/spring-boot-project/spring-boot-docs/src/main/asciidoc/attributes.adoc b/spring-boot-project/spring-boot-docs/src/main/asciidoc/attributes.adoc new file mode 100644 index 00000000000..90b29df0c39 --- /dev/null +++ b/spring-boot-project/spring-boot-docs/src/main/asciidoc/attributes.adoc @@ -0,0 +1,143 @@ +:doctype: book +:idprefix: +:idseparator: - +:toc: left +:toclevels: 4 +:tabsize: 4 +:numbered: +:sectanchors: +:sectnums: +:icons: font +:hide-uri-scheme: +:docinfo: shared,private + +:spring-boot-repo: snapshot +:github-tag: master +:spring-boot-docs-version: current +:spring-boot-docs: https://docs.spring.io/spring-boot/docs/{spring-boot-docs-version}/reference +:spring-boot-docs-current: https://docs.spring.io/spring-boot/docs/current/reference +:github-repo: spring-projects/spring-boot +:github-raw: https://raw.github.com/{github-repo}/{github-tag} +:github-code: https://github.com/{github-repo}/tree/{github-tag} +:github-issues: https://github.com/{github-repo}/issues/ +:github-wiki: https://github.com/{github-repo}/wiki +:github-master-code: https://github.com/{github-repo}/tree/master +:sc-ext: java +:sc-spring-boot: {github-code}/spring-boot-project/spring-boot/src/main/java/org/springframework/boot +:sc-spring-boot-autoconfigure: {github-code}/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure +:sc-spring-boot-actuator: {github-code}/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate +:sc-spring-boot-actuator-autoconfigure: {github-code}/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure +:sc-spring-boot-cli: {github-code}/spring-boot-project/spring-boot-cli/src/main/java/org/springframework/boot/cli +:sc-spring-boot-devtools: {github-code}/spring-boot-project/spring-boot-devtools/src/main/java/org/springframework/boot/devtools +:sc-spring-boot-test: {github-code}/spring-boot-project/spring-boot-test/src/main/java/org/springframework/boot/test +:sc-spring-boot-test-autoconfigure: {github-code}/spring-boot-project/spring-boot-test-autoconfigure/src/main/java/org/springframework/boot/test/autoconfigure +:dc-ext: html +:dc-root: https://docs.spring.io/spring-boot/docs/{spring-boot-docs-version}/api +:dc-spring-boot: {dc-root}/org/springframework/boot +:dc-spring-boot-autoconfigure: {dc-root}/org/springframework/boot/autoconfigure +:dc-spring-boot-actuator: {dc-root}/org/springframework/boot/actuate +:dc-spring-boot-test: {dc-root}/org/springframework/boot/test +:dc-spring-boot-test-autoconfigure: {dc-root}/org/springframework/boot/test/autoconfigure +:dependency-management-plugin: https://github.com/spring-gradle-plugins/dependency-management-plugin +:dependency-management-plugin-documentation: {dependency-management-plugin}/blob/master/README.md +:java-javadoc: https://docs.oracle.com/javase/8/docs/api/ +:spring-boot-actuator-api: https://docs.spring.io/spring-boot/docs/{spring-boot-docs-version}/actuator-api/ +:spring-boot-maven-plugin-site: https://docs.spring.io/spring-boot/docs/{spring-boot-docs-version}/maven-plugin +:spring-boot-gradle-plugin: https://docs.spring.io/spring-boot/docs/{spring-boot-docs-version}/gradle-plugin +:spring-boot-gradle-plugin-reference: https://docs.spring.io/spring-boot/docs/{spring-boot-docs-version}/gradle-plugin/reference/html +:spring-reference: https://docs.spring.io/spring/docs/{spring-docs-version}/spring-framework-reference/ +:spring-initializr-reference: https://docs.spring.io/initializr/docs/current/reference/htmlsingle +:spring-rest-docs: https://projects.spring.io/spring-restdocs/ +:spring-integration: https://projects.spring.io/spring-integration/ +:spring-session: https://projects.spring.io/spring-session/ +:spring-framework: http://projects.spring.io/spring-framework/ +:spring-security: http://projects.spring.io/spring-security/ +:spring-data-jpa: http://projects.spring.io/spring-data-jpa/ +:spring-security-reference: https://docs.spring.io/spring-security/site/docs/{spring-security-docs-version}/reference/htmlsingle +:spring-security-oauth2-reference: https://projects.spring.io/spring-security-oauth/docs/oauth2.html +:spring-webservices-reference: https://docs.spring.io/spring-ws/docs/{spring-webservices-docs-version}/reference/ +:spring-javadoc: https://docs.spring.io/spring/docs/{spring-docs-version}/javadoc-api/org/springframework +:spring-amqp-javadoc: https://docs.spring.io/spring-amqp/docs/current/api/org/springframework/amqp +:spring-batch-javadoc: https://docs.spring.io/spring-batch/apidocs/org/springframework/batch +:spring-data-javadoc: https://docs.spring.io/spring-data/jpa/docs/current/api/org/springframework/data/jpa +:spring-data-commons-javadoc: https://docs.spring.io/spring-data/commons/docs/current/api/org/springframework/data +:spring-data-mongo-javadoc: https://docs.spring.io/spring-data/mongodb/docs/current/api/org/springframework/data/mongodb +:spring-data-mongo: https://projects.spring.io/spring-data-mongodb/ +:spring-data: https://projects.spring.io/spring-data/ +:spring-data-rest-javadoc: https://docs.spring.io/spring-data/rest/docs/current/api/org/springframework/data/rest +:gradle-userguide: https://www.gradle.org/docs/current/userguide +:ant-manual: http://ant.apache.org/manual +:code-examples: {sources-root}/main/java/org/springframework/boot/docs +:test-examples: {sources-root}/test/java/org/springframework/boot/docs +:gradle-user-guide: https://docs.gradle.org/4.2.1/userguide +:hibernate-documentation: https://docs.jboss.org/hibernate/orm/5.3/userguide/html_single/Hibernate_User_Guide.html +:jetty-documentation: https://www.eclipse.org/jetty/documentation/9.4.x +:jooq-manual: https://www.jooq.org/doc/{jooq-version}/manual-single-page +:micrometer-concepts-documentation: https://micrometer.io/docs/concepts +:micrometer-registry-documentation: http://micrometer.io/docs/registry +:tomcat-documentation: https://tomcat.apache.org/tomcat-8.5-doc +:kotlin-documentation: https://kotlinlang.org/docs/reference/ +:junit5-documentation: https://junit.org/junit5/docs/current/user-guide +:spring-boot-repo: snapshot +:github-tag: master +:spring-boot-docs-version: current +:spring-boot-docs: https://docs.spring.io/spring-boot/docs/{spring-boot-docs-version}/reference +:spring-boot-docs-current: https://docs.spring.io/spring-boot/docs/current/reference +:github-repo: spring-projects/spring-boot +:github-raw: https://raw.github.com/{github-repo}/{github-tag} +:github-code: https://github.com/{github-repo}/tree/{github-tag} +:github-issues: https://github.com/{github-repo}/issues/ +:github-wiki: https://github.com/{github-repo}/wiki +:github-master-code: https://github.com/{github-repo}/tree/master +:sc-ext: java +:sc-spring-boot: {github-code}/spring-boot-project/spring-boot/src/main/java/org/springframework/boot +:sc-spring-boot-autoconfigure: {github-code}/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure +:sc-spring-boot-actuator: {github-code}/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate +:sc-spring-boot-actuator-autoconfigure: {github-code}/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure +:sc-spring-boot-cli: {github-code}/spring-boot-project/spring-boot-cli/src/main/java/org/springframework/boot/cli +:sc-spring-boot-devtools: {github-code}/spring-boot-project/spring-boot-devtools/src/main/java/org/springframework/boot/devtools +:sc-spring-boot-test: {github-code}/spring-boot-project/spring-boot-test/src/main/java/org/springframework/boot/test +:sc-spring-boot-test-autoconfigure: {github-code}/spring-boot-project/spring-boot-test-autoconfigure/src/main/java/org/springframework/boot/test/autoconfigure +:dc-ext: html +:dc-root: https://docs.spring.io/spring-boot/docs/{spring-boot-docs-version}/api +:dc-spring-boot: {dc-root}/org/springframework/boot +:dc-spring-boot-autoconfigure: {dc-root}/org/springframework/boot/autoconfigure +:dc-spring-boot-actuator: {dc-root}/org/springframework/boot/actuate +:dc-spring-boot-test: {dc-root}/org/springframework/boot/test +:dc-spring-boot-test-autoconfigure: {dc-root}/org/springframework/boot/test/autoconfigure +:dependency-management-plugin: https://github.com/spring-gradle-plugins/dependency-management-plugin +:dependency-management-plugin-documentation: {dependency-management-plugin}/blob/master/README.md +:java-javadoc: https://docs.oracle.com/javase/8/docs/api/ +:spring-boot-actuator-api: https://docs.spring.io/spring-boot/docs/{spring-boot-docs-version}/actuator-api/ +:spring-boot-maven-plugin-site: https://docs.spring.io/spring-boot/docs/{spring-boot-docs-version}/maven-plugin +:spring-boot-gradle-plugin: https://docs.spring.io/spring-boot/docs/{spring-boot-docs-version}/gradle-plugin +:spring-boot-gradle-plugin-reference: https://docs.spring.io/spring-boot/docs/{spring-boot-docs-version}/gradle-plugin/reference/html +:spring-reference: https://docs.spring.io/spring/docs/{spring-docs-version}/spring-framework-reference/ +:spring-rest-docs: https://projects.spring.io/spring-restdocs/ +:spring-integration: https://projects.spring.io/spring-integration/ +:spring-session: https://projects.spring.io/spring-session/ +:spring-framework: http://projects.spring.io/spring-framework/ +:spring-security: http://projects.spring.io/spring-security/ +:spring-data-jpa: http://projects.spring.io/spring-data-jpa/ +:spring-security-reference: https://docs.spring.io/spring-security/site/docs/{spring-security-docs-version}/reference/htmlsingle +:spring-security-oauth2-reference: https://projects.spring.io/spring-security-oauth/docs/oauth2.html +:spring-webservices-reference: https://docs.spring.io/spring-ws/docs/{spring-webservices-docs-version}/reference/ +:spring-javadoc: https://docs.spring.io/spring/docs/{spring-docs-version}/javadoc-api/org/springframework +:spring-amqp-javadoc: https://docs.spring.io/spring-amqp/docs/current/api/org/springframework/amqp +:spring-batch-javadoc: https://docs.spring.io/spring-batch/apidocs/org/springframework/batch +:spring-data-javadoc: https://docs.spring.io/spring-data/jpa/docs/current/api/org/springframework/data/jpa +:spring-data-commons-javadoc: https://docs.spring.io/spring-data/commons/docs/current/api/org/springframework/data +:spring-data-mongo-javadoc: https://docs.spring.io/spring-data/mongodb/docs/current/api/org/springframework/data/mongodb +:spring-data-mongo: https://projects.spring.io/spring-data-mongodb/ +:spring-data: https://projects.spring.io/spring-data/ +:spring-data-rest-javadoc: https://docs.spring.io/spring-data/rest/docs/current/api/org/springframework/data/rest +:gradle-userguide: https://www.gradle.org/docs/current/userguide +:ant-manual: http://ant.apache.org/manual +:gradle-user-guide: https://docs.gradle.org/4.2.1/userguide +:hibernate-documentation: https://docs.jboss.org/hibernate/orm/5.2/userguide/html_single/Hibernate_User_Guide.html +:jetty-documentation: https://www.eclipse.org/jetty/documentation/9.4.x +:micrometer-concepts-documentation: https://micrometer.io/docs/concepts +:micrometer-registry-documentation: http://micrometer.io/docs/registry +:tomcat-documentation: https://tomcat.apache.org/tomcat-8.5-doc +:kotlin-documentation: https://kotlinlang.org/docs/reference/ +:junit5-documentation: https://junit.org/junit5/docs/current/user-guide diff --git a/spring-boot-project/spring-boot-docs/src/main/asciidoc/build-tool-plugins.adoc b/spring-boot-project/spring-boot-docs/src/main/asciidoc/build-tool-plugins.adoc index 0c45a612b71..5d3867b5310 100644 --- a/spring-boot-project/spring-boot-docs/src/main/asciidoc/build-tool-plugins.adoc +++ b/spring-boot-project/spring-boot-docs/src/main/asciidoc/build-tool-plugins.adoc @@ -1,5 +1,6 @@ [[build-tool-plugins]] -= Build tool plugins += Build Tool Plugins +include::attributes.adoc[] [partintro] -- diff --git a/spring-boot-project/spring-boot-docs/src/main/asciidoc/colophon.adoc b/spring-boot-project/spring-boot-docs/src/main/asciidoc/colophon.adoc new file mode 100644 index 00000000000..ed835bdf895 --- /dev/null +++ b/spring-boot-project/spring-boot-docs/src/main/asciidoc/colophon.adoc @@ -0,0 +1,11 @@ +[colophon] += Colophon + +{spring-boot-version} + +Copyright © 2012-2018 + +Copies of this document may be made for your own use and for distribution to +others, provided that you do not charge any fee for such copies and further +provided that each copy contains this Copyright Notice, whether distributed in +print or electronically. diff --git a/spring-boot-project/spring-boot-docs/src/main/asciidoc/deployment.adoc b/spring-boot-project/spring-boot-docs/src/main/asciidoc/deployment.adoc index 12112a5f8ce..b43b2481e91 100644 --- a/spring-boot-project/spring-boot-docs/src/main/asciidoc/deployment.adoc +++ b/spring-boot-project/spring-boot-docs/src/main/asciidoc/deployment.adoc @@ -1,5 +1,6 @@ [[deployment]] = Deploying Spring Boot Applications +include::attributes.adoc[] [partintro] -- diff --git a/spring-boot-project/spring-boot-docs/src/main/asciidoc/documentation-overview.adoc b/spring-boot-project/spring-boot-docs/src/main/asciidoc/documentation-overview.adoc index 44af5711b7a..aabedda6f57 100644 --- a/spring-boot-project/spring-boot-docs/src/main/asciidoc/documentation-overview.adoc +++ b/spring-boot-project/spring-boot-docs/src/main/asciidoc/documentation-overview.adoc @@ -1,5 +1,6 @@ [[boot-documentation]] = Spring Boot Documentation +include::attributes.adoc[] [partintro] -- diff --git a/spring-boot-project/spring-boot-docs/src/main/asciidoc/getting-started.adoc b/spring-boot-project/spring-boot-docs/src/main/asciidoc/getting-started.adoc index b247a845921..e7c477cb6cb 100644 --- a/spring-boot-project/spring-boot-docs/src/main/asciidoc/getting-started.adoc +++ b/spring-boot-project/spring-boot-docs/src/main/asciidoc/getting-started.adoc @@ -1,5 +1,6 @@ [[getting-started]] = Getting Started +include::attributes.adoc[] [partintro] -- @@ -627,7 +628,7 @@ important parts in the next few sections. [[getting-started-first-application-annotations]] -==== The @RestController and @RequestMapping Annotations +==== The `@RestController` and `@RequestMapping` Annotations The first annotation on our `Example` class is `@RestController`. This is known as a _stereotype_ annotation. It provides hints for people reading the code and for Spring that the class plays a specific role. In this case, our class is a web `@Controller`, so diff --git a/spring-boot-project/spring-boot-docs/src/main/asciidoc/howto.adoc b/spring-boot-project/spring-boot-docs/src/main/asciidoc/howto.adoc index d718cca7ad6..2a75d498a3d 100644 --- a/spring-boot-project/spring-boot-docs/src/main/asciidoc/howto.adoc +++ b/spring-boot-project/spring-boot-docs/src/main/asciidoc/howto.adoc @@ -1,5 +1,6 @@ [[howto]] -= '`How-to`' guides += "`How-to`" Guides +include::attributes.adoc[] [partintro] -- diff --git a/spring-boot-project/spring-boot-docs/src/main/asciidoc/images/epub-cover.png b/spring-boot-project/spring-boot-docs/src/main/asciidoc/images/epub-cover.png new file mode 100644 index 00000000000..8536552f854 Binary files /dev/null and b/spring-boot-project/spring-boot-docs/src/main/asciidoc/images/epub-cover.png differ diff --git a/spring-boot-project/spring-boot-docs/src/main/asciidoc/images/epub-cover.svg b/spring-boot-project/spring-boot-docs/src/main/asciidoc/images/epub-cover.svg new file mode 100644 index 00000000000..797468ad394 --- /dev/null +++ b/spring-boot-project/spring-boot-docs/src/main/asciidoc/images/epub-cover.svg @@ -0,0 +1,13 @@ + + + + + + Spring Boot + Reference Guide + Phillip Webb, Dave Syer, Josh Long, + Stéphane Nicoll, Rob Winch, Andy Wilkinson, + Marcel Overdijk, Christian Dupuis, + Sébastien Deleuze, Michael Simons, + Vedran Pavić, Jay Bryant, Madhura Bhave + diff --git a/spring-boot-project/spring-boot-docs/src/main/asciidoc/index.adoc b/spring-boot-project/spring-boot-docs/src/main/asciidoc/index.adoc index e88a7004744..a443828cf64 100644 --- a/spring-boot-project/spring-boot-docs/src/main/asciidoc/index.adoc +++ b/spring-boot-project/spring-boot-docs/src/main/asciidoc/index.adoc @@ -1,90 +1,18 @@ -= Spring Boot Reference Guide -Phillip Webb; Dave Syer; Josh Long; Stéphane Nicoll; Rob Winch; Andy Wilkinson; Marcel Overdijk; Christian Dupuis; Sébastien Deleuze; Michael Simons; Vedran Pavić; Jay Bryant; Madhura Bhave -:doctype: book -:toc: -:toclevels: 4 -:source-highlighter: prettify -:numbered: -:icons: font -:hide-uri-scheme: -:spring-boot-repo: snapshot -:github-tag: master -:spring-boot-docs-version: current -:spring-boot-docs: https://docs.spring.io/spring-boot/docs/{spring-boot-docs-version}/reference -:spring-boot-docs-current: https://docs.spring.io/spring-boot/docs/current/reference -:github-repo: spring-projects/spring-boot -:github-raw: https://raw.github.com/{github-repo}/{github-tag} -:github-code: https://github.com/{github-repo}/tree/{github-tag} -:github-issues: https://github.com/{github-repo}/issues/ -:github-wiki: https://github.com/{github-repo}/wiki -:github-master-code: https://github.com/{github-repo}/tree/master -:sc-ext: java -:sc-spring-boot: {github-code}/spring-boot-project/spring-boot/src/main/java/org/springframework/boot -:sc-spring-boot-autoconfigure: {github-code}/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure -:sc-spring-boot-actuator: {github-code}/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate -:sc-spring-boot-actuator-autoconfigure: {github-code}/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure -:sc-spring-boot-cli: {github-code}/spring-boot-project/spring-boot-cli/src/main/java/org/springframework/boot/cli -:sc-spring-boot-devtools: {github-code}/spring-boot-project/spring-boot-devtools/src/main/java/org/springframework/boot/devtools -:sc-spring-boot-test: {github-code}/spring-boot-project/spring-boot-test/src/main/java/org/springframework/boot/test -:sc-spring-boot-test-autoconfigure: {github-code}/spring-boot-project/spring-boot-test-autoconfigure/src/main/java/org/springframework/boot/test/autoconfigure -:dc-ext: html -:dc-root: https://docs.spring.io/spring-boot/docs/{spring-boot-docs-version}/api -:dc-spring-boot: {dc-root}/org/springframework/boot -:dc-spring-boot-autoconfigure: {dc-root}/org/springframework/boot/autoconfigure -:dc-spring-boot-actuator: {dc-root}/org/springframework/boot/actuate -:dc-spring-boot-test: {dc-root}/org/springframework/boot/test -:dc-spring-boot-test-autoconfigure: {dc-root}/org/springframework/boot/test/autoconfigure -:dependency-management-plugin: https://github.com/spring-gradle-plugins/dependency-management-plugin -:dependency-management-plugin-documentation: {dependency-management-plugin}/blob/master/README.md -:java-javadoc: https://docs.oracle.com/javase/8/docs/api/ -:spring-boot-actuator-api: https://docs.spring.io/spring-boot/docs/{spring-boot-docs-version}/actuator-api/ -:spring-boot-maven-plugin-site: https://docs.spring.io/spring-boot/docs/{spring-boot-docs-version}/maven-plugin -:spring-boot-gradle-plugin: https://docs.spring.io/spring-boot/docs/{spring-boot-docs-version}/gradle-plugin -:spring-boot-gradle-plugin-reference: https://docs.spring.io/spring-boot/docs/{spring-boot-docs-version}/gradle-plugin/reference/html -:spring-reference: https://docs.spring.io/spring/docs/{spring-docs-version}/spring-framework-reference/ -:spring-initializr-reference: https://docs.spring.io/initializr/docs/current/reference/htmlsingle -:spring-rest-docs: https://projects.spring.io/spring-restdocs/ -:spring-integration: https://projects.spring.io/spring-integration/ -:spring-session: https://projects.spring.io/spring-session/ -:spring-framework: http://projects.spring.io/spring-framework/ -:spring-security: http://projects.spring.io/spring-security/ -:spring-data-jpa: http://projects.spring.io/spring-data-jpa/ -:spring-security-reference: https://docs.spring.io/spring-security/site/docs/{spring-security-docs-version}/reference/htmlsingle -:spring-security-oauth2-reference: https://projects.spring.io/spring-security-oauth/docs/oauth2.html -:spring-webservices-reference: https://docs.spring.io/spring-ws/docs/{spring-webservices-docs-version}/reference/ -:spring-javadoc: https://docs.spring.io/spring/docs/{spring-docs-version}/javadoc-api/org/springframework -:spring-amqp-javadoc: https://docs.spring.io/spring-amqp/docs/current/api/org/springframework/amqp -:spring-batch-javadoc: https://docs.spring.io/spring-batch/apidocs/org/springframework/batch -:spring-data-javadoc: https://docs.spring.io/spring-data/jpa/docs/current/api/org/springframework/data/jpa -:spring-data-commons-javadoc: https://docs.spring.io/spring-data/commons/docs/current/api/org/springframework/data -:spring-data-mongo-javadoc: https://docs.spring.io/spring-data/mongodb/docs/current/api/org/springframework/data/mongodb -:spring-data-mongo: https://projects.spring.io/spring-data-mongodb/ -:spring-data: https://projects.spring.io/spring-data/ -:spring-data-rest-javadoc: https://docs.spring.io/spring-data/rest/docs/current/api/org/springframework/data/rest -:gradle-userguide: https://www.gradle.org/docs/current/userguide -:ant-manual: http://ant.apache.org/manual -:code-examples: ../java/org/springframework/boot/docs -:test-examples: ../../test/java/org/springframework/boot/docs -:gradle-user-guide: https://docs.gradle.org/4.2.1/userguide -:hibernate-documentation: https://docs.jboss.org/hibernate/orm/5.3/userguide/html_single/Hibernate_User_Guide.html -:jetty-documentation: https://www.eclipse.org/jetty/documentation/9.4.x -:jooq-manual: https://www.jooq.org/doc/{jooq-version}/manual-single-page -:micrometer-concepts-documentation: https://micrometer.io/docs/concepts -:micrometer-registry-documentation: http://micrometer.io/docs/registry -:tomcat-documentation: https://tomcat.apache.org/tomcat-8.5-doc -:kotlin-documentation: https://kotlinlang.org/docs/reference/ -:junit5-documentation: https://junit.org/junit5/docs/current/user-guide -// ====================================================================================== += Spring Boot Reference Documentation +Phillip Webb, Dave Syer, Josh Long, Stéphane Nicoll, Rob Winch, Andy Wilkinson, Marcel Overdijk, Christian Dupuis, Sébastien Deleuze, Michael Simons, Vedran Pavić, Jay Bryant, Madhura Bhave +:docinfo: shared -include::documentation-overview.adoc[] -include::getting-started.adoc[] -include::using-spring-boot.adoc[] -include::spring-boot-features.adoc[] -include::production-ready-features.adoc[] -include::deployment.adoc[] -include::spring-boot-cli.adoc[] -include::build-tool-plugins.adoc[] -include::howto.adoc[] -include::appendix.adoc[] +The reference documentation consists of the following sections: -// ====================================================================================== +[horizontal] +<> :: Legal information. +<> :: About the Documentation, Getting Help, First Steps, and more. +<> :: Introducing Spring Boot, System Requirements, Servlet Containers, Installing Spring Boot, Developing Your First Spring Boot Application +<> :: Build Systems, Structuring Your Code, Configuration, Spring Beans and Dependency Injection, and more. +<> :: Profiles, Logging, Security, Caching, Spring Integration, Testing, and more. +<> :: Monitoring, Metrics, Auditing, and more. +<> :: Deploying to the Cloud, Installing as a Unix application. +<> :: Installing the CLI, Using the CLI, Configuring the CLI, and more. +<> :: Maven Plugin, Gradle Plugin, Antlib, and more. +<> :: Application Development, Configuration, Embedded Servers, Data Access, and many more. +<> :: Properties, Metadata, Configuration, Dependencies, and more. diff --git a/spring-boot-project/spring-boot-docs/src/main/asciidoc/production-ready-features.adoc b/spring-boot-project/spring-boot-docs/src/main/asciidoc/production-ready-features.adoc index 5053592ffe5..4feb97a7362 100644 --- a/spring-boot-project/spring-boot-docs/src/main/asciidoc/production-ready-features.adoc +++ b/spring-boot-project/spring-boot-docs/src/main/asciidoc/production-ready-features.adoc @@ -1,5 +1,6 @@ [[production-ready]] -= Spring Boot Actuator: Production-ready features += Spring Boot Actuator: Production-ready Features +include::attributes.adoc[] [partintro] -- diff --git a/spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-cli.adoc b/spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-cli.adoc index 215a93989ce..252281433d2 100644 --- a/spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-cli.adoc +++ b/spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-cli.adoc @@ -1,5 +1,6 @@ [[cli]] = Spring Boot CLI +include::attributes.adoc[] [partintro] -- diff --git a/spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc b/spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc index d170c3c1c2f..82097e91b50 100644 --- a/spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc +++ b/spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc @@ -1,5 +1,6 @@ [[boot-features]] -= Spring Boot features += Spring Boot Features +include::attributes.adoc[] [partintro] -- diff --git a/spring-boot-project/spring-boot-docs/src/main/asciidoc/using-spring-boot.adoc b/spring-boot-project/spring-boot-docs/src/main/asciidoc/using-spring-boot.adoc index bf2ae501c7e..732f463b45b 100644 --- a/spring-boot-project/spring-boot-docs/src/main/asciidoc/using-spring-boot.adoc +++ b/spring-boot-project/spring-boot-docs/src/main/asciidoc/using-spring-boot.adoc @@ -1,5 +1,6 @@ [[using-boot]] = Using Spring Boot +include::attributes.adoc[] [partintro] --