deltaspike-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From rafab...@apache.org
Subject deltaspike git commit: DELTASPIKE-808 - Fix examples page
Date Tue, 30 Dec 2014 22:38:19 GMT
Repository: deltaspike
Updated Branches:
  refs/heads/master cf16cd3ae -> 01861806d


DELTASPIKE-808 - Fix examples page


Project: http://git-wip-us.apache.org/repos/asf/deltaspike/repo
Commit: http://git-wip-us.apache.org/repos/asf/deltaspike/commit/01861806
Tree: http://git-wip-us.apache.org/repos/asf/deltaspike/tree/01861806
Diff: http://git-wip-us.apache.org/repos/asf/deltaspike/diff/01861806

Branch: refs/heads/master
Commit: 01861806d3e29a17b3dcf2acdea29a3c94c6ad9f
Parents: cf16cd3
Author: Rafael Benevides <rafabene@gmail.com>
Authored: Tue Dec 30 20:38:00 2014 -0200
Committer: Rafael Benevides <rafabene@gmail.com>
Committed: Tue Dec 30 20:38:00 2014 -0200

----------------------------------------------------------------------
 deltaspike/pom.xml                   |   7 +-
 documentation/pom.xml                |  19 ++--
 pom.xml                              |   2 +-
 site/pom.xml                         |  17 ++--
 site/src/main/asciidoc/examples.adoc |  12 +--
 template/document.html.erb           | 156 ++++++++++++++++--------------
 6 files changed, 109 insertions(+), 104 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/deltaspike/blob/01861806/deltaspike/pom.xml
----------------------------------------------------------------------
diff --git a/deltaspike/pom.xml b/deltaspike/pom.xml
index eece822..b278b94 100644
--- a/deltaspike/pom.xml
+++ b/deltaspike/pom.xml
@@ -42,9 +42,7 @@
     <packaging>pom</packaging>
 
     <name>Apache DeltaSpike Sources</name>
-    <description>
-        Apache DeltaSpike CDI Extensions.
-    </description>
+    <description>Apache DeltaSpike CDI Extensions.</description>
     <url>http://deltaspike.apache.org</url>
 
     <modules>
@@ -104,7 +102,7 @@
                         </execution>
                     </executions>
                 </plugin>
-
+                <!-- Javadoc plugin -->
                 <plugin>
                     <groupId>org.apache.maven.plugins</groupId>
                     <artifactId>maven-javadoc-plugin</artifactId>
@@ -160,6 +158,7 @@
                         </groups>
                     </configuration>
                 </plugin>
+                <!-- Publish Javadoc online -->
                 <plugin>
                     <groupId>org.apache.maven.plugins</groupId>
                     <artifactId>maven-scm-publish-plugin</artifactId>

http://git-wip-us.apache.org/repos/asf/deltaspike/blob/01861806/documentation/pom.xml
----------------------------------------------------------------------
diff --git a/documentation/pom.xml b/documentation/pom.xml
index b1f087c..51b3077 100644
--- a/documentation/pom.xml
+++ b/documentation/pom.xml
@@ -34,9 +34,7 @@
     <packaging>pom</packaging>
 
     <name>Apache DeltaSpike Documentation</name>
-    <description>
-      Documentation of DeltaSpike project.
-    </description>
+    <description>Documentation of DeltaSpike project.</description>
     <url>http://deltaspike.apache.org/documentation</url>
 
     <properties>
@@ -44,15 +42,9 @@
         <svn.scmPubUrlStaging>https://svn.apache.org/repos/asf/deltaspike/site/trunk/content/staging/documentation/</svn.scmPubUrlStaging>
     </properties>
 
-    <distributionManagement>
-        <site>
-            <id>apache.website</id>
-            <url>${svn.scmPubUrl}</url>
-        </site>
-    </distributionManagement>
-
     <build>
         <plugins>
+            <!-- Configure ASCIIDOC plugin -->
             <plugin>
                 <groupId>org.asciidoctor</groupId>
                 <artifactId>asciidoctor-maven-plugin</artifactId>
@@ -67,10 +59,13 @@
                 </executions>
                 <configuration>
                     <attributes>
-                        <basedir>..</basedir>
+                        <!-- Site Base Dir relative path -->
+                        <sitebasedir>..</sitebasedir>
                     </attributes>
                 </configuration>
             </plugin>
+
+            <!-- Publis documentation online -->
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-scm-publish-plugin</artifactId>
@@ -78,7 +73,7 @@
                     <execution>
                         <id>scm-publish</id>
                         <phase>site-deploy</phase>
-                        <!-- deploy site with maven-scm-publish-plugin -->
+                        <!-- deploy documentation with maven-scm-publish-plugin -->
                         <goals>
                             <goal>publish-scm</goal>
                         </goals>

http://git-wip-us.apache.org/repos/asf/deltaspike/blob/01861806/pom.xml
----------------------------------------------------------------------
diff --git a/pom.xml b/pom.xml
index e20dad1..b47f171 100644
--- a/pom.xml
+++ b/pom.xml
@@ -29,7 +29,7 @@
 
     <!-- 
      * Please do not use this pom for other deltaspike modules.
-     * Instead use the one from parent/pom.xml!
+     * Instead use the one from deltaspike/parent/pom.xml!
      *
      * This very pom.xml contains only the basic build layout 
      * and no build-rules at all. See parent/pom.xml for all

http://git-wip-us.apache.org/repos/asf/deltaspike/blob/01861806/site/pom.xml
----------------------------------------------------------------------
diff --git a/site/pom.xml b/site/pom.xml
index 9b15799..66ad00c 100644
--- a/site/pom.xml
+++ b/site/pom.xml
@@ -34,9 +34,7 @@
     <packaging>pom</packaging>
 
     <name>Apache DeltaSpike Site</name>
-    <description>
-    DeltaSpike website
-  </description>
+    <description>Website content of DeltaSpike project.</description>
     <url>http://deltaspike.apache.org</url>
 
     <properties>
@@ -44,15 +42,9 @@
         <svn.scmPubUrlStaging>https://svn.apache.org/repos/asf/deltaspike/site/trunk/content/staging/</svn.scmPubUrlStaging>
     </properties>
 
-    <distributionManagement>
-        <site>
-            <id>apache.website</id>
-            <url>${svn.scmPubUrl}</url>
-        </site>
-    </distributionManagement>
-
     <build>
         <plugins>
+            <!-- Configure ASCIIDOC plugin -->
             <plugin>
                 <groupId>org.asciidoctor</groupId>
                 <artifactId>asciidoctor-maven-plugin</artifactId>
@@ -67,10 +59,13 @@
                 </executions>
                 <configuration>
                     <attributes>
-                        <basedir>.</basedir>
+                        <!-- Site Base Dir relative path -->
+                        <sitebasedir>.</sitebasedir>
                     </attributes>
                 </configuration>
             </plugin>
+
+            <!-- Publish site content -->
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-scm-publish-plugin</artifactId>

http://git-wip-us.apache.org/repos/asf/deltaspike/blob/01861806/site/src/main/asciidoc/examples.adoc
----------------------------------------------------------------------
diff --git a/site/src/main/asciidoc/examples.adoc b/site/src/main/asciidoc/examples.adoc
index 57c5c5e..224396c 100644
--- a/site/src/main/asciidoc/examples.adoc
+++ b/site/src/main/asciidoc/examples.adoc
@@ -4,23 +4,23 @@
 
 :toc:
 
