From 261f18cc01ade646fe5f7dd7dc6039a34a55dacf Mon Sep 17 00:00:00 2001 From: Christian Tzolov Date: Sun, 20 Oct 2024 12:30:07 +0200 Subject: [PATCH] Update Spring AI docs build and content - Upgrade Antora Maven plugin to 1.0.0-alpha.4 (replace Replace the io.spring.maven.antora:antora-maven-plugin:0.0.4) - Update playbook configuration for Antora 3.2.0-alpha.6 - Refine documentation layout and styling - Enhance observability documentation with formatted tables - Adjust Spring AI logo size and update integration diagram --- spring-ai-docs/pom.xml | 18 ++++-- .../src/main/antora/antora-playbook.yml | 14 ++++- ...vg => spring-ai-integration-diagram-3.svg} | 48 ++++++---------- .../main/antora/modules/ROOT/pages/index.adoc | 5 +- .../ROOT/pages/observability/index.adoc | 55 +++++++++++++------ 5 files changed, 78 insertions(+), 62 deletions(-) rename spring-ai-docs/src/main/antora/modules/ROOT/images/{spring-ai-integration-diagram2.svg => spring-ai-integration-diagram-3.svg} (54%) diff --git a/spring-ai-docs/pom.xml b/spring-ai-docs/pom.xml index e674565c5..dee459480 100644 --- a/spring-ai-docs/pom.xml +++ b/spring-ai-docs/pom.xml @@ -13,23 +13,29 @@ - io.spring.maven.antora + org.antora antora-maven-plugin - ${io.spring.maven.antora-version} + 1.0.0-alpha.4 true + + + + + src/main/antora/antora-playbook.yml + @antora/cli@3.2.0-alpha.6 @antora/atlas-extension@1.0.0-alpha.2 - @antora/collector-extension@1.0.0-alpha.3 + @antora/collector-extension@1.0.0-beta.1 @asciidoctor/tabs@1.0.0-beta.6 @springio/antora-extensions@1.14.2 - @springio/asciidoctor-extensions@1.0.0-alpha.10 + @springio/asciidoctor-extensions@1.0.0-alpha.12 @djencks/asciidoctor-mathjax@0.0.9 - + org.apache.maven.plugins maven-assembly-plugin diff --git a/spring-ai-docs/src/main/antora/antora-playbook.yml b/spring-ai-docs/src/main/antora/antora-playbook.yml index 0823fbc64..c2b46bdb9 100644 --- a/spring-ai-docs/src/main/antora/antora-playbook.yml +++ b/spring-ai-docs/src/main/antora/antora-playbook.yml @@ -1,14 +1,18 @@ -# PACKAGES antora@3.2.0-alpha.2 @antora/atlas-extension:1.0.0-alpha.1 @antora/collector-extension@1.0.0-alpha.3 @springio/antora-extensions@1.1.0-alpha.2 @asciidoctor/tabs@1.0.0-alpha.12 @opendevise/antora-release-line-extension@1.0.0-alpha.2 +# PACKAGES antora@3.2.0-alpha.6 @antora/atlas-extension:1.0.0-alpha.1 @antora/collector-extension@1.0.0-alpha.3 @springio/antora-extensions@1.1.0-alpha.2 @asciidoctor/tabs@1.0.0-alpha.12 @opendevise/antora-release-line-extension@1.0.0-alpha.2 # # The purpose of this Antora playbook is to build the docs in the current branch. antora: extensions: - '@antora/collector-extension' - - require: '@springio/antora-extensions/root-component-extension' + # - require: '@springio/antora-extensions/root-component-extension' + - require: '@springio/antora-extensions' root_component_name: 'ai' site: title: Spring AI Reference url: https://docs.spring.io/spring-ai/reference + robots: allow +git: + ensure_git_suffix: false content: sources: - url: ./../../../.. @@ -17,6 +21,7 @@ content: worktrees: true asciidoc: attributes: + page-related-doc-categories: ai,java,ml page-pagination: '' hide-uri-scheme: '@' tabs-sync-option: '@' @@ -25,11 +30,14 @@ asciidoc: extensions: - '@asciidoctor/tabs' - '@springio/asciidoctor-extensions' - - '@djencks/asciidoctor-mathjax' + - '@springio/asciidoctor-extensions/javadoc-extension' - '@springio/asciidoctor-extensions/include-code-extension' + - '@djencks/asciidoctor-mathjax' sourcemap: true urls: + latest_version_segment_strategy: redirect:to latest_version_segment: '' + redirect_facility: httpd runtime: log: failure_level: warn diff --git a/spring-ai-docs/src/main/antora/modules/ROOT/images/spring-ai-integration-diagram2.svg b/spring-ai-docs/src/main/antora/modules/ROOT/images/spring-ai-integration-diagram-3.svg similarity index 54% rename from spring-ai-docs/src/main/antora/modules/ROOT/images/spring-ai-integration-diagram2.svg rename to spring-ai-docs/src/main/antora/modules/ROOT/images/spring-ai-integration-diagram-3.svg index 98115792a..98fb78a05 100644 --- a/spring-ai-docs/src/main/antora/modules/ROOT/images/spring-ai-integration-diagram2.svg +++ b/spring-ai-docs/src/main/antora/modules/ROOT/images/spring-ai-integration-diagram-3.svg @@ -7,7 +7,7 @@ stroke-linecap="square" stroke-miterlimit="10" id="svg21" - sodipodi:docname="spring-ai-integration-diagram.svg" + sodipodi:docname="spring-ai-integration-diagram copy.svg" width="456.38483" height="301.31775" inkscape:version="1.3.2 (091e20e, 2023-11-25)" @@ -29,13 +29,13 @@ inkscape:pageopacity="0.0" inkscape:pagecheckerboard="0" inkscape:deskcolor="#d1d1d1" - inkscape:zoom="2.6322001" - inkscape:cx="313.04611" - inkscape:cy="194.13418" + inkscape:zoom="1.5548401" + inkscape:cx="237.96659" + inkscape:cy="138.27788" inkscape:window-width="1728" inkscape:window-height="925" - inkscape:window-x="2321" - inkscape:window-y="292" + inkscape:window-x="0" + inkscape:window-y="164" inkscape:window-maximized="0" inkscape:current-layer="g21" />