Files

Chris Bono 9dbe763932 Fix config props defaults and descriptions

This commit simplifies the client properties by setting the default values
directly on the properties and removes markdown from the property javadocs.
This improves end user experience by adding default values and descriptions
to the generated config props docs.

Signed-off-by: Chris Bono <chris.bono@gmail.com>

2024-12-05 06:51:19 +00:00

src

Fix config props defaults and descriptions

2024-12-05 06:51:19 +00:00

.gitignore

Reinstate flatten plugin

2024-10-22 11:17:53 +01:00

Gemfile

Add automation for README.md generation at top level

2024-10-22 09:27:57 +01:00

package.json

Install nodejs independently of antora

2024-10-22 10:07:02 +01:00

pom.xml

Back to snapshots

2024-11-28 15:37:42 +00:00

README.md

Add CONTRIBUTING.md

2024-10-22 09:50:08 +01:00

README.md

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 package phase 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.