Publishing Maven plugin documentation

piranhacloud · Nov 16, 2024 · c19d3ea · c19d3ea
1 parent c9319e0
commit c19d3ea
Show file tree

Hide file tree

Showing 45 changed files with 1,542 additions and 0 deletions.
diff --git a/snapshot/maven/plugin/css/apache-maven-fluido-2.0.0.min.css b/snapshot/maven/plugin/css/apache-maven-fluido-2.0.0.min.css
diff --git a/snapshot/maven/plugin/css/print.css b/snapshot/maven/plugin/css/print.css
@@ -0,0 +1,35 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+#banner,
+#footer,
+#leftcol,
+#breadcrumbs,
+.docs #toc,
+.docs .courtesylinks,
+#leftColumn,
+#navColumn {
+  display: none !important;
+}
+
+#bodyColumn,
+body.docs div.docs {
+  margin: 0 !important;
+  border: none !important;
+}
diff --git a/snapshot/maven/plugin/css/site.css b/snapshot/maven/plugin/css/site.css
@@ -0,0 +1 @@
+/* You can override this file with your own styles */
diff --git a/snapshot/maven/plugin/fonts/glyphicons-halflings-regular.eot b/snapshot/maven/plugin/fonts/glyphicons-halflings-regular.eot
diff --git a/snapshot/maven/plugin/fonts/glyphicons-halflings-regular.svg b/snapshot/maven/plugin/fonts/glyphicons-halflings-regular.svg
diff --git a/snapshot/maven/plugin/fonts/glyphicons-halflings-regular.ttf b/snapshot/maven/plugin/fonts/glyphicons-halflings-regular.ttf
diff --git a/snapshot/maven/plugin/fonts/glyphicons-halflings-regular.woff b/snapshot/maven/plugin/fonts/glyphicons-halflings-regular.woff
diff --git a/snapshot/maven/plugin/help-mojo.html b/snapshot/maven/plugin/help-mojo.html
@@ -0,0 +1,124 @@
+<!DOCTYPE html>
+
+
+<!--
+ | Generated by Apache Maven Doxia Site Renderer 2.0.0 from org.apache.maven.plugins:maven-plugin-report-plugin:3.15.0:report at 2024-11-16
+ | Rendered using Apache Maven Fluido Skin 2.0.0
+-->
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0" />
+    <title>piranha:help – Piranha Maven Plugin</title>
+    <link rel="stylesheet" href="./css/apache-maven-fluido-2.0.0.min.css" />
+    <link rel="stylesheet" href="./css/site.css" />
+    <link rel="stylesheet" href="./css/print.css" media="print" />
+    <script src="./js/apache-maven-fluido-2.0.0.min.js"></script>
+  </head>
+  <body>
+    <div class="container-fluid container-fluid-top">
+      <header>
+        <div id="banner">
+          <div class="pull-left"><div id="bannerLeft"><h1>Piranha Maven Plugin</h1></div></div>
+          <div class="pull-right"></div>
+          <div class="clear"><hr/></div>
+        </div>
+
+      </header>
+      <div class="row-fluid">
+        <header id="leftColumn" class="span2">
+          <nav class="well sidebar-nav">
+  <ul class="nav nav-list">
+   <li class="nav-header">Overview</li>
+    <li><a href="index.html">About</a></li>
+    <li><a href="plugin-info.html">Plugin Documentation</a></li>
+  </ul>
+          </nav>
+          <div class="well sidebar-nav">
+            <div id="poweredBy">
+              <div class="clear"></div>
+              <div class="clear"></div>
+<a href="https://maven.apache.org/" class="builtBy" target="_blank"><img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" /></a>
+            </div>
+          </div>
+        </header>
+        <main id="bodyColumn" class="span10">
+<section><a id="piranha.3Ahelp"></a>
+<h1>piranha:help</h1>
+<p><strong>Full name</strong>:</p>
+<p>cloud.piranha.maven:piranha-maven-plugin:24.12.0-SNAPSHOT:help</p>
+<p><strong>Description</strong>:</p>
+<p>Display help information on piranha-maven-plugin.
+<br />
+ Call <code>mvn piranha:help -Ddetail=true -Dgoal=&lt;goal-name&gt;</code> to display parameter details.</p>
+<p><strong>Attributes</strong>:</p>
+<ul>
+<li>The goal is thread-safe and supports parallel builds.</li></ul><section><a id="Optional_Parameters"></a>
+<h2>Optional Parameters</h2>
+<table class="table table-striped">
+<tr class="a">
+<th>Name</th>
+<th>Type</th>
+<th>Since</th>
+<th>Description</th></tr>
+<tr class="b">
+<td><a href="#detail"><code>&lt;detail&gt;</code></a></td>
+<td><code>boolean</code></td>
+<td><code>-</code></td>
+<td>If <code>true</code>, display all settable properties for each goal.<br /><strong>Default</strong>: <code>false</code><br /><strong>User Property</strong>: <code>detail</code></td></tr>
+<tr class="a">
+<td><a href="#goal"><code>&lt;goal&gt;</code></a></td>
+<td><code>String</code></td>
+<td><code>-</code></td>
+<td>The name of the goal for which to show help. If unspecified, all goals will be displayed.<br /><strong>User Property</strong>: <code>goal</code></td></tr>
+<tr class="b">
+<td><a href="#indentSize"><code>&lt;indentSize&gt;</code></a></td>
+<td><code>int</code></td>
+<td><code>-</code></td>
+<td>The number of spaces per indentation level, should be positive.<br /><strong>Default</strong>: <code>2</code><br /><strong>User Property</strong>: <code>indentSize</code></td></tr>
+<tr class="a">
+<td><a href="#lineLength"><code>&lt;lineLength&gt;</code></a></td>
+<td><code>int</code></td>
+<td><code>-</code></td>
+<td>The maximum length of a display line, should be positive.<br /><strong>Default</strong>: <code>80</code><br /><strong>User Property</strong>: <code>lineLength</code></td></tr></table></section><section><a id="Parameter_Details"></a>
+<h2>Parameter Details</h2><a id="detail"></a><section><a id="a.3Cdetail.3E"></a>
+<h3>&lt;detail&gt;</h3>
+<div>If <code>true</code>, display all settable properties for each goal.</div>
+<ul>
+<li><strong>Type</strong>: <code>boolean</code></li>
+<li><strong>Required</strong>: <code>No</code></li>
+<li><strong>User Property</strong>: <code>detail</code></li>
+<li><strong>Default</strong>: <code>false</code></li></ul><hr /></section><a id="goal"></a><section><a id="a.3Cgoal.3E"></a>
+<h3>&lt;goal&gt;</h3>
+<div>The name of the goal for which to show help. If unspecified, all goals will be displayed.</div>
+<ul>
+<li><strong>Type</strong>: <code>java.lang.String</code></li>
+<li><strong>Required</strong>: <code>No</code></li>
+<li><strong>User Property</strong>: <code>goal</code></li></ul><hr /></section><a id="indentSize"></a><section><a id="a.3CindentSize.3E"></a>
+<h3>&lt;indentSize&gt;</h3>
+<div>The number of spaces per indentation level, should be positive.</div>
+<ul>
+<li><strong>Type</strong>: <code>int</code></li>
+<li><strong>Required</strong>: <code>No</code></li>
+<li><strong>User Property</strong>: <code>indentSize</code></li>
+<li><strong>Default</strong>: <code>2</code></li></ul><hr /></section><a id="lineLength"></a><section><a id="a.3ClineLength.3E"></a>
+<h3>&lt;lineLength&gt;</h3>
+<div>The maximum length of a display line, should be positive.</div>
+<ul>
+<li><strong>Type</strong>: <code>int</code></li>
+<li><strong>Required</strong>: <code>No</code></li>
+<li><strong>User Property</strong>: <code>lineLength</code></li>
+<li><strong>Default</strong>: <code>80</code></li></ul></section></section></section>        </main>
+      </div>
+    </div>
+    <hr/>
+    <footer>
+      <div class="container-fluid">
+        <div class="row-fluid">
+Copyright (c) 2002-2024 Manorrock.com. All rights reserved.
+        </div>
+      </div>
+    </footer>
+  </body>
+</html>
diff --git a/snapshot/maven/plugin/images/accessories-text-editor.png b/snapshot/maven/plugin/images/accessories-text-editor.png
diff --git a/snapshot/maven/plugin/images/add.gif b/snapshot/maven/plugin/images/add.gif
diff --git a/snapshot/maven/plugin/images/apache-maven-project-2.png b/snapshot/maven/plugin/images/apache-maven-project-2.png
diff --git a/snapshot/maven/plugin/images/application-certificate.png b/snapshot/maven/plugin/images/application-certificate.png
diff --git a/snapshot/maven/plugin/images/contact-new.png b/snapshot/maven/plugin/images/contact-new.png
diff --git a/snapshot/maven/plugin/images/document-properties.png b/snapshot/maven/plugin/images/document-properties.png
diff --git a/snapshot/maven/plugin/images/drive-harddisk.png b/snapshot/maven/plugin/images/drive-harddisk.png
diff --git a/snapshot/maven/plugin/images/fix.gif b/snapshot/maven/plugin/images/fix.gif
diff --git a/snapshot/maven/plugin/images/icon_error_sml.gif b/snapshot/maven/plugin/images/icon_error_sml.gif
diff --git a/snapshot/maven/plugin/images/icon_help_sml.gif b/snapshot/maven/plugin/images/icon_help_sml.gif
diff --git a/snapshot/maven/plugin/images/icon_info_sml.gif b/snapshot/maven/plugin/images/icon_info_sml.gif
diff --git a/snapshot/maven/plugin/images/icon_success_sml.gif b/snapshot/maven/plugin/images/icon_success_sml.gif
diff --git a/snapshot/maven/plugin/images/icon_warning_sml.gif b/snapshot/maven/plugin/images/icon_warning_sml.gif
diff --git a/snapshot/maven/plugin/images/image-x-generic.png b/snapshot/maven/plugin/images/image-x-generic.png
diff --git a/snapshot/maven/plugin/images/internet-web-browser.png b/snapshot/maven/plugin/images/internet-web-browser.png
diff --git a/snapshot/maven/plugin/images/logos/build-by-maven-black.png b/snapshot/maven/plugin/images/logos/build-by-maven-black.png
diff --git a/snapshot/maven/plugin/images/logos/build-by-maven-white.png b/snapshot/maven/plugin/images/logos/build-by-maven-white.png
diff --git a/snapshot/maven/plugin/images/logos/maven-feather.png b/snapshot/maven/plugin/images/logos/maven-feather.png
diff --git a/snapshot/maven/plugin/images/network-server.png b/snapshot/maven/plugin/images/network-server.png
diff --git a/snapshot/maven/plugin/images/package-x-generic.png b/snapshot/maven/plugin/images/package-x-generic.png
diff --git a/snapshot/maven/plugin/images/profiles/pre-release.png b/snapshot/maven/plugin/images/profiles/pre-release.png
diff --git a/snapshot/maven/plugin/images/profiles/retired.png b/snapshot/maven/plugin/images/profiles/retired.png
diff --git a/snapshot/maven/plugin/images/profiles/sandbox.png b/snapshot/maven/plugin/images/profiles/sandbox.png
diff --git a/snapshot/maven/plugin/images/remove.gif b/snapshot/maven/plugin/images/remove.gif
diff --git a/snapshot/maven/plugin/images/rss.png b/snapshot/maven/plugin/images/rss.png
diff --git a/snapshot/maven/plugin/images/update.gif b/snapshot/maven/plugin/images/update.gif
diff --git a/snapshot/maven/plugin/images/window-new.png b/snapshot/maven/plugin/images/window-new.png
diff --git a/snapshot/maven/plugin/img/glyphicons-halflings-white.png b/snapshot/maven/plugin/img/glyphicons-halflings-white.png
diff --git a/snapshot/maven/plugin/img/glyphicons-halflings.png b/snapshot/maven/plugin/img/glyphicons-halflings.png
diff --git a/snapshot/maven/plugin/index.html b/snapshot/maven/plugin/index.html
@@ -0,0 +1,63 @@
+<!DOCTYPE html>
+
+
+<!--
+ | Generated by Apache Maven Doxia Site Renderer 2.0.0 from org.apache.maven.plugins:maven-project-info-reports-plugin:3.8.0:index at 2024-11-16
+ | Rendered using Apache Maven Fluido Skin 2.0.0
+-->
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0" />
+    <title>About – Piranha Maven Plugin</title>
+    <link rel="stylesheet" href="./css/apache-maven-fluido-2.0.0.min.css" />
+    <link rel="stylesheet" href="./css/site.css" />
+    <link rel="stylesheet" href="./css/print.css" media="print" />
+    <script src="./js/apache-maven-fluido-2.0.0.min.js"></script>
+  </head>
+  <body>
+    <div class="container-fluid container-fluid-top">
+      <header>
+        <div id="banner">
+          <div class="pull-left"><div id="bannerLeft"><h1>Piranha Maven Plugin</h1></div></div>
+          <div class="pull-right"></div>
+          <div class="clear"><hr/></div>
+        </div>
+
+      </header>
+      <div class="row-fluid">
+        <header id="leftColumn" class="span2">
+          <nav class="well sidebar-nav">
+  <ul class="nav nav-list">
+   <li class="nav-header">Overview</li>
+    <li class="active"><a>About</a></li>
+    <li><a href="plugin-info.html">Plugin Documentation</a></li>
+  </ul>
+          </nav>
+          <div class="well sidebar-nav">
+            <div id="poweredBy">
+              <div class="clear"></div>
+              <div class="clear"></div>
+<a href="https://maven.apache.org/" class="builtBy" target="_blank"><img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" /></a>
+            </div>
+          </div>
+        </header>
+        <main id="bodyColumn" class="span10">
+<section><a id="About_Piranha_-_Maven_-_Plugin"></a>
+<h1>About Piranha - Maven - Plugin</h1>
+<p>The Piranha Maven Plugin delivers you with a Maven plugin you can
+        use to deploy your web application to any of our Piranha distributions
+        facilitating an inner-loop development experience.</p></section>        </main>
+      </div>
+    </div>
+    <hr/>
+    <footer>
+      <div class="container-fluid">
+        <div class="row-fluid">
+Copyright (c) 2002-2024 Manorrock.com. All rights reserved.
+        </div>
+      </div>
+    </footer>
+  </body>
+</html>
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		/* You can override this file with your own styles */