From f6b7730dac73f28823f38ec6ea2d50115f591733 Mon Sep 17 00:00:00 2001 From: Andy Wilkinson Date: Mon, 14 Jun 2021 13:24:01 +0100 Subject: [PATCH] Use Asciidoctor's revision line to provide document's version Using the revision line means that the revision number is automatically set. The revision number is then included by the HTML and PDF backends in the standard location. In the HTML backend that's alongside the list of authors. In the PDF backend that's on the title page. Closes gh-26851 --- .../src/docs/asciidoc/index.adoc | 2 ++ .../spring-boot-docs/src/docs/asciidoc/attributes.adoc | 1 + .../spring-boot-docs/src/docs/asciidoc/index.adoc | 3 +-- .../spring-boot-docs/src/docs/asciidoc/index.singleadoc | 3 +-- .../spring-boot-gradle-plugin/src/docs/asciidoc/index.adoc | 2 ++ .../spring-boot-maven-plugin/src/docs/asciidoc/index.adoc | 2 ++ 6 files changed, 9 insertions(+), 4 deletions(-) diff --git a/spring-boot-project/spring-boot-actuator-autoconfigure/src/docs/asciidoc/index.adoc b/spring-boot-project/spring-boot-actuator-autoconfigure/src/docs/asciidoc/index.adoc index 58c9f5105c..ae9bc8a734 100644 --- a/spring-boot-project/spring-boot-actuator-autoconfigure/src/docs/asciidoc/index.adoc +++ b/spring-boot-project/spring-boot-actuator-autoconfigure/src/docs/asciidoc/index.adoc @@ -1,5 +1,7 @@ = Spring Boot Actuator Web API Documentation Andy Wilkinson +v{gradle-project-version} +:!version-label: :doctype: book :toc: left :toclevels: 4 diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/attributes.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/attributes.adoc index 4b5a16f7ce..202ceb6179 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/attributes.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/attributes.adoc @@ -1,3 +1,4 @@ +:!version-label: :doctype: book :idprefix: :idseparator: - diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/index.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/index.adoc index b1d68bb692..eb3c2d0c94 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/index.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/index.adoc @@ -1,11 +1,10 @@ [[spring-boot-reference-documentation]] = Spring Boot Reference Documentation include::authors.adoc[] +v{spring-boot-version} :docinfo: shared include::attributes.adoc[] -*{spring-boot-version}* - The reference documentation consists of the following sections: [horizontal] diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/index.singleadoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/index.singleadoc index 0dd8a6aa2e..4347569c1a 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/index.singleadoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/index.singleadoc @@ -1,11 +1,10 @@ [[spring-boot-reference-documentation]] = Spring Boot Reference Documentation include::authors.adoc[] +v{spring-boot-version} :docinfo: shared include::attributes.adoc[] -*{spring-boot-version}* - include::legal.adoc[leveloffset=+1] include::documentation-overview.adoc[leveloffset=+1] include::getting-started.adoc[leveloffset=+1] diff --git a/spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/docs/asciidoc/index.adoc b/spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/docs/asciidoc/index.adoc index 9d5d6465d8..726922075b 100644 --- a/spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/docs/asciidoc/index.adoc +++ b/spring-boot-project/spring-boot-tools/spring-boot-gradle-plugin/src/docs/asciidoc/index.adoc @@ -1,5 +1,7 @@ = Spring Boot Gradle Plugin Reference Guide Andy Wilkinson, Scott Frederick +v{gradle-project-version} +:!version-label: :doctype: book :toc: left :toclevels: 4 diff --git a/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/docs/asciidoc/index.adoc b/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/docs/asciidoc/index.adoc index 814a7fcfa7..8c696c3df5 100644 --- a/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/docs/asciidoc/index.adoc +++ b/spring-boot-project/spring-boot-tools/spring-boot-maven-plugin/src/docs/asciidoc/index.adoc @@ -1,5 +1,7 @@ = Spring Boot Maven Plugin Documentation Stephane Nicoll, Andy Wilkinson, Scott Frederick +v{gradle-project-version} +:!version-label: :doctype: book :toc: left :toclevels: 4