Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 2 additions & 5 deletions build-docs.sh
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
#!/bin/bash

# Be sure the ConfigurationPropertiesAsciidocGenerator is compiled
./mvnw -pl spring-grpc-docs package

# Generate the config props and antora site
./mvnw -pl spring-grpc-docs process-resources antora -P docs
# Generate the antora site
./mvnw -pl spring-grpc-docs process-resources antora
4 changes: 2 additions & 2 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

<modules>
<module>spring-grpc-build-dependencies</module>
<!-- <module>spring-grpc-docs</module>-->
<module>spring-grpc-docs</module>
<module>spring-grpc-dependencies</module>
<module>spring-grpc-core</module>
<!-- <module>samples</module>-->
Expand Down Expand Up @@ -70,7 +70,7 @@
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<java.version>17</java.version>
<!-- internal dependencies -->
<spring-boot.version>4.0.0-M3</spring-boot.version>
<spring-boot.version>4.0.0-SNAPSHOT</spring-boot.version>
<jackson.version>2.20.0</jackson.version>
<junit.version>5.13.4</junit.version>
<assertj.version>3.27.4</assertj.version>
Expand Down
7 changes: 0 additions & 7 deletions spring-grpc-docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,6 @@

The top level README and CONTRIBUTING guidelines documentation are generated from sources in this module on `mvn package` using [`asciidoctor-reducer`](https://github.com/asciidoctor/asciidoctor-reducer) and [`downdoc`](https://github.com/opendevise/downdoc).

## Configuration Properties
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 `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:
Expand Down
50 changes: 0 additions & 50 deletions spring-grpc-docs/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -16,23 +16,10 @@
<maven-exec-plugin.version>3.4.1</maven-exec-plugin.version>
<maven-frontend-plugin.version>1.15.1</maven-frontend-plugin.version>
<maven-gem-plugin.version>3.0.3</maven-gem-plugin.version>
<configprops.path>${project.basedir}/src/main/antora/modules/ROOT/partials/_configprops.adoc</configprops.path>
<configprops.inclusionPattern>spring.grpc.*</configprops.inclusionPattern>
<jruby.version>9.4.6.0</jruby.version>
<disable.checkstyle.checks>true</disable.checkstyle.checks>
</properties>
<!-- Dependencies used to build the config props doc generator -->
<dependencies>
<dependency>
<groupId>org.springframework.grpc</groupId>
<artifactId>spring-grpc-spring-boot-starter</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>${jackson.version}</version>
</dependency>
<dependency>
<groupId>rubygems</groupId>
<artifactId>asciidoctor-reducer</artifactId>
Expand Down Expand Up @@ -184,43 +171,6 @@
</plugins>
</build>

<profiles>
<profile>
<id>docs</id>
<activation>
<activeByDefault>false</activeByDefault>
</activation>
<build>
<plugins>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>exec-maven-plugin</artifactId>
<version>${maven-exec-plugin.version}</version>
<executions>
<execution>
<id>generate-configprops</id>
<phase>process-resources</phase>
<goals>
<goal>java</goal>
</goals>
<configuration>
<includeProjectDependencies>true</includeProjectDependencies>
<includePluginDependencies>false</includePluginDependencies>
<mainClass>
org.springframework.grpc.internal.ConfigurationPropertiesAsciidocGenerator</mainClass>
<arguments>
<argument>${configprops.path}</argument>
<argument>${configprops.inclusionPattern}</argument>
</arguments>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
</profile>
</profiles>

<repositories>
<repository>
<id>mavengems</id>
Expand Down
1 change: 0 additions & 1 deletion spring-grpc-docs/src/main/antora/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,3 @@
* xref:server.adoc[GRPC Server]
* xref:client.adoc[GRPC Clients]
* xref:contribution-guidelines.adoc[Contribution Guidelines]
* xref:appendix.adoc[]
11 changes: 0 additions & 11 deletions spring-grpc-docs/src/main/antora/modules/ROOT/pages/appendix.adoc

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ spring:
----
NOTE: The items in the `health-indicator-paths` are the identifiers of the indicator which is typically the name of the indicator bean without the `HealthIndicator` suffix.

You can use the xref:appendix.adoc#common-application-properties["spring.grpc.server.health.*"] application properties to further configure the health feature.
You can use the `spring.grpc.server.health.*` application properties to further configure the health feature.

== Client-side
Spring gRPC can also autoconfigure the https://grpc.io/docs/guides/health-checking/[client-side] health check feature to your gRPC clients.
Expand Down

This file was deleted.

This file was deleted.