Fixed jenkinsci#135

khmarbaise · khmarbaise · commit 22ffa6ea7717 · 2016-04-16T21:07:40.000+02:00
o First step for setting up a documentation
   structure.
 o This setup uses Maven site generation with
   support for asciidoctor / markdown.
diff --git a/pom.xml b/pom.xml
@@ -17,7 +17,7 @@
     <version>9</version>
   </parent>
 
-  <name>Jenkins Client</name>
+  <name>Jenkins API client for Java</name>
   <url>http://github.com/RisingOak/jenkins-client</url>
   <description>A Jenkins API client for Java</description>
 
@@ -48,6 +48,8 @@
     <maven.compiler.source>1.7</maven.compiler.source>
     <maven.compiler.target>1.7</maven.compiler.target>
 
+    <asciidoctor-maven-plugin.version>1.5.3</asciidoctor-maven-plugin.version>
+
     <!-- Version of Jenkins to use for Integration Tests -->
     <jenkins-version>1.644</jenkins-version>
     <junit.version>4.11</junit.version>
@@ -197,7 +199,7 @@
         <plugin>
           <groupId>org.apache.maven.plugins</groupId>
           <artifactId>maven-source-plugin</artifactId>
-          <version>2.4</version>
+          <version>3.0.0</version>
           <executions>
             <!--
               ! here we override the super-pom attach-sources execution id which
@@ -241,7 +243,7 @@
         <plugin>
           <groupId>org.apache.maven.plugins</groupId>
           <artifactId>maven-compiler-plugin</artifactId>
-          <version>3.3</version>
+          <version>3.5.1</version>
         </plugin>
         <!--
           ! We define a newer version than in parent.
@@ -279,9 +281,45 @@
             <scmBranch>gh-pages</scmBranch>
           </configuration>
         </plugin>
+        <plugin>
+          <groupId>org.asciidoctor</groupId>
+          <artifactId>asciidoctor-maven-plugin</artifactId>
+          <version>${asciidoctor-maven-plugin.version}</version>
+        </plugin>
       </plugins>
     </pluginManagement>
     <plugins>
+        <plugin>
+            <groupId>org.apache.maven.plugins</groupId>
+            <artifactId>maven-site-plugin</artifactId>
+            <version>3.4</version>
+            <dependencies>
+                <dependency>
+                    <groupId>org.apache.maven.doxia</groupId>
+                    <artifactId>doxia-module-markdown</artifactId>
+                    <version>1.6</version>
+                </dependency>
+                <dependency>
+                    <groupId>org.asciidoctor</groupId>
+                    <artifactId>asciidoctor-maven-plugin</artifactId>
+                    <version>${asciidoctor-maven-plugin.version}</version>
+                </dependency>
+            </dependencies>
+            <configuration>
+                <asciidoc>
+                  <!-- optional site-wide AsciiDoc attributes -->
+                  <attributes>
+                    <icons>font</icons>
+                    <source-highlighter>coderay</source-highlighter>
+                    <coderay-css>style</coderay-css>
+                    <toclevels>2</toclevels>
+                    <project-version>${project.version}</project-version>
+                    <sectnums>true</sectnums>
+                    <preserveDirectories>true</preserveDirectories>
+                  </attributes>
+                </asciidoc>
+            </configuration>
+        </plugin>
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-shade-plugin</artifactId>
@@ -332,6 +370,7 @@
         <artifactId>maven-project-info-reports-plugin</artifactId>
         <version>2.8</version>
       </plugin>
+      <!--
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-pmd-plugin</artifactId>
@@ -355,6 +394,7 @@
         <artifactId>maven-jxr-plugin</artifactId>
         <version>2.5</version>
       </plugin>
+      -->
     </plugins>
   </reporting>
 
diff --git a/src/main`java/com/offbytwo/jenkins/client/util/RequestReleasingInputStream.java b/src/main`java/com/offbytwo/jenkins/client/util/RequestReleasingInputStream.java
diff --git a/src/main`java/com/offbytwo/jenkins/model/Artifact.java b/src/main`java/com/offbytwo/jenkins/model/Artifact.java
diff --git a/src/site/asciidoc/index.adoc b/src/site/asciidoc/index.adoc
@@ -0,0 +1,7 @@
+:revnumber: ${project-version}
+
+== Overview ==
+
+Here you can see the first page.
+This is the first.
+
diff --git a/src/site/asciidoc/sub/sub.adoc b/src/site/asciidoc/sub/sub.adoc
@@ -0,0 +1 @@
+Test
diff --git a/src/site/markdown/upgrade.md b/src/site/markdown/upgrade.md
@@ -0,0 +1,8 @@
+## Overview ##
+
+Document in markdown. Here you can write documentation
+with structure [with links][link]
+
+
+[link]: http://www.jenkins-ci.org
+
diff --git a/src/site/site.xml b/src/site/site.xml
@@ -7,7 +7,7 @@
   <skin>
     <groupId>org.apache.maven.skins</groupId>
     <artifactId>maven-fluido-skin</artifactId>
-    <version>1.4</version>
+    <version>1.5</version>
   </skin>
 
   <custom>
@@ -27,6 +27,10 @@
   <body>
     <menu name="Overview">
       <item name="Introduction" href="index.html"/>
+      <item name="Upgrade" href="upgrade.html"/>
+    </menu>
+    <menu name="Sub">
+      <item name="Sub" href="sub/sub.html"/>
     </menu>
     <menu ref="reports" />
   </body>
