Skip to content

Commit dcdb3f1

Browse files
committed
Merge pull request #10889 from Jay Bryant
* gh-10889: Wrap documentation-overview.adoc at 90 characters and use title case
2 parents 75914be + 8f2653d commit dcdb3f1

File tree

1 file changed

+59
-56
lines changed

1 file changed

+59
-56
lines changed

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

Lines changed: 59 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ as a map for the rest of the document.
1010

1111

1212
[[boot-documentation-about]]
13-
== About the documentation
13+
== About the Documentation
1414
The Spring Boot reference guide is available as
1515

1616
* {spring-boot-docs}/html[HTML]
@@ -20,46 +20,46 @@ The Spring Boot reference guide is available as
2020
The latest copy
2121
is available at {spring-boot-docs-current}.
2222

23-
Copies of this document may be made for your own use and for
24-
distribution to others, provided that you do not charge any fee for such copies and
25-
further provided that each copy contains this Copyright Notice, whether distributed in
26-
print or electronically.
23+
Copies of this document may be made for your own use and for distribution to others,
24+
provided that you do not charge any fee for such copies and further provided that each
25+
copy contains this Copyright Notice, whether distributed in print or electronically.
2726

2827

2928

3029
[[boot-documentation-getting-help]]
31-
== Getting help
30+
== Getting Help
3231
If you have trouble with Spring Boot, we would like to help.
3332

34-
* Try the <<howto.adoc#howto, How-to documents>>. They provide solutions to the most common
35-
questions.
36-
* Learn the Spring basics. Spring Boot builds on many other Spring projects. Check
37-
the http://spring.io[spring.io] web-site for a wealth of reference documentation. If
38-
you are starting out with Spring, try one of the http://spring.io/guides[guides].
33+
* Try the <<howto.adoc#howto, How-to documents>>. They provide solutions to the most
34+
common questions.
35+
* Learn the Spring basics. Spring Boot builds on many other Spring projects. Check the
36+
http://spring.io[spring.io] web-site for a wealth of reference documentation. If you are
37+
starting out with Spring, try one of the http://spring.io/guides[guides].
3938
* Ask a question. We monitor http://stackoverflow.com[stackoverflow.com] for questions
40-
tagged with http://stackoverflow.com/tags/spring-boot[`spring-boot`].
39+
tagged with http://stackoverflow.com/tags/spring-boot[`spring-boot`].
4140
* Report bugs with Spring Boot at https://github.com/spring-projects/spring-boot/issues.
4241

43-
NOTE: All of Spring Boot is open source, including the documentation. If you find problems
44-
with the docs or if you want to improve them, please {github-code}[get involved].
42+
NOTE: All of Spring Boot is open source, including the documentation. If you find
43+
problems with the docs or if you want to improve them, please {github-code}[get
44+
involved].
4545

4646

4747

4848
[[boot-documentation-first-steps]]
49-
== First steps
49+
== First Steps
5050
If you are getting started with Spring Boot or 'Spring' in general, start with
5151
<<getting-started.adoc#getting-started, the following topics>>:
5252

5353
* *From scratch:*
54-
<<getting-started.adoc#getting-started-introducing-spring-boot, Overview>> |
55-
<<getting-started.adoc#getting-started-system-requirements, Requirements>> |
56-
<<getting-started.adoc#getting-started-installing-spring-boot, Installation>>
54+
<<getting-started.adoc#getting-started-introducing-spring-boot, Overview>> |
55+
<<getting-started.adoc#getting-started-system-requirements, Requirements>> |
56+
<<getting-started.adoc#getting-started-installing-spring-boot, Installation>>
5757
* *Tutorial:*
58-
<<getting-started.adoc#getting-started-first-application, Part 1>> |
59-
<<getting-started.adoc#getting-started-first-application-code, Part 2>>
58+
<<getting-started.adoc#getting-started-first-application, Part 1>> |
59+
<<getting-started.adoc#getting-started-first-application-code, Part 2>>
6060
* *Running your example:*
61-
<<getting-started.adoc#getting-started-first-application-run, Part 1>> |
62-
<<getting-started.adoc#getting-started-first-application-executable-jar, Part 2>>
61+
<<getting-started.adoc#getting-started-first-application-run, Part 1>> |
62+
<<getting-started.adoc#getting-started-first-application-executable-jar, Part 2>>
6363

6464

6565

@@ -68,56 +68,58 @@ Ready to actually start using Spring Boot? <<using-spring-boot.adoc#using-boot,
6868
you covered>>:
6969

7070
* *Build systems:*
71-
<<using-spring-boot.adoc#using-boot-maven, Maven>> |
72-
<<using-spring-boot.adoc#using-boot-gradle, Gradle>> |
73-
<<using-spring-boot.adoc#using-boot-ant, Ant>> |
74-
<<using-spring-boot.adoc#using-boot-starter, Starters>>
71+
<<using-spring-boot.adoc#using-boot-maven, Maven>> |
72+
<<using-spring-boot.adoc#using-boot-gradle, Gradle>> |
73+
<<using-spring-boot.adoc#using-boot-ant, Ant>> |
74+
<<using-spring-boot.adoc#using-boot-starter, Starters>>
7575
* *Best practices:*
76-
<<using-spring-boot.adoc#using-boot-structuring-your-code, Code Structure>> |
77-
<<using-spring-boot.adoc#using-boot-configuration-classes, @Configuration>> |
78-
<<using-spring-boot.adoc#using-boot-auto-configuration, @EnableAutoConfiguration>> |
79-
<<using-spring-boot.adoc#using-boot-spring-beans-and-dependency-injection, Beans and Dependency Injection>>
76+
<<using-spring-boot.adoc#using-boot-structuring-your-code, Code Structure>> |
77+
<<using-spring-boot.adoc#using-boot-configuration-classes, @Configuration>> |
78+
<<using-spring-boot.adoc#using-boot-auto-configuration, @EnableAutoConfiguration>> |
79+
<<using-spring-boot.adoc#using-boot-spring-beans-and-dependency-injection, Beans and
80+
Dependency Injection>>
8081
* *Running your code*
81-
<<using-spring-boot.adoc#using-boot-running-from-an-ide, IDE>> |
82-
<<using-spring-boot.adoc#using-boot-running-as-a-packaged-application, Packaged>> |
83-
<<using-spring-boot.adoc#using-boot-running-with-the-maven-plugin, Maven>> |
84-
<<using-spring-boot.adoc#using-boot-running-with-the-gradle-plugin, Gradle>>
82+
<<using-spring-boot.adoc#using-boot-running-from-an-ide, IDE>> |
83+
<<using-spring-boot.adoc#using-boot-running-as-a-packaged-application, Packaged>> |
84+
<<using-spring-boot.adoc#using-boot-running-with-the-maven-plugin, Maven>> |
85+
<<using-spring-boot.adoc#using-boot-running-with-the-gradle-plugin, Gradle>>
8586
* *Packaging your app:*
86-
<<using-spring-boot.adoc#using-boot-packaging-for-production, Production jars>>
87+
<<using-spring-boot.adoc#using-boot-packaging-for-production, Production jars>>
8788
* *Spring Boot CLI:*
8889
<<spring-boot-cli.adoc#cli, Using the CLI>>
8990

9091

9192

92-
== Learning about Spring Boot features
93+
== Learning about Spring Boot Features
9394
Need more details about Spring Boot's core features?
9495
<<spring-boot-features.adoc#boot-features, The following content is for you>>:
9596

9697
* *Core Features:*
97-
<<spring-boot-features.adoc#boot-features-spring-application, SpringApplication>> |
98-
<<spring-boot-features.adoc#boot-features-external-config, External Configuration>> |
99-
<<spring-boot-features.adoc#boot-features-profiles, Profiles>> |
100-
<<spring-boot-features.adoc#boot-features-logging, Logging>>
98+
<<spring-boot-features.adoc#boot-features-spring-application, SpringApplication>> |
99+
<<spring-boot-features.adoc#boot-features-external-config, External Configuration>> |
100+
<<spring-boot-features.adoc#boot-features-profiles, Profiles>> |
101+
<<spring-boot-features.adoc#boot-features-logging, Logging>>
101102
* *Web Applications:*
102-
<<spring-boot-features.adoc#boot-features-spring-mvc, MVC>> |
103-
<<spring-boot-features.adoc#boot-features-embedded-container, Embedded Containers>>
103+
<<spring-boot-features.adoc#boot-features-spring-mvc, MVC>> |
104+
<<spring-boot-features.adoc#boot-features-embedded-container, Embedded Containers>>
104105
* *Working with data:*
105-
<<spring-boot-features.adoc#boot-features-sql, SQL>> |
106-
<<spring-boot-features.adoc#boot-features-nosql, NO-SQL>>
106+
<<spring-boot-features.adoc#boot-features-sql, SQL>> |
107+
<<spring-boot-features.adoc#boot-features-nosql, NO-SQL>>
107108
* *Messaging:*
108-
<<spring-boot-features.adoc#boot-features-messaging, Overview>> |
109-
<<spring-boot-features.adoc#boot-features-jms, JMS>>
109+
<<spring-boot-features.adoc#boot-features-messaging, Overview>> |
110+
<<spring-boot-features.adoc#boot-features-jms, JMS>>
110111
* *Testing:*
111-
<<spring-boot-features.adoc#boot-features-testing, Overview>> |
112-
<<spring-boot-features.adoc#boot-features-testing-spring-boot-applications, Boot Applications>> |
113-
<<spring-boot-features.adoc#boot-features-test-utilities, Utils>>
112+
<<spring-boot-features.adoc#boot-features-testing, Overview>> |
113+
<<spring-boot-features.adoc#boot-features-testing-spring-boot-applications, Boot
114+
Applications>> |
115+
<<spring-boot-features.adoc#boot-features-test-utilities, Utils>>
114116
* *Extending:*
115-
<<spring-boot-features.adoc#boot-features-developing-auto-configuration, Auto-configuration>> |
116-
<<spring-boot-features.adoc#boot-features-condition-annotations, @Conditions>>
117+
<<spring-boot-features.adoc#boot-features-developing-auto-configuration, Auto-configuration>> |
118+
<<spring-boot-features.adoc#boot-features-condition-annotations, @Conditions>>
117119

118120

119121

120-
== Moving to production
122+
== Moving to Production
121123
When you are ready to push your Spring Boot application to production, we have
122124
<<production-ready-features.adoc#production-ready, some tricks>> that you might like:
123125

@@ -135,7 +137,7 @@ When you are ready to push your Spring Boot application to production, we have
135137

136138

137139

138-
== Advanced topics
140+
== Advanced Topics
139141
Finally, we have a few topics for more advanced users:
140142

141143
* *Spring Boot Applications Deployment:*
@@ -145,7 +147,8 @@ Finally, we have a few topics for more advanced users:
145147
<<build-tool-plugins.adoc#build-tool-plugins-maven-plugin, Maven>> |
146148
<<build-tool-plugins.adoc#build-tool-plugins-gradle-plugin, Gradle>>
147149
* *Appendix:*
148-
<<appendix-application-properties.adoc#common-application-properties, Application Properties>> |
149-
<<appendix-auto-configuration-classes.adoc#auto-configuration-classes, Auto-configuration classes>> |
150+
<<appendix-application-properties.adoc#common-application-properties, Application
151+
Properties>> |
152+
<<appendix-auto-configuration-classes.adoc#auto-configuration-classes, Auto-configuration
153+
classes>> |
150154
<<appendix-executable-jar-format.adoc#executable-jar, Executable Jars>>
151-

0 commit comments

Comments
 (0)