Fix generating config props asciidoc file (#1010)

awspring · Jan 3, 2024 · 2c39154 · 2c39154
1 parent b3030ad
commit 2c39154
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 26 deletions.
diff --git a/docs/pom.xml b/docs/pom.xml
@@ -14,6 +14,7 @@
 	<properties>
 		<docs.main>spring-cloud-aws</docs.main>
 		<main.basedir>${basedir}/..</main.basedir>
+		<configprops.path>${project.basedir}/src/main/asciidoc/_configprops.adoc</configprops.path>
 		<configprops.inclusionPattern>spring.cloud.aws.*</configprops.inclusionPattern>
 		<upload-docs-zip.phase>deploy</upload-docs-zip.phase>
 		<generated-docs-multipage-output.dir>${project.build.directory}/generated-docs/${project.version}/reference/html</generated-docs-multipage-output.dir>
@@ -60,17 +61,13 @@
 									<configuration>
 										<artifactItems>
 											<artifactItem>
-												<groupId>org.springframework.cloud
-												</groupId>
-												<artifactId>spring-cloud-build-docs
-												</artifactId>
-												<version>${spring-cloud-build.version}
-												</version>
+												<groupId>org.springframework.cloud</groupId>
+												<artifactId>spring-cloud-build-docs</artifactId>
+												<version>${spring-cloud-build.version}</version>
 												<classifier>sources</classifier>
 												<type>jar</type>
 												<overWrite>true</overWrite>
-												<outputDirectory>${docs.resources.dir}
-												</outputDirectory>
+												<outputDirectory>${docs.resources.dir}</outputDirectory>
 											</artifactItem>
 										</artifactItems>
 									</configuration>
@@ -84,17 +81,13 @@
 									<configuration>
 										<artifactItems>
 											<artifactItem>
-												<groupId>org.springframework.cloud
-												</groupId>
-												<artifactId>spring-cloud-build-docs
-												</artifactId>
-												<version>${spring-cloud-build.version}
-												</version>
+												<groupId>org.springframework.cloud</groupId>
+												<artifactId>spring-cloud-build-docs</artifactId>
+												<version>${spring-cloud-build.version}</version>
 												<classifier>jar-with-dependencies</classifier>
 												<type>jar</type>
 												<overWrite>true</overWrite>
-												<outputDirectory>${docs.classes.dir}
-												</outputDirectory>
+												<outputDirectory>${docs.classes.dir}</outputDirectory>
 											</artifactItem>
 										</artifactItems>
 									</configuration>
@@ -140,12 +133,9 @@
 							</executions>
 							<dependencies>
 								<dependency>
-									<groupId>org.springframework.cloud
-									</groupId>
-									<artifactId>spring-cloud-build-docs
-									</artifactId>
-									<version>${spring-cloud-build.version}
-									</version>
+									<groupId>org.springframework.cloud</groupId>
+									<artifactId>spring-cloud-build-docs</artifactId>
+									<version>${spring-cloud-build.version}</version>
 									<classifier>${spring-cloud-build-docs-classifier}</classifier>
 									<type>jar</type>
 								</dependency>
@@ -213,12 +203,10 @@
 									<github-raw>
 										https://raw.githubusercontent.com/spring-cloud/${docs.main}/${github-tag}@
 									</github-raw>
-									<github-code>https://github.com/spring-cloud/${docs.main}/tree/${github-tag}@
-									</github-code>
+									<github-code>https://github.com/spring-cloud/${docs.main}/tree/${github-tag}@</github-code>
 									<github-issues>https://github.com/spring-cloud/${docs.main}/issues/@</github-issues>
 									<github-wiki>https://github.com/spring-cloud/${docs.main}/wiki@</github-wiki>
-									<github-master-code>https://github.com/spring-cloud/${docs.main}/tree/master@
-									</github-master-code>
+									<github-master-code>https://github.com/spring-cloud/${docs.main}/tree/master@</github-master-code>
 									<index-link>${index-link}@</index-link>
 
 									<!-- Spring Cloud specific -->

diff --git a/docs/src/main/asciidoc/_configprops.adoc b/docs/src/main/asciidoc/_configprops.adoc
@@ -42,6 +42,7 @@
 |spring.cloud.aws.s3.accelerate-mode-enabled |  | Option to enable using the accelerate endpoint when accessing S3. Accelerate endpoints allow faster transfer of objects by using Amazon CloudFront's globally distributed edge locations.
 |spring.cloud.aws.s3.checksum-validation-enabled |  | Option to disable doing a validation of the checksum of an object stored in S3.
 |spring.cloud.aws.s3.chunked-encoding-enabled |  | Option to enable using chunked encoding when signing the request payload for {@link software.amazon.awssdk.services.s3.model.PutObjectRequest} and {@link software.amazon.awssdk.services.s3.model.UploadPartRequest}.
+|spring.cloud.aws.s3.cross-region-enabled |  | Enables cross-region bucket access.
 |spring.cloud.aws.s3.crt.initial-read-buffer-size-in-bytes |  | Configure the starting buffer size the client will use to buffer the parts downloaded from S3. Maintain a larger window to keep up a high download throughput; parts cannot download in parallel unless the window is large enough to hold multiple parts. Maintain a smaller window to limit the amount of data buffered in memory.
 |spring.cloud.aws.s3.crt.max-concurrency |  | Specifies the maximum number of S3 connections that should be established during transfer.
 |spring.cloud.aws.s3.crt.minimum-part-size-in-bytes |  | Sets the minimum part size for transfer parts. Decreasing the minimum part size causes multipart transfer to be split into a larger number of smaller parts. Setting this value too low has a negative effect on transfer speeds, causing extra latency and network communication for each part.