From 547c4f3fb14777014103faa9f3d3e29c82d19742 Mon Sep 17 00:00:00 2001 From: Andy Wilkinson Date: Mon, 4 Apr 2016 11:32:15 +0100 Subject: [PATCH] Simplify documentation of Asciidoctor Maven plugin's phase Previously the phase was documented as `package` by default with instructions to change it to `prepare-package` if you want to include the documentation in the project's package. This led to some confusion and sometimes the step to change it to `prepare-package` was missed. This commit updates the documentation to recommend that `prepare-package` is always used. It works equally well for both cases (packaging the documentation or not) and avoids the possible confusion described above. Closes gh-218 --- docs/src/docs/asciidoc/getting-started.adoc | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/docs/src/docs/asciidoc/getting-started.adoc b/docs/src/docs/asciidoc/getting-started.adoc index 0232564b..4a12eef4 100644 --- a/docs/src/docs/asciidoc/getting-started.adoc +++ b/docs/src/docs/asciidoc/getting-started.adoc @@ -134,7 +134,7 @@ described below. generate-docs - package <6> + prepare-package <6> process-asciidoc @@ -159,9 +159,8 @@ described below. <4> Add the Asciidoctor plugin <5> Define an attribute named `snippets` that can be used when including the generated snippets in your documentation. -<6> [[getting-started-build-configuration-maven-plugin-phase]] If you want to -<> in your -project's jar you should use the `prepare-package` phase. +<6> Using `prepare-package` allows the documentation to be + <>. [[getting-started-build-configuration-maven-packaging]] ==== Packaging the documentation @@ -170,10 +169,8 @@ You may want to package the generated documentation in your project's jar file, example to have it {spring-boot-docs}/#boot-features-spring-mvc-static-content[served as static content] by Spring Boot. -First, configure the Asciidoctor plugin so that it runs in the `prepare-package` phase, as -<>. Now configure -Maven's resources plugin to copy the generated documentation into a location where it'll -be included in the project's jar: +Configure Maven's resources plugin to copy the generated documentation into a location +where it'll be included in the project's jar: [source,xml,indent=0] ----