You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@gora.apache.org by bu...@apache.org on 2014/01/07 14:03:42 UTC
svn commit: r893156 - in /websites/staging/gora/trunk/content: ./
current/quickstart.html
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"><dependency</span> <span class="na">org=</span><span class="s">"org.apache.gora"</span> <span class="na">name=</span><span class="s">"gora-core"</span> <span class="na">rev=</span><span class="s">"</span><span class="cp">${</span><span class="n">version</span><span class="cp">}</span><span class="s">"</span> <span class="na">conf=</span><span class="s">"*->compile"</span> <span class="na">changing=</span><span class="s">"true"</span><span class="nt">></span>
<span class="nt"><dependency</span> <span class="na">org=</span><span class="s">"org.apache.gora"</span> <span class="na">name=</span><span class="s">"gora-dynamodb"</span> <span class="na">rev=</span><span class="s">"</span><span class="cp">${</span><span class="n">version</span><span class="cp">}</span><span class="s">"</span> <span class="na">conf=</span><span class="s">"*->compile"</span> <span class="na">changing=</span><span class="s">"true"</span><span class="nt">></span>
<span class="nt"><dependency</span> <span class="na">org=</span><span class="s">"org.apache.gora"</span> <span class="na">name=</span><span class="s">"gora-hbase"</span> <span class="na">rev=</span><span class="s">"</span><span class="cp">${</span><span class="n">version</span><span class="cp">}</span><span class="s">"</span> <span class="na">conf=</span><span class="s">"*->compile"</span> <span class="na">changing=</span><span class="s">"true"</span><span class="nt">></span>
- <span class="nt"><dependency</span> <span class="na">org=</span><span class="s">"org.apache.gora"</span> <span class="na">name=</span><span class="s">"gora-cassandra"</span> <span class="na">rev=</span><span class="s">"</span><span class="cp">${</span><span class="n">version</span><span class="cp">}</span><span class="s">"</span> <span class="na">conf=</span><span class="s">"*->compile"</span> <span class="na">changing=</span><span class="s">"true"</span><span class="nt">></span>
- <span class="nt"><dependency</span> <span class="na">org=</span><span class="s">"org.apache.gora"</span> <span class="na">name=</span><span class="s">"gora-sql"</span> <span class="na">rev=</span><span class="s">"</span><span class="cp">${</span><span class="n">version</span><span class="cp">}</span><span class="s">"</span> <span class="na">conf=</span><span class="s">"*->compile"</span> <span class="na">changing=</span><span class="s">"true"</span><span class="nt">></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"><resolvers></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"><dependency></span>
<span class="nt"><groupId></span>org.apache.gora<span class="nt"></groupId></span>
<span class="nt"><artifactId></span>gora-core<span class="nt"></artifactId></span>
<span class="nt"><version></span><span class="cp">${</span><span class="n">version</span><span class="cp">}</span><span class="nt"></version></span>
-<span class="nt"></dependency></span>
+ <span class="nt"></dependency></span>
<span class="nt"><dependency></span>
<span class="nt"><groupId></span>org.apache.gora<span class="nt"></groupId></span>
@@ -207,56 +206,38 @@ to your project by adding the following
<span class="nt"><version></span><span class="cp">${</span><span class="n">version</span><span class="cp">}</span><span class="nt"></version></span>
<span class="nt"></dependency></span>
-<span class="nt"><dependency></span>
- <span class="nt"><groupId></span>org.apache.gora<span class="nt"></groupId></span>
- <span class="nt"><artifactId></span>gora-cassandra<span class="nt"></artifactId></span>
- <span class="nt"><version></span><span class="cp">${</span><span class="n">version</span><span class="cp">}</span><span class="nt"></version></span>
-<span class="nt"></dependency></span>
-
-<span class="nt"><dependency></span>
- <span class="nt"><groupId></span>org.apache.gora<span class="nt"></groupId></span>
- <span class="nt"><artifactId></span>gora-dynamodb<span class="nt"></artifactId></span>
- <span class="nt"><version></span><span class="cp">${</span><span class="n">version</span><span class="cp">}</span><span class="nt"></version></span>
-<span class="nt"></dependency></span>
-
-
-<span class="nt"><dependency></span>
- <span class="nt"><groupId></span>org.apache.gora<span class="nt"></groupId></span>
- <span class="nt"><artifactId></span>gora-hbase<span class="nt"></artifactId></span>
- <span class="nt"><version></span><span class="cp">${</span><span class="n">version</span><span class="cp">}</span><span class="nt"></version></span>
-<span class="nt"></dependency></span>
-
-<span class="nt"><dependency></span>
- <span class="nt"><groupId></span>org.apache.gora<span class="nt"></groupId></span>
- <span class="nt"><artifactId></span>gora-sql<span class="nt"></artifactId></span>
- <span class="nt"><version></span><span class="cp">${</span><span class="n">version</span><span class="cp">}</span><span class="nt"></version></span>
-<span class="nt"></dependency></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"><repository></span>
+ <span class="nt"><id></span>apache-repo-snapshots<span class="nt"></id></span>
+ <span class="nt"><url></span>https://repository.apache.org/content/repositories/snapshots/<span class="nt"></url></span>
+ <span class="nt"><releases></span>
+ <span class="nt"><enabled></span>false<span class="nt"></enabled></span>
+ <span class="nt"></releases></span>
+ <span class="nt"><snapshots></span>
+ <span class="nt"><enabled></span>true<span class="nt"></enabled></span>
+ <span class="nt"></snapshots></span>
+<span class="nt"></repository></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) -->