updated tutorial and docs

This commit is contained in:
Michael Hunger
2011-03-16 00:22:06 +01:00
parent e5f9c6b3bb
commit 264b423b98
7 changed files with 54 additions and 11 deletions

View File

@@ -3,7 +3,8 @@
<book xmlns:xi="http://www.w3.org/2001/XInclude">
<bookinfo>
<title>The Spring Data Graph Guidebook</title>
<title>Good Relationships</title>
<subtitle>The Spring Data Graph Guidebook</subtitle>
<releaseinfo>&version;</releaseinfo>
<authorgroup>
@@ -25,6 +26,13 @@
</author>
</authorgroup>
<mediaobject>
<imageobject>
<imagedata fileref="springdatagraph.png"/>
</imageobject>
</mediaobject>
<legalnotice>
<para>
Copies of this document may be made for your own use and for distribution
@@ -52,12 +60,33 @@
</preface-->
<preface id="about-book">
<title>About this book</title>
<title>About this Guide Book</title>
<para>
Duplex book -> Fowler bliki
1. Narrative / Tutorial
2. Reference docs
Welcome to the Spring Data Graph Guide Book. Thank you for taking the time to get an in depth look into the
usage and workings of the <ulink url="https://github.com/SpringSource/spring-data-graph">Spring Data Graph Library</ulink>. Spring Data Graph is part of the <ulink url="http://springsource.org/spring-data">Spring Data project</ulink> which
aims to provide the convenient programming model of the Spring Framework to the big field modern datastores
(mostly NoSQL). Spring Data Graph in particular currently provides integration for the <ulink url="http://neo4j.org">Neo4j Graph Database</ulink>.
</para><para>
It was written by developers for developers. So hopefully we created a documentation that is well received by
our peers.
</para><para>
If you have any feedback to the Spring Data Graph Library or this book, please provide it via <ulink url="https://jira.springsource.org/browse/DATAGRAPH">SpringSource JIRA</ulink>,
the <ulink url="http://forum.springsource.org/forumdisplay.php?f=80">SpringSource NoSQL Forum</ulink>, <ulink
url="https://github.com/SpringSource/spring-data-graph/issues">github comments or issues</ulink> or the <ulink url="http://neo4j.org/community/list/">Neo4j mailing list</ulink>.
</para><para>
This book is presented as a <ulink url="http://martinfowler.com/bliki/DuplexBook.html">duplex book</ulink>, a term coined by Martin Fowler. A duplex book consists of at least two
parts. The first part is an easily accessible narrative, that gives the reader an overview of the topics contained
in the book. It contains lots of examples and more general discussion topics. This should be the only part of
the book that is required to be read cover-to-cover.
</para><para>
We chose a tutorial describing the creation of a web applicaton (cineasts.net) that allows movie enthusiasts to
find the favorites, rate them, connect with each other and enjoy social features. The application is running on
Neo4j using Spring Data Graph and the well known Spring Web Stack.
</para><para>
The second part is the classic reference documentation containing the detailed information about the library.
It discusses the programming model, the underlying assumptions, used toolset (like aspectj) as well as the APIs
for the object-graph mapping and the template approach. The reference docs should be mainly used to look up
concrete bits of information or to dig deeper into certain topics.
</para>
</preface>
@@ -65,7 +94,14 @@
<title>Tutorial</title>
<partintro>
<para>
Tutorial intro ...
In this first part of the book we run a tutorial that creates a complete web application built on top of Spring Data Graph.
It uses a domain that should be familiar to most - movies. So for cineasts.net we decided to add a social
touch to the whole movie rating business, allowing friends to share their ratings and get recommendations
for new friends and movies.
</para><para>
The tutorial is presented as a colloquial description of the steps necessary to create the application.
It provides the configuration and code examples that are needed to understand what's happening. The complete
source code repository for running the app is available on <ulink url="http://github.com/jexp/cineasts">github</ulink>.
</para>
</partintro>

Binary file not shown.

After

Width:  |  Height:  |  Size: 124 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 125 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 269 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 92 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 50 KiB

View File

@@ -4,7 +4,7 @@
<title>Allow me to introduce - Cineasts.net</title>
<para>
Once upon a time I wanted to build a social movie database myself. First things first - I had a name: "Cineasts" - the people
crazy about movies. So I went ahead and bought the domain, cineasts.net. So, the project was almost done.
crazy about movies. So I went ahead and got the domain, cineasts.net. So, the project was almost done.
</para><para>
I had some ideas as well. Of course there should be Actors who play Roles in Movies. I needed the Cineast, too, someone
had to rate the movies after all. And while they were there, they could also make friends. Find someone to accompany them to the cinema or share
@@ -16,9 +16,16 @@ existing friends.
<imagedata fileref="cineasts.png"/>
</imageobject>
</mediaobject>
</para><para>I looked for possible sources for data, IMDB was my first stop, but they charge 15k for data usage. Fortunately I found themoviedb.org which has
liberal terms and conditions and a nice API for fetching the data.
</para><para>I looked for possible sources for data, IMDB was my first stop, but they charge 15k USD for data usage. Fortunately I found <ulink url="http://themoviedb.org">TheMoviedb.org</ulink> which has
built its data independently by users and provides the data for free for any usecase. The also have liberal terms and conditions and a nice API for fetching the data.
</para><para>
There were many more ideas but I wanted to get something done over the course of one day. So this was the scope I was going to tackle. * What is Cineasts.net
There were many more ideas but I wanted to get something done over the course of one day. So this was the scope I was going to tackle. And this is how it should look
like.
</para>
<mediaobject>
<imageobject>
<imagedata fileref="cineasts_main.png"/>
</imageobject>
</mediaobject>
</chapter>