Antora für Dokumentation.

.gitignore

@@ -7,6 +7,12 @@ target/
 ### schließe node aus
 web-frontend/node/
 
+# Node.js Artefakte im docs Modul
+docs/node/
+docs/node_modules/
+# Antora Output (Standardmäßig im Ordner 'build' oder 'public')
+docs/build/
+
 ### IntelliJ IDEA ###
 .idea/modules.xml
 .idea/jarRepositories.xml

.idea/encodings.xml

@@ -7,11 +7,13 @@
     <file url="file://$PROJECT_DIR$/client-app/src/main/resources" charset="UTF-8" />
     <file url="file://$PROJECT_DIR$/client-lib/src/main/java" charset="UTF-8" />
     <file url="file://$PROJECT_DIR$/client-lib/src/main/resources" charset="UTF-8" />
+    <file url="file://$PROJECT_DIR$/client-web/src/main/java" charset="UTF-8" />
+    <file url="file://$PROJECT_DIR$/client-web/src/main/resources" charset="UTF-8" />
+    <file url="file://$PROJECT_DIR$/docs/src/main/java" charset="UTF-8" />
+    <file url="file://$PROJECT_DIR$/docs/src/main/resources" charset="UTF-8" />
     <file url="file://$PROJECT_DIR$/server-app/src/main/java" charset="UTF-8" />
     <file url="file://$PROJECT_DIR$/server-app/src/main/resources" charset="UTF-8" />
     <file url="file://$PROJECT_DIR$/src/main/java" charset="UTF-8" />
     <file url="file://$PROJECT_DIR$/src/main/resources" charset="UTF-8" />
-    <file url="file://$PROJECT_DIR$/web-frontend/src/main/java" charset="UTF-8" />
-    <file url="file://$PROJECT_DIR$/web-frontend/src/main/resources" charset="UTF-8" />
   </component>
 </project>

client-web/pom.xml

@@ -8,7 +8,7 @@
     <artifactId>productknowledge-parent</artifactId>
     <version>1.0-SNAPSHOT</version>
   </parent>
-  <artifactId>web-frontend</artifactId>
+  <artifactId>client-web</artifactId>
 
   <build>
     <plugins>

docs/antora-playbook.yml

@@ -0,0 +1,11 @@
+site:
+  title: Product Knowledge Docs
+  start_page: ROOT:index.adoc
+content:
+  sources:
+    - url: ..
+      branches: HEAD
+      start_path: docs
+ui:
+  bundle:
+    url: https://gitlab.com/antora/antora-ui-default/-/jobs/artifacts/master/raw/build/ui-bundle.zip?job=bundle-stable

docs/antora.yml

@@ -0,0 +1,5 @@
+name: product-knowledge
+version: '1.0'
+title: Product Knowledge Documentation
+nav:
+  - modules/ROOT/nav.adoc

docs/modules/ROOT/nav.adoc

@@ -0,0 +1,8 @@
+
+* xref:index.adoc[Einführung]
+* xref:setup.adoc[Installation & Setup]
+
+* Ebenen
+ ** xref:ebenen.adoc[Ebenen]
+
+* API Dokumentation

docs/modules/ROOT/pages/ebenen.adoc

@@ -0,0 +1 @@
+Folgende Ebenen sind vorgesehen:

docs/modules/ROOT/pages/index.adoc

@@ -0,0 +1 @@
+Allerhand Text index

docs/modules/ROOT/pages/setup.adoc

@@ -0,0 +1 @@
+Hier text zum Setup

docs/pom.xml

@@ -11,29 +11,75 @@
 
   <artifactId>docs</artifactId>
 
-  <!-- ... existing code ... -->
   <build>
     <plugins>
+<!--      <plugin>-->
+<!--        <groupId>org.asciidoctor</groupId>-->
+<!--        <artifactId>asciidoctor-maven-plugin</artifactId>-->
+<!--        &lt;!&ndash; Keine Version nötig, kommt vom Parent &ndash;&gt;-->
+<!--        <executions>-->
+<!--          <execution>-->
+<!--            <id>generate-docs</id>-->
+<!--            <phase>prepare-package</phase>-->
+<!--            <goals>-->
+<!--              <goal>process-asciidoc</goal>-->
+<!--            </goals>-->
+<!--            <configuration>-->
+<!--              <attributes>-->
+<!--                <project-root>${project.basedir}/..</project-root>-->
+<!--                <project-name>${project.parent.name}</project-name>-->
+<!--                <project-version>${project.version}</project-version>-->
+<!--                <project-root>${project.basedir}/..</project-root>-->
+<!--                <revnumber>${project.version}</revnumber>-->
+<!--                <revdate>${maven.build.timestamp}</revdate>-->
+<!--                <source-highlighter>coderay</source-highlighter>-->
+<!--              </attributes>-->
+<!--            </configuration>-->
+<!--          </execution>-->
+<!--        </executions>-->
+<!--      </plugin>-->
       <plugin>
-        <groupId>org.asciidoctor</groupId>
+        <groupId>com.github.eirslett</groupId>
-        <artifactId>asciidoctor-maven-plugin</artifactId>
+        <artifactId>frontend-maven-plugin</artifactId>
-        <!-- Keine Version nötig, kommt vom Parent -->
+        <version>1.15.0</version>
         <executions>
+          <!-- 1. Node.js und npm lokal im docs-Verzeichnis installieren -->
           <execution>
-            <id>generate-docs</id>
+            <id>install-node-and-npm</id>
-            <phase>prepare-package</phase>
             <goals>
-              <goal>process-asciidoc</goal>
+              <goal>install-node-and-npm</goal>
             </goals>
             <configuration>
-              <attributes>
+              <nodeVersion>v20.10.0</nodeVersion>
-                <!-- Pfad-Helper, um auf Code in anderen Modulen zuzugreifen -->
+            </configuration>
-                <project-root>${project.basedir}/..</project-root>
+          </execution>
-              </attributes>
+
+          <!-- 2. Antora lokal installieren -->
+          <execution>
+            <id>npm-install-antora</id>
+            <phase>generate-resources</phase>
+            <goals>
+              <goal>npm</goal>
+            </goals>
+            <configuration>
+              <arguments>install @antora/cli@3.1 @antora/site-generator@3.1</arguments>
+            </configuration>
+          </execution>
+
+          <!-- 3. Antora ausführen, um die Seite zu bauen -->
+          <execution>
+            <id>run-antora</id>
+            <phase>prepare-package</phase>
+            <goals>
+              <goal>npx</goal>
+            </goals>
+            <configuration>
+              <arguments>antora antora-playbook.yml</arguments>
             </configuration>
           </execution>
         </executions>
       </plugin>
+
     </plugins>
   </build>
 </project>

docs/src/main/asciidoc/index.adoc

@@ -1,5 +1,5 @@
 = Dokumentation für {project-name}
-Vorname Nachname <autor@example.com>
+Jens Bühring <jens.buehring@kapdion.com>
 :icons: font
 
 == Einleitung
@@ -7,4 +7,7 @@ Dies ist die zentrale Dokumentation für unser Jakarta EE & Spring Projekt.
 
 == Module
 * *api-definition*: Enthält die Api.
-* *Web*: Angular Frontend und REST-Controller.
+* *server-app* Eine Server-Applikation, welche Beispielprodukte zur Verfügung stellt.
+* *client-lib* Client-Library
+* *client-app* Client-Java-App, verwendet Client-Library
+* *client-web*: Angular Implementierung eines Clients

pom.xml

@@ -17,7 +17,7 @@
     <module>server-app</module>
     <module>client-lib</module>
     <module>client-app</module>
-    <module>web-frontend</module>
+    <module>client-web</module>
     <module>docs</module>
   </modules>
 

server-app/pom.xml

@@ -27,7 +27,7 @@
     <!-- warte auf web-frontend, damit die gebauten Seiten eingebettet werden können -->
     <dependency>
       <groupId>com.kapdion.pisano</groupId>
-      <artifactId>web-frontend</artifactId>
+      <artifactId>client-web</artifactId>
       <version>${project.version}</version>
       <type>pom</type>
       <scope>provided</scope>