From b527d364dc972a821149e47254256f51a5adab9d Mon Sep 17 00:00:00 2001 From: Brian Clozel Date: Tue, 23 Apr 2019 22:41:40 +0200 Subject: [PATCH] Reinstate single page reference documentation This commit reinstates the single-page variant for the Spring Boot reference documentation. Now the single and multi-page variants are hosted under the same `"html"` folder, as `"index.html"` and `"single-index.html"`. Note that files ending in `"index.html`" are treated as index files by the spring-doc-resources project and their table of contents do not display a "Back to index" link. Fixes gh-16295 --- .../main/asciidoc/documentation-overview.adoc | 3 +++ .../src/main/asciidoc/index-docinfo.xml | 13 ------------- .../src/main/asciidoc/index.adoc | 1 + .../src/main/asciidoc/single-index.adoc | 17 +++++++++++++++++ 4 files changed, 21 insertions(+), 13 deletions(-) delete mode 100644 spring-boot-project/spring-boot-docs/src/main/asciidoc/index-docinfo.xml create mode 100644 spring-boot-project/spring-boot-docs/src/main/asciidoc/single-index.adoc diff --git a/spring-boot-project/spring-boot-docs/src/main/asciidoc/documentation-overview.adoc b/spring-boot-project/spring-boot-docs/src/main/asciidoc/documentation-overview.adoc index 5fce1e8c7447..15a40ad2344f 100644 --- a/spring-boot-project/spring-boot-docs/src/main/asciidoc/documentation-overview.adoc +++ b/spring-boot-project/spring-boot-docs/src/main/asciidoc/documentation-overview.adoc @@ -12,6 +12,9 @@ as a map for the rest of the document. [[boot-documentation-about]] == About the Documentation +The Spring Boot reference guide is available as +<> or +<> documentation. The latest copy of the reference documentation is available at {spring-boot-docs-current}. diff --git a/spring-boot-project/spring-boot-docs/src/main/asciidoc/index-docinfo.xml b/spring-boot-project/spring-boot-docs/src/main/asciidoc/index-docinfo.xml deleted file mode 100644 index 790b18701d2b..000000000000 --- a/spring-boot-project/spring-boot-docs/src/main/asciidoc/index-docinfo.xml +++ /dev/null @@ -1,13 +0,0 @@ -Spring Boot -{spring-boot-version} - - 2012-2018 - - - - Copies of this document may be made for your own use and for distribution to - others, provided that you do not charge any fee for such copies and further - provided that each copy contains this Copyright Notice, whether distributed in - print or electronically. - - diff --git a/spring-boot-project/spring-boot-docs/src/main/asciidoc/index.adoc b/spring-boot-project/spring-boot-docs/src/main/asciidoc/index.adoc index 27b2556e87d4..87266a1ff081 100644 --- a/spring-boot-project/spring-boot-docs/src/main/asciidoc/index.adoc +++ b/spring-boot-project/spring-boot-docs/src/main/asciidoc/index.adoc @@ -1,3 +1,4 @@ +[[spring-boot-reference-documentation]] = Spring Boot Reference Documentation Phillip Webb, Dave Syer, Josh Long, Stéphane Nicoll, Rob Winch, Andy Wilkinson, Marcel Overdijk, Christian Dupuis, Sébastien Deleuze, Michael Simons, Vedran Pavić, Jay Bryant, Madhura Bhave :docinfo: shared diff --git a/spring-boot-project/spring-boot-docs/src/main/asciidoc/single-index.adoc b/spring-boot-project/spring-boot-docs/src/main/asciidoc/single-index.adoc new file mode 100644 index 000000000000..7df3ffe43274 --- /dev/null +++ b/spring-boot-project/spring-boot-docs/src/main/asciidoc/single-index.adoc @@ -0,0 +1,17 @@ +[[spring-boot-reference-documentation]] += Spring Boot Reference Documentation +Phillip Webb, Dave Syer, Josh Long, Stéphane Nicoll, Rob Winch, Andy Wilkinson, Marcel Overdijk, Christian Dupuis, Sébastien Deleuze, Michael Simons, Vedran Pavić, Jay Bryant, Madhura Bhave +:docinfo: shared +include::attributes.adoc[] + +include::legal.adoc[leveloffset=+1] +include::documentation-overview.adoc[leveloffset=+1] +include::getting-started.adoc[leveloffset=+1] +include::using-spring-boot.adoc[leveloffset=+1] +include::spring-boot-features.adoc[leveloffset=+1] +include::production-ready-features.adoc[leveloffset=+1] +include::deployment.adoc[leveloffset=+1] +include::spring-boot-cli.adoc[leveloffset=+1] +include::build-tool-plugins.adoc[leveloffset=+1] +include::howto.adoc[leveloffset=+1] +include::appendix.adoc[leveloffset=+1]