Skip to content

Commit 3f123ce

Browse files
committed
build: update Antora to 3.1.12 and fix documentation warnings
Upgrade Antora documentation generator and resolve all build warnings for cleaner documentation builds. - Update Antora CLI and site generator from 3.1.4 to 3.1.12 - Update Node.js to 20.17.0 LTS and npm to 10.9.2 - Fix deprecated npm package warnings (inflight, glob, gulp-vinyl-zip) - Replace deprecated {attachmentsdir} with modern Antora 3.x attachment syntax - Update api-reference.adoc to use xref:attachment$ instead of link:{attachmentsdir} - Change javadoc-base-url to use relative path instead of deprecated attribute
1 parent e710fdd commit 3f123ce

File tree

5 files changed

+739
-1656
lines changed

5 files changed

+739
-1656
lines changed

docs/antora-playbook.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,8 @@ asciidoc:
2929
toc: ~
3030
xrefstyle: short
3131
# Javadoc-specific attributes
32-
javadoc-base-url: '{attachmentsdir}/javadoc'
32+
# Using relative paths from the page location
33+
javadoc-base-url: '_attachments/javadoc'
3334
javadoc-core-url: '{javadoc-base-url}/modules/redis-om-spring'
3435
javadoc-ai-url: '{javadoc-base-url}/modules/redis-om-spring-ai'
3536
javadoc-aggregate-url: '{javadoc-base-url}/aggregate'

docs/build.gradle

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ description = 'Redis OM Spring Documents Site'
1212

1313
// Define properties similar to Maven pom.xml
1414
ext {
15-
nodeVersion = '20.5.0' // Note: no 'v' prefix for node-gradle plugin
16-
npmVersion = '9.8.0'
17-
antoraVersion = '3.1.4'
15+
nodeVersion = '20.17.0' // LTS version
16+
npmVersion = '10.9.2'
17+
antoraVersion = '3.1.12'
1818
}
1919

2020
// Configure Node.js plugin

docs/content/modules/ROOT/pages/api-reference.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ The API documentation is automatically generated from the latest release and inc
2323

2424
The core Redis OM Spring module provides the fundamental functionality for object mapping, repositories, and search capabilities.
2525

26-
link:{attachmentsdir}/javadoc/modules/redis-om-spring/index.html[Redis OM Spring Core API^, role="external"]
26+
xref:attachment$javadoc/modules/redis-om-spring/index.html[Redis OM Spring Core API^, role="external", window="_blank"]
2727

2828
=== Key Packages
2929

@@ -39,7 +39,7 @@ link:{attachmentsdir}/javadoc/modules/redis-om-spring/index.html[Redis OM Spring
3939

4040
The AI extension module provides vector embedding and similarity search capabilities with multiple AI provider integrations.
4141

42-
link:{attachmentsdir}/javadoc/modules/redis-om-spring-ai/index.html[Redis OM Spring AI API^, role="external"]
42+
xref:attachment$javadoc/modules/redis-om-spring-ai/index.html[Redis OM Spring AI API^, role="external", window="_blank"]
4343

4444
=== Key Packages
4545

@@ -51,7 +51,7 @@ link:{attachmentsdir}/javadoc/modules/redis-om-spring-ai/index.html[Redis OM Spr
5151

5252
For a unified view of all modules and their interactions:
5353

54-
link:{attachmentsdir}/javadoc/aggregate/index.html[Complete API Reference^, role="external"]
54+
xref:attachment$javadoc/aggregate/index.html[Complete API Reference^, role="external", window="_blank"]
5555

5656
This aggregated documentation provides:
5757

0 commit comments

Comments
 (0)