You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by da...@apache.org on 2012/12/21 11:57:12 UTC
svn commit: r1424861 - in /isis/site/trunk/content: contributors/about.md
contributors/recreating-the-applib-docs.md
contributors/updating-the-applib-docs.md core/applib.md documentation.md
getting-started/quickstart-archetype.md
Author: danhaywood
Date: Fri Dec 21 10:57:12 2012
New Revision: 1424861
URL: http://svn.apache.org/viewvc?rev=1424861&view=rev
Log:
isis site - archetype docs, applib docs
Added:
isis/site/trunk/content/contributors/updating-the-applib-docs.md
- copied unchanged from r1424854, isis/site/trunk/content/contributors/recreating-the-applib-docs.md
Removed:
isis/site/trunk/content/contributors/recreating-the-applib-docs.md
Modified:
isis/site/trunk/content/contributors/about.md
isis/site/trunk/content/core/applib.md
isis/site/trunk/content/documentation.md
isis/site/trunk/content/getting-started/quickstart-archetype.md
Modified: isis/site/trunk/content/contributors/about.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/contributors/about.md?rev=1424861&r1=1424860&r2=1424861&view=diff
==============================================================================
--- isis/site/trunk/content/contributors/about.md (original)
+++ isis/site/trunk/content/contributors/about.md Fri Dec 21 10:57:12 2012
@@ -5,7 +5,8 @@ Title: Contributors
- [Contributing](contributing.html)
- [Development Environment](development-environment.html)
- [Building Isis](building-isis.html)
-- [Recreating an archetype](contributors/recreating-an-archetype.html)
+- [Recreating an archetype](recreating-an-archetype.html)
+- [Updating the applib docs](updating-the-applib-docs.html)
- [Git Policy](git-policy.html)
- [Git Cookbook](git-cookbook.html)
- [Versioning Policy](versioning-policy.html)
Modified: isis/site/trunk/content/core/applib.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/core/applib.md?rev=1424861&r1=1424860&r2=1424861&view=diff
==============================================================================
--- isis/site/trunk/content/core/applib.md (original)
+++ isis/site/trunk/content/core/applib.md Fri Dec 21 10:57:12 2012
@@ -4,6 +4,4 @@ Apache Isis works using convention-over-
These conventions are together known as the Apache Isis Programming Model. The Apache Isis Application Library - or AppLib - constitutes those elements of the programming model that are declarative (such as annotations and interfaces). It also contains the `DomainObjectContainer` interface, which is normally injected into your domain objects and represents the only point of coupling from your domain into the framework.
-See the applib programming guide ([HTML](http://incubator.apache.org/isis/applib/docbkx/html/guide/isis-applib.html) or [PDF](http://incubator.apache.org/isis/applib/docbkx/pdf/isis-applib.pdf)) for further details.
-
-<!-- TODO: migrate content over from incubator -->
+See the applib programming guide ([HTML](guides/isis-applib.html) or [PDF](guides/isis-applib.pdf)) for further details.
Modified: isis/site/trunk/content/documentation.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/documentation.md?rev=1424861&r1=1424860&r2=1424861&view=diff
==============================================================================
--- isis/site/trunk/content/documentation.md (original)
+++ isis/site/trunk/content/documentation.md Fri Dec 21 10:57:12 2012
@@ -16,7 +16,7 @@ Title: Documentation
### Archetypes
-- [Quickstart Archetype](getting-started/quickstart-archetype.html) (`0.2.0-incubating`)
+- [Quickstart Archetype](getting-started/quickstart-archetype.html) (`1.0.0-RC1`)
<!--
- [Wicket/Restful/JDO Archetype](getting-started/quickstart-archetype-wicket-restful-jdo.html)
- [Scimpi/NoSQL Archetype](getting-started/quickstart-archetype-scimpi-nosql.html)
@@ -48,6 +48,7 @@ Title: Documentation
- [Development Environment](contributors/development-environment.html)
- [Building Isis](contributors/building-isis.html)
- [Recreating an archetype](contributors/recreating-an-archetype.html)
+- [Updating the applib docs](contributors/updating-the-applib-docs.html)
- [Git Policy](contributors/git-policy.html)
- [Git Cookbook](contributors/git-cookbook.html)
- [Versioning Policy](contributors/versioning-policy.html)
@@ -67,7 +68,7 @@ Title: Documentation
{group
-## Core [1.0.0-RC1](core/release-notes/about.html)
+## Core [1.0.0-RC2](core/release-notes/about.html)
{row-even
@@ -115,7 +116,7 @@ Title: Documentation
{span-one-third
-### Wicket [1.0.0-RC1](components/viewers/wicket/release-notes/about.html)
+### Wicket [1.0.0-RC2](components/viewers/wicket/release-notes/about.html)
- [About](components/viewers/wicket/about.html)
@@ -123,7 +124,7 @@ Title: Documentation
{span-one-third
-### RestfulObjects [1.0.0-RC1](components/viewers/restfulobjects/release-notes/about.html)
+### RestfulObjects [1.0.0-RC2](components/viewers/restfulobjects/release-notes/about.html)
- [About](components/viewers/restfulobjects/about.html)
@@ -195,7 +196,7 @@ Title: Documentation
{span-one-third
-### JDO [1.0.0-RC1](components/objectstores/jdo/release-notes/about.html)
+### JDO [1.0.0-RC2](components/objectstores/jdo/release-notes/about.html)
- [About](components/objectstores/jdo/about.html)
- [Maven and Eclipse](components/objectstores/jdo/hints-and-tips.html)
@@ -245,7 +246,7 @@ Title: Documentation
{span-one-third
-### File [1.0.0-RC1](components/security/file/release-notes/about.html)
+### File [1.0.0-RC2](components/security/file/release-notes/about.html)
- [About](components/security/file/about.html)
Modified: isis/site/trunk/content/getting-started/quickstart-archetype.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/getting-started/quickstart-archetype.md?rev=1424861&r1=1424860&r2=1424861&view=diff
==============================================================================
--- isis/site/trunk/content/getting-started/quickstart-archetype.md (original)
+++ isis/site/trunk/content/getting-started/quickstart-archetype.md Fri Dec 21 10:57:12 2012
@@ -1,4 +1,4 @@
-Title: Quickstart Archetype (0.2.0-incubating)
+Title: Quickstart Archetype (1.0.0)
The quickest way to get started with Apache Isis is to run the quickstart archetype. This will generate a simple one-class domain model, for tracking to-do items. The intention is not to showcase all of Isis' capabilities; rather it is to allow you to very easily modify the generated app to your own domain.
@@ -10,9 +10,9 @@ Then run the following command:
<pre>
mvn archetype:generate \
- -D archetypeGroupId=org.apache.isis \
- -D archetypeArtifactId=quickstart-archetype \
- -D archetypeVersion=0.2.0-incubating \
+ -D archetypeGroupId=org.apache.isis.archetype \
+ -D archetypeArtifactId=quickstart_wicket_restful_jdo-archetype \
+ -D archetypeVersion=1.0.0 \
-D groupId=com.mycompany \
-D artifactId=myapp
</pre>
@@ -42,7 +42,11 @@ where `myapp` is the `artifactId` entere
### Running the App
-Once you've built the app, you can run it in a variety of ways.
+The `quickstart_wicket_restful_jdo` archetype generates two WAR files, one for the [wicket viewer](../components/viewers/wicket/about.html) and one for the [restfulobjects viewer](../components/viewers/wicket/about.html). You can deploy either or both. The wicket viewer WAR is built by the `viewer-wicket` module; the restful objects viewer WAR is built by the `viewer-restfulobjects` module.
+
+By default each run with JDO objectstore configured to use an in-memory HSQLDB connection. To share data between the webapps (or indeed to persist data between runs), you'll therefore need to reconfigure both webapps to use some other shared database connection. See the `persistor_datanucleus.properties` file for details.
+
+Once you've built the app (having reconfigured JDO if required), you can run either WAR in a variety of ways.
The first is to simply deploying the generated WAR (`webapp/target/myapp-webapp-1.0-SNAPSHOT.war`) to a servlet container.
@@ -54,10 +58,10 @@ mvn jetty:run
If you do this, note that the context path changes; check the console output.
-In addition to the standard WAR< the archetype also builds a self-hosted version of the WAR. You can therefore also simply run the WAR as a standalone app:
+In addition to the standard WAR< the archetype also builds a self-hosted version of the WAR. You can therefore also simply run the WAR as a standalone app; for example:
<pre>
-java -jar webapp/target/myapp-webapp-1.0-SNAPSHOT-jetty-console.war
+java -jar viewer-wicket/target/myapp-viewer-wicket-1.0-SNAPSHOT-jetty-console.war
</pre>
This can also be accomplished using an embedded Ant target provided in the build script:
@@ -79,10 +83,9 @@ As noted above, the generated app is a v
<tr><td>myapp</td><td>The parent (aggregator) module</td></tr>
<tr><td>myapp-dom</td><td>The domain object model, consisting of <tt>ToDoItem</tt> and <tt>ToDoItems</tt> (repository) interface.</td></tr>
<tr><td>myapp-fixture</td><td>Domain object fixtures used for initializing the system when being demo'ed or for unit testing.</td></tr>
-<tr><td>myapp-objstore-dflt</td><td>Implementation of <tt>ToDoItems</tt> repository, for the default (in-memory) object store.</td></tr>
-<tr><td>myapp-webapp </td><td>Run as a webapp (from <tt>web.xml</tt>) using either the HTML viewer or the JSON (RESTful) viewer</td></tr>
-<tr><td>myapp-tests-bdd</td><td>Run domain object tests using Isis' integration with the Concordion BDD framework.</td></tr>
-<tr><td>myapp-tests-junit</td><td>Run domain object tests using Isis' custom test runner for JUnit runner</td></tr>
+<tr><td>myapp-objstore-jdo</td><td>Implementation of <tt>ToDoItems</tt> repository, using JDO objectstore.</td></tr>
+<tr><td>myapp-wicket-viewer</td><td>Run as a webapp (from <tt>web.xml</tt>) using the Wicket viewer</td></tr>
+<tr><td>myapp-wicket-restfulobjects</td><td>Run as a webapp (from <tt>web.xml</tt>) using the RestfulObjects viewer</td></tr>
</table>
-The most significant omission with the generated application is that it is configured only to support the default in-memory object store. What this means is that any changes you make to objects will not be persisted between runs. If you'd like to use other viewers and object stores, ask for help on the [users mailing list](../support.html).
\ No newline at end of file
+If you run into issues, please don't hesitate to ask for help on the [users mailing list](../support.html).
\ No newline at end of file