You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by mg...@apache.org on 2016/03/25 15:11:05 UTC
[29/50] isis git commit: ISIS-1335: remove simpleapp-archetype.adoc,
changed the few references to instead reference the relevant 'getting
started' chapter of ugfun (user guide fundamentals).
ISIS-1335: remove simpleapp-archetype.adoc, changed the few references to instead reference the relevant 'getting started' chapter of ugfun (user guide fundamentals).
Also removed ug.adoc, was just there for old links. Previously removed rg.adoc.
Project: http://git-wip-us.apache.org/repos/asf/isis/repo
Commit: http://git-wip-us.apache.org/repos/asf/isis/commit/3b9c6b31
Tree: http://git-wip-us.apache.org/repos/asf/isis/tree/3b9c6b31
Diff: http://git-wip-us.apache.org/repos/asf/isis/diff/3b9c6b31
Branch: refs/heads/ISIS-1223-upgrade-to-wicket-7
Commit: 3b9c6b3138cdbe8ab3f948f1a8a956e971c812ca
Parents: ae96b7b
Author: Dan Haywood <da...@haywood-associates.co.uk>
Authored: Mon Mar 21 19:47:54 2016 +0000
Committer: Dan Haywood <da...@haywood-associates.co.uk>
Committed: Mon Mar 21 19:47:54 2016 +0000
----------------------------------------------------------------------
.../src/main/asciidoc/downloads.adoc | 2 +-
.../guides/_cgcom_verifying-releases.adoc | 2 +-
.../asciidoc/guides/simpleapp-archetype.adoc | 164 -------------------
.../src/main/asciidoc/guides/ug.adoc | 32 ----
.../src/main/asciidoc/screencasts.adoc | 4 +-
5 files changed, 4 insertions(+), 200 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/isis/blob/3b9c6b31/adocs/documentation/src/main/asciidoc/downloads.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/downloads.adoc b/adocs/documentation/src/main/asciidoc/downloads.adoc
index 4a12657..c47eba6 100644
--- a/adocs/documentation/src/main/asciidoc/downloads.adoc
+++ b/adocs/documentation/src/main/asciidoc/downloads.adoc
@@ -15,7 +15,7 @@ Apache Isis™ software is a framework for rapidly developing domain-driven
== Getting Started
-If you just want to get going quickly, we suggest using our Maven archetype. For more information, see link:./simpleapp-archetype.html[here].
+If you just want to get going quickly, we suggest using our Maven archetype. For more information, see xref:guides/ugfun.adoc#_ugfun_getting-started_simpleapp-archetype[SimpleApp archetype][here].
http://git-wip-us.apache.org/repos/asf/isis/blob/3b9c6b31/adocs/documentation/src/main/asciidoc/guides/_cgcom_verifying-releases.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/_cgcom_verifying-releases.adoc b/adocs/documentation/src/main/asciidoc/guides/_cgcom_verifying-releases.adoc
index efd8054..0a7301e 100644
--- a/adocs/documentation/src/main/asciidoc/guides/_cgcom_verifying-releases.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/_cgcom_verifying-releases.adoc
@@ -95,7 +95,7 @@ Confirm that the versions of the Isis artifacts now cached in your local reposit
==== Verifying binary artifacts
-You can verify the binary releases by configuring your local Maven install to point to the Maven staging repository (or repositories) and then using them, eg to run the link:../intro/getting-started/simpleapp-archetype.html[simpleapp archetype] and running the resultant app.
+You can verify the binary releases by configuring your local Maven install to point to the Maven staging repository (or repositories) and then using them, eg to run the xref:ugfun.adoc#_ugfun_getting-started_simpleapp-archetype[SimpleApp archetype1] and running the resultant app.
Configuring your local Maven install amounts to updating the `~/.m2/settings.xml` file:
http://git-wip-us.apache.org/repos/asf/isis/blob/3b9c6b31/adocs/documentation/src/main/asciidoc/guides/simpleapp-archetype.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/simpleapp-archetype.adoc b/adocs/documentation/src/main/asciidoc/guides/simpleapp-archetype.adoc
deleted file mode 100644
index be437c1..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/simpleapp-archetype.adoc
+++ /dev/null
@@ -1,164 +0,0 @@
-[[simpleapp-archetype]]
-= SimpleApp Archetype
-:notice: licensed to the apache software foundation (asf) under one or more contributor license agreements. see the notice file distributed with this work for additional information regarding copyright ownership. the asf licenses this file to you under the apache license, version 2.0 (the "license"); you may not use this file except in compliance with the license. you may obtain a copy of the license at. http://www.apache.org/licenses/license-2.0 . unless required by applicable law or agreed to in writing, software distributed under the license is distributed on an "as is" basis, without warranties or conditions of any kind, either express or implied. see the license for the specific language governing permissions and limitations under the license.
-:_basedir: ../
-:_imagesdir: images/
-:toc: right
-
-
-
-
-The quickest way to get started with Apache Isis is to run the simple archetype. This will generate a very simple one-class domain model, called `SimpleObject`, with a single property `name`. There is also a corresponding `SimpleObjectRepository` domain service. From this you can easily rename these initial classes, and extend to build up your own Apache Isis domain application.
-
-
-
-
-
-== Generating the App
-
-Create a new directory, and `cd` into that directory.
-
-Then run the following command:
-
-[source,bash]
-----
-mvn archetype:generate \
- -D archetypeGroupId=org.apache.isis.archetype \
- -D archetypeArtifactId=simpleapp-archetype \
- -D archetypeVersion=1.11.1 \
- -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.
-
-
-
-
-=== Snapshot release
-
-We also maintain the archetype for the most current `-SNAPSHOT`; an app generated with this archetype will contain the latest features of Apache Isis, but the usual caveats apply: some features still in development may be unstable.
-
-The process is almost identical to that for stable releases, however the `archetype:generate` goal is called with slightly different arguments:
-
-[source,bash]
-----
-mvn archetype:generate \
- -D archetypeGroupId=org.apache.isis.archetype \
- -D archetypeArtifactId=simpleapp-archetype \
- -D archetypeVersion=1.12.0-SNAPSHOT \
- -D groupId=com.mycompany \
- -D artifactId=myapp \
- -D version=1.0-SNAPSHOT \
- -D archetypeRepository=http://repository-estatio.forge.cloudbees.com/snapshot/ \
- -B
-----
-
-where as before:
-
-- `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
-
-but also:
-
-- `archetypeVersion` is the SNAPSHOT version of Apache Isis.
-- `archetypeRepository` specifies the location of our snapshot repo (hosted on [CloudBees](http://www.cloudbees.com)), and
-
-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:
-
-[source,bash]
-----
-cd myapp
-mvn clean install
-----
-
-where `myapp` is the `artifactId` entered above.
-
-
-
-
-== Running the App
-
-The `simpleapp` archetype generates a single WAR file, configured to run both the link:./guides/ugvw.html#[Wicket viewer] and the link:./guides/ugvro.html#[Restful Objects viewer]. The archetype also configures the JDO/DataNucleus objectstore to use an in-memory HSQLDB connection.
-
-Once you've built the app, you can run the WAR in a variety of ways.
-
-First, you could run the WAR in a Maven-hosted Jetty instance:
-
-[source,bash]
-----
-cd webapp
-mvn jetty:run -D jetty.port=9090
-----
-
-In the above, we've passed in a property to indicate a different port from the default port (8080).
-
-Second, you could also run the app by deploying the generated WAR (`webapp/target/myapp-webapp-1.0-SNAPSHOT.war`) to a standalone servlet container such as [Tomcat](http://tomcat.apache.org).
-
-Alternatively, you can run the app from within an IDE, using the main class is `org.apache.isis.WebServer`. The classpath should be that of the `myapp-webapp` submodule. The `WebServer` takes a number of parameters, most useful being `--appManifest` (or `-m`), which allows the app manifest to be specified.
-
-
-
-
-== Using the App
-
-The archetype provides a welcome page that explains the classes and files generated, and provides detailed guidance and what to do next.
-
-The app itself is configured to run using shiro security, as configured in the `WEB-INF/shiro.ini` config file. To log in, use `sven/pass`.
-
-
-
-== Modifying the App
-
-Once you are familiar with the generated app, you'll want to start modifying it. Check out our the link:.guides/ug.html[Users' Guide], which has how-tos and a complete reference guide (as well as some background concepts and discussion of more advanced techniques).
-
-If you use IntelliJ or Eclipse, you'll also want to set up your IDE; this is also described in the link:dg.adoc#_dg_ide[Developers' Guide].
-
-
-== App Structure
-
-As noted above, the generated app is a very simple application consisting of a single domain object that can be easily renamed and extended. The intention is not to showcase all of Apache Isis' capabilities; rather it is to allow you to very easily modify the generated application (eg rename `SimpleObject` to `Customer`) without having to waste time deleting lots of generated code.
-
-
-.Table caption
-[cols="1,1a", options="header"]
-|===
-| Module
-| Description
-
-
-|myapp
-|The parent (aggregator) module
-
-|myapp-dom
-|The domain object model, consisting of <tt>SimpleObject</tt> and <tt>SimpleObjects</tt> (repository) domain service.
-
-|myapp-fixture
-|Domain object fixtures used for initializing the system when being demo'ed or for unit testing.
-
-|myapp-integtests
-|End-to-end integration tests, that exercise from the UI through to the database
-
-|myapp-webapp
-|Run as a webapp (from `web.xml`) using either the Wicket viewer or the RestfulObjects viewer
-
-|===
-
-
-If you run into issues, please don't hesitate to ask for help on the link:../../support.html[users mailing list].
http://git-wip-us.apache.org/repos/asf/isis/blob/3b9c6b31/adocs/documentation/src/main/asciidoc/guides/ug.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/ug.adoc b/adocs/documentation/src/main/asciidoc/guides/ug.adoc
deleted file mode 100644
index 98a43c8..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/ug.adoc
+++ /dev/null
@@ -1,32 +0,0 @@
-[[ug]]
-= User Guides
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-:_basedir: ../
-:_imagesdir: images/
-:numbered:
-
-
-Apache Isis documentation is broken out into a number of user, reference and "supporting procedures" guides.
-
-The *user guides* available are:
-
-* xref:ugfun.adoc#[Fundamentals]
-* xref:ugvw.adoc#[Wicket viewer]
-* xref:ugvro.adoc#[Restful Objects viewer]
-* xref:ugsec.adoc#[Security]
-* xref:ugtst.adoc#[Testing]
-* xref:ugbtb.adoc#[Beyond the Basics]
-
-The reference guides are:
-
-* xref:rgant.adoc#[Annotations]
-* xref:rgsvc.adoc#[Domain Services]
-* xref:rgcfg.adoc#[Configuration Properties]
-* xref:rgcms.adoc#[Classes, Methods and Schema]
-* xref:rgmvn.adoc#[Apache Isis Maven plugin]
-
-The remaining guides are:
-
-* xref:dg.adoc#[Developers' Guide] (how to set up a development environment
-for Apache Isis and contribute back to the project)
-* xref:cgcom.adoc#[Committers' Guide] (release procedures and related practices)
http://git-wip-us.apache.org/repos/asf/isis/blob/3b9c6b31/adocs/documentation/src/main/asciidoc/screencasts.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/screencasts.adoc b/adocs/documentation/src/main/asciidoc/screencasts.adoc
index 5f36788..26c6d3c 100644
--- a/adocs/documentation/src/main/asciidoc/screencasts.adoc
+++ b/adocs/documentation/src/main/asciidoc/screencasts.adoc
@@ -93,7 +93,7 @@ Learn more link:./guides/dg.html#_dg_ide_intellij[here]
|Commands and Auditing (v1.6.0) +
-_Configuring the command and auditing add-on modules for the link:./simpleapp-archetype.html[simpleapp]._ +
+_Configuring the command and auditing add-on modules for the xref:guides/ugfun.adoc#_ugfun_getting-started_simpleapp-archetype[SimpleApp]._ +
Learn more at the (non-ASF) Isis addons' http://github.com/isisaddons/isis-module-command[command] and http://github.com/isisaddons/isis-module-audit[audit] modules
@@ -102,7 +102,7 @@ Learn more at the (non-ASF) Isis addons' http://github.com/isisaddons/isis-modul
|Security (v1.6.0) +
-_Configuring the security add-on module for for the link:./simpleapp-archetype.html[simpleapp]._ +
+_Configuring the security add-on module for for the xref:guides/ugfun.adoc#_ugfun_getting-started_simpleapp-archetype[SimpleApp]._ +
Learn more at the (non-ASF) http://github.com/isisaddons/isis-module-security[Isis addons' security] module