-A collection of ready-to-build Maven-based projects are provided to demonstrate the inclusion
of DeltaSpike in applications. Each example showcases a different DeltaSpike feature and explores
the mechanics of DeltaSpike implementation. You can use these examples to see DeltaSpike in
action and learn how to add these capabilities to your own projects. The Maven-based project
examples are available in `deltaspike-project-<version>-source-release.zip`.
+A collection of ready-to-build Maven-based projects are provided to demonstrate the inclusion
of DeltaSpike in applications. Each example showcases a different DeltaSpike feature and explores
the mechanics of DeltaSpike implementation. You can use these examples to see DeltaSpike in
action and learn how to add these capabilities to your own projects. The Maven-based project
examples are available in `deltaspike-project-{latestStable}-source-release.zip`.
 	
 To begin using the projects, complete the following steps:
 
-. link:https://deltaspike.apache.org/download.html[Download `deltaspike-project-<version>-source-release.zip`]
+. link:https://deltaspike.apache.org/download.html[Download `deltaspike-project-{latestStable}-source-release.zip`]
 . Extract the archive contents
 +
-[source,shell]
+[subs="+attributes"]
 ----
-$ unzip deltaspike-project-<version>-source-release.zip
+$ unzip deltaspike-project-{latestStable}-source-release.zip
 ----
 +
 . Build the projects
 +
-[source,shell]
+[subs="+attributes"]
 ----
-$ cd /path/to/deltaspike-project-<version>/examples
+$ cd /path/to/deltaspike-project-{latestStable}/examples
 $ mvn clean package
 ----
 

http://git-wip-us.apache.org/repos/asf/deltaspike/blob/01861806/template/document.html.erb
----------------------------------------------------------------------
diff --git a/template/document.html.erb b/template/document.html.erb
index 118fc9f..c9bf8b9 100644
--- a/template/document.html.erb
+++ b/template/document.html.erb
@@ -12,7 +12,24 @@
 
 <title><%= document.name %></title>
 
-<!-- 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 &quot;License&quot;); 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 &quot;AS IS&quot; 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. -->
+<!--
+    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.
+-->
 
 <!-- Styles -->
 
@@ -24,83 +41,82 @@
 <%= ::Asciidoctor::Stylesheets.instance.coderay_stylesheet_data %>
 
 body {
-	padding-top: 60px;
-	padding-bottom: 40px;
+  padding-top: 60px;
+  padding-bottom: 40px;
 }
 </style>
+
 <script type="text/javascript">
 
-	  var _gaq = _gaq || [];
-	  _gaq.push(['_setAccount', 'UA-36103647-1']);
-	  _gaq.push(['_trackPageview']);
-	
-	  (function() {
-		var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
-		ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
-		var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
-	  })();
-	
-	</script>
+    var _gaq = _gaq || [];
+    _gaq.push(['_setAccount', 'UA-36103647-1']);
+    _gaq.push(['_trackPageview']);
+
+    (function() {
+    var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+    ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+    var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+    })();
+
+  </script>
 </head>
 
 <body>
 
-	<div class="navbar navbar-fixed-top">
-		<div class="navbar-inner">
-			<div class="container">
-				<a class="btn btn-navbar" data-toggle="collapse"
-					data-target=".nav-collapse"> <span class="icon-bar"></span> <span
-					class="icon-bar"></span> <span class="icon-bar"></span>
-				</a> <a class="brand logocolor"
-					href="<%= (attr :basedir) %>/index.html">Apache DeltaSpike</a>
-				<div class="nav-collapse">
-					<ul class="nav">
-						<li class="active"><a
-							href="<%= (attr :basedir) %>/index.html">Home</a></li>
-						<li><a href="<%= (attr :basedir) %>/documentation">Documentation</a></li>
-						<li><a href="<%= (attr :basedir) %>/javadoc.html">Javadoc</a></li>
-						<li><a href="<%= (attr :basedir) %>/documentation/source.html">Source</a></li>
-						<li><a href="<%= (attr :basedir) %>/download.html">Download</a></li>
-						<li><a href="<%= (attr :basedir) %>/community.html">Community</a></li>
-						<!-- <li><a href="./support.html">Support</a></li>  -->
-						<li><a href="<%= (attr :basedir) %>/news.html">News</a></li>
-						<li><a href="<%= (attr :basedir) %>/migration-guide.html">Migration</a></li>
-					</ul>
-				</div>
-				<!--/.nav-collapse -->
-				<form id="search-form" action="http://www.google.com/search"
-					method="get" class="navbar-search pull-right">
-					<input value="deltaspike.apache.org" name="sitesearch"
-						type="hidden"> <input class="search-query" name="q"
-						id="query" type="text">
-				</form>
-			</div>
-		</div>
-	</div>
-
-	<div class="container">
-		<div class="row">
-			<div class="span12">
-				<div class="page-title">
-			    <h1><%= document.name %></h1>
-                </div>
-
-				<div id="toc" class="<%= attr 'toc-class', 'toc' %>">
-       	 		<%= converter.convert_with_options @document, 'outline', :toclevels => 4
 %>
