Author: danhaywood
Date: Fri Nov 14 15:14:53 2014
New Revision: 1639664
URL: http://svn.apache.org/r1639664
Log:
updating archetype pages
Modified:
isis/site/trunk/content/intro/getting-started/simpleapp-archetype.md
isis/site/trunk/content/intro/getting-started/todoapp-archetype.md
Modified: isis/site/trunk/content/intro/getting-started/simpleapp-archetype.md
URL:
http://svn.apache.org/viewvc/isis/site/trunk/content/intro/getting-started/simpleapp-archetype.md?rev=1639664&r1=1639663&r2=1639664&view=diff
==============================================================================
--- isis/site/trunk/content/intro/getting-started/simpleapp-archetype.md
(original)
+++ isis/site/trunk/content/intro/getting-started/simpleapp-archetype.md Fri
Nov 14 15:14:53 2014
@@ -4,7 +4,7 @@ The quickest way to get started with Apa
If you want to see a more functionally complete example, also check out the
[TodoApp archetype](todoapp-archetype.html); this will give you a good idea of
what makes up a not-too-complex Isis application. In fact, we recommend that
you run both archetypes: this archetype generates a very simple application for
you to refactor and extend, while the ToDo app provides to guide your own
development.
-## Generating the App
+## Generating the App (stable release)
Create a new directory, and `cd` into that directory.
@@ -27,6 +27,52 @@ where:
The archetype generation process will then run; it only takes a few seconds.
+## Generating the App (snapshot release)
+
+We also maintain the archetype for the most current `-SNAPSHOT`; an app
generated with this archetype will contain the latest features of Isis, but the
usual caveats that some of those features may still be unstable.
+
+The process is almost identical, however you first need to configure your
Maven instance to point to our snapshot repository (hosted on
[Cloudbees](http://www.cloudbees.com). Add the following to your
`~/.m2/settings.xml` file:
+
+ <profile>
+ <id>cloudbees-snapshots</id>
+ <activation>
+ <activeByDefault>true</activeByDefault>
+ </activation>
+ <repositories>
+ <repository>
+ <id>snapshots-repo</id>
+
<url>http://repository-estatio.forge.cloudbees.com/snapshot/</url>
+ <releases>
+ <enabled>false</enabled>
+ </releases>
+ <snapshots>
+ <enabled>true</enabled>
+ </snapshots>
+ </repository>
+ </repositories>
+ </profile>
+
+This should be places within the <profiles> element of the file.
+
+With this done you should then be able to generate from the SNAPSHOT (note the
different `archetypeVersion`):
+
+ mvn archetype:generate \
+ -D archetypeGroupId=org.apache.isis.archetype \
+ -D archetypeArtifactId=simpleapp-archetype \
+ -D archetypeVersion=1.8.0-SNAPSHOT \
+ -D groupId=com.mycompany \
+ -D artifactId=myapp \
+ -D version=1.0-SNAPSHOT \
+ -B
+
+where:
+
+- `groupId` represents your own organization, and
+- `artifactId` is a unique identifier for this app within your organization.
+- `version` is the initial (snapshot) version of your app
+
+The archetype generation process will then run; it only takes a few seconds.
+
## Building the App
Switch into the root directory of your newly generated app, and build your app:
Modified: isis/site/trunk/content/intro/getting-started/todoapp-archetype.md
URL:
http://svn.apache.org/viewvc/isis/site/trunk/content/intro/getting-started/todoapp-archetype.md?rev=1639664&r1=1639663&r2=1639664&view=diff
==============================================================================
--- isis/site/trunk/content/intro/getting-started/todoapp-archetype.md
(original)
+++ isis/site/trunk/content/intro/getting-started/todoapp-archetype.md Fri Nov
14 15:14:53 2014
@@ -28,7 +28,7 @@ A run-through of the main features of th
An earlier screencast, relating to v1.2.0, is available
[here](https://www.youtube.com/watch?v=1_vc01LIBUU).>
-### Generating the App
+### Generating the App (stable release)
Create a new directory, and `cd` into that directory.
@@ -51,6 +51,54 @@ where:
The archetype generation process will then run; it only takes a few seconds.
+
+## Generating the App (snapshot release)
+
+We also maintain the archetype for the most current `-SNAPSHOT`; an app
generated with this archetype will contain the latest features of Isis, but the
usual caveats that some of those features may still be unstable.
+
+The process is almost identical, however you first need to configure your
Maven instance to point to our snapshot repository (hosted on
[Cloudbees](http://www.cloudbees.com). Add the following to your
`~/.m2/settings.xml` file:
+
+ <profile>
+ <id>cloudbees-snapshots</id>
+ <activation>
+ <activeByDefault>true</activeByDefault>
+ </activation>
+ <repositories>
+ <repository>
+ <id>snapshots-repo</id>
+
<url>http://repository-estatio.forge.cloudbees.com/snapshot/</url>
+ <releases>
+ <enabled>false</enabled>
+ </releases>
+ <snapshots>
+ <enabled>true</enabled>
+ </snapshots>
+ </repository>
+ </repositories>
+ </profile>
+
+This should be places within the <profiles> element of the file.
+
+With this done you should then be able to generate from the SNAPSHOT (note the
different `archetypeVersion`):
+
+ mvn archetype:generate \
+ -D archetypeGroupId=org.apache.isis.archetype \
+ -D archetypeArtifactId=todoapp-archetype \
+ -D archetypeVersion=1.8.0-SNAPSHOT \
+ -D groupId=com.mycompany \
+ -D artifactId=myapp \
+ -D version=1.0-SNAPSHOT \
+ -B
+
+where:
+
+- `groupId` represents your own organization, and
+- `artifactId` is a unique identifier for this app within your organization.
+- `version` is the initial (snapshot) version of your app
+
+The archetype generation process will then run; it only takes a few seconds.
+
+
## Building the App
Switch into the root directory of your newly generated app, and build your app:
