Skip to content

Commit 581e841

Browse files
committed
Update docs README w/ steps on generating config props
Signed-off-by: Chris Bono <chris.bono@gmail.com>
1 parent fbae1c9 commit 581e841

File tree

2 files changed

+5
-2
lines changed

2 files changed

+5
-2
lines changed

build-docs.sh

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
#!/bin/bash
2+
3+
./mvnw -pl spring-grpc-docs process-resources antora -P docs

spring-grpc-docs/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@ The top level README and CONTRIBUTING guidleines documentation are generated fro
88
The Spring gRPC configuration properties are automatically documented as follows:
99

1010
1. This module contains a Java class (`org.springframework.grpc.internal.ConfigurationPropertiesAsciidocGenerator`) that is compiled when the module is built.
11-
1. This class is then used during the Maven `package` phase to generate an asciidoc page containing each of the configuration properties.
11+
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.
1212
1. The asciidoc is then included in the Antora reference documentation.
1313

1414
## Antora Site
1515

1616
To build the Antora site locally run the following command from the project root directory:
1717
```
18-
./mvnw -pl spring-grpc-docs antora
18+
./mvnw -pl spring-grpc-docs process-resources antora -P docs
1919
```
2020
You can then view the output by opening `spring-grpc-docs/target/antora/site/index.html`.

0 commit comments

Comments
 (0)