-       	 		<hr>	
-       	 		
-				<%= document.content %>
-			</div>
-
-			<hr>
-
-			<footer>
-				<p>Copyright © 2011-2014 The Apache Software Foundation, Licensed under the Apache
License, Version 2.0.</p>
-				<p>Apache and the Apache feather logo are trademarks of The Apache Software Foundation.</p>
-			</footer>
-
-		</div>
-		<!-- /.container -->
+  <div class="navbar navbar-fixed-top">
+    <div class="navbar-inner">
+      <div class="container">
+        <a class="btn btn-navbar" data-toggle="collapse"
+          data-target=".nav-collapse"> <span class="icon-bar"></span> <span
+          class="icon-bar"></span> <span class="icon-bar"></span>
+        </a>
+        <a class="brand logocolor" href="<%= (attr :sitebasedir) %>/index.html">Apache
DeltaSpike</a>
+        <div class="nav-collapse">
+          <ul class="nav">
+            <li class="active"><a href="<%= (attr :sitebasedir) %>/index.html">Home</a></li>
+            <li><a href="<%= (attr :sitebasedir) %>/documentation">Documentation</a></li>
+            <li><a href="<%= (attr :sitebasedir) %>/javadoc.html">Javadoc</a></li>
+            <li><a href="<%= (attr :sitebasedir) %>/documentation/source.html">Source</a></li>
+            <li><a href="<%= (attr :sitebasedir) %>/download.html">Download</a></li>
+            <li><a href="<%= (attr :sitebasedir) %>/community.html">Community</a></li>
+            <!-- <li><a href="./support.html">Support</a></li>
 -->
+            <li><a href="<%= (attr :sitebasedir) %>/news.html">News</a></li>
+            <li><a href="<%= (attr :sitebasedir) %>/migration-guide.html">Migration</a></li>
+          </ul>
+        </div>
+        <!--/.nav-collapse -->
+        <form id="search-form" action="http://www.google.com/search"
+          method="get" class="navbar-search pull-right">
+          <input value="deltaspike.apache.org" name="sitesearch"
+            type="hidden"> <input class="search-query" name="q"
+            id="query" type="text">
+        </form>
+      </div>
+    </div>
+  </div>
+
+  <div class="container">
+    <div class="row">
+      <div class="span12">
+        <div class="page-title">
+          <h1><%= document.name %></h1>
+        </div>
+
+        <div id="toc" class="<%= attr 'toc-class', 'toc' %>">
+            <%= converter.convert_with_options @document, 'outline', :toclevels =>
4  %>
+            <hr>
+            <%= document.content %>
+        </div>
+
+        <hr>
 
+        <footer>
+          <p>Copyright © 2011-2014 The Apache Software Foundation,
+            Licensed under the Apache License, Version 2.0.</p>
+          <p>Apache and the Apache feather logo are trademarks of The Apache Software
Foundation.</p>
+        </footer>
+      </div>
+    </div>
+  </div>
 </body>
 </html>


Mime
View raw message