From 53d855320bb10e3e184a0da1b678b1af76ba96bb Mon Sep 17 00:00:00 2001 From: Stephane Nicoll Date: Mon, 28 Aug 2017 09:19:52 +0200 Subject: [PATCH] Clarify the required steps to build the documentation Previously we didn't mention that the project must have been built locally first (to get the sources for javadoc generation for instance). This commit clarifies that. Closes gh-10086 --- README.adoc | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/README.adoc b/README.adoc index 00582640fd..58a2ec18a8 100755 --- a/README.adoc +++ b/README.adoc @@ -121,6 +121,13 @@ another project just mention that in your pull request.)_ === Building reference documentation +First of all, make sure you have built the project: + +[indent=0] +---- + $ ./mvnw clean install +---- + The reference documentation requires the documentation of the Maven plugin to be available so you need to build that first since it's not generated by default. @@ -129,8 +136,9 @@ available so you need to build that first since it's not generated by default. $ ./mvnw clean install -pl spring-boot-tools/spring-boot-maven-plugin -Pdefault,full ---- -The documentation also includes auto-generated information about the starters. To -allow this information to be collected, the starter projects must be built first: +The documentation also includes auto-generated information about the starters. You might +have that in your local repository already (per the first step) but if you want to refresh +it: [indent=0] ----