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 2012/02/16 16:03:28 UTC
svn commit: r1245012 - in /gora/trunk/docs/src: content/xdocs/quickstart.xml
content/xdocs/site.xml content/xdocs/tutorial.xml
resources/images/gora-logo.png resources/images/powered-by-gora.png
skinconf.xml
Author: lewismc
Date: Thu Feb 16 15:03:28 2012
New Revision: 1245012
URL: http://svn.apache.org/viewvc?rev=1245012&view=rev
Log:
commit to make vital updates to current docs. This is the first time I've made changes to this portion of code so hopefully all goes well.
Added:
gora/trunk/docs/src/resources/images/gora-logo.png (with props)
gora/trunk/docs/src/resources/images/powered-by-gora.png (with props)
Modified:
gora/trunk/docs/src/content/xdocs/quickstart.xml
gora/trunk/docs/src/content/xdocs/site.xml
gora/trunk/docs/src/content/xdocs/tutorial.xml
gora/trunk/docs/src/skinconf.xml
Modified: gora/trunk/docs/src/content/xdocs/quickstart.xml
URL: http://svn.apache.org/viewvc/gora/trunk/docs/src/content/xdocs/quickstart.xml?rev=1245012&r1=1245011&r2=1245012&view=diff
==============================================================================
--- gora/trunk/docs/src/content/xdocs/quickstart.xml (original)
+++ gora/trunk/docs/src/content/xdocs/quickstart.xml Thu Feb 16 15:03:28 2012
@@ -33,34 +33,33 @@
<section>
<title> Download </title>
- <p> Gora has not released a version yet, so you need to check out the source first.
- Instructions for how to check out the source code using svn or git can be found
+ <p> First you need to check out the most stable Gora release through the official Apache Gora release page <a href="ext:releases">here</a>.</a>
+ <p>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
<a href="ext:vcs">here</a>.
</p>
</section>
<section>
- <title> Compiling the project </title>
+ <title> Compiling the project (Maven users)</title>
<p>Once you have the source code for Gora, you can compile the project using</p>
<p>
<code>
- $ cd gora
+ $ cd gora
</code> <br/>
<code>
- $ ant
+ $ mvn clean compile
</code>
</p>
<p> You can also compile individual modules by cd'ing to the module directory and
- runnint <code>ant</code> there. </p>
+ running <code>$ mvn clean compile</code> there. </p>
</section>
<section>
<title> Setting up your project </title>
<p>
- Gora uses ivy to manage it's dependencies. However, since Gora has no
- releases yet, Gora artifacts are not pushed to central maven repository
- or ivy repositories.</p>
- <p> You can manage Gora dependency in a few ways. </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> You can manage Gora dependencies in a few ways. </p>
<section>
<title> Using ivy to manage gora </title>
@@ -69,16 +68,18 @@
<p>
<code>
- <dependency org="org.apache.gora" name="gora-hbase" rev="0.1" conf="*->compile" changing="true">
+ <dependency org="org.apache.gora" name="gora-hbase" rev="${version}" conf="*->compile" changing="true">
</code><br/>
<code>
- <dependency org="org.apache.gora" name="gora-cassandra" rev="0.1" conf="*->compile" changing="true">
+ <dependency org="org.apache.gora" name="gora-cassandra" rev="${version}" conf="*->compile" changing="true">
</code><br/>
<code>
- <dependency org="org.apache.gora" name="gora-sql" rev="0.1" conf="*->compile" changing="true">
+ <dependency org="org.apache.gora" name="gora-sql" rev="${version}" conf="*->compile" changing="true">
</code>
</p>
+ <p><b>N.B.</b> The <code>${version}</code> variable should be replaced by the most stable Gora release.</p>
+
<p>Only add the modules <code>gora-hbase, gora-cassandra, gora-sql</code>
that you will use, and set the <code>conf</code> to point to the
configurations (of your project) that you want to depend on gora. The
@@ -106,13 +107,40 @@
<p>This forces gora to be built locally rather than look for it in other
repositories.</p>
+ </section>
+ <section>
+ <title> Using Maven to manage Gora </title>
+ <p>If your project however uses maven, then you can include gora dependencies
+ to your project by adding the following lines to your <code>pom.xml</code> file: </p>
+
+ <p>
+ <code>
+ <dependency>
+ <groupId>org.apache.gora</groupId>
+ <artifactId>gora-hbase</artifactId>
+ <version>${version}</version>
+ </dependency>
+ </code><br/>
+ <code>
+ <dependency>
+ <groupId>org.apache.gora</groupId>
+ <artifactId>gora-cassandra</artifactId>
+ <version>${version}</version>
+ </dependency>
+ </code><br/>
+ <code>
+ <dependency>
+ <groupId>org.apache.gora</groupId>
+ <artifactId>gora-sql</artifactId>
+ <version>${version}</version>
+ </dependency>
+ </code>
+ </p>
- <p>However in using ivy, some of Gora's dependencies can not be retrieved
- through ivy or maven. These external jars reside in directories under
- <code>gora-[modulename]/lib-ext/</code>. If you are adding gora-[modulename]
- to your <code>ivy.xml</code>, make sure that the modules dependencies are
- resolved by ivy/maven and include manually all of the external jars in
- <code>lib-ext</code> directory. </p>
+ <p><b>N.B.</b> The <code>${version}</code> variable should be replaced by the most stable Gora release.</p>
+
+ <p>Only add the modules <code>gora-hbase, gora-cassandra, gora-sql</code>
+ that you will use.
</section>
<section>
Modified: gora/trunk/docs/src/content/xdocs/site.xml
URL: http://svn.apache.org/viewvc/gora/trunk/docs/src/content/xdocs/site.xml?rev=1245012&r1=1245011&r2=1245012&view=diff
==============================================================================
--- gora/trunk/docs/src/content/xdocs/site.xml (original)
+++ gora/trunk/docs/src/content/xdocs/site.xml Thu Feb 16 15:03:28 2012
@@ -54,17 +54,19 @@ See http://forrest.apache.org/docs/linki
<external-refs>
<wiki href="https://cwiki.apache.org/confluence/display/GORA/Index" />
+ <releases href="http://gora.apache.org/releases.html"/>
<issues href="http://issues.apache.org/jira/browse/GORA"/>
- <vcs href="http://incubator.apache.org/gora/version_control.html" />
- <devmail href="http://incubator.apache.org/gora/mailing_lists.html"/>
+ <vcs href="http://gora.apache.org/version_control.html" />
+ <devmail href="http://gora.apache.org/mailing_lists.html"/>
- <gora href="http://incubator.apache.org/gora/"/>
+ <gora href="http://gora.apache.org/"/>
<avro href="http://avro.apache.org/"/>
<avrospec href="http://avro.apache.org/docs/current/spec.html"/>
<hadoop href="http://hadoop.apache.org/mapreduce/"/>
<hdfs href="http://hadoop.apache.org/hdfs/"/>
<mapreduce href="http://hadoop.apache.org/mapreduce/"/>
<hbase href="http://hbase.apache.org/"/>
+ <hector href="http://hector-client.org/" />
<cassandra href="http://cassandra.apache.org/"/>
<nutch href="http://nutch.apache.org/"/>
<sponsors href="http://www.apache.org/foundation/thanks.html"/>
Modified: gora/trunk/docs/src/content/xdocs/tutorial.xml
URL: http://svn.apache.org/viewvc/gora/trunk/docs/src/content/xdocs/tutorial.xml?rev=1245012&r1=1245011&r2=1245012&view=diff
==============================================================================
--- gora/trunk/docs/src/content/xdocs/tutorial.xml (original)
+++ gora/trunk/docs/src/content/xdocs/tutorial.xml Thu Feb 16 15:03:28 2012
@@ -29,9 +29,9 @@
<section>
<title>Introduction</title>
- <p>This is the official tutorial for Gora. For this tutorial, we
- will be implementing a system to store our web server logs in HBase,
- and analyze the results using Hadoop and store the results either in HSQLDB or MySQL.</p>
+ <p>This is the official tutorial for Apache Gora. For this tutorial, we
+ will be implementing a system to store our web server logs in Apache HBase,
+ and analyze the results using Apache Hadoop and store the results either in HSQLDB or MySQL.</p>
<p> In this tutorial we will first look at how to set up the environment and
configure Gora and the data stores. Later, we will go over the data we will use and
@@ -43,9 +43,10 @@
<section>
<title>Introduction to Gora</title>
- <p> Gora is an ORM framework for Column Stores such as Apache HBase,
- Apache Cassandra, and the like with support for SQL and Hadoop. Gora
- uses Apache Avro, which is a serialization framework. In Avro, the
+ <p> The Apache Gora open source framework provides an in-memory data
+ model and persistence for big data. Gora supports persisting to
+ column stores, key value stores, document stores and RDBMSs, and
+ analyzing the data with extensive Apache Hadoop MapReduce support. In Avro, the
beans to hold the data and RPC interfaces are defined using a JSON
schema. In mapping the data beans to data store specific settings,
Gora depends on mapping files, which are specific to each data store.
@@ -117,7 +118,7 @@
<p>Since gora-tutorial is a top level module of Gora, it depends on the directory
structure imposed by Gora's main build scripts (<code>build.xml</code> and
- <code>build-common.xml</code>). Java source code resides in directory <code>
+ <code>build-common.xml</code> with Ivy and pom.xml for Maven). The Java source code resides in directory <code>
src/main/java/</code>, avro schemas in <code>src/main/avro/</code>, and data in
<code>src/main/resources/</code>.</p>
</section>
@@ -128,11 +129,12 @@
store the logs. For those of you not familiar with HBase, it is a NoSQL
column store with an architecture very similar to Google's BigTable. </p>
<!-- TODO: Tutorial for SQL and Cassandra -->
- <p> Unless you have already HBase setup, we will go over the steps at
+ <p> If you don't already have already HBase setup, you can go over the steps at
<a href="http://hbase.apache.org/docs/r0.20.6/api/overview-summary.html#overview_description"> HBase Overview </a>
- documentation. Gora uses HBase version 0.20.6, so download this version from
+ documentation. Although Gora aims to support the most recent HBase versions, the above tutorial is
+ specifically for HBase 0.20.6 (don't worry the principals are the same), so download a version from
<a href="http://hbase.apache.org/releases.html">HBase releases</a>. After extracting
- the file, cd to the hbase-0.20.6 directory and start the HBase server. </p>
+ the file, cd to the hbase-${dist} directory and start the HBase server. </p>
<p><code>$ bin/start-hbase.sh</code> </p>
<p> and make sure that HBase is available by using the Hbase shell.
<p><code>$ bin/hbase shell</code> </p>
@@ -849,8 +851,8 @@ org.apache.gora.tutorial.log.generated.P
<section>
<title> Setting up the database </title>
<p> First we need to download HSQL dependencies. For that, uncomment the following line
- from <code>gora-tutorial/ivy/ivy.xml</code>. MySQL users should uncomment the mysql
- dependency instead. </p>
+ from <code>gora-tutorial/ivy/ivy.xml</code> (if using Maven hsqldb should already be available).
+ Ofcourse MySQL users should uncomment the mysql dependency instead. </p>
<p><code><!--<dependency org="org.hsqldb" name="hsqldb" rev="2.0.0" conf="*->default"/>-->
</code></p>
@@ -1172,13 +1174,14 @@ ROW COLUMN+CELL
<p>The source code for the projects using Gora can also be checked out as a reference. <a href="ext:nutch">Apache Nutch</a> is
one of the first class users of Gora; so looking into how Nutch uses Gora is always a good idea.
- <!--TODO: give link to powered by page --></p>
+ </p>
+ <p> Please feel free to grab our <a href="http://gora.apache.org/images/powered-by-gora.png">poweredBy</a> sticker and embedded it in anything backed by Apache Gora.
</section>
<section>
<title>Feedback</title>
<p> At last, thanks for trying out Gora. If you find any bugs or you have suggestions for improvement,
- do not hesitate to give feedback on gora-dev <a href="ext:devmail">mailing list</a>. </p>
+ do not hesitate to give feedback on the dev@gora.apache.org <a href="ext:devmail">mailing list</a>. </p>
</section>
</body>
Added: gora/trunk/docs/src/resources/images/gora-logo.png
URL: http://svn.apache.org/viewvc/gora/trunk/docs/src/resources/images/gora-logo.png?rev=1245012&view=auto
==============================================================================
Binary file - no diff available.
Propchange: gora/trunk/docs/src/resources/images/gora-logo.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: gora/trunk/docs/src/resources/images/powered-by-gora.png
URL: http://svn.apache.org/viewvc/gora/trunk/docs/src/resources/images/powered-by-gora.png?rev=1245012&view=auto
==============================================================================
Binary file - no diff available.
Propchange: gora/trunk/docs/src/resources/images/powered-by-gora.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Modified: gora/trunk/docs/src/skinconf.xml
URL: http://svn.apache.org/viewvc/gora/trunk/docs/src/skinconf.xml?rev=1245012&r1=1245011&r2=1245012&view=diff
==============================================================================
--- gora/trunk/docs/src/skinconf.xml (original)
+++ gora/trunk/docs/src/skinconf.xml Thu Feb 16 15:03:28 2012
@@ -28,7 +28,7 @@ which will be used to configure the chos
no search box. @domain will enable sitesearch for the specific domain with google.
In other words google will search the @domain for the query string.
-->
- <search name="Gora" domain="incubator.apache.org/gora/" provider="google" box-location="default"/>
+ <search name="Apache Gora" domain="gora.apache.org/" provider="google" box-location="default"/>
<!-- Disable the print link? If enabled, invalid HTML 4.0.1 -->
<disable-print-link>true</disable-print-link>
<!-- Disable the PDF link? -->
@@ -58,18 +58,18 @@ which will be used to configure the chos
<disable-font-script>true</disable-font-script>
<!-- mandatory project logo
default skin: renders it at the top -->
- <project-name>Gora</project-name>
- <project-description>Gora is an ORM framework for column stores such as Apache HBase and Apache Cassandra with a specific focus on Hadoop.</project-description>
- <project-url>http://incubator.apache.org/gora/</project-url>
- <project-logo>images/gora-logo.jpg</project-logo>
+ <project-name>Apache Gora</project-name>
+ <project-description>The Apache Gora open source framework provides an in-memory data model and persistence for big data. Gora supports persisting to column stores, key value stores, document stores and RDBMSs, and analyzing the data with extensive Apache Hadoop MapReduce support. </project-description>
+ <project-url>http://gora.apache.org/</project-url>
+ <project-logo>images/gora-logo.png</project-logo>
<!-- Alternative static image:
<project-logo>images/project-logo.gif</project-logo> -->
<!-- optional group logo
default skin: renders it at the top-left corner -->
- <group-name>Apache Incubator</group-name>
- <group-description></group-description>
- <group-url>http://incubator.apache.org/</group-url>
- <group-logo>http://incubator.apache.org/images/apache-incubator-logo.png</group-logo>
+ <group-name>Apache Software Foundation</group-name>
+ <group-description>The ASF is made up of nearly 100 top level projects that cover a wide range of technologies. Chances are if you are looking for a rewarding experience in Open Source, you are going to find it here.</group-description>
+ <group-url>http://apache.org/</group-url>
+ <group-logo>http://www.apache.org/images/asf-logo.gif</group-logo>
<!-- Alternative static image:
<group-logo>images/group-logo.gif</group-logo> -->
<!-- optional host logo (e.g. sourceforge logo)
@@ -99,7 +99,7 @@ which will be used to configure the chos
-->
<trail>
<link1 name="Apache" href="http://apache.org/"/>
- <link2 name="Gora" href="http://incubator.apache.org/gora/"/>
+ <link2 name="Gora" href="http://gora.apache.org/"/>
<link3 name="" href=""/>
</trail>
<!-- Configure the TOC, i.e. the Table of Contents.