Skip to content

Commit 1b3de4b

Browse files
committed
Merge pull request #10754 from Jay Bryant
* gh-10754: Editorial changes to overview section of the reference documentation
2 parents 76c4819 + 9a98503 commit 1b3de4b

File tree

1 file changed

+25
-26
lines changed

1 file changed

+25
-26
lines changed

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

Lines changed: 25 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,21 @@
33

44
[partintro]
55
--
6-
This section provides a brief overview of Spring Boot reference documentation. Think of
7-
it as map for the rest of the document. You can read this reference guide in a linear
8-
fashion, or you can skip sections if something doesn't interest you.
6+
This section provides a brief overview of Spring Boot reference documentation. It serves
7+
as a map for the rest of the document.
98
--
109

1110

1211

1312
[[boot-documentation-about]]
1413
== About the documentation
15-
The Spring Boot reference guide is available as {spring-boot-docs}/html[html],
16-
{spring-boot-docs}/pdf/spring-boot-reference.pdf[pdf]
17-
and {spring-boot-docs}/epub/spring-boot-reference.epub[epub] documents. The latest copy
14+
The Spring Boot reference guide is available as
15+
16+
* {spring-boot-docs}/html[HTML]
17+
* {spring-boot-docs}/pdf/spring-boot-reference.pdf[PDF]
18+
* {spring-boot-docs}/epub/spring-boot-reference.epub[EPUB]
19+
20+
The latest copy
1821
is available at {spring-boot-docs-current}.
1922

2023
Copies of this document may be made for your own use and for
@@ -26,26 +29,26 @@ print or electronically.
2629

2730
[[boot-documentation-getting-help]]
2831
== Getting help
29-
Having trouble with Spring Boot, We'd like to help!
32+
If you have trouble with Spring Boot, we would like to help.
3033

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

40-
NOTE: All of Spring Boot is open source, including the documentation! If you find problems
41-
with the docs; or if you just want to improve them, please {github-code}[get involved].
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].
4245

4346

4447

4548
[[boot-documentation-first-steps]]
4649
== First steps
47-
If you're just getting started with Spring Boot, or 'Spring' in general,
48-
<<getting-started.adoc#getting-started, this is the place to start!>>
50+
If you are getting started with Spring Boot or 'Spring' in general, start with
51+
<<getting-started.adoc#getting-started, the following topics>>:
4952

5053
* *From scratch:*
5154
<<getting-started.adoc#getting-started-introducing-spring-boot, Overview>> |
@@ -61,8 +64,8 @@ If you're just getting started with Spring Boot, or 'Spring' in general,
6164

6265

6366
== Working with Spring Boot
64-
Ready to actually start using Spring Boot? <<using-spring-boot.adoc#using-boot, We've
65-
got you covered>>.
67+
Ready to actually start using Spring Boot? <<using-spring-boot.adoc#using-boot, We have
68+
you covered>>:
6669

6770
* *Build systems:*
6871
<<using-spring-boot.adoc#using-boot-maven, Maven>> |
@@ -88,7 +91,7 @@ got you covered>>.
8891

8992
== Learning about Spring Boot features
9093
Need more details about Spring Boot's core features?
91-
<<spring-boot-features.adoc#boot-features, This is for you>>!
94+
<<spring-boot-features.adoc#boot-features, The following content is for you>>:
9295

9396
* *Core Features:*
9497
<<spring-boot-features.adoc#boot-features-spring-application, SpringApplication>> |
@@ -115,8 +118,8 @@ Need more details about Spring Boot's core features?
115118

116119

117120
== Moving to production
118-
When you're ready to push your Spring Boot application to production, we've got
119-
<<production-ready-features.adoc#production-ready, some tricks that you might like>>!
121+
When you are ready to push your Spring Boot application to production, we have
122+
<<production-ready-features.adoc#production-ready, some tricks>> that you might like:
120123

121124
* *Management endpoints:*
122125
<<production-ready-features.adoc#production-ready-endpoints, Overview>> |
@@ -133,9 +136,9 @@ When you're ready to push your Spring Boot application to production, we've got
133136

134137

135138
== Advanced topics
136-
Lastly, we have a few topics for the more advanced user.
139+
Finally, we have a few topics for more advanced users:
137140

138-
* *Deploy Spring Boot Applications:*
141+
* *Spring Boot Applications Deployment:*
139142
<<deployment.adoc#cloud-deployment, Cloud Deployment>> |
140143
<<deployment.adoc#deployment-service, OS Service>>
141144
* *Build tool plugins:*
@@ -145,7 +148,3 @@ Lastly, we have a few topics for the more advanced user.
145148
<<appendix-application-properties.adoc#common-application-properties, Application Properties>> |
146149
<<appendix-auto-configuration-classes.adoc#auto-configuration-classes, Auto-configuration classes>> |
147150
<<appendix-executable-jar-format.adoc#executable-jar, Executable Jars>>
148-
149-
150-
151-

0 commit comments

Comments
 (0)