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 2013/06/04 00:33:16 UTC
svn commit: r864275 - in /websites/staging/gora/trunk/content: ./
current/quickstart.html
Author: buildbot
Date: Mon Jun 3 22:33:16 2013
New Revision: 864275
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 Mon Jun 3 22:33:16 2013
@@ -1 +1 @@
-1488454
+1489213
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 Mon Jun 3 22:33:16 2013
@@ -124,122 +124,132 @@ under the License.
<div class="container" id="Gora_Quick Start">
-<p>Introduction
-This is a quick start guide to help you setup the project.</p>
-<p>Download
-First you need to check out the most stable Gora release through the official
+<h1></h1>
+<h1></h1>
+<h1 id="introduction">Introduction</h1>
+<p>This is a quick start guide to help you setup the project.</p>
+<h2 id="download">Download</h2>
+<p>First you need to check out the most stable Gora release through the official
Apache Gora <a href="../downloads.html">release page</a>.<br />
For those who would like to use a development version Gora or simply wish to
work with the bleeding edge, instructions for how to check out the source
code using svn or git can be found on the <a href="../version_control.html">version control</a> documentation. </p>
-<p>Setting up your project
-More recently Gora began using Maven to manage it's dependencies and build lifecycle.
+<h2 id="setting-up-your-project">Setting up your project</h2>
+<p>More recently Gora began using Maven to manage it's dependencies and build lifecycle.
Stable Gora releases are available on the central maven repository or ivy repositories
-and Gora-SNAPSHOT OSGi bundle artifacts are now pushed to the Apache Nexus
-<a href="https://repository.apache.org/index.html#nexus-search;quick~gora">here</a>.</p></p>
-<p>Compiling the project
-If you have the source code for Gora, you can compile the project using</p>
-<p>$ cd gora
-$ mvn clean compile</p>
-<p>You can also compile individual modules by cd'ing to the module directory and running
-$ mvn clean compile there.</p>
-<p>If you want to use Gora as a dependency, you can manage it in a few ways. </p>
-<p>Using ivy to manage gora
-If your project already uses ivy, then you can include gora dependencies
-to your ivy by adding the following lines to your ivy.xml file: </p>
-<div class="codehilite"><pre> <span class="ni">&lt;</span>dependency org="org.apache.gora" name="gora-core" rev="<span class="cp">${</span><span class="n">version</span><span class="cp">}</span>" conf="*-<span class="ni">&gt;</span>compile" changing="true"<span class="ni">&gt;</span>
+and Gora-SNAPSHOT OSGi bundle artifacts are now pushed to<br />
+<a href="https://repository.apache.org/index.html#nexus-search;quick~gora">Apache Nexus</a>.</p></p>
+<h2 id="compiling-the-project">Compiling the project</h2>
+<p>If you have the source code for Gora, you can compile the project using</p>
+<div class="codehilite"><pre><span class="nv">$</span> <span class="nv">cd</span> <span class="n">gora</span>
+<span class="nv">$</span> <span class="nv">mvn</span> <span class="n">clean</span> <span class="n">compile</span>
+</pre></div>
- <span class="ni">&lt;</span>dependency org="org.apache.gora" name="gora-dynamodb" rev="<span class="cp">${</span><span class="n">version</span><span class="cp">}</span>" conf="*-<span class="ni">&gt;</span>compile" changing="true"<span class="ni">&gt;</span>
- <span class="ni">&lt;</span>dependency org="org.apache.gora" name="gora-hbase" rev="<span class="cp">${</span><span class="n">version</span><span class="cp">}</span>" conf="*-<span class="ni">&gt;</span>compile" changing="true"<span class="ni">&gt;</span>
+<p>You can also compile individual modules by cd'ing to the module directory and running</p>
+<div class="codehilite"><pre><span class="nv">$</span> <span class="nv">mvn</span> <span class="n">clean</span> <span class="n">compile</span>
+</pre></div>
- <span class="ni">&lt;</span>dependency org="org.apache.gora" name="gora-cassandra" rev="<span class="cp">${</span><span class="n">version</span><span class="cp">}</span>" conf="*-<span class="ni">&gt;</span>compile" changing="true"<span class="ni">&gt;</span>
- <span class="ni">&lt;</span>dependency org="org.apache.gora" name="gora-sql" rev="<span class="cp">${</span><span class="n">version</span><span class="cp">}</span>" conf="*-<span class="ni">&gt;</span>compile" changing="true"<span class="ni">&gt;</span>
+<p>If you want to use Gora as a dependency, you can manage it in a few ways. </p>
+<h2 id="using-ivy-to-manage-gora">Using ivy to manage Gora</h2>
+<p>If your project already uses ivy, then you can include gora dependencies
+to your ivy by adding the following lines to your ivy.xml file: </p>
+<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>
</pre></div>
-<p>N.B. The ${version} variable should be replaced by the most stable Gora release.</p>
+<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
source and use the recompiled version.</p>
<p>Add the following to your ivysettings.xml</p>
-<div class="codehilite"><pre><span class="o">&</span><span class="ow">lt</span><span class="p">;</span><span class="n">resolvers</span><span class="o">&</span><span class="ow">gt</span><span class="p">;</span>
- <span class="o">...</span>
- <span class="o">&</span><span class="ow">lt</span><span class="p">;</span><span class="n">chain</span> <span class="n">name</span><span class="o">=</span><span class="s">"internal"</span><span class="o">&</span><span class="ow">gt</span><span class="p">;</span>
- <span class="o">&</span><span class="ow">lt</span><span class="p">;</span><span class="n">resolver</span> <span class="nb">ref</span><span class="o">=</span><span class="s">"local"</span><span class="o">/&</span><span class="ow">gt</span><span class="p">;</span>
- <span class="o">&</span><span class="ow">lt</span><span class="p">;</span><span class="o">/</span><span class="n">chain</span><span class="o">&</span><span class="ow">gt</span><span class="p">;</span>
- <span class="o">...</span>
-<span class="o">&</span><span class="ow">lt</span><span class="p">;</span><span class="o">/</span><span class="n">resolvers</span><span class="o">&</span><span class="ow">gt</span><span class="p">;</span>
-<span class="o">&</span><span class="ow">lt</span><span class="p">;</span><span class="n">modules</span><span class="o">&</span><span class="ow">gt</span><span class="p">;</span>
- <span class="o">...</span>
- <span class="o">&</span><span class="ow">lt</span><span class="p">;</span><span class="n">module</span> <span class="n">organisation</span><span class="o">=</span><span class="s">"org.apache.gora"</span> <span class="n">name</span><span class="o">=</span><span class="s">".*"</span> <span class="n">resolver</span><span class="o">=</span><span class="s">"internal"</span><span class="o">/&</span><span class="ow">gt</span><span class="p">;</span>
- <span class="o">...</span>
-<span class="o">&</span><span class="ow">lt</span><span class="p">;</span><span class="o">/</span><span class="n">modules</span><span class="o">&</span><span class="ow">gt</span><span class="p">;</span>
+<div class="codehilite"><pre><span class="nt"><resolvers></span>
+ ...
+ <span class="nt"><chain</span> <span class="na">name=</span><span class="s">"internal"</span><span class="nt">></span>
+ <span class="nt"><resolver</span> <span class="na">ref=</span><span class="s">"local"</span><span class="nt">></span>
+ <span class="nt"></chain></span>
+ ...
+<span class="nt"></resolvers></span>
+<span class="nt"><modules></span>
+ ...
+ <span class="nt"><module</span> <span class="na">organisation=</span><span class="s">"org.apache.gora"</span> <span class="na">name=</span><span class="s">".*"</span> <span class="na">resolver=</span><span class="s">"internal"</span><span class="nt">></span>
+ ...
+<span class="nt"></modules></span>
</pre></div>
<p>This forces gora to be built locally rather than look for it in other repositories.</p>
-<p>Using Maven to manage Gora
-If your project however uses maven, then you can include gora dependencies
+<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
to your project by adding the following lines to your pom.xml file: </p>
-<div class="codehilite"><pre><span class="ni">&lt;</span>dependency<span class="ni">&gt;</span>
- <span class="ni">&lt;</span>groupId>org.apache.gora<span class="ni">&lt;</span>/groupId<span class="ni">&gt;</span>
- <span class="ni">&lt;</span>artifactId>gora-core<span class="ni">&lt;</span>/artifactId<span class="ni">&gt;</span>
- <span class="ni">&lt;</span>version><span class="cp">${</span><span class="n">version</span><span class="cp">}</span><span class="ni">&lt;</span>/version<span class="ni">&gt;</span>
-<span class="ni">&lt;</span>/dependency<span class="ni">&gt;</span>
-
-<span class="ni">&lt;</span>dependency<span class="ni">&gt;</span>
- <span class="ni">&lt;</span>groupId>org.apache.gora<span class="ni">&lt;</span>/groupId<span class="ni">&gt;</span>
- <span class="ni">&lt;</span>artifactId>gora-hbase<span class="ni">&lt;</span>/artifactId<span class="ni">&gt;</span>
- <span class="ni">&lt;</span>version><span class="cp">${</span><span class="n">version</span><span class="cp">}</span><span class="ni">&lt;</span>/version<span class="ni">&gt;</span>
-<span class="ni">&lt;</span>/dependency<span class="ni">&gt;</span>
-
-<span class="ni">&lt;</span>dependency<span class="ni">&gt;</span>
- <span class="ni">&lt;</span>groupId>org.apache.gora<span class="ni">&lt;</span>/groupId<span class="ni">&gt;</span>
- <span class="ni">&lt;</span>artifactId>gora-dynamodb<span class="ni">&lt;</span>/artifactId<span class="ni">&gt;</span>
- <span class="ni">&lt;</span>version><span class="cp">${</span><span class="n">version</span><span class="cp">}</span><span class="ni">&lt;</span>/version<span class="ni">&gt;</span>
-<span class="ni">&lt;</span>/dependency<span class="ni">&gt;</span>
-
-<span class="ni">&lt;</span>dependency<span class="ni">&gt;</span>
- <span class="ni">&lt;</span>groupId>org.apache.gora<span class="ni">&lt;</span>/groupId<span class="ni">&gt;</span>
- <span class="ni">&lt;</span>artifactId>gora-cassandra<span class="ni">&lt;</span>/artifactId<span class="ni">&gt;</span>
- <span class="ni">&lt;</span>version><span class="cp">${</span><span class="n">version</span><span class="cp">}</span><span class="ni">&lt;</span>/version<span class="ni">&gt;</span>
-<span class="ni">&lt;</span>/dependency<span class="ni">&gt;</span>
-
-<span class="ni">&lt;</span>dependency<span class="ni">&gt;</span>
- <span class="ni">&lt;</span>groupId>org.apache.gora<span class="ni">&lt;</span>/groupId<span class="ni">&gt;</span>
- <span class="ni">&lt;</span>artifactId>gora-sql<span class="ni">&lt;</span>/artifactId<span class="ni">&gt;</span>
- <span class="ni">&lt;</span>version><span class="cp">${</span><span class="n">version</span><span class="cp">}</span><span class="ni">&lt;</span>/version<span class="ni">&gt;</span>
-<span class="ni">&lt;</span>/dependency<span class="ni">&gt;</span>
+<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"><groupId></span>org.apache.gora<span class="nt"></groupId></span>
+ <span class="nt"><artifactId></span>gora-accumulo<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-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>
</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>
-<p>Managing gora jars manually
-You can include gora jars manually, if you prefer so. After compiling gora
+<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>What's next
-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>
+<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>
or is available on the <a href="https://cwiki.apache.org/confluence/display/GORA/Index">wiki</a>. </p>
-<p>Gora Modules
-Gora source code is organized in a modular architecture. The
+<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 with going over the documentation for the gora-core
+<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="/overview.html">overview</a>.</p>
+are linked to from the <a href="current//overview.html">overview</a>.</p>
</div> <!-- /container (main block) -->