You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@gora.apache.org by le...@apache.org on 2013/06/04 00:33:09 UTC
svn commit: r1489213 - /gora/site/trunk/content/current/quickstart.md
Author: lewismc
Date: Mon Jun 3 22:33:09 2013
New Revision: 1489213
URL: http://svn.apache.org/r1489213
Log:
Documentation patch from David Medinets
Modified:
gora/site/trunk/content/current/quickstart.md
Modified: gora/site/trunk/content/current/quickstart.md
URL: http://svn.apache.org/viewvc/gora/site/trunk/content/current/quickstart.md?rev=1489213&r1=1489212&r2=1489213&view=diff
==============================================================================
--- gora/site/trunk/content/current/quickstart.md (original)
+++ gora/site/trunk/content/current/quickstart.md Mon Jun 3 22:33:09 2013
@@ -1,49 +1,59 @@
Title: Quick Start
+#
+
+#
+
Introduction
+=============
+
This is a quick start guide to help you setup the project.
Download
+--------
+
First you need to check out the most stable Gora release through the official
Apache Gora [release page](../downloads.html).
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 [version control](../version_control.html) documentation.
-Setting up your project
+Setting up your project
+-----------------------
+
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>
+and Gora-SNAPSHOT OSGi bundle artifacts are now pushed to
+<a href="https://repository.apache.org/index.html#nexus-search;quick~gora">Apache Nexus</a>.</p>
Compiling the project
+---------------------
+
If you have the source code for Gora, you can compile the project using
-$ cd gora
-$ mvn clean compile
+ $ cd gora
+ $ mvn clean compile
-You can also compile individual modules by cd'ing to the module directory and running
-$ mvn clean compile there.
+You can also compile individual modules by cd'ing to the module directory and running
+ $ mvn clean compile
If you want to use Gora as a dependency, you can manage it in a few ways.
-Using ivy to manage gora
+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:
- <dependency org="org.apache.gora" name="gora-core" rev="${version}" conf="*->compile" changing="true">
-
- <dependency org="org.apache.gora" name="gora-dynamodb" rev="${version}" conf="*->compile" changing="true">
-
- <dependency org="org.apache.gora" name="gora-hbase" rev="${version}" conf="*->compile" changing="true">
-
- <dependency org="org.apache.gora" name="gora-cassandra" rev="${version}" conf="*->compile" changing="true">
+ <dependency org="org.apache.gora" name="gora-core" rev="${version}" conf="*->compile" changing="true">
+ <dependency org="org.apache.gora" name="gora-dynamodb" rev="${version}" conf="*->compile" changing="true">
+ <dependency org="org.apache.gora" name="gora-hbase" rev="${version}" conf="*->compile" changing="true">
+ <dependency org="org.apache.gora" name="gora-cassandra" rev="${version}" conf="*->compile" changing="true">
+ <dependency org="org.apache.gora" name="gora-sql" rev="${version}" conf="*->compile" changing="true">
- <dependency org="org.apache.gora" name="gora-sql" rev="${version}" conf="*->compile" changing="true">
-
-N.B. The ${version} variable should be replaced by the most stable Gora release.
+Note: The ${version} variable should be replaced by the most stable Gora release.
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
@@ -53,61 +63,72 @@ source and use the recompiled version.
Add the following to your ivysettings.xml
- <resolvers>
+ <resolvers>
...
- <chain name="internal">
- <resolver ref="local"/>
- </chain>
+ <chain name="internal">
+ <resolver ref="local">
+ </chain>
...
- </resolvers>
- <modules>
+ </resolvers>
+ <modules>
...
- <module organisation="org.apache.gora" name=".*" resolver="internal"/>
+ <module organisation="org.apache.gora" name=".*" resolver="internal">
...
- </modules>
+ </modules>
This forces gora to be built locally rather than look for it in other repositories.
-Using Maven to manage Gora
+Using Maven to manage Gora
+--------------------------
+
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:
- <dependency>
- <groupId>org.apache.gora</groupId>
- <artifactId>gora-core</artifactId>
- <version>${version}</version>
- </dependency>
-
- <dependency>
- <groupId>org.apache.gora</groupId>
- <artifactId>gora-hbase</artifactId>
- <version>${version}</version>
- </dependency>
-
- <dependency>
- <groupId>org.apache.gora</groupId>
- <artifactId>gora-dynamodb</artifactId>
- <version>${version}</version>
- </dependency>
+ <dependency>
+ <groupId>org.apache.gora</groupId>
+ <artifactId>gora-core</artifactId>
+ <version>${version}</version>
+ </dependency>
+
+ <dependency>
+ <groupId>org.apache.gora</groupId>
+ <artifactId>gora-accumulo</artifactId>
+ <version>${version}</version>
+ </dependency>
+
+ <dependency>
+ <groupId>org.apache.gora</groupId>
+ <artifactId>gora-cassandra</artifactId>
+ <version>${version}</version>
+ </dependency>
+
+ <dependency>
+ <groupId>org.apache.gora</groupId>
+ <artifactId>gora-dynamodb</artifactId>
+ <version>${version}</version>
+ </dependency>
- <dependency>
- <groupId>org.apache.gora</groupId>
- <artifactId>gora-cassandra</artifactId>
- <version>${version}</version>
- </dependency>
-
- <dependency>
- <groupId>org.apache.gora</groupId>
- <artifactId>gora-sql</artifactId>
- <version>${version}</version>
- </dependency>
+
+ <dependency>
+ <groupId>org.apache.gora</groupId>
+ <artifactId>gora-hbase</artifactId>
+ <version>${version}</version>
+ </dependency>
+
+ <dependency>
+ <groupId>org.apache.gora</groupId>
+ <artifactId>gora-sql</artifactId>
+ <version>${version}</version>
+ </dependency>
N.B. The ${version} variable should be replaced by the most stable Gora release.
Again, only add the modules that you will use.
-Managing gora jars manually
+Managing Gora Jars Manually
+---------------------------
+
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
@@ -116,18 +137,22 @@ gora-core/build/gora-core-x.Ã.jar and
modules that you want to use ( for example
gora-hbase/build/gora-hbase-x.Ã.jar)
-What's next
+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 [overview](/overview.html)
+Most of the current documentation is linked to from the [overview](current/overview.html)
or is available on the [wiki](https://cwiki.apache.org/confluence/display/GORA/Index).
Gora Modules
+------------
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.
-It is wise so start with going over the documentation for the gora-core
+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 [overview](/overview.html).
+are linked to from the [overview](current//overview.html).
+