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

Simplify documentation of Asciidoctor Maven plugin's phase

Browse Source 
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
This commit is contained in:
Andy Wilkinson
2016-04-04 11:32:15 +01:00
parent 36bacb470b
commit 547c4f3fb1
1 changed files with 5 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/src/docs/asciidoc/getting-started.adoc
View File

@@ -134,7 +134,7 @@ described below.
<executions>
<execution>
<id>generate-docs</id>
<phase>package</phase> <6>
<phase>prepare-package</phase> <6>
<goals>
<goal>process-asciidoc</goal>
</goals>
@@ -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
<<getting-started-build-configuration-maven-packaging, package the documentation>> 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, included in the package>>.
[[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
<<getting-started-build-configuration-maven-plugin-phase, described above>>. 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]
----