Skip to content

Commit 91120e7

Browse files
onobcdsyer
authored andcommitted
Remove the config props documenation
Now that the configuration properties have moved into Spring Boot there is no need to generate and maintain them here in this repo. As such, this commit removes all things configuration properties. Signed-off-by: onobc <[email protected]>
1 parent 0141234 commit 91120e7

File tree

9 files changed

+5
-293
lines changed

9 files changed

+5
-293
lines changed

build-docs.sh

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
11
#!/bin/bash
22

3-
# Be sure the ConfigurationPropertiesAsciidocGenerator is compiled
4-
./mvnw -pl spring-grpc-docs package
5-
6-
# Generate the config props and antora site
7-
./mvnw -pl spring-grpc-docs process-resources antora -P docs
3+
# Generate the antora site
4+
./mvnw -pl spring-grpc-docs process-resources antora

pom.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515

1616
<modules>
1717
<module>spring-grpc-build-dependencies</module>
18-
<!-- <module>spring-grpc-docs</module>-->
18+
<module>spring-grpc-docs</module>
1919
<module>spring-grpc-dependencies</module>
2020
<module>spring-grpc-core</module>
2121
<!-- <module>samples</module>-->
@@ -70,7 +70,7 @@
7070
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
7171
<java.version>17</java.version>
7272
<!-- internal dependencies -->
73-
<spring-boot.version>4.0.0-M3</spring-boot.version>
73+
<spring-boot.version>4.0.0-SNAPSHOT</spring-boot.version>
7474
<jackson.version>2.20.0</jackson.version>
7575
<junit.version>5.13.4</junit.version>
7676
<assertj.version>3.27.4</assertj.version>

spring-grpc-docs/README.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,6 @@
44

55
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).
66

7-
## Configuration Properties
8-
The Spring gRPC configuration properties are automatically documented as follows:
9-
10-
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 `process-resources` phase in the `docs` profile to generate an asciidoc page containing each of the configuration properties.
12-
1. The asciidoc is then included in the Antora reference documentation.
13-
147
## Antora Site
158

169
To build the Antora site locally run the following command from the project root directory:

spring-grpc-docs/pom.xml

Lines changed: 0 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -16,23 +16,10 @@
1616
<maven-exec-plugin.version>3.4.1</maven-exec-plugin.version>
1717
<maven-frontend-plugin.version>1.15.1</maven-frontend-plugin.version>
1818
<maven-gem-plugin.version>3.0.3</maven-gem-plugin.version>
19-
<configprops.path>${project.basedir}/src/main/antora/modules/ROOT/partials/_configprops.adoc</configprops.path>
20-
<configprops.inclusionPattern>spring.grpc.*</configprops.inclusionPattern>
2119
<jruby.version>9.4.6.0</jruby.version>
2220
<disable.checkstyle.checks>true</disable.checkstyle.checks>
2321
</properties>
24-
<!-- Dependencies used to build the config props doc generator -->
2522
<dependencies>
26-
<dependency>
27-
<groupId>org.springframework.grpc</groupId>
28-
<artifactId>spring-grpc-spring-boot-starter</artifactId>
29-
<version>${project.version}</version>
30-
</dependency>
31-
<dependency>
32-
<groupId>com.fasterxml.jackson.core</groupId>
33-
<artifactId>jackson-databind</artifactId>
34-
<version>${jackson.version}</version>
35-
</dependency>
3623
<dependency>
3724
<groupId>rubygems</groupId>
3825
<artifactId>asciidoctor-reducer</artifactId>
@@ -184,43 +171,6 @@
184171
</plugins>
185172
</build>
186173

187-
<profiles>
188-
<profile>
189-
<id>docs</id>
190-
<activation>
191-
<activeByDefault>false</activeByDefault>
192-
</activation>
193-
<build>
194-
<plugins>
195-
<plugin>
196-
<groupId>org.codehaus.mojo</groupId>
197-
<artifactId>exec-maven-plugin</artifactId>
198-
<version>${maven-exec-plugin.version}</version>
199-
<executions>
200-
<execution>
201-
<id>generate-configprops</id>
202-
<phase>process-resources</phase>
203-
<goals>
204-
<goal>java</goal>
205-
</goals>
206-
<configuration>
207-
<includeProjectDependencies>true</includeProjectDependencies>
208-
<includePluginDependencies>false</includePluginDependencies>
209-
<mainClass>
210-
org.springframework.grpc.internal.ConfigurationPropertiesAsciidocGenerator</mainClass>
211-
<arguments>
212-
<argument>${configprops.path}</argument>
213-
<argument>${configprops.inclusionPattern}</argument>
214-
</arguments>
215-
</configuration>
216-
</execution>
217-
</executions>
218-
</plugin>
219-
</plugins>
220-
</build>
221-
</profile>
222-
</profiles>
223-
224174
<repositories>
225175
<repository>
226176
<id>mavengems</id>

spring-grpc-docs/src/main/antora/modules/ROOT/nav.adoc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,3 @@
44
* xref:server.adoc[GRPC Server]
55
* xref:client.adoc[GRPC Clients]
66
* xref:contribution-guidelines.adoc[Contribution Guidelines]
7-
* xref:appendix.adoc[]

spring-grpc-docs/src/main/antora/modules/ROOT/pages/appendix.adoc

Lines changed: 0 additions & 11 deletions
This file was deleted.

spring-grpc-docs/src/main/antora/modules/ROOT/pages/health.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ spring:
2626
----
2727
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.
2828

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

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

spring-grpc-docs/src/main/antora/modules/ROOT/partials/_configprops.adoc

Lines changed: 0 additions & 59 deletions
This file was deleted.

spring-grpc-docs/src/main/java/org/springframework/grpc/internal/ConfigurationPropertiesAsciidocGenerator.java

Lines changed: 0 additions & 157 deletions
This file was deleted.

0 commit comments

Comments
 (0)