Reorder documentation overview section
The documentation overview sections is supposed to provide a map for the rest of the reference document. The getting help and upgrading sections were moved to align with that.
This commit is contained in:
Madhura Bhave
parent
9e2339b5d0
commit
aa873d3a22
|
|
@ -0,0 +1,5 @@
|
|||
[[upgrading.from-1x]]
|
||||
== Upgrading from 1.x
|
||||
|
||||
If you are upgrading from the `1.x` release of Spring Boot, check the {github-wiki}/Spring-Boot-2.0-Migration-Guide["`migration guide`" on the project wiki] that provides detailed upgrade instructions.
|
||||
Check also the {github-wiki}["`release notes`"] for a list of "`new and noteworthy`" features for each release.
|
||||
|
|
@ -3,7 +3,7 @@ include::attributes.adoc[]
|
|||
|
||||
|
||||
[[documentation]]
|
||||
= Spring Boot Documentation
|
||||
= Documentation Overview
|
||||
include::attributes.adoc[]
|
||||
|
||||
|
||||
|
|
@ -11,20 +11,17 @@ include::attributes.adoc[]
|
|||
This section provides a brief overview of Spring Boot reference documentation.
|
||||
It serves as a map for the rest of the document.
|
||||
|
||||
The latest copy of this document is available at {spring-boot-current-docs}.
|
||||
|
||||
|
||||
include::documentation/about.adoc[]
|
||||
|
||||
include::documentation/getting-help.adoc[]
|
||||
|
||||
include::documentation/upgrading.adoc[]
|
||||
|
||||
include::documentation/first-steps.adoc[]
|
||||
|
||||
include::documentation/upgrading.adoc[]
|
||||
|
||||
include::documentation/using.adoc[]
|
||||
|
||||
include::documentation/features.adoc[]
|
||||
|
||||
include::documentation/actuator.adoc[]
|
||||
|
||||
include::documentation/advanced.adoc[]
|
||||
include::documentation/advanced.adoc[]
|
||||
|
|
@ -1,9 +0,0 @@
|
|||
[[documentation.about]]
|
||||
== About the Documentation
|
||||
The Spring Boot reference guide is available as:
|
||||
|
||||
* {spring-boot-docs}/html/[Multi-page HTML]
|
||||
* {spring-boot-docs}/htmlsingle/[Single page HTML]
|
||||
* {spring-boot-docs}/pdf/spring-boot-reference.pdf[PDF]
|
||||
|
||||
The latest copy is available at {spring-boot-current-docs}.
|
||||
|
|
@ -1,16 +0,0 @@
|
|||
[[documentation.getting-help]]
|
||||
== Getting Help
|
||||
If you have trouble with Spring Boot, we would like to help.
|
||||
|
||||
* Try the <<howto#howto, How-to documents>>.
|
||||
They provide solutions to the most common questions.
|
||||
* Learn the Spring basics.
|
||||
Spring Boot builds on many other Spring projects.
|
||||
Check the https://spring.io[spring.io] web-site for a wealth of reference documentation.
|
||||
If you are starting out with Spring, try one of the https://spring.io/guides[guides].
|
||||
* Ask a question.
|
||||
We monitor https://stackoverflow.com[stackoverflow.com] for questions tagged with https://stackoverflow.com/tags/spring-boot[`spring-boot`].
|
||||
* 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 with the docs or if you want to improve them, please {spring-boot-code}[get involved].
|
||||
|
|
@ -1,9 +1,11 @@
|
|||
[[documentation.upgrading]]
|
||||
== Upgrading From an Earlier Version
|
||||
Instructions for how to upgrade from earlier versions of Spring Boot are provided on the project {github-wiki}[wiki].
|
||||
Follow the links in the {github-wiki}#release-notes[release notes] section to find the version that you want to upgrade to.
|
||||
|
||||
Upgrading instructions are always the first item in the release notes.
|
||||
If you are more than one release behind, please make sure that you also review the release notes of the versions that you jumped.
|
||||
|
||||
You should always ensure that you are running a {github-wiki}/Supported-Versions[supported version] of Spring Boot.
|
||||
|
||||
Depending on the version that you are upgrading to, you can find some additional tips here:
|
||||
|
||||
* *From 1.x:* <<actuator#upgrading.from-1x, Upgrading from 1.x>>
|
||||
* *To a new feature release:* <<upgrading#upgrading.to-feature, Upgrading to New Feature Release>>
|
||||
* *Spring Boot CLI:* <<upgrading#upgrading.cli, Upgrading the Spring Boot CLI>>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
[[documentation.using]]
|
||||
== Working with Spring Boot
|
||||
== Developing with Spring Boot
|
||||
Ready to actually start using Spring Boot? <<using#using, We have you covered>>:
|
||||
|
||||
* *Build systems:* <<using#using.build-systems.maven, Maven>> | <<using#using.build-systems.gradle, Gradle>> | <<using#using.build-systems.ant, Ant>> | <<using#using.build-systems.starters, Starters>>
|
||||
|
|
|
|||
|
|
@ -0,0 +1,18 @@
|
|||
[[getting-help]]
|
||||
= Getting Help
|
||||
include::attributes.adoc[]
|
||||
|
||||
If you have trouble with Spring Boot, we would like to help.
|
||||
|
||||
* Try the <<howto#howto, How-to documents>>.
|
||||
They provide solutions to the most common questions.
|
||||
* Learn the Spring basics.
|
||||
Spring Boot builds on many other Spring projects.
|
||||
Check the https://spring.io[spring.io] web-site for a wealth of reference documentation.
|
||||
If you are starting out with Spring, try one of the https://spring.io/guides[guides].
|
||||
* Ask a question.
|
||||
We monitor https://stackoverflow.com[stackoverflow.com] for questions tagged with https://stackoverflow.com/tags/spring-boot[`spring-boot`].
|
||||
* 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 with the docs or if you want to improve them, please {spring-boot-code}[get involved].
|
||||
|
|
@ -233,29 +233,3 @@ You should see the following output:
|
|||
Hello World!
|
||||
----
|
||||
|
||||
|
||||
|
||||
[[getting-started.installing.upgrading]]
|
||||
=== Upgrading from an Earlier Version of Spring Boot
|
||||
If you are upgrading from the `1.x` release of Spring Boot, check the {github-wiki}/Spring-Boot-2.0-Migration-Guide["`migration guide`" on the project wiki] that provides detailed upgrade instructions.
|
||||
Check also the {github-wiki}["`release notes`"] for a list of "`new and noteworthy`" features for each release.
|
||||
|
||||
When upgrading to a new feature release, some properties may have been renamed or removed.
|
||||
Spring Boot provides a way to analyze your application's environment and print diagnostics at startup, but also temporarily migrate properties at runtime for you.
|
||||
To enable that feature, add the following dependency to your project:
|
||||
|
||||
[source,xml,indent=0,subs="verbatim"]
|
||||
----
|
||||
<dependency>
|
||||
<groupId>org.springframework.boot</groupId>
|
||||
<artifactId>spring-boot-properties-migrator</artifactId>
|
||||
<scope>runtime</scope>
|
||||
</dependency>
|
||||
----
|
||||
|
||||
WARNING: Properties that are added late to the environment, such as when using `@PropertySource`, will not be taken into account.
|
||||
|
||||
NOTE: Once you're done with the migration, please make sure to remove this module from your project's dependencies.
|
||||
|
||||
To upgrade an existing CLI installation, use the appropriate package manager command (for example, `brew upgrade`).
|
||||
If you manually installed the CLI, follow the <<getting-started#getting-started.installing.cli.manual-installation, standard instructions>>, remembering to update your `PATH` environment variable to remove any older references.
|
||||
|
|
|
|||
|
|
@ -4,14 +4,17 @@ include::authors.adoc[]
|
|||
v{spring-boot-version}
|
||||
include::attributes.adoc[]
|
||||
|
||||
This document is also available as {spring-boot-docs}/html/[Multi-page HTML], {spring-boot-docs}/htmlsingle/[Single page HTML] and {spring-boot-docs}/pdf/spring-boot-reference.pdf[PDF].
|
||||
|
||||
|
||||
The reference documentation consists of the following sections:
|
||||
|
||||
[horizontal]
|
||||
<<legal#legal,Legal>> :: Legal information.
|
||||
<<documentation#documentation,Documentation Overview>> :: About the Documentation, Getting Help, First Steps, and more.
|
||||
<<getting-help#getting-help,Getting Help>> :: Resources for getting help.
|
||||
<<documentation#documentation,Documentation Overview>> :: About the Documentation, First Steps, and more.
|
||||
<<getting-started#getting-started,Getting Started>> :: Introducing Spring Boot, System Requirements, Servlet Containers, Installing Spring Boot, Developing Your First Spring Boot Application
|
||||
<<upgrading#upgrading,Upgrading Spring Boot Applications>> :: Upgrading from 1.x, Upgrading to a new feature release, Upgrading the Spring Boot CLI
|
||||
<<using#using,Using Spring Boot>> :: Build Systems, Structuring Your Code, Configuration, Spring Beans and Dependency Injection, DevTools, and more.
|
||||
<<features#features,Spring Boot Features>> :: Profiles, Logging, Security, Caching, Spring Integration, Testing, and more.
|
||||
<<actuator#actuator,Spring Boot Actuator>> :: Monitoring, Metrics, Auditing, and more.
|
||||
|
|
|
|||
|
|
@ -4,14 +4,19 @@ include::authors.adoc[]
|
|||
v{spring-boot-version}
|
||||
include::attributes.adoc[]
|
||||
|
||||
This document is also available as {spring-boot-docs}/html/[Multi-page HTML], {spring-boot-docs}/htmlsingle/[Single page HTML] and {spring-boot-docs}/pdf/spring-boot-reference.pdf[PDF].
|
||||
|
||||
|
||||
include::legal.adoc[leveloffset=+1]
|
||||
|
||||
include::getting-help.adoc[leveloffset=+1]
|
||||
|
||||
include::documentation.adoc[leveloffset=+1]
|
||||
|
||||
include::getting-started.adoc[leveloffset=+1]
|
||||
|
||||
include::upgrading.adoc[leveloffset=+1]
|
||||
|
||||
include::using.adoc[leveloffset=+1]
|
||||
|
||||
include::features.adoc[leveloffset=+1]
|
||||
|
|
|
|||
|
|
@ -0,0 +1,15 @@
|
|||
[[upgrading]]
|
||||
= Upgrading Spring Boot
|
||||
include::attributes.adoc[]
|
||||
|
||||
Instructions for how to upgrade from earlier versions of Spring Boot are provided on the project {github-wiki}[wiki].
|
||||
Follow the links in the {github-wiki}#release-notes[release notes] section to find the version that you want to upgrade to.
|
||||
|
||||
Upgrading instructions are always the first item in the release notes.
|
||||
If you are more than one release behind, please make sure that you also review the release notes of the versions that you jumped.
|
||||
|
||||
include::upgrading/from-1x.adoc[]
|
||||
|
||||
include::upgrading/to-feature.adoc[]
|
||||
|
||||
include::upgrading/cli.adoc[]
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
[[upgrading.cli]]
|
||||
== Upgrading the Spring Boot CLI
|
||||
|
||||
To upgrade an existing CLI installation, use the appropriate package manager command (for example, `brew upgrade`).
|
||||
If you manually installed the CLI, follow the <<getting-started#getting-started.installing.cli.manual-installation, standard instructions>>, remembering to update your `PATH` environment variable to remove any older references.
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
[[upgrading.from-1x]]
|
||||
== Upgrading from 1.x
|
||||
|
||||
If you are upgrading from the `1.x` release of Spring Boot, check the {github-wiki}/Spring-Boot-2.0-Migration-Guide["`migration guide`" on the project wiki] that provides detailed upgrade instructions.
|
||||
Check also the {github-wiki}["`release notes`"] for a list of "`new and noteworthy`" features for each release.
|
||||
|
|
@ -0,0 +1,19 @@
|
|||
[[upgrading.to-feature]]
|
||||
== Upgrading to a new feature release
|
||||
|
||||
When upgrading to a new feature release, some properties may have been renamed or removed.
|
||||
Spring Boot provides a way to analyze your application's environment and print diagnostics at startup, but also temporarily migrate properties at runtime for you.
|
||||
To enable that feature, add the following dependency to your project:
|
||||
|
||||
[source,xml,indent=0,subs="verbatim"]
|
||||
----
|
||||
<dependency>
|
||||
<groupId>org.springframework.boot</groupId>
|
||||
<artifactId>spring-boot-properties-migrator</artifactId>
|
||||
<scope>runtime</scope>
|
||||
</dependency>
|
||||
----
|
||||
|
||||
WARNING: Properties that are added late to the environment, such as when using `@PropertySource`, will not be taken into account.
|
||||
|
||||
NOTE: Once you're done with the migration, please make sure to remove this module from your project's dependencies.
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
[[using]]
|
||||
= Using Spring Boot
|
||||
= Developing with Spring Boot
|
||||
include::attributes.adoc[]
|
||||
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue