deltaspike-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From build...@apache.org
Subject svn commit: r922740 - in /websites/staging/deltaspike/trunk/content: ./ community.html documentation.html
Date Thu, 18 Sep 2014 20:18:02 GMT
Author: buildbot
Date: Thu Sep 18 20:18:02 2014
New Revision: 922740

Log:
Staging update by buildbot for deltaspike

Added:
    websites/staging/deltaspike/trunk/content/documentation.html
Modified:
    websites/staging/deltaspike/trunk/content/   (props changed)
    websites/staging/deltaspike/trunk/content/community.html

Propchange: websites/staging/deltaspike/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Thu Sep 18 20:18:02 2014
@@ -1 +1 @@
-1625561
+1626073

Modified: websites/staging/deltaspike/trunk/content/community.html
==============================================================================
--- websites/staging/deltaspike/trunk/content/community.html (original)
+++ websites/staging/deltaspike/trunk/content/community.html Thu Sep 18 20:18:02 2014
@@ -103,6 +103,8 @@ If you have troubles to find the informa
 <h1 id="getting-involved">Getting Involved</h1>
 <p>Everybody is welcome to get involved with our community. You can find general information
at <a href="http://apache.org/foundation/getinvolved.html">http://apache.org/foundation/getinvolved.html</a>
and <a href="http://apache.org/foundation/how-it-works.html">http://apache.org/foundation/how-it-works.html</a>.
 The following sections provides some details about the different levels of getting involved.</p>
+<p>If you want to contribute with <a href="/documentation/">DeltaSpike Documentation</a>,
please read the <a href="documentation.html">instructions
+about the Documentation</a> that adresses how to contribute, render and publish it.</p>
 <h2 id="contributors">Contributors</h2>
 <p>Before you get a committer you have to contribute to our effort. E.g. you can help
users, participate in discussions on the dev list, submit patches,... . Therefore, it's essential
to file a/n <a href="http://www.apache.org/licenses/icla.txt">(I)CLA</a> or <a
href="http://www.apache.org/licenses/cla-corporate.txt">CLA</a> and send it to secretary
at apache dot org (or fax it) as early as possible.</p>
 <p>If you would like to submit a patch through Jira, you can have a look at the <a
href="suggested-git-workflows.html">suggested approach</a>.</p>

Added: websites/staging/deltaspike/trunk/content/documentation.html
==============================================================================
--- websites/staging/deltaspike/trunk/content/documentation.html (added)
+++ websites/staging/deltaspike/trunk/content/documentation.html Thu Sep 18 20:18:02 2014
@@ -0,0 +1,166 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <meta name="description" content="deltaspike-generate-pages">
+    <meta name="author" content="chm">
+
+    <title>Apache DeltaSpike - Documentation</title>
+
+    
+
+    
+    
+
+    <!-- Styles -->
+    
+    <link href="./resources/css/bootstrap.css" rel="stylesheet">    
+    <!--<link href="./resources/css/prettify.css" rel="stylesheet" /> -->
+    <link href="./resources/css/codehilite.css" rel="stylesheet" />
+    <link href="./resources/css/bootstrap-responsive.css" rel="stylesheet">
+    <style type="text/css">
+        body {
+            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>
+</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="/index.html">Apache DeltaSpike</a>
+                <div class="nav-collapse">
+                    <ul class="nav">
+                        <li class="active"><a href="./index.html">Home</a></li>
+                        <li><a href="./documentation/">Documentation</a></li>
+                        <li><a href="./documentation/source.html">Source</a></li>
+                        <li><a href="./download.html">Download</a></li>
+                        <li><a href="./community.html">Community</a></li>
+                        <!-- <li><a href="./support.html">Support</a></li>
 -->
+                        <li><a href="./news.html">News</a></li>
+                        <li><a href="./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>Documentation</h1>
+              </div>
+              <p>Notice:    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.</p>
+<div class="toc">
+<ul>
+<li><a href="#sources">Sources</a></li>
+<li><a href="#format">Format</a></li>
+<li><a href="#rendering-documentation-as-html">Rendering documentation as HTML</a></li>
+<li><a href="#publish-procedure">Publish procedure</a></li>
+</ul>
+</div>
+<hr />
+<h1 id="sources">Sources</h1>
+<p>DeltaSpike documentation is available with the <a href="documentation/source.html">sources</a>.</p>
+<h1 id="format">Format</h1>
+<p>The format used for DeltaSpike documentation is <a href="http://www.methods.co.nz/asciidoc/">ASCIIDOC</a>
because it's easily exportable to PDF, HTML, and it's also easy to contribute. It can be used
to export also to epub and also be used to write books</p>
+<h1 id="rendering-documentation-as-html">Rendering documentation as HTML</h1>
+<p><em>Requirenment: Have <a href="http://maven.apache.org/">Maven</a>
installed.</em></p>
+<p>If you cloned the source repository and want to render the documentation as HTML,
you just need to run the following command:</p>
+<div class="codehilite"><pre>$ <span class="n">cd</span> <span
class="n">REPO_ROOT</span><span class="o">/</span><span class="n">documentation</span>
+$ <span class="n">mvn</span> <span class="n">site</span>
+</pre></div>
+
+
+<p>The generate documentation will be available at <code>REPO_ROOT/documentation/target/site</code></p>
+<h1 id="publish-procedure">Publish procedure</h1>
+<p>To publish the documentation at <a href="http://deltaspike.apache.org/documentation/">DeltaSpike
Site</a> you have do the following steps:</p>
+<p>Put the following information in your ~/.m2/settings.xml file</p>
+<div class="codehilite"><pre><span class="nt">&lt;server&gt;</span>
+  <span class="nt">&lt;id&gt;</span>deltaspike-site<span class="nt">&lt;/id&gt;</span>
+  <span class="nt">&lt;username&gt;&lt;YOUR_USERNAME&gt;&lt;/username&gt;</span>
+  <span class="nt">&lt;password&gt;&lt;YOUR_PASSWORD&gt;&lt;/password&gt;</span>
+<span class="nt">&lt;/server&gt;</span>
+</pre></div>
+
+
+<p>Then run:</p>
+<div class="codehilite"><pre><span class="n">mvn</span> <span
class="n">site</span><span class="o">-</span><span class="n">deploy</span>
+</pre></div>
+
+
+<p>After log in to <a href="https://cms.apache.org/deltaspike/publish">https://cms.apache.org/deltaspike/publish</a>
and click on the <code>Submit</code> button.</p>
+          </div>
+      </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 -->
+
+    <!-- Javascript
+    ================================================== -->
+    <!-- Placed at the end of the document so the pages load faster -->
+    <!--<script src="./resources/js/prettyfy.js"></script> -->
+    <script src="./resources/js/prettyprint.js"></script>
+    <script src="./resources/js/jquery.js"></script>
+    <script src="./resources/js/bootstrap-transition.js"></script>
+    <script src="./resources/js/bootstrap-alert.js"></script>
+    <script src="./resources/js/bootstrap-modal.js"></script>
+    <script src="./resources/js/bootstrap-dropdown.js"></script>
+    <script src="./resources/js/bootstrap-scrollspy.js"></script>
+    <script src="./resources/js/bootstrap-tab.js"></script>
+    <script src="./resources/js/bootstrap-tooltip.js"></script>
+    <script src="./resources/js/bootstrap-popover.js"></script>
+    <script src="./resources/js/bootstrap-button.js"></script>
+    <script src="./resources/js/bootstrap-collapse.js"></script>
+    <script src="./resources/js/bootstrap-carousel.js"></script>
+    <script src="./resources/js/bootstrap-typeahead.js"></script>
+</body>
+</html>



Mime
View raw message