62499c8be2
This commit renames the GrpcChannelConfigurer to GrpcChannelBuilderCustomizer to more accurately represent its purpose and for consistency with the server-side terminology. Additionally, a new `What's new?` doc is added to list breaking changes between versions. See #52 Signed-off-by: Chris Bono <chris.bono@gmail.com>
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.