Hacking Documentation

Diese Dokumentation wird im Projektverzeichniss unter src/main/site verwaltet.

Dabei wird Projektweit das xdoc Format verwendet.

Generiert wird die Dokumentation durch den Befehl mvn site:site und der Befehl mvn site:deploy veröffentlicht - entsprechende Berechtigungen vorrausgesetzt - die Seite auf github im gh-pages des Repositories.

Dazu muss in der lokalen Maven Konfiguration ( $HOME/.m2/settings.xml ) der Benutzer zum Zugriff auf das Repository auf git eingestellt sein. 

<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
                  http://maven.apache.org/xsd/settings-1.0.0.xsd">
	<servers>
		<server>
			<id>github-project-site</id>
			<username>git</username>
		</server>
	</servers>
</settings>