Spring/spring-boot
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Reorder documentation overview section

Browse Source 
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
2021-06-09 21:36:28 -07:00
parent 0ec598c99d
commit 91ca9763e0
15 changed files with 90 additions and 67 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
spring-boot-project/spring-boot-docs/src/docs/asciidoc/documentation/about.adoc
View File

@@ -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}.

16
spring-boot-project/spring-boot-docs/src/docs/asciidoc/documentation/getting-help.adoc
View File

@@ -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].

12
spring-boot-project/spring-boot-docs/src/docs/asciidoc/documentation/upgrading.adoc
View File

@@ -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>>

2
spring-boot-project/spring-boot-docs/src/docs/asciidoc/documentation/using.adoc
View File

@@ -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>>