gora-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From build...@apache.org
Subject svn commit: r893156 - in /websites/staging/gora/trunk/content: ./ current/quickstart.html
Date Tue, 07 Jan 2014 13:03:42 GMT
Author: buildbot
Date: Tue Jan  7 13:03:42 2014
New Revision: 893156

Log:
Staging update by buildbot for gora

Modified:
    websites/staging/gora/trunk/content/   (props changed)
    websites/staging/gora/trunk/content/current/quickstart.html

Propchange: websites/staging/gora/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Tue Jan  7 13:03:42 2014
@@ -1 +1 @@
-1556197
+1556203

Modified: websites/staging/gora/trunk/content/current/quickstart.html
==============================================================================
--- websites/staging/gora/trunk/content/current/quickstart.html (original)
+++ websites/staging/gora/trunk/content/current/quickstart.html Tue Jan  7 13:03:42 2014
@@ -164,16 +164,15 @@ to your ivy by adding the following line
 <div class="codehilite"><pre>  <span class="nt">&lt;dependency</span>
<span class="na">org=</span><span class="s">&quot;org.apache.gora&quot;</span>
<span class="na">name=</span><span class="s">&quot;gora-core&quot;</span>
<span class="na">rev=</span><span class="s">&quot;</span><span
class="cp">${</span><span class="n">version</span><span class="cp">}</span><span
class="s">&quot;</span> <span class="na">conf=</span><span class="s">&quot;*-&gt;compile&quot;</span>
<span class="na">changing=</span><span class="s">&quot;true&quot;</span><span
class="nt">&gt;</span>
   <span class="nt">&lt;dependency</span> <span class="na">org=</span><span
class="s">&quot;org.apache.gora&quot;</span> <span class="na">name=</span><span
class="s">&quot;gora-dynamodb&quot;</span> <span class="na">rev=</span><span
class="s">&quot;</span><span class="cp">${</span><span class="n">version</span><span
class="cp">}</span><span class="s">&quot;</span> <span class="na">conf=</span><span
class="s">&quot;*-&gt;compile&quot;</span> <span class="na">changing=</span><span
class="s">&quot;true&quot;</span><span class="nt">&gt;</span>
   <span class="nt">&lt;dependency</span> <span class="na">org=</span><span
class="s">&quot;org.apache.gora&quot;</span> <span class="na">name=</span><span
class="s">&quot;gora-hbase&quot;</span> <span class="na">rev=</span><span
class="s">&quot;</span><span class="cp">${</span><span class="n">version</span><span
class="cp">}</span><span class="s">&quot;</span> <span class="na">conf=</span><span
class="s">&quot;*-&gt;compile&quot;</span> <span class="na">changing=</span><span
class="s">&quot;true&quot;</span><span class="nt">&gt;</span>
     
-  <span class="nt">&lt;dependency</span> <span class="na">org=</span><span
class="s">&quot;org.apache.gora&quot;</span> <span class="na">name=</span><span
class="s">&quot;gora-cassandra&quot;</span> <span class="na">rev=</span><span
class="s">&quot;</span><span class="cp">${</span><span class="n">version</span><span
class="cp">}</span><span class="s">&quot;</span> <span class="na">conf=</span><span
class="s">&quot;*-&gt;compile&quot;</span> <span class="na">changing=</span><span
class="s">&quot;true&quot;</span><span class="nt">&gt;</span>
-  <span class="nt">&lt;dependency</span> <span class="na">org=</span><span
class="s">&quot;org.apache.gora&quot;</span> <span class="na">name=</span><span
class="s">&quot;gora-sql&quot;</span> <span class="na">rev=</span><span
class="s">&quot;</span><span class="cp">${</span><span class="n">version</span><span
class="cp">}</span><span class="s">&quot;</span> <span class="na">conf=</span><span
class="s">&quot;*-&gt;compile&quot;</span> <span class="na">changing=</span><span
class="s">&quot;true&quot;</span><span class="nt">&gt;</span>
+  ...etc
 </pre></div>
 
 
 <p>Note: The ${version} variable should be replaced by the most stable Gora release.</p>
 <p>Only add the modules that you will use, and set the conf to point to the 
-configurations (of your project) that you want to depend on gora. The 
-changing="true" attribute states that, gora artifacts 
-should not be cached, which is required if you want to change gora's 
+configurations (of your project) that you want to depend on Gora. The 
+changing="true" attribute states that, Gora artifacts 
+should not be cached, which is required if you want to change Gora's 
 source and use the recompiled version.</p>
 <p>Add the following to your ivysettings.xml</p>
 <div class="codehilite"><pre><span class="nt">&lt;resolvers&gt;</span>
@@ -191,15 +190,15 @@ source and use the recompiled version.</
 </pre></div>
 
 
-<p>This forces gora to be built locally rather than look for it in other repositories.</p>
+<p>This forces Gora to be built locally rather than look for it in other repositories.</p>
 <h2 id="using-maven-to-manage-gora">Using Maven to manage Gora</h2>
-<p>If your project however uses maven, then you can include gora dependencies
+<p>If your project however uses maven, then you can include Gora dependencies
 to your project by adding the following lines to your pom.xml file: </p>
 <div class="codehilite"><pre><span class="nt">&lt;dependency&gt;</span>
     <span class="nt">&lt;groupId&gt;</span>org.apache.gora<span class="nt">&lt;/groupId&gt;</span>
     <span class="nt">&lt;artifactId&gt;</span>gora-core<span class="nt">&lt;/artifactId&gt;</span>
     <span class="nt">&lt;version&gt;</span><span class="cp">${</span><span
class="n">version</span><span class="cp">}</span><span class="nt">&lt;/version&gt;</span>
-<span class="nt">&lt;/dependency&gt;</span>
+ <span class="nt">&lt;/dependency&gt;</span>
 
 <span class="nt">&lt;dependency&gt;</span>
     <span class="nt">&lt;groupId&gt;</span>org.apache.gora<span class="nt">&lt;/groupId&gt;</span>
@@ -207,56 +206,38 @@ to your project by adding the following 
     <span class="nt">&lt;version&gt;</span><span class="cp">${</span><span
class="n">version</span><span class="cp">}</span><span class="nt">&lt;/version&gt;</span>
 <span class="nt">&lt;/dependency&gt;</span>
 
-<span class="nt">&lt;dependency&gt;</span>
-    <span class="nt">&lt;groupId&gt;</span>org.apache.gora<span class="nt">&lt;/groupId&gt;</span>
-    <span class="nt">&lt;artifactId&gt;</span>gora-cassandra<span
class="nt">&lt;/artifactId&gt;</span>
-    <span class="nt">&lt;version&gt;</span><span class="cp">${</span><span
class="n">version</span><span class="cp">}</span><span class="nt">&lt;/version&gt;</span>
-<span class="nt">&lt;/dependency&gt;</span>
-
-<span class="nt">&lt;dependency&gt;</span>
-    <span class="nt">&lt;groupId&gt;</span>org.apache.gora<span class="nt">&lt;/groupId&gt;</span>
-    <span class="nt">&lt;artifactId&gt;</span>gora-dynamodb<span class="nt">&lt;/artifactId&gt;</span>
-    <span class="nt">&lt;version&gt;</span><span class="cp">${</span><span
class="n">version</span><span class="cp">}</span><span class="nt">&lt;/version&gt;</span>
-<span class="nt">&lt;/dependency&gt;</span>
-
-
-<span class="nt">&lt;dependency&gt;</span>
-    <span class="nt">&lt;groupId&gt;</span>org.apache.gora<span class="nt">&lt;/groupId&gt;</span>
-    <span class="nt">&lt;artifactId&gt;</span>gora-hbase<span class="nt">&lt;/artifactId&gt;</span>
-    <span class="nt">&lt;version&gt;</span><span class="cp">${</span><span
class="n">version</span><span class="cp">}</span><span class="nt">&lt;/version&gt;</span>
-<span class="nt">&lt;/dependency&gt;</span>
-
-<span class="nt">&lt;dependency&gt;</span>
-    <span class="nt">&lt;groupId&gt;</span>org.apache.gora<span class="nt">&lt;/groupId&gt;</span>
-    <span class="nt">&lt;artifactId&gt;</span>gora-sql<span class="nt">&lt;/artifactId&gt;</span>
-    <span class="nt">&lt;version&gt;</span><span class="cp">${</span><span
class="n">version</span><span class="cp">}</span><span class="nt">&lt;/version&gt;</span>
-<span class="nt">&lt;/dependency&gt;</span>
+...etc
 </pre></div>
 
 
 <p>N.B. The ${version} variable should be replaced by the most stable Gora release.</p>
 <p>Again, only add the modules that you will use.</p>
+<h2 id="specifying-gora-snapshot-dependencies">Specifying Gora SNAPSHOT dependencies</h2>
+<p>If you want to depend on Gora development snapshots, e.g. to get access to recent
bug fixes, 
+you should add the following to your pom.xml:</p>
+<div class="codehilite"><pre><span class="nt">&lt;repository&gt;</span>
+  <span class="nt">&lt;id&gt;</span>apache-repo-snapshots<span class="nt">&lt;/id&gt;</span>
+  <span class="nt">&lt;url&gt;</span>https://repository.apache.org/content/repositories/snapshots/<span
class="nt">&lt;/url&gt;</span>
+  <span class="nt">&lt;releases&gt;</span>
+    <span class="nt">&lt;enabled&gt;</span>false<span class="nt">&lt;/enabled&gt;</span>
+  <span class="nt">&lt;/releases&gt;</span>
+  <span class="nt">&lt;snapshots&gt;</span>
+    <span class="nt">&lt;enabled&gt;</span>true<span class="nt">&lt;/enabled&gt;</span>
+  <span class="nt">&lt;/snapshots&gt;</span>
+<span class="nt">&lt;/repository&gt;</span>
+</pre></div>
+
+
 <h2 id="managing-gora-jars-manually">Managing Gora Jars Manually</h2>
-<p>You can include gora jars manually, if you prefer so. After compiling gora 
-first copy all the jars in gora-[modulename]/lib/ dir. Then 
-copy all the jars in gora-core/lib/ since all of the modules depend 
-on gora-core. Last, copy the actual gora-jars in
-gora-core/build/gora-core-x.×.jar and the jars of all the other 
-modules that you want to use ( for example 
-gora-hbase/build/gora-hbase-x.×.jar)</p>
+<p>You can include Gora jars manually, if you prefer so. After compiling Gora 
+first and generating the desired artifacts, copy all the jars in gora-[modulename]/lib/ 
+and gora-[modulename]/target/gora-${modulename}.jar dir's to your desired 
+location. Finally copy all the jars in gora-core/lib/ since all of the 
+modules depend on gora-core. </p>
 <h2 id="whats-next">What's Next?</h2>
-<p>After setting up gora, you might want to check out the documentation. 
-Most of the current documentation is linked to from the <a href="current/overview.html">overview</a>
+<p>After setting up Gora, you might want to check out the documentation. 
+Most of the current documentation is linked to from the <a href="/overview.html">overview</a>
 or is available on the <a href="https://cwiki.apache.org/confluence/display/GORA/Index">wiki</a>.
</p>
-<h2 id="gora-modules">Gora Modules</h2>
-<p>Gora source code is organized in a modular architecture. The 
-gora-core module is the main module which contains the core of 
-the code. All other modules depend on the gora-core module. Each data 
-store backend in Gora resides in it's own module. The documentation for 
-the specific module can be found at the module's documentation directory. </p>
-<p>It is wise so start reading the documentation for the gora-core 
-module and then the specific data store module(s) you want to use. All modules 
-are linked to from the <a href="current//overview.html">overview</a>.</p>
 
   </div> <!-- /container (main block) -->
 



Mime
View raw message