Skip to content

Commit e42545f

Browse files
Enable docs build to fail on AsciiDoc warnings
- Configure asciidoctor-maven-plugin to treat warnings as errors (for example, unterminated blocks) - Fix duplicate section ID warning in kinesis-stream-binder.adoc - Convert "encryption types" in s3.adoc from a numbered list to subsections to avoid list-continuity warnings - Add docs validation job to CI workflow Fixes #1571
1 parent c0f6b43 commit e42545f

File tree

4 files changed

+24
-5
lines changed

4 files changed

+24
-5
lines changed

.github/workflows/build.yml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,19 @@ jobs:
2626
cache: maven
2727
- name: Build with Maven
2828
run: ./mvnw -V -B verify -Pspring
29+
docs:
30+
name: Validate Docs
31+
runs-on: ubuntu-latest
32+
steps:
33+
- uses: actions/checkout@v6
34+
- name: Set up JDK 17
35+
uses: actions/setup-java@v5
36+
with:
37+
distribution: temurin
38+
java-version: 17.0.12
39+
cache: maven
40+
- name: Validate AsciiDoc
41+
run: ./mvnw -V -B clean verify -Pdocs-classic -DskipTests
2942
sonar:
3043
name: Run Sonar Analysis
3144
runs-on: ubuntu-latest

docs/pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -257,7 +257,7 @@
257257
<logHandler>
258258
<outputToConsole>true</outputToConsole>
259259
<failIf>
260-
<!-- <severity>DEBUG</severity>-->
260+
<severity>WARN</severity>
261261
</failIf>
262262
</logHandler>
263263
</configuration>

docs/src/main/asciidoc/kinesis-stream-binder.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -484,7 +484,7 @@ If [Server-Side Encryption](https://docs.aws.amazon.com/streams/latest/dev/what-
484484
}
485485
----
486486

487-
[[dynamodb-streams-support]]
487+
[[kinesis-binder-dynamodb-streams-support]]
488488
=== DynamoDB Streams Support
489489

490490
The Kinesis Binder provides support for consuming CDC events from the https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Streams.html[DynamoDB Streams].

docs/src/main/asciidoc/s3.adoc

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -145,9 +145,12 @@ To autoconfigure Encryption Client simply add the following dependency.
145145

146146
We are supporting 3 types of encryption.
147147

148-
1. To configure encryption via KMS key specify `spring.cloud.aws.s3.encryption.key-id` with KMS key arn and this key will be used to encrypt your files.
148+
==== KMS Key Encryption
149+
150+
To configure encryption via KMS key specify `spring.cloud.aws.s3.encryption.key-id` with KMS key arn and this key will be used to encrypt your files.
149151

150152
Also, following dependency is required.
153+
151154
[source,xml]
152155
----
153156
<dependency>
@@ -157,8 +160,9 @@ Also, following dependency is required.
157160
</dependency>
158161
----
159162

163+
==== RSA Asymmetric Encryption
160164

161-
2. Asymmetric encryption is possible via RSA to enable it you will have to implement `io.awspring.cloud.autoconfigure.s3.S3RsaProvider`
165+
Asymmetric encryption is possible via RSA. To enable it you will have to implement `io.awspring.cloud.autoconfigure.s3.S3RsaProvider`.
162166

163167
NOTE: You will have to store private and public keys yourself otherwise you won't be able to decrypt the data later.
164168

@@ -184,7 +188,9 @@ public class MyRsaProvider implements S3RsaProvider {
184188
}
185189
----
186190

187-
3. Last option is if you want to use symmetric algorithm, this is possible via `io.awspring.cloud.autoconfigure.s3.S3AesProvider`
191+
==== AES Symmetric Encryption
192+
193+
If you want to use symmetric algorithm, this is possible via `io.awspring.cloud.autoconfigure.s3.S3AesProvider`.
188194

189195
NOTE: Ensure the private key is stored using secure storage mechanisms that prevent unauthorized access.
190196

0 commit comments

Comments
 (0)