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 2017/10/10 22:36:53 UTC
[isis] 03/04: ISIS-1465: promotes archetype sections into chapters
This is an automated email from the ASF dual-hosted git repository.
danhaywood pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/isis.git
commit 38a7950b9cdfe785b9dafb30d5c27b14da59fbf4
Author: Dan Haywood <da...@haywood-associates.co.uk>
AuthorDate: Tue Oct 10 23:33:48 2017 +0100
ISIS-1465: promotes archetype sections into chapters
---
.../asciidoc/guides/dg/_dg_hints-and-tips.adoc | 1 +
.../_dg_hints-and-tips_datanucleus-enhancer.adoc} | 4 ++-
.../main/asciidoc/guides/dg/_dg_ide_eclipse.adoc | 2 +-
.../guides/ugfun/_ugfun_getting-started.adoc | 40 ----------------------
...ugfun_getting-started_helloworld-archetype.adoc | 8 +++--
..._ugfun_getting-started_simpleapp-archetype.adoc | 14 ++++----
.../src/main/asciidoc/guides/ugfun/ugfun.adoc | 4 ++-
7 files changed, 22 insertions(+), 51 deletions(-)
diff --git a/adocs/documentation/src/main/asciidoc/guides/dg/_dg_hints-and-tips.adoc b/adocs/documentation/src/main/asciidoc/guides/dg/_dg_hints-and-tips.adoc
index 5df8b8c..c64e106 100644
--- a/adocs/documentation/src/main/asciidoc/guides/dg/_dg_hints-and-tips.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/dg/_dg_hints-and-tips.adoc
@@ -25,6 +25,7 @@ See also hints-n-tips chapters in the:
// tag::inclusions[]
+include::_dg_hints-and-tips_datanucleus-enhancer.adoc[leveloffset=+1]
include::_dg_hints-and-tips_enabling-logging.adoc[leveloffset=+1]
include::_dg_hints-and-tips_enhance-only.adoc[leveloffset=+1]
include::_dg_hints-and-tips_how-run-fixtures-on-app-startup.adoc[leveloffset=+1]
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_getting-started_datanucleus-enhancer.adoc b/adocs/documentation/src/main/asciidoc/guides/dg/_dg_hints-and-tips_datanucleus-enhancer.adoc
similarity index 98%
rename from adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_getting-started_datanucleus-enhancer.adoc
rename to adocs/documentation/src/main/asciidoc/guides/dg/_dg_hints-and-tips_datanucleus-enhancer.adoc
index f3de3d1..81a61d0 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_getting-started_datanucleus-enhancer.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/dg/_dg_hints-and-tips_datanucleus-enhancer.adoc
@@ -1,4 +1,4 @@
-[[_ugfun_getting-started_datanucleus-enhancer]]
+[[_dg_hints-and-tips_datanucleus-enhancer]]
= Datanucleus Enhancer
: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 ag [...]
:_basedir: ../../
@@ -50,3 +50,5 @@ If running on Windows, then there's a good chance you'll hit the http://msdn.mic
This file is also required if you are using developing in Eclipse and relying on the DataNucleus plugin for Eclipse rather than the DataNucleus plugin for Maven. More information can be found xref:../dg/dg.adoc#_dg_ide_eclipse[here].
====
+
+
diff --git a/adocs/documentation/src/main/asciidoc/guides/dg/_dg_ide_eclipse.adoc b/adocs/documentation/src/main/asciidoc/guides/dg/_dg_ide_eclipse.adoc
index f7f68ef..b7578db 100644
--- a/adocs/documentation/src/main/asciidoc/guides/dg/_dg_ide_eclipse.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/dg/_dg_ide_eclipse.adoc
@@ -78,7 +78,7 @@ image::{_imagesdir}eclipse/eclipse-110-project-support.png[width="600px",link="{
DataNucleus' enhancer uses the domain object model's own classpath to reference DataNucleus JARs.
So, even though your domain objects are unlikely to depend on DataNucleus, these references must still be present.
-See the earlier section on xref:../ugfun/ugfun.adoc#_ugfun_getting-started_datanucleus-enhancer[DataNucleus enhancer] for details of the contents of the `pom.xml`.
+See the section in xref:dg.adoc#_dg_hints-and-tips_datanucleus-enhancer[DataNucleus enhancer] for details of the contents of the `pom.xml`.
Chances are it is already set up from running the xref:../ugfun/ugfun.adoc#_ugfun_getting-started_helloworld-archetype[HelloWorld] or the xref:../ugfun/ugfun.adoc#_ugfun_getting-started_simpleapp-archetype[SimpleApp] archetype.
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_getting-started.adoc b/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_getting-started.adoc
deleted file mode 100644
index b7c8c9c..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_getting-started.adoc
+++ /dev/null
@@ -1,40 +0,0 @@
-[[_ugfun_getting-started]]
-= Getting Started
-: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 ag [...]
-:_basedir: ../../
-:_imagesdir: images/
-
-
-
-
-To get you up and running quickly, Apache Isis provides two archetypes:
-
-* xref:../ugfun/ugfun.adoc#_ugfun_getting-started_helloworld-archetype[HelloWorld archetype] generates a one domain class application so you can quickly learn about Apache Isis by trying it out. +
-+
-For simplisty, the generated application is a single Maven module containing both the business logic classes and the bootstrapping code.
-
-* xref:../ugfun/ugfun.adoc#_ugfun_getting-started_simpleapp-archetype[SimpleApp archetype], a slightly more sophisticated one domain class version suitable for use as the basis of your own apps. +
-+
-This is still quite minimal so that you won't have to spend lots of time removing generated artifacts.
-On the other hand, it does set up a standard multi-module maven structure with unit- and integration tests pre-configured, as well as a webapp module so that you can easily run your app.
-We strongly recommend that you preserve this structure as you develop your own Isis application.
-
-In this chapter we also discuss the xref:../ugfun/ugfun.adoc#_ugfun_getting-started_datanucleus-enhancer[DataNucleus enhancer].
-link:http://www.datanucleus.org/[DataNucleus] is the reference implementation of the JDO (Java Data Objects) spec, and Apache Isis integrates with DataNucleus as its persistence layer.
-The enhancer performs post-processing on the bytecode of your persistent domain entities, such that they can be persisted by Apache Isis' JDO/DataNucleus objectstore.
-
-[NOTE]
-====
-The xref:../ugfun/ugfun.adoc#_ugfun_getting-started_helloworld-archetype[HelloWorld] and xref:../ugfun/ugfun.adoc#_ugfun_getting-started_simpleapp-archetype[SimpleApp] archetypes automatically configures the enhancer, so there's little you need to do at this stage.
-
-Even so we feel it's a good idea to be aware of this critical part of Apache Isis runtime; if the enhancer does not run, then you'll find the app fails to start with (what will seem like) quite an obscure exception message.
-====
-
-
-
-
-include::_ugfun_getting-started_prerequisites.adoc[leveloffset=+1]
-include::_ugfun_getting-started_helloworld-archetype.adoc[leveloffset=+1]
-include::_ugfun_getting-started_simpleapp-archetype.adoc[leveloffset=+1]
-include::_ugfun_getting-started_datanucleus-enhancer.adoc[leveloffset=+1]
-
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_getting-started_helloworld-archetype.adoc b/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_getting-started_helloworld-archetype.adoc
index fb3fbae..7765bd0 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_getting-started_helloworld-archetype.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_getting-started_helloworld-archetype.adoc
@@ -5,6 +5,7 @@
:_imagesdir: images/
+
The quickest way to start learning about Apache Isis is to run the `helloworld` archetype.
This will generate a tiny Apache Isis app, consisting of a simple one-class domain model, called `HelloWorldObject`, and a supporting `HelloWorldObjects` domain service.
Both the business logic and supporting bootstrapping classes are in a single Maven module (in different Java packages).
@@ -17,6 +18,9 @@ This also creates a minimal application, but provides more structure and example
====
+include::_ugfun_getting-started_prerequisites.adoc[leveloffset=+1]
+
+
[[__ugfun_getting-started_helloworld-archetype_generating-the-app]]
== Generating the App
@@ -355,13 +359,13 @@ The default configuration does not require any configuration of the servlet cont
Most of the time, though, you'll probably want to run the app from within your IDE.
The mechanics of doing this will vary by IDE; see the xref:../dg/dg.adoc#_dg_ide[Developers' Guide] for details of setting up Eclipse or IntelliJ IDEA.
-Basically, though, it amounts to running `org.apache.isis.WebServer`, and ensuring that the xref:../ugfun/ugfun.adoc#_ugfun_getting-started_datanucleus-enhancer[DataNucleus enhancer] has properly processed all domain entities.
+Basically, though, it amounts to running `org.apache.isis.WebServer`, and ensuring that the xref:../dg/dg.adoc#_dg_hints-and-tips_datanucleus-enhancer[DataNucleus enhancer] has properly processed all domain entities.
Here's what the setup looks like in IntelliJ IDEA:
image::{_imagesdir}getting-started/helloworld.png[width="600px",link="{_imagesdir}getting-started/helloworld.png"]
-with the maven goal to run the DataNucleus enhancer (discussed in more detail xref:ugfun.adoc#_ugfun_getting-started_datanucleus-enhancer[here]) before launch defined as:
+with the maven goal to run the DataNucleus enhancer (discussed in more detail xref:../dg/dg.adoc#_dg_hints-and-tips_datanucleus-enhancer[here]) before launch defined as:
image::{_imagesdir}getting-started/helloworld-before-launch.png[width="600px",link="{_imagesdir}getting-started/helloworld-before-launch.png"]
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_getting-started_simpleapp-archetype.adoc b/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_getting-started_simpleapp-archetype.adoc
index c0a935f..9fbdc13 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_getting-started_simpleapp-archetype.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugfun/_ugfun_getting-started_simpleapp-archetype.adoc
@@ -10,15 +10,15 @@ Like the xref:ugfun.adoc#_ugfun_getting-started_helloworld-archetype[helloworld
However, the generated application also provides more structure to assist you as your application grows.
+We'll talk more about the structure of the generated app xref:ugfun.adoc#__ugfun_getting-started_simpleapp-archetype_structure-of-the-app[below], but for now let's see how to generate the application.
+
+
[TIP]
====
The (non-ASF) Incode Platform's link:http://platform.incode.org/quickstart/quickstart.html[quickstart archetype] builds upon the simpleapp archetype, but also adds in support for various Incode Platform modules such as security, auditing, commands and publishing.
====
-We'll talk more about the structure of the generated app xref:ugfun.adoc#__ugfun_getting-started_simpleapp-archetype_structure-of-the-app[below], but for now let's see how to generate the application.
-
-
[[__ugfun_getting-started_simpleapp-archetype_generating-the-app]]
== Generating the App
@@ -456,7 +456,7 @@ The files in `src/main/jettyconsole` provide a splash image (if not run in headl
+
This uses the Dockerfile residing in `docker/Dockerfile` (under `src/main/resources`).
-* also, the xref:../rgmvn.adoc#[Apache Isis Maven plugin] is also configured to generate a xref:../rgmvn/rgmvn.adoc#_rgmvn_swagger[swagger] spec file for the entire application, in the `xxx-webapp` module
+* also, the xref:../rgmvn/rgmvn.adoc#[Apache Isis Maven plugin] is also configured to generate a xref:../rgmvn/rgmvn.adoc#_rgmvn_swagger[swagger] spec file for the entire application, in the `xxx-webapp` module
Now you know your way around the code generated by the archetype, lets see how to build the app and run it.
@@ -559,13 +559,13 @@ Once more, see link:https://github.com/danhaywood/java-mavenmixin-docker#how-to-
Most of the time, though, you'll probably want to run the app from within your IDE.
The mechanics of doing this will vary by IDE; see the xref:../dg/dg.adoc#_dg_ide[Developers' Guide] for details of setting up Eclipse or IntelliJ IDEA.
-Basically, though, it amounts to running `org.apache.isis.WebServer`, and ensuring that the xref:../ugfun/ugfun.adoc#_ugfun_getting-started_datanucleus-enhancer[DataNucleus enhancer] has properly processed all domain entities.
+Basically, though, it amounts to running `org.apache.isis.WebServer`, and ensuring that the xref:../dg/dg.adoc#_dg_hints-and-tips_datanucleus-enhancer[DataNucleus enhancer] has properly processed all domain entities.
Here's what the setup looks like in IntelliJ IDEA:
image::{_imagesdir}getting-started/simpleapp-webapp.png[width="600px",link="{_imagesdir}getting-started/simpleapp-webapp.png"]
-with the maven goal to run the DataNucleus enhancer (discussed in more detail xref:ugfun.adoc#_ugfun_getting-started_datanucleus-enhancer[here]) before launch defined as:
+with the maven goal to run the DataNucleus enhancer (discussed in more detail xref:../dg/dg.adoc#_dg_hints-and-tips_datanucleus-enhancer[here]) before launch defined as:
image::{_imagesdir}getting-started/simpleapp-webapp-before-launch.png[width="600px",link="{_imagesdir}getting-started/simpleapp-webapp-before-launch.png"]
@@ -658,3 +658,5 @@ The intention is not to showcase all of Apache Isis' capabilities; rather it is
If you run into issues, please don't hesitate to ask for help on the link:http://isis.apache.org/help.html[users mailing list].
+
+
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugfun/ugfun.adoc b/adocs/documentation/src/main/asciidoc/guides/ugfun/ugfun.adoc
index 5ad57f5..5ceb088 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugfun/ugfun.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugfun/ugfun.adoc
@@ -52,7 +52,9 @@ include::_ugfun_core-concepts.adoc[leveloffset=+1]
include::_ugfun_building-blocks.adoc[leveloffset=+1]
-include::_ugfun_getting-started.adoc[leveloffset=+1]
+include::_ugfun_getting-started_helloworld-archetype.adoc[leveloffset=+1]
+
+include::_ugfun_getting-started_simpleapp-archetype.adoc[leveloffset=+1]
include::_ugfun_programming-model.adoc[leveloffset=+1]
include::_ugfun_ui-hints.adoc[leveloffset=+1]
--
To stop receiving notification emails like this one, please contact
"commits@isis.apache.org" <co...@isis.apache.org>.