AUTH-11 enhance documentation

appNG · Nov 15, 2017 · f195247 · f195247
1 parent f7b2476
commit f195247
Show file tree

Hide file tree

Showing 4 changed files with 451 additions and 21 deletions.
diff --git a/application-home/application.xml b/application-home/application.xml
@@ -28,7 +28,7 @@
 		<property id="successPage" description="The path the user is forwarded to after successfull login">/appng-manager</property>
 		<property id="enableDeeplinks" description="set to true to forward the user to the originally requested page">true</property>
 		<property id="digestLoginRedirectWithServletPath" description="set to true to redirect to the original servlet path after a digest login (without query params)">false</property>
-		<property id="mailFrom" description="the sender address for emails send during passwort retrieval">support@aiticon.de</property>
+		<property id="mailFrom" description="the sender address for emails send during passwort retrieval">support@example.com</property>
 		<property id="digestMaxValidity" description="the maximum validity of a login digest in minutes">3</property>
 	</properties>
 

diff --git a/pom.xml b/pom.xml
@@ -15,6 +15,7 @@
 		<urlAlias>authentication</urlAlias>
 		<displayName>Authentication</displayName>
 		<longDescription><![CDATA[This application provides several authentication mechanisms (Formular, NTML, Digest).]]></longDescription>
+		<asciidocPhase>deploy</asciidocPhase>
 	</properties>
 
 	<parent>
@@ -161,37 +162,60 @@
 			<plugin>
 				<groupId>org.asciidoctor</groupId>
 				<artifactId>asciidoctor-maven-plugin</artifactId>
-				<version>1.5.2.1</version>
+				<version>1.5.5</version>
 				<dependencies>
 					<dependency>
 						<groupId>org.asciidoctor</groupId>
 						<artifactId>asciidoctorj-pdf</artifactId>
-						<version>1.5.0-alpha.9</version>
+						<version>1.5.0-alpha.15</version>
 					</dependency>
 				</dependencies>
-
+				<configuration>
+					<attributes>
+						<icons>font</icons>
+						<pagenums />
+						<toc />
+						<toclevels>3</toclevels>
+						<idprefix />
+						<idseparator>-</idseparator>
+						<numbered>true</numbered>
+						<project-version>${project.version}</project-version>
+						<project-name>${project.name}</project-name>
+					</attributes>
+				</configuration>
 				<executions>
 					<execution>
+						<id>html</id>
+						<phase>${asciidocPhase}</phase>
+						<goals>
+							<goal>process-asciidoc</goal>
+						</goals>
 						<configuration>
-							<backend>pdf</backend>
+							<backend>html5</backend>
+							<sectids>true</sectids>
 							<sourceHighlighter>coderay</sourceHighlighter>
+							<outputDirectory>${project.build.directory}/generated-docs/html</outputDirectory>
+							<sourceDocumentName>readme.adoc</sourceDocumentName>
 							<attributes>
+								<linkcss>true</linkcss>
 								<icons>font</icons>
-								<pagenums />
-								<toc />
-								<toclevels>3</toclevels>
-								<idprefix />
-								<idseparator>-</idseparator>
-								<numbered>true</numbered>
-								<project-version>${project.version}</project-version>
-								<project-name>${project.name}</project-name>
+								<sectanchors>true</sectanchors>
+								<stylesheet>appng.css</stylesheet>
 							</attributes>
 						</configuration>
-						<id>output-html</id>
-						<phase>generate-resources</phase>
+					</execution>
+					<execution>
+						<id>pdf</id>
+						<phase>${asciidocPhase}</phase>
 						<goals>
 							<goal>process-asciidoc</goal>
 						</goals>
+						<configuration>
+							<backend>pdf</backend>
+							<sourceHighlighter>coderay</sourceHighlighter>
+							<sourceDocumentName>readme.adoc</sourceDocumentName>
+							<outputDirectory>${project.build.directory}/generated-docs/pdf</outputDirectory>
+						</configuration>
 					</execution>
 				</executions>
 			</plugin>