24a797ee4b
The problem with the flatten plugin is that it unconditionally nukes the dependency management section, which we very much need in our "dependencies" modules. The key is to make the "dependencies" pom independent of the main reactor (pattern copied form Spring Cloud). Then you can run flatten in the main reactor build and not in the dependencies, which then retain there useful properties and dependency management.
Spring gRPC Docs
README
The top level README and CONTRIBUTING guidleines documentation are generated from sources in this module on mvn package using asciidoctor-reducer and downdoc.
Configuration Properties
The Spring gRPC configuration properties are automatically documented as follows:
- This module contains a Java class (
org.springframework.grpc.internal.ConfigurationPropertiesAsciidocGenerator) that is compiled when the module is built. - This class is then used during the Maven
packagephase to generate an asciidoc page containing each of the configuration properties. - The asciidoc is then included in the Antora reference documentation.
Antora Site
To build the Antora site locally run the following command from the project root directory:
./mvnw -pl spring-grpc-docs antora
You can then view the output by opening spring-grpc-docs/target/antora/site/index.html.