root
/
spring-boot
1
0
Fork 0
Code Issues Pull Requests 1 Packages Projects Releases Wiki Activity

Wrap documentation-overview.adoc at 90 characters and use title case

Browse Source 
Closes gh-10889
pull/10896/head
Jay Bryant 7 years ago committed by Andy Wilkinson
parent 75914be777
commit 8f2653d4c7
1 changed files with 59 additions and 56 deletions
Show Stats Download Patch File Download Diff File

115
spring-boot-project/spring-boot-docs/src/main/asciidoc/documentation-overview.adoc
Unescape Escape View File

@ -10,7 +10,7 @@ as a map for the rest of the document.
[[boot-documentation-about]] [[boot-documentation-about]]
== About the documentation == About the Documentation
The Spring Boot reference guide is available as The Spring Boot reference guide is available as
* {spring-boot-docs}/html[HTML] * {spring-boot-docs}/html[HTML]
@ -20,46 +20,46 @@ The Spring Boot reference guide is available as
The latest copy 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 distribution to others,
distribution to others, provided that you do not charge any fee for such copies and provided that you do not charge any fee for such copies and further provided that each
further provided that each copy contains this Copyright Notice, whether distributed in copy contains this Copyright Notice, whether distributed in print or electronically.
print or electronically.
[[boot-documentation-getting-help]] [[boot-documentation-getting-help]]
== Getting help == Getting Help
If you have trouble with Spring Boot, we would like to help. If you have trouble with Spring Boot, we would like to help.
* Try the <<howto.adoc#howto, How-to documents>>. They provide solutions to the most common * Try the <<howto.adoc#howto, How-to documents>>. They provide solutions to the most
questions. common 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
the http://spring.io[spring.io] web-site for a wealth of reference documentation. If http://spring.io[spring.io] web-site for a wealth of reference documentation. If you are
you are starting out with Spring, try one of the http://spring.io/guides[guides]. 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
with the docs or if you want to improve them, please {github-code}[get involved]. problems 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 are getting started with Spring Boot or 'Spring' in general, start with If you are getting started with Spring Boot or 'Spring' in general, start with
<<getting-started.adoc#getting-started, the following topics>>: <<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>> |
<<getting-started.adoc#getting-started-system-requirements, Requirements>> | <<getting-started.adoc#getting-started-system-requirements, Requirements>> |
<<getting-started.adoc#getting-started-installing-spring-boot, Installation>> <<getting-started.adoc#getting-started-installing-spring-boot, Installation>>
* *Tutorial:* * *Tutorial:*
<<getting-started.adoc#getting-started-first-application, Part 1>> | <<getting-started.adoc#getting-started-first-application, Part 1>> |
<<getting-started.adoc#getting-started-first-application-code, Part 2>> <<getting-started.adoc#getting-started-first-application-code, Part 2>>
* *Running your example:* * *Running your example:*
<<getting-started.adoc#getting-started-first-application-run, Part 1>> | <<getting-started.adoc#getting-started-first-application-run, Part 1>> |
<<getting-started.adoc#getting-started-first-application-executable-jar, Part 2>> <<getting-started.adoc#getting-started-first-application-executable-jar, Part 2>>
@ -68,56 +68,58 @@ Ready to actually start using Spring Boot? <<using-spring-boot.adoc#using-boot,
you covered>>: you covered>>:
* *Build systems:* * *Build systems:*
<<using-spring-boot.adoc#using-boot-maven, Maven>> | <<using-spring-boot.adoc#using-boot-maven, Maven>> |
<<using-spring-boot.adoc#using-boot-gradle, Gradle>> | <<using-spring-boot.adoc#using-boot-gradle, Gradle>> |
<<using-spring-boot.adoc#using-boot-ant, Ant>> | <<using-spring-boot.adoc#using-boot-ant, Ant>> |
<<using-spring-boot.adoc#using-boot-starter, Starters>> <<using-spring-boot.adoc#using-boot-starter, Starters>>
* *Best practices:* * *Best practices:*
<<using-spring-boot.adoc#using-boot-structuring-your-code, Code Structure>> | <<using-spring-boot.adoc#using-boot-structuring-your-code, Code Structure>> |
<<using-spring-boot.adoc#using-boot-configuration-classes, @Configuration>> | <<using-spring-boot.adoc#using-boot-configuration-classes, @Configuration>> |
<<using-spring-boot.adoc#using-boot-auto-configuration, @EnableAutoConfiguration>> | <<using-spring-boot.adoc#using-boot-auto-configuration, @EnableAutoConfiguration>> |
<<using-spring-boot.adoc#using-boot-spring-beans-and-dependency-injection, Beans and Dependency Injection>> <<using-spring-boot.adoc#using-boot-spring-beans-and-dependency-injection, Beans and
Dependency Injection>>
* *Running your code* * *Running your code*
<<using-spring-boot.adoc#using-boot-running-from-an-ide, IDE>> | <<using-spring-boot.adoc#using-boot-running-from-an-ide, IDE>> |
<<using-spring-boot.adoc#using-boot-running-as-a-packaged-application, Packaged>> | <<using-spring-boot.adoc#using-boot-running-as-a-packaged-application, Packaged>> |
<<using-spring-boot.adoc#using-boot-running-with-the-maven-plugin, Maven>> | <<using-spring-boot.adoc#using-boot-running-with-the-maven-plugin, Maven>> |
<<using-spring-boot.adoc#using-boot-running-with-the-gradle-plugin, Gradle>> <<using-spring-boot.adoc#using-boot-running-with-the-gradle-plugin, Gradle>>
* *Packaging your app:* * *Packaging your app:*
<<using-spring-boot.adoc#using-boot-packaging-for-production, Production jars>> <<using-spring-boot.adoc#using-boot-packaging-for-production, Production jars>>
* *Spring Boot CLI:* * *Spring Boot CLI:*
<<spring-boot-cli.adoc#cli, Using the CLI>> <<spring-boot-cli.adoc#cli, Using the CLI>>
== 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, The following content 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>> |
<<spring-boot-features.adoc#boot-features-external-config, External Configuration>> | <<spring-boot-features.adoc#boot-features-external-config, External Configuration>> |
<<spring-boot-features.adoc#boot-features-profiles, Profiles>> | <<spring-boot-features.adoc#boot-features-profiles, Profiles>> |
<<spring-boot-features.adoc#boot-features-logging, Logging>> <<spring-boot-features.adoc#boot-features-logging, Logging>>
* *Web Applications:* * *Web Applications:*
<<spring-boot-features.adoc#boot-features-spring-mvc, MVC>> | <<spring-boot-features.adoc#boot-features-spring-mvc, MVC>> |
<<spring-boot-features.adoc#boot-features-embedded-container, Embedded Containers>> <<spring-boot-features.adoc#boot-features-embedded-container, Embedded Containers>>
* *Working with data:* * *Working with data:*
<<spring-boot-features.adoc#boot-features-sql, SQL>> | <<spring-boot-features.adoc#boot-features-sql, SQL>> |
<<spring-boot-features.adoc#boot-features-nosql, NO-SQL>> <<spring-boot-features.adoc#boot-features-nosql, NO-SQL>>
* *Messaging:* * *Messaging:*
<<spring-boot-features.adoc#boot-features-messaging, Overview>> | <<spring-boot-features.adoc#boot-features-messaging, Overview>> |
<<spring-boot-features.adoc#boot-features-jms, JMS>> <<spring-boot-features.adoc#boot-features-jms, JMS>>
* *Testing:* * *Testing:*
<<spring-boot-features.adoc#boot-features-testing, Overview>> | <<spring-boot-features.adoc#boot-features-testing, Overview>> |
<<spring-boot-features.adoc#boot-features-testing-spring-boot-applications, Boot Applications>> | <<spring-boot-features.adoc#boot-features-testing-spring-boot-applications, Boot
<<spring-boot-features.adoc#boot-features-test-utilities, Utils>> Applications>> |
<<spring-boot-features.adoc#boot-features-test-utilities, Utils>>
* *Extending:* * *Extending:*
<<spring-boot-features.adoc#boot-features-developing-auto-configuration, Auto-configuration>> | <<spring-boot-features.adoc#boot-features-developing-auto-configuration, Auto-configuration>> |
<<spring-boot-features.adoc#boot-features-condition-annotations, @Conditions>> <<spring-boot-features.adoc#boot-features-condition-annotations, @Conditions>>
== Moving to production == Moving to Production
When you are ready to push your Spring Boot application to production, we have 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:
@ -135,7 +137,7 @@ When you are ready to push your Spring Boot application to production, we have
== Advanced topics == Advanced Topics
Finally, we have a few topics for more advanced users: Finally, we have a few topics for more advanced users:
* *Spring Boot Applications Deployment:* * *Spring Boot Applications Deployment:*
@ -145,7 +147,8 @@ Finally, we have a few topics for more advanced users:
<<build-tool-plugins.adoc#build-tool-plugins-maven-plugin, Maven>> | <<build-tool-plugins.adoc#build-tool-plugins-maven-plugin, Maven>> |
<<build-tool-plugins.adoc#build-tool-plugins-gradle-plugin, Gradle>> <<build-tool-plugins.adoc#build-tool-plugins-gradle-plugin, Gradle>>
* *Appendix:* * *Appendix:*
<<appendix-application-properties.adoc#common-application-properties, Application Properties>> | <<appendix-application-properties.adoc#common-application-properties, Application
<<appendix-auto-configuration-classes.adoc#auto-configuration-classes, Auto-configuration classes>> | Properties>> |
<<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>>

Write Preview
Loading…
Cancel
Save