Apache 2 Lizenz aufgenommen
This commit is contained in:
4
docs/README.md
Normal file
4
docs/README.md
Normal file
@@ -0,0 +1,4 @@
|
||||
Integration in die Anwendung (Jakarta EE / Spring)
|
||||
direkt in deine Spring Boot Anwendung einbetten, damit sie unter http://localhost:8080/docs/index.html erreichbar ist:
|
||||
|
||||
Konfiguriere das Maven-Plugin so, dass es die Antora-Ausgabe nach server-app/src/main/resources/static/docs kopiert.
|
||||
@@ -1,6 +1,6 @@
|
||||
site:
|
||||
title: Product Knowledge Docs
|
||||
start_page: ROOT:index.adoc
|
||||
title: Product Knowledge Documentation
|
||||
start_page: product-knowledge:ROOT:index.adoc
|
||||
content:
|
||||
sources:
|
||||
- url: ..
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
name: product-knowledge
|
||||
version: '1.0'
|
||||
title: Product Knowledge Documentation
|
||||
title: Product Knowledge
|
||||
nav:
|
||||
- modules/ROOT/nav.adoc
|
||||
@@ -1 +1,6 @@
|
||||
Allerhand Text index
|
||||
Allerhand Text index
|
||||
|
||||
// ... existing code ...
|
||||
== Lizenz
|
||||
Dieses Projekt ist unter der link:https://www.apache.org/licenses/LICENSE-2.0.txt[Apache License 2.0] lizenziert.
|
||||
|
||||
|
||||
24
docs/pom.xml
24
docs/pom.xml
@@ -80,6 +80,30 @@
|
||||
</executions>
|
||||
</plugin>
|
||||
|
||||
<plugin>
|
||||
<artifactId>maven-resources-plugin</artifactId>
|
||||
<version>3.3.1</version>
|
||||
<executions>
|
||||
<execution>
|
||||
<id>copy-docs-to-server</id>
|
||||
<phase>package</phase> <!-- Kopieren nach dem Antora-Build -->
|
||||
<goals>
|
||||
<goal>copy-resources</goal>
|
||||
</goals>
|
||||
<configuration>
|
||||
<!-- Ziel: Der statische Ressourcen-Ordner deines Spring-Moduls -->
|
||||
<outputDirectory>${project.basedir}/../server-app/src/main/resources/static/docs</outputDirectory>
|
||||
<resources>
|
||||
<resource>
|
||||
<!-- Quelle: Der Standard-Output von Antora -->
|
||||
<directory>${project.basedir}/build/site</directory>
|
||||
<filtering>false</filtering>
|
||||
</resource>
|
||||
</resources>
|
||||
</configuration>
|
||||
</execution>
|
||||
</executions>
|
||||
</plugin>
|
||||
</plugins>
|
||||
</build>
|
||||
</project>
|
||||
@@ -1,13 +0,0 @@
|
||||
= Dokumentation für {project-name}
|
||||
Jens Bühring <jens.buehring@kapdion.com>
|
||||
:icons: font
|
||||
|
||||
== Einleitung
|
||||
Dies ist die zentrale Dokumentation für unser Jakarta EE & Spring Projekt.
|
||||
|
||||
== Module
|
||||
* *api-definition*: Enthält die Api.
|
||||
* *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
|
||||
Reference in New Issue
Block a user