Polish asciidoc formatting

This commit is contained in:
Phillip Webb
2021-05-19 13:04:08 -07:00
parent a28072bab4
commit 2dbf39c738
36 changed files with 66 additions and 156 deletions

View File

@@ -7,13 +7,9 @@ To use the Spring Boot Maven Plugin, include the appropriate XML in the `plugins
include::../maven/getting-started/pom.xml[tags=getting-started]
----
If you use a milestone or snapshot release, you also need to add the appropriate `pluginRepository` elements, as shown in the following listing:
[source,xml,indent=0,subs="verbatim,attributes",tabsize=4]
----
include::../maven/getting-started/plugin-repositories-pom.xml[tags=plugin-repositories]
----

View File

@@ -3,4 +3,3 @@
The Spring Boot Plugin has the following goals:
include::goals/overview.adoc[]

View File

@@ -1,3 +1,4 @@
[[spring-boot-maven-plugin-documentation]]
= Spring Boot Maven Plugin Documentation
Stephane Nicoll, Andy Wilkinson, Scott Frederick
:doctype: book
@@ -9,7 +10,6 @@ Stephane Nicoll, Andy Wilkinson, Scott Frederick
:hide-uri-scheme:
:docinfo: shared,private
:attribute-missing: warn
:buildpacks-reference: https://buildpacks.io/docs
:spring-boot-docs: https://docs.spring.io/spring-boot/docs/{gradle-project-version}
:spring-boot-api: {spring-boot-docs}/api/org/springframework/boot
@@ -19,18 +19,26 @@ Stephane Nicoll, Andy Wilkinson, Scott Frederick
:paketo-java-reference: {paketo-reference}/buildpacks/language-family-buildpacks/java
[[introduction]]
== Introduction
The Spring Boot Maven Plugin provides Spring Boot support in https://maven.org[Apache Maven].
It allows you to package executable jar or war archives, run Spring Boot applications, generate build information and start your Spring Boot application prior to running integration tests.
include::getting-started.adoc[]
include::using.adoc[]
include::goals.adoc[]
include::packaging.adoc[]
include::packaging-oci-image.adoc[]
include::running.adoc[]
include::integration-tests.adoc[]
include::build-info.adoc[]
include::help.adoc[]
include::help.adoc[]

View File

@@ -1,6 +1,5 @@
[[repackage]]
== Packaging Executable Archives
The plugin can create executable archives (jar files and war files) that contain all of an application's dependencies and can then be run with `java -jar`.
Packaging an executable archive is performed by the `repackage` goal, as shown in the following example:
@@ -71,6 +70,7 @@ include::../maven/packaging/disable-layers-pom.xml[tags=disable-layers]
----
[[repackage-layers-configuration]]
==== Custom Layers Configuration
Depending on your application, you may want to tune how layers are created and add new ones.
@@ -89,8 +89,6 @@ The following example shows how the default ordering described above can be defi
include::../maven/packaging/layers.xml[tags=layers]
----
The `layers` XML format is defined in three sections:
* The `<application>` block defines how the application classes and resources should be layered.
@@ -151,7 +149,6 @@ In that setup, only the configuration should be specified, as shown in the follo
include::../maven/packaging/repackage-configuration-pom.xml[tags=repackage-configuration]
----
This configuration will generate two artifacts: the original one and the repackaged counter part produced by the repackage goal.
Both will be installed/deployed transparently.
@@ -163,7 +160,6 @@ The following configuration installs/deploys a single `task` classified artifact
include::../maven/packaging/classified-artifact-pom.xml[tags=classified-artifact]
----
As both the `maven-jar-plugin` and the `spring-boot-maven-plugin` runs at the same phase, it is important that the jar plugin is defined first (so that it runs before the repackage goal).
Again, if you are using `spring-boot-starter-parent`, this can be simplified as follows:

View File

@@ -26,7 +26,6 @@ To enable it, just add the following dependency to your project:
include::../maven/running/devtools-pom.xml[tags=devtools]
----
When `devtools` is running, it detects change when you recompile your application and automatically refreshes it.
This works for not only resources but code as well.
It also provides a LiveReload server so that it can automatically trigger a browser refresh whenever things change.
@@ -176,6 +175,3 @@ The profiles to enable can be specified on the command line as well, make sure t
----
$ mvn spring-boot:run -Dspring-boot.run.profiles=local,dev
----