From 581e8415505b8a2519a227b7148b6f73b2bc16e1 Mon Sep 17 00:00:00 2001 From: Chris Bono Date: Fri, 21 Feb 2025 13:09:51 -0600 Subject: [PATCH] Update docs README w/ steps on generating config props Signed-off-by: Chris Bono --- build-docs.sh | 3 +++ spring-grpc-docs/README.md | 4 ++-- 2 files changed, 5 insertions(+), 2 deletions(-) create mode 100755 build-docs.sh diff --git a/build-docs.sh b/build-docs.sh new file mode 100755 index 0000000..09f50ec --- /dev/null +++ b/build-docs.sh @@ -0,0 +1,3 @@ +#!/bin/bash + +./mvnw -pl spring-grpc-docs process-resources antora -P docs diff --git a/spring-grpc-docs/README.md b/spring-grpc-docs/README.md index 92c6e2b..0b066cd 100644 --- a/spring-grpc-docs/README.md +++ b/spring-grpc-docs/README.md @@ -8,13 +8,13 @@ The top level README and CONTRIBUTING guidleines documentation are generated fro The Spring gRPC configuration properties are automatically documented as follows: 1. This module contains a Java class (`org.springframework.grpc.internal.ConfigurationPropertiesAsciidocGenerator`) that is compiled when the module is built. -1. This class is then used during the Maven `package` phase to generate an asciidoc page containing each of the configuration properties. +1. This class is then used during the Maven `process-resources` phase in the `docs` profile to generate an asciidoc page containing each of the configuration properties. 1. 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 +./mvnw -pl spring-grpc-docs process-resources antora -P docs ``` You can then view the output by opening `spring-grpc-docs/target/antora/site/index.html`.