svn commit: r1416653 - in /isis/site/trunk/content: documentation.md download.md getting-started/about.md getting-started/examples.md getting-started/resources/quickstart_dnd_junit_bdd.tar.gz getting-started/resources/quickstart_wicket_restful_jdo.tar.gz

[da...@apache.org]

Author: danhaywood
Date: Mon Dec  3 20:20:55 2012
New Revision: 1416653

URL: http://svn.apache.org/viewvc?rev=1416653&view=rev
Log:
isis site: adding snapshot examples

Added:
    isis/site/trunk/content/getting-started/examples.md
    isis/site/trunk/content/getting-started/resources/quickstart_dnd_junit_bdd.tar.gz   (with props)
    isis/site/trunk/content/getting-started/resources/quickstart_wicket_restful_jdo.tar.gz   (with props)
Modified:
    isis/site/trunk/content/documentation.md
    isis/site/trunk/content/download.md
    isis/site/trunk/content/getting-started/about.md

Modified: isis/site/trunk/content/documentation.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/documentation.md?rev=1416653&r1=1416652&r2=1416653&view=diff
==============================================================================
--- isis/site/trunk/content/documentation.md (original)
+++ isis/site/trunk/content/documentation.md Mon Dec  3 20:20:55 2012
@@ -9,6 +9,7 @@ Title: Documentation
 ### Getting started
 
 - [Demo App](getting-started/demo-app.html) (`0.2.0-incubating`)
+- [Examples](getting-started/examples.html) (`0.3.1-SNAPSHOT`)
 - [Cheat Sheet](getting-started/cheat-sheet.html)
 - [Icons](getting-started/icons.html)
 

Modified: isis/site/trunk/content/download.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/download.md?rev=1416653&r1=1416652&r2=1416653&view=diff
==============================================================================
--- isis/site/trunk/content/download.md (original)
+++ isis/site/trunk/content/download.md Mon Dec  3 20:20:55 2012
@@ -6,10 +6,12 @@ Isis graduated from the Apache incubator
 
 In the meantime, you can download the Isis source code using:
 
-    svn checkout https://svn.apache.org/repos/asf/isis/trunk
+    git clone https://git.apache.org/isis.git
 
-There is also a mirrored copy up on [github](https://github.com/danhaywood/apache-isis-tlp).  We'll be moving over to Apache supported git infrastructure shortly (but will maintain a github mirror).
 
+## Examples
+
+There are some examples of running against the current snapshot; see [here](getting-started/examples.html).
 
 ## Previous releases
 

Modified: isis/site/trunk/content/getting-started/about.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/getting-started/about.md?rev=1416653&r1=1416652&r2=1416653&view=diff
==============================================================================
--- isis/site/trunk/content/getting-started/about.md (original)
+++ isis/site/trunk/content/getting-started/about.md Mon Dec  3 20:20:55 2012
@@ -1,6 +1,7 @@
 Title: Getting started
 
 - [Demo application](demo-app.html)
+- [Examples](examples.html)
 - [Quickstart archetype](quickstart-archetype.html)
 - [Cheat sheet](cheat-sheet.html)
 - [Icons](icons.html)

Added: isis/site/trunk/content/getting-started/examples.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/getting-started/examples.md?rev=1416653&view=auto
==============================================================================
--- isis/site/trunk/content/getting-started/examples.md (added)
+++ isis/site/trunk/content/getting-started/examples.md Mon Dec  3 20:20:55 2012
@@ -0,0 +1,60 @@
+Title: Examples
+
+The following examples are zipped-up versions of the `examples/` directory, configured to run against the current SNAPSHOT.
+
+* if you've built Isis from the source code, then these examples will run against your local cached Isis modules
+
+* If you **haven't** built Isis from source code, then these examples will pull down the current snapshots on the [Apache snapshot repo](https://repository.apache.org/index.html).
+
+In both cases the domain object model is a very simple todo application.  No prizes for originality there, but we wanted a one domain class that you could easily refactor for your own purposes.
+
+### Wicket/Restful Objects/JDO
+
+This example configures two webapps: the [Wicket viewer](../components/viewers/wicket/about.html) and the [Restful Objects viewer](../components/viewers/restfulobjects/about.html).  In both cases the webapps run against [JDO Object store](../components/objectstores/jdo/about.html).
+
+The default configuration is an HSQLDB in-memory database, so changes are not persisted and are not shared between the webapps if run concurrently.  This can easily be changed though by editing the `persistor_datanucleus.properties` file (in `src/main/webapp/WEB-INF` for both webapps).
+
+To build the example:
+
+* download the [tarfile](resources/quickstart_wicket_restful_jdo.tar.gz) and unzip using `gunzip` and `tar xvf`
+* build using Maven:
+<pre>
+  mvn clean install
+</pre>
+
+To run the Wicket viewer, use:
+
+<pre>
+cd viewer-wicket
+mvn antrun:run
+</pre>
+
+which runs a self-hosted WAR file.  Alternatively you can deploy the WAR file (in the `target` directory) to a servlet container.
+
+To run the Restful Objects viewer, use:
+
+<pre>
+cd viewer-restfulobjects
+mvn antrun:run
+</pre>
+
+### DnD/Junit/BDD (Concordion)
+
+This example demonstrates the use of domain object testing using the [junit viewer](../components/viewers/junit/about.html), BDD-style testing using the [BDD viewer](../components/viewers/bdd/about.html), as well as using the [DnD viewer](../components/viewers/dnd/about.html) to explore the domain model.  The viewers are configured to use the [in-memory objectstore](../components/objectstores/inmemory/about.html), so changes are never persisted between runs.
+
+To build the example:
+
+* download the [tarfile](resources/quickstart_dnd_junit_bdd.tar.gz) and unzip using `gunzip` and `tar xvf`
+* build using Maven:
+<pre>
+  mvn clean install
+</pre>
+
+The act of building will actually execute the tests.  Running the BDD tests also generates a transcript, which you can find in `/tmp/concordion/bdd/stories/AllStories.html`.  
+
+To run the DnD viewer, use:
+
+<pre>
+cd viewer-dnd
+mvn antrun:run
+</pre>

Added: isis/site/trunk/content/getting-started/resources/quickstart_dnd_junit_bdd.tar.gz
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/getting-started/resources/quickstart_dnd_junit_bdd.tar.gz?rev=1416653&view=auto
==============================================================================
Binary file - no diff available.

Propchange: isis/site/trunk/content/getting-started/resources/quickstart_dnd_junit_bdd.tar.gz
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: isis/site/trunk/content/getting-started/resources/quickstart_wicket_restful_jdo.tar.gz
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/getting-started/resources/quickstart_wicket_restful_jdo.tar.gz?rev=1416653&view=auto
==============================================================================
Binary file - no diff available.

Propchange: isis/site/trunk/content/getting-started/resources/quickstart_wicket_restful_jdo.tar.gz
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream