Skip to content

Commit a7d22aa

Browse files
Jay Bryantbclozel
Jay Bryant
authored andcommitted
Reorganize asciidoc content
This commit adds an index page for the multi-file HTML version, and fixed a couple of casing issues (significant words starting with lower case in headings). While researching how to get the content from index-docinfo.xml into the output, I came across the notion of a colophon, which is a good name for the information in that file. I have consequently changed "Legal" (which I never liked but couldn't think of a better term for at the time) to "Colophon". See gh-12611
1 parent a60c575 commit a7d22aa

21 files changed

+207
-100
lines changed
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
[[appendix]]
22
= Appendices
33

4-
include::appendix-application-properties.adoc[]
5-
include::appendix-configuration-metadata.adoc[]
6-
include::appendix-auto-configuration-classes.adoc[]
7-
include::appendix-test-auto-configuration.adoc[]
8-
include::appendix-executable-jar-format.adoc[]
9-
include::appendix-dependency-versions.adoc[]
4+
include::attributes.adoc[]
5+
6+
include::appendix/application-properties.adoc[]
7+
include::appendix/configuration-metadata.adoc[]
8+
include::appendix/auto-configuration-classes.adoc[]
9+
include::appendix/test-auto-configuration.adoc[]
10+
include::appendix/executable-jar-format.adoc[]
11+
include::appendix/dependency-versions.adoc[]

spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix-test-auto-configuration.adoc renamed to spring-boot-project/spring-boot-docs/src/main/asciidoc/appendix/test-auto-configuration.adoc

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
[appendix]
22
[[test-auto-configuration]]
3-
== Test auto-configuration annotations
3+
== Test Auto-configuration Annotations
4+
45
The following table lists the various `@…Test` annotations that can be used to test
56
slices of your application and the auto-configuration that they import by default:
67

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,143 @@
1+
:doctype: book
2+
:idprefix:
3+
:idseparator: -
4+
:toc: left
5+
:toclevels: 4
6+
:tabsize: 4
7+
:numbered:
8+
:sectanchors:
9+
:sectnums:
10+
:icons: font
11+
:hide-uri-scheme:
12+
:docinfo: shared,private
13+
14+
:spring-boot-repo: snapshot
15+
:github-tag: master
16+
:spring-boot-docs-version: current
17+
:spring-boot-docs: https://docs.spring.io/spring-boot/docs/{spring-boot-docs-version}/reference
18+
:spring-boot-docs-current: https://docs.spring.io/spring-boot/docs/current/reference
19+
:github-repo: spring-projects/spring-boot
20+
:github-raw: https://raw.github.com/{github-repo}/{github-tag}
21+
:github-code: https://github.com/{github-repo}/tree/{github-tag}
22+
:github-issues: https://github.com/{github-repo}/issues/
23+
:github-wiki: https://github.com/{github-repo}/wiki
24+
:github-master-code: https://github.com/{github-repo}/tree/master
25+
:sc-ext: java
26+
:sc-spring-boot: {github-code}/spring-boot-project/spring-boot/src/main/java/org/springframework/boot
27+
:sc-spring-boot-autoconfigure: {github-code}/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure
28+
:sc-spring-boot-actuator: {github-code}/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate
29+
:sc-spring-boot-actuator-autoconfigure: {github-code}/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure
30+
:sc-spring-boot-cli: {github-code}/spring-boot-project/spring-boot-cli/src/main/java/org/springframework/boot/cli
31+
:sc-spring-boot-devtools: {github-code}/spring-boot-project/spring-boot-devtools/src/main/java/org/springframework/boot/devtools
32+
:sc-spring-boot-test: {github-code}/spring-boot-project/spring-boot-test/src/main/java/org/springframework/boot/test
33+
:sc-spring-boot-test-autoconfigure: {github-code}/spring-boot-project/spring-boot-test-autoconfigure/src/main/java/org/springframework/boot/test/autoconfigure
34+
:dc-ext: html
35+
:dc-root: https://docs.spring.io/spring-boot/docs/{spring-boot-docs-version}/api
36+
:dc-spring-boot: {dc-root}/org/springframework/boot
37+
:dc-spring-boot-autoconfigure: {dc-root}/org/springframework/boot/autoconfigure
38+
:dc-spring-boot-actuator: {dc-root}/org/springframework/boot/actuate
39+
:dc-spring-boot-test: {dc-root}/org/springframework/boot/test
40+
:dc-spring-boot-test-autoconfigure: {dc-root}/org/springframework/boot/test/autoconfigure
41+
:dependency-management-plugin: https://github.com/spring-gradle-plugins/dependency-management-plugin
42+
:dependency-management-plugin-documentation: {dependency-management-plugin}/blob/master/README.md
43+
:java-javadoc: https://docs.oracle.com/javase/8/docs/api/
44+
:spring-boot-actuator-api: https://docs.spring.io/spring-boot/docs/{spring-boot-docs-version}/actuator-api/
45+
:spring-boot-maven-plugin-site: https://docs.spring.io/spring-boot/docs/{spring-boot-docs-version}/maven-plugin
46+
:spring-boot-gradle-plugin: https://docs.spring.io/spring-boot/docs/{spring-boot-docs-version}/gradle-plugin
47+
:spring-boot-gradle-plugin-reference: https://docs.spring.io/spring-boot/docs/{spring-boot-docs-version}/gradle-plugin/reference/html
48+
:spring-reference: https://docs.spring.io/spring/docs/{spring-docs-version}/spring-framework-reference/
49+
:spring-initializr-reference: https://docs.spring.io/initializr/docs/current/reference/htmlsingle
50+
:spring-rest-docs: https://projects.spring.io/spring-restdocs/
51+
:spring-integration: https://projects.spring.io/spring-integration/
52+
:spring-session: https://projects.spring.io/spring-session/
53+
:spring-framework: http://projects.spring.io/spring-framework/
54+
:spring-security: http://projects.spring.io/spring-security/
55+
:spring-data-jpa: http://projects.spring.io/spring-data-jpa/
56+
:spring-security-reference: https://docs.spring.io/spring-security/site/docs/{spring-security-docs-version}/reference/htmlsingle
57+
:spring-security-oauth2-reference: https://projects.spring.io/spring-security-oauth/docs/oauth2.html
58+
:spring-webservices-reference: https://docs.spring.io/spring-ws/docs/{spring-webservices-docs-version}/reference/
59+
:spring-javadoc: https://docs.spring.io/spring/docs/{spring-docs-version}/javadoc-api/org/springframework
60+
:spring-amqp-javadoc: https://docs.spring.io/spring-amqp/docs/current/api/org/springframework/amqp
61+
:spring-batch-javadoc: https://docs.spring.io/spring-batch/apidocs/org/springframework/batch
62+
:spring-data-javadoc: https://docs.spring.io/spring-data/jpa/docs/current/api/org/springframework/data/jpa
63+
:spring-data-commons-javadoc: https://docs.spring.io/spring-data/commons/docs/current/api/org/springframework/data
64+
:spring-data-mongo-javadoc: https://docs.spring.io/spring-data/mongodb/docs/current/api/org/springframework/data/mongodb
65+
:spring-data-mongo: https://projects.spring.io/spring-data-mongodb/
66+
:spring-data: https://projects.spring.io/spring-data/
67+
:spring-data-rest-javadoc: https://docs.spring.io/spring-data/rest/docs/current/api/org/springframework/data/rest
68+
:gradle-userguide: https://www.gradle.org/docs/current/userguide
69+
:ant-manual: http://ant.apache.org/manual
70+
:code-examples: {sources-root}/main/java/org/springframework/boot/docs
71+
:test-examples: {sources-root}/test/java/org/springframework/boot/docs
72+
:gradle-user-guide: https://docs.gradle.org/4.2.1/userguide
73+
:hibernate-documentation: https://docs.jboss.org/hibernate/orm/5.3/userguide/html_single/Hibernate_User_Guide.html
74+
:jetty-documentation: https://www.eclipse.org/jetty/documentation/9.4.x
75+
:jooq-manual: https://www.jooq.org/doc/{jooq-version}/manual-single-page
76+
:micrometer-concepts-documentation: https://micrometer.io/docs/concepts
77+
:micrometer-registry-documentation: http://micrometer.io/docs/registry
78+
:tomcat-documentation: https://tomcat.apache.org/tomcat-8.5-doc
79+
:kotlin-documentation: https://kotlinlang.org/docs/reference/
80+
:junit5-documentation: https://junit.org/junit5/docs/current/user-guide
81+
:spring-boot-repo: snapshot
82+
:github-tag: master
83+
:spring-boot-docs-version: current
84+
:spring-boot-docs: https://docs.spring.io/spring-boot/docs/{spring-boot-docs-version}/reference
85+
:spring-boot-docs-current: https://docs.spring.io/spring-boot/docs/current/reference
86+
:github-repo: spring-projects/spring-boot
87+
:github-raw: https://raw.github.com/{github-repo}/{github-tag}
88+
:github-code: https://github.com/{github-repo}/tree/{github-tag}
89+
:github-issues: https://github.com/{github-repo}/issues/
90+
:github-wiki: https://github.com/{github-repo}/wiki
91+
:github-master-code: https://github.com/{github-repo}/tree/master
92+
:sc-ext: java
93+
:sc-spring-boot: {github-code}/spring-boot-project/spring-boot/src/main/java/org/springframework/boot
94+
:sc-spring-boot-autoconfigure: {github-code}/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure
95+
:sc-spring-boot-actuator: {github-code}/spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate
96+
:sc-spring-boot-actuator-autoconfigure: {github-code}/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure
97+
:sc-spring-boot-cli: {github-code}/spring-boot-project/spring-boot-cli/src/main/java/org/springframework/boot/cli
98+
:sc-spring-boot-devtools: {github-code}/spring-boot-project/spring-boot-devtools/src/main/java/org/springframework/boot/devtools
99+
:sc-spring-boot-test: {github-code}/spring-boot-project/spring-boot-test/src/main/java/org/springframework/boot/test
100+
:sc-spring-boot-test-autoconfigure: {github-code}/spring-boot-project/spring-boot-test-autoconfigure/src/main/java/org/springframework/boot/test/autoconfigure
101+
:dc-ext: html
102+
:dc-root: https://docs.spring.io/spring-boot/docs/{spring-boot-docs-version}/api
103+
:dc-spring-boot: {dc-root}/org/springframework/boot
104+
:dc-spring-boot-autoconfigure: {dc-root}/org/springframework/boot/autoconfigure
105+
:dc-spring-boot-actuator: {dc-root}/org/springframework/boot/actuate
106+
:dc-spring-boot-test: {dc-root}/org/springframework/boot/test
107+
:dc-spring-boot-test-autoconfigure: {dc-root}/org/springframework/boot/test/autoconfigure
108+
:dependency-management-plugin: https://github.com/spring-gradle-plugins/dependency-management-plugin
109+
:dependency-management-plugin-documentation: {dependency-management-plugin}/blob/master/README.md
110+
:java-javadoc: https://docs.oracle.com/javase/8/docs/api/
111+
:spring-boot-actuator-api: https://docs.spring.io/spring-boot/docs/{spring-boot-docs-version}/actuator-api/
112+
:spring-boot-maven-plugin-site: https://docs.spring.io/spring-boot/docs/{spring-boot-docs-version}/maven-plugin
113+
:spring-boot-gradle-plugin: https://docs.spring.io/spring-boot/docs/{spring-boot-docs-version}/gradle-plugin
114+
:spring-boot-gradle-plugin-reference: https://docs.spring.io/spring-boot/docs/{spring-boot-docs-version}/gradle-plugin/reference/html
115+
:spring-reference: https://docs.spring.io/spring/docs/{spring-docs-version}/spring-framework-reference/
116+
:spring-rest-docs: https://projects.spring.io/spring-restdocs/
117+
:spring-integration: https://projects.spring.io/spring-integration/
118+
:spring-session: https://projects.spring.io/spring-session/
119+
:spring-framework: http://projects.spring.io/spring-framework/
120+
:spring-security: http://projects.spring.io/spring-security/
121+
:spring-data-jpa: http://projects.spring.io/spring-data-jpa/
122+
:spring-security-reference: https://docs.spring.io/spring-security/site/docs/{spring-security-docs-version}/reference/htmlsingle
123+
:spring-security-oauth2-reference: https://projects.spring.io/spring-security-oauth/docs/oauth2.html
124+
:spring-webservices-reference: https://docs.spring.io/spring-ws/docs/{spring-webservices-docs-version}/reference/
125+
:spring-javadoc: https://docs.spring.io/spring/docs/{spring-docs-version}/javadoc-api/org/springframework
126+
:spring-amqp-javadoc: https://docs.spring.io/spring-amqp/docs/current/api/org/springframework/amqp
127+
:spring-batch-javadoc: https://docs.spring.io/spring-batch/apidocs/org/springframework/batch
128+
:spring-data-javadoc: https://docs.spring.io/spring-data/jpa/docs/current/api/org/springframework/data/jpa
129+
:spring-data-commons-javadoc: https://docs.spring.io/spring-data/commons/docs/current/api/org/springframework/data
130+
:spring-data-mongo-javadoc: https://docs.spring.io/spring-data/mongodb/docs/current/api/org/springframework/data/mongodb
131+
:spring-data-mongo: https://projects.spring.io/spring-data-mongodb/
132+
:spring-data: https://projects.spring.io/spring-data/
133+
:spring-data-rest-javadoc: https://docs.spring.io/spring-data/rest/docs/current/api/org/springframework/data/rest
134+
:gradle-userguide: https://www.gradle.org/docs/current/userguide
135+
:ant-manual: http://ant.apache.org/manual
136+
:gradle-user-guide: https://docs.gradle.org/4.2.1/userguide
137+
:hibernate-documentation: https://docs.jboss.org/hibernate/orm/5.2/userguide/html_single/Hibernate_User_Guide.html
138+
:jetty-documentation: https://www.eclipse.org/jetty/documentation/9.4.x
139+
:micrometer-concepts-documentation: https://micrometer.io/docs/concepts
140+
:micrometer-registry-documentation: http://micrometer.io/docs/registry
141+
:tomcat-documentation: https://tomcat.apache.org/tomcat-8.5-doc
142+
:kotlin-documentation: https://kotlinlang.org/docs/reference/
143+
:junit5-documentation: https://junit.org/junit5/docs/current/user-guide

spring-boot-project/spring-boot-docs/src/main/asciidoc/build-tool-plugins.adoc

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
[[build-tool-plugins]]
2-
= Build tool plugins
2+
= Build Tool Plugins
3+
include::attributes.adoc[]
34

45
[partintro]
56
--
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
[colophon]
2+
= Colophon
3+
4+
{spring-boot-version}
5+
6+
Copyright © 2012-2018
7+
8+
Copies of this document may be made for your own use and for distribution to
9+
others, provided that you do not charge any fee for such copies and further
10+
provided that each copy contains this Copyright Notice, whether distributed in
11+
print or electronically.

spring-boot-project/spring-boot-docs/src/main/asciidoc/deployment.adoc

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
[[deployment]]
22
= Deploying Spring Boot Applications
3+
include::attributes.adoc[]
34

45
[partintro]
56
--

spring-boot-project/spring-boot-docs/src/main/asciidoc/documentation-overview.adoc

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
[[boot-documentation]]
22
= Spring Boot Documentation
3+
include::attributes.adoc[]
34

45
[partintro]
56
--

spring-boot-project/spring-boot-docs/src/main/asciidoc/getting-started.adoc

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
[[getting-started]]
22
= Getting Started
3+
include::attributes.adoc[]
34

45
[partintro]
56
--
@@ -627,7 +628,7 @@ important parts in the next few sections.
627628

628629

629630
[[getting-started-first-application-annotations]]
630-
==== The @RestController and @RequestMapping Annotations
631+
==== The `@RestController` and `@RequestMapping` Annotations
631632
The first annotation on our `Example` class is `@RestController`. This is known as a
632633
_stereotype_ annotation. It provides hints for people reading the code and for Spring
633634
that the class plays a specific role. In this case, our class is a web `@Controller`, so

spring-boot-project/spring-boot-docs/src/main/asciidoc/howto.adoc

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
[[howto]]
2-
= '`How-to`' guides
2+
= "`How-to`" Guides
3+
include::attributes.adoc[]
34

45
[partintro]
56
--
Loading

0 commit comments

Comments
 (0)