root
/
spring-boot
mirror of https://github.com/spring-projects/spring-boot.git
1
0
Fork 0
Code Issues Actions 15 Packages Projects Releases Wiki Activity

Merge pull request #10754 from Jay Bryant 

* gh-10754:
  Editorial changes to overview section of the reference documentation
This commit is contained in:
Andy Wilkinson 2017-10-24 11:44:29 +01:00
parent 76c4819053 9a9850310c
commit 1b3de4bbec
1 changed files with 25 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -3,18 +3,21 @@
[partintro] [partintro]
-- --
This section provides a brief overview of Spring Boot reference documentation. Think of This section provides a brief overview of Spring Boot reference documentation. It serves
it as map for the rest of the document. You can read this reference guide in a linear as a map for the rest of the document.
fashion, or you can skip sections if something doesn't interest you.
-- --
[[boot-documentation-about]] [[boot-documentation-about]]
== About the documentation == About the documentation
The Spring Boot reference guide is available as {spring-boot-docs}/html[html], The Spring Boot reference guide is available as
{spring-boot-docs}/pdf/spring-boot-reference.pdf[pdf]
and {spring-boot-docs}/epub/spring-boot-reference.epub[epub] documents. The latest copy * {spring-boot-docs}/html[HTML]
* {spring-boot-docs}/pdf/spring-boot-reference.pdf[PDF]
* {spring-boot-docs}/epub/spring-boot-reference.epub[EPUB]
The latest copy
is available at {spring-boot-docs-current}. is available at {spring-boot-docs-current}.
Copies of this document may be made for your own use and for Copies of this document may be made for your own use and for
@ -26,26 +29,26 @@ print or electronically.
[[boot-documentation-getting-help]] [[boot-documentation-getting-help]]
== Getting help == Getting help
Having trouble with Spring Boot, We'd like to help! If you have trouble with Spring Boot, we would like to help.
* Try the <<howto.adoc#howto, How-to's>> -- they provide solutions to the most common * Try the <<howto.adoc#howto, How-to documents>>. They provide solutions to the most common
questions. questions.
* Learn the Spring basics -- Spring Boot builds on many other Spring projects, check * Learn the Spring basics. Spring Boot builds on many other Spring projects. Check
the http://spring.io[spring.io] web-site for a wealth of reference documentation. If the http://spring.io[spring.io] web-site for a wealth of reference documentation. If
you are just starting out with Spring, try one of the http://spring.io/guides[guides]. you are starting out with Spring, try one of the http://spring.io/guides[guides].
* Ask a question - we monitor http://stackoverflow.com[stackoverflow.com] for questions * Ask a question. We monitor http://stackoverflow.com[stackoverflow.com] for questions
tagged with http://stackoverflow.com/tags/spring-boot[`spring-boot`]. tagged with http://stackoverflow.com/tags/spring-boot[`spring-boot`].
* Report bugs with Spring Boot at https://github.com/spring-projects/spring-boot/issues. * Report bugs with Spring Boot at https://github.com/spring-projects/spring-boot/issues.
NOTE: All of Spring Boot is open source, including the documentation! If you find problems NOTE: All of Spring Boot is open source, including the documentation. If you find problems
with the docs; or if you just want to improve them, please {github-code}[get involved]. with the docs or if you want to improve them, please {github-code}[get involved].
[[boot-documentation-first-steps]] [[boot-documentation-first-steps]]
== First steps == First steps
If you're just getting started with Spring Boot, or 'Spring' in general, If you are getting started with Spring Boot or 'Spring' in general, start with
<<getting-started.adoc#getting-started, this is the place to start!>> <<getting-started.adoc#getting-started, the following topics>>:
* *From scratch:* * *From scratch:*
<<getting-started.adoc#getting-started-introducing-spring-boot, Overview>> | <<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,
== Working with Spring Boot == Working with Spring Boot
Ready to actually start using Spring Boot? <<using-spring-boot.adoc#using-boot, We've Ready to actually start using Spring Boot? <<using-spring-boot.adoc#using-boot, We have
got you covered>>. you covered>>:
* *Build systems:* * *Build systems:*
<<using-spring-boot.adoc#using-boot-maven, Maven>> | <<using-spring-boot.adoc#using-boot-maven, Maven>> |
@ -88,7 +91,7 @@ got you covered>>.
== Learning about Spring Boot features == Learning about Spring Boot features
Need more details about Spring Boot's core features? Need more details about Spring Boot's core features?
<<spring-boot-features.adoc#boot-features, This is for you>>! <<spring-boot-features.adoc#boot-features, The following content is for you>>:
* *Core Features:* * *Core Features:*
<<spring-boot-features.adoc#boot-features-spring-application, SpringApplication>> | <<spring-boot-features.adoc#boot-features-spring-application, SpringApplication>> |
@ -115,8 +118,8 @@ Need more details about Spring Boot's core features?
== Moving to production == Moving to production
When you're ready to push your Spring Boot application to production, we've got When you are ready to push your Spring Boot application to production, we have
<<production-ready-features.adoc#production-ready, some tricks that you might like>>! <<production-ready-features.adoc#production-ready, some tricks>> that you might like:
* *Management endpoints:* * *Management endpoints:*
<<production-ready-features.adoc#production-ready-endpoints, Overview>> | <<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
== Advanced topics == Advanced topics
Lastly, we have a few topics for the more advanced user. Finally, we have a few topics for more advanced users:
* *Deploy Spring Boot Applications:* * *Spring Boot Applications Deployment:*
<<deployment.adoc#cloud-deployment, Cloud Deployment>> | <<deployment.adoc#cloud-deployment, Cloud Deployment>> |
<<deployment.adoc#deployment-service, OS Service>> <<deployment.adoc#deployment-service, OS Service>>
* *Build tool plugins:* * *Build tool plugins:*
@ -145,7 +148,3 @@ Lastly, we have a few topics for the more advanced user.
<<appendix-application-properties.adoc#common-application-properties, Application Properties>> | <<appendix-application-properties.adoc#common-application-properties, Application Properties>> |
<<appendix-auto-configuration-classes.adoc#auto-configuration-classes, Auto-configuration classes>> | <<appendix-auto-configuration-classes.adoc#auto-configuration-classes, Auto-configuration classes>> |
<<appendix-executable-jar-format.adoc#executable-jar, Executable Jars>> <<appendix-executable-jar-format.adoc#executable-jar, Executable Jars>>