Commit 53d85532 authored by Stephane Nicoll's avatar Stephane Nicoll

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
parent 2cbffc32
......@@ -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]
----
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment