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 2019/09/09 21:42:41 UTC
[isis] 10/11: ISIS-2062: moves simpleapp into its own Antora cpt.
This is an automated email from the ASF dual-hosted git repository.
danhaywood pushed a commit to branch v2-antora
in repository https://gitbox.apache.org/repos/asf/isis.git
commit 32a3f037582dc8a0a0e12bde9265ba6b70dc7da7
Author: Dan Haywood <da...@apache.org>
AuthorDate: Thu Aug 22 13:51:10 2019 +0100
ISIS-2062: moves simpleapp into its own Antora cpt.
Moves files, updates site.yml, updates references.
---
antora/components/arch/modules/ROOT/nav.adoc | 2 --
.../components/arch/modules/ROOT/pages/about.adoc | 37 ----------------------
.../arch/modules/simpleapp/_attributes.adoc | 6 ----
.../arch/modules/simpleapp/pages/_attributes.adoc | 4 ---
.../simpleapp/pages/_partials/_attributes.adoc | 4 ---
.../downloads/modules/ROOT/pages/about.adoc | 2 +-
.../modules/cfg/pages/specifying-components.adoc | 2 +-
.../pages/classes/AppManifest-bootstrapping.adoc | 2 +-
antora/components/rg/modules/mvn/pages/intro.adoc | 4 +--
.../components/rg/modules/mvn/pages/validate.adoc | 2 +-
.../FixtureScriptsSpecificationProvider.adoc | 2 +-
.../modules/cgcom/pages/verifying-releases.adoc | 2 +-
.../pages/hints-and-tips/datanucleus-enhancer.adoc | 4 +--
.../dg/pages/hints-and-tips/enabling-logging.adoc | 2 +-
.../how-run-fixtures-on-app-startup.adoc | 2 +-
.../support/modules/dg/pages/ide/eclipse.adoc | 4 +--
antora/components/toc/modules/ROOT/nav.adoc | 2 +-
.../components/toc/modules/ROOT/pages/about.adoc | 2 +-
.../ROOT/pages/more-thanks/more-thanks.adoc | 2 +-
.../what-is-apache-isis/common-use-cases.adoc | 2 +-
.../what-is-apache-isis/screencasts-older.adoc | 4 +--
.../pages/what-is-apache-isis/screencasts.adoc | 2 +-
.../ug/modules/btb/pages/deployment/neo4j.adoc | 4 +--
antora/components/ug/modules/btb/pages/i18n.adoc | 2 +-
.../fun/pages/programming-model/properties.adoc | 2 +-
.../disabling-persistence-by-reachability.adoc | 2 +-
.../odn/pages/configuring/persistence-xml.adoc | 2 +-
antora/components/ug/modules/sec/pages/about.adoc | 2 +-
.../sec/pages/configuring-isis-to-use-shiro.adoc | 2 +-
.../shiro-realm-implementations/ini-realm.adoc | 2 +-
.../bdd-spec-support/maven-configuration.adoc | 2 +-
.../pages/bdd-spec-support/writing-a-bdd-spec.adoc | 4 +--
.../tst/pages/fixture-scripts/api-and-usage.adoc | 10 +++---
.../pages/integ-test-support/bootstrapping.adoc | 2 +-
.../integ-test-support/maven-configuration.adoc | 6 ++--
.../unit-test-support/maven-configuration.adoc | 6 ++--
.../ug/modules/vw/pages/layout/file-based.adoc | 2 +-
.../helloworld/doc/modules/ROOT/pages/about.adoc | 4 +--
site.yml | 12 +++----
39 files changed, 54 insertions(+), 107 deletions(-)
diff --git a/antora/components/arch/modules/ROOT/nav.adoc b/antora/components/arch/modules/ROOT/nav.adoc
deleted file mode 100644
index 8f86ccd..0000000
--- a/antora/components/arch/modules/ROOT/nav.adoc
+++ /dev/null
@@ -1,2 +0,0 @@
-* xref:about.adoc[Prerequisites]
-
diff --git a/antora/components/arch/modules/ROOT/pages/about.adoc b/antora/components/arch/modules/ROOT/pages/about.adoc
deleted file mode 100644
index f52368d..0000000
--- a/antora/components/arch/modules/ROOT/pages/about.adoc
+++ /dev/null
@@ -1,37 +0,0 @@
-= Maven Archetypes
-include::_attributes.adoc[]
-
-Apache Isis provides two different Maven archetypes to use as a "quick start" for your applications.
-
-* the xref:helloworld:ROOT:about.adoc[helloworld] archetype is a single Maven module that contains the absolute minimum; there are not tests or fixture scripts, just a single entity and domain service
-
-* the xref:arch:simpleapp:about.adoc[simpleapp] archetype is similar to "helloworld", however it provides more structure and guidance:
-
-** it is broken up into several Maven modules, separating out the bootstrapping code from the domain logic.
-** it contains examples of unit tests, integration tests and BDD (cucumber) specs.
-
-+
-The simpleapp archetype's functionality is still minimal though: just a single entity, a domain service and a home page.
-
-Follow the links above for more details on getting started with these archetypes.
-
-
-== Prerequisites
-
-Apache Isis is a Java based framework, so in terms of prerequisites, you'll need to install:
-
-* Java 8 JDK
-* link:http://maven.apache.org[Apache Maven] 3.5+
-
-You'll probably also want to use an IDE; the Apache Isis committers use either IntelliJ or Eclipse; in the xref:support:dg:ide.adoc[Developers' Guide] we have detailed setup instructions for using these two IDEs.
-If you're a NetBeans user you should have no problems as it too has strong support for Maven.
-
-When building and running within an IDE, you'll also need to configure the Datanucleus enhancer.
-This is implemented as a Maven plugin, so in the case of IntelliJ, it's easy enough to run the enhancer as required.
-It should be just as straightforward for NetBeans too.
-
-For Eclipse the maven integration story is a little less refined.
-All is not lost, however; DataNucleus also has an implementation of the enhancer as an Eclipse plugin, which usually works well enough.
-
-
-
diff --git a/antora/components/arch/modules/simpleapp/_attributes.adoc b/antora/components/arch/modules/simpleapp/_attributes.adoc
deleted file mode 100644
index 787e5c4..0000000
--- a/antora/components/arch/modules/simpleapp/_attributes.adoc
+++ /dev/null
@@ -1,6 +0,0 @@
-ifndef::env-site,env-github[]
-:attachmentsdir: {moduledir}/assets/attachments
-:examplesdir: {moduledir}/examples
-:imagesdir: {moduledir}/assets/images
-:partialsdir: {moduledir}/pages/_partials
-endif::[]
diff --git a/antora/components/arch/modules/simpleapp/pages/_attributes.adoc b/antora/components/arch/modules/simpleapp/pages/_attributes.adoc
deleted file mode 100644
index e8ada7c..0000000
--- a/antora/components/arch/modules/simpleapp/pages/_attributes.adoc
+++ /dev/null
@@ -1,4 +0,0 @@
-ifndef::env-site,env-github[]
-:moduledir: ..
-include::{moduledir}/_attributes.adoc[]
-endif::[]
diff --git a/antora/components/arch/modules/simpleapp/pages/_partials/_attributes.adoc b/antora/components/arch/modules/simpleapp/pages/_partials/_attributes.adoc
deleted file mode 100644
index d011536..0000000
--- a/antora/components/arch/modules/simpleapp/pages/_partials/_attributes.adoc
+++ /dev/null
@@ -1,4 +0,0 @@
-ifndef::env-site,env-github[]
-:moduledir: ../..
-include::{moduledir}/_attributes.adoc[]
-endif::[]
diff --git a/antora/components/downloads/modules/ROOT/pages/about.adoc b/antora/components/downloads/modules/ROOT/pages/about.adoc
index 2c461ff..b539c0b 100644
--- a/antora/components/downloads/modules/ROOT/pages/about.adoc
+++ b/antora/components/downloads/modules/ROOT/pages/about.adoc
@@ -13,7 +13,7 @@ Use for prototyping or production.
== Getting Started
-If you just want to get going quickly, we suggest using our xref:arch:simpleapp:about.adoc[Maven archetype].
+If you just want to get going quickly, we suggest using our xref:simpleapp:ROOT:about.adoc[Maven archetype].
diff --git a/antora/components/rg/modules/cfg/pages/specifying-components.adoc b/antora/components/rg/modules/cfg/pages/specifying-components.adoc
index fc1b341..e8c5052 100644
--- a/antora/components/rg/modules/cfg/pages/specifying-components.adoc
+++ b/antora/components/rg/modules/cfg/pages/specifying-components.adoc
@@ -29,7 +29,7 @@ To specify the `AppManifest` as a configuration property, use:
|`o.a.i.applib.AppManifest` +
By convention this implementation resides in an `myapp-app` Maven module (as opposed to `myapp-dom` or `myapp-fixture`).
-See the xref:arch:simpleapp:about.adoc[SimpleApp archetype] for details.
+See the xref:simpleapp:ROOT:about.adoc[SimpleApp archetype] for details.
|===
diff --git a/antora/components/rg/modules/cms/pages/classes/AppManifest-bootstrapping.adoc b/antora/components/rg/modules/cms/pages/classes/AppManifest-bootstrapping.adoc
index 16917e7..4559da3 100644
--- a/antora/components/rg/modules/cms/pages/classes/AppManifest-bootstrapping.adoc
+++ b/antora/components/rg/modules/cms/pages/classes/AppManifest-bootstrapping.adoc
@@ -255,7 +255,7 @@ In other words these describe how the application chooses to configure the frame
+
The classic example here is the JDBC URL.
-For example, the xref:arch:simpleapp:about.adoc[SimpleApp archetype]'s `AppManifest` is defined as:
+For example, the xref:simpleapp:ROOT:about.adoc[SimpleApp archetype]'s `AppManifest` is defined as:
[source,java]
----
diff --git a/antora/components/rg/modules/mvn/pages/intro.adoc b/antora/components/rg/modules/mvn/pages/intro.adoc
index f0856cd..967043d 100644
--- a/antora/components/rg/modules/mvn/pages/intro.adoc
+++ b/antora/components/rg/modules/mvn/pages/intro.adoc
@@ -36,7 +36,7 @@ As noted in the introduction, all the goals require an xref:rg:cms:classes/AppMa
This can be extremely minimal; it isn't necessary to use the main `AppManifest` (in the `app` module) used to bootstrap the application, you can instead use a cut-down one.
This then allows the plugins to be run during the build of the `dom` module, rather than having to run in the context of the `integtest` module.
-For example, the xref:arch:simpleapp:about.adoc[SimpleApp]'s
+For example, the xref:simpleapp:ROOT:about.adoc[SimpleApp]'s
manifest is:
[source,java]
@@ -82,6 +82,6 @@ We recommend the following:
* run the `xsd` plugin in a new `xsd` submodule; contributed actions are irrelevant for this particular goal; having a separate submodule allows the configuration of both the `xsd` goal (to generate the XSD schemas) and any other XSD-related configuration to be kept in a single place.
-The xref:arch:simpleapp:about.adoc[SimpleApp archetype] reflects these recommendations for the `validate` and `swagger` goals.
+The xref:simpleapp:ROOT:about.adoc[SimpleApp archetype] reflects these recommendations for the `validate` and `swagger` goals.
You can find an example of the `xsd` plugin in the (non-ASF) http://github.com/isisaddons/isis-app-todoapp[Isis addons' todoapp] application.
diff --git a/antora/components/rg/modules/mvn/pages/validate.adoc b/antora/components/rg/modules/mvn/pages/validate.adoc
index 9d58f50..036fc11 100644
--- a/antora/components/rg/modules/mvn/pages/validate.adoc
+++ b/antora/components/rg/modules/mvn/pages/validate.adoc
@@ -106,7 +106,7 @@ mvn test -Dskip.isis-validate
== Example of failure
-In the xref:arch:simpleapp:about.adoc[SimpleApp] application the `SimpleObject` defines an `updateName` action.
+In the xref:simpleapp:ROOT:about.adoc[SimpleApp] application the `SimpleObject` defines an `updateName` action.
This has a supporting method:
diff --git a/antora/components/rg/modules/svc/pages/testing/FixtureScriptsSpecificationProvider.adoc b/antora/components/rg/modules/svc/pages/testing/FixtureScriptsSpecificationProvider.adoc
index 1c04299..94e0074 100644
--- a/antora/components/rg/modules/svc/pages/testing/FixtureScriptsSpecificationProvider.adoc
+++ b/antora/components/rg/modules/svc/pages/testing/FixtureScriptsSpecificationProvider.adoc
@@ -49,7 +49,7 @@ The class is immutable but it has a builder (obtained using `FixturescriptsSpeci
== Implementation
-The xref:arch:simpleapp:about.adoc[SimpleApp archetype] has a simple implementation of this service:
+The xref:simpleapp:ROOT:about.adoc[SimpleApp archetype] has a simple implementation of this service:
[source,java]
----
diff --git a/antora/components/support/modules/cgcom/pages/verifying-releases.adoc b/antora/components/support/modules/cgcom/pages/verifying-releases.adoc
index 7bb2890..7bfc8c4 100644
--- a/antora/components/support/modules/cgcom/pages/verifying-releases.adoc
+++ b/antora/components/support/modules/cgcom/pages/verifying-releases.adoc
@@ -131,7 +131,7 @@ Alternatively, you can xref:support:cgcom:verifying-releases.adoc#casting-a-vote
== (Optional) 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 xref:helloworld:ROOT:about.adoc[HelloWorld archetype] or the xref:arch:simpleapp:about.adoc[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:helloworld:ROOT:about.adoc[HelloWorld archetype] or the xref:simpleapp:ROOT:about.adoc[SimpleApp archetype] and running the resultant app.
Configuring your local Maven install amounts to updating the `~/.m2/settings.xml` file:
diff --git a/antora/components/support/modules/dg/pages/hints-and-tips/datanucleus-enhancer.adoc b/antora/components/support/modules/dg/pages/hints-and-tips/datanucleus-enhancer.adoc
index 1a27c8e..f35c40b 100644
--- a/antora/components/support/modules/dg/pages/hints-and-tips/datanucleus-enhancer.adoc
+++ b/antora/components/support/modules/dg/pages/hints-and-tips/datanucleus-enhancer.adoc
@@ -18,7 +18,7 @@ What this means is that the enhancer -- available as both a Maven plugin and as
If working from the Maven command line, JDO enhancement is done using the `maven-datanucleus-plugin`.
-Both the xref:helloworld:ROOT:about.adoc[HelloWorld] and xref:arch:simpleapp:about.adoc[SimpleApp] Maven archetypes generate applications that have this plugin pre-configured.
+Both the xref:helloworld:ROOT:about.adoc[HelloWorld] and xref:simpleapp:ROOT:about.adoc[SimpleApp] Maven archetypes generate applications that have this plugin pre-configured.
@@ -39,7 +39,7 @@ It's also a good idea to ensure that every domain module(s) containing entities
----
<1> change as required; typically is the name of the domain module.
-Again, the applications generated by both the xref:helloworld:ROOT:about.adoc[HelloWorld] and xref:arch:simpleapp:about.adoc[Simpleapp] Maven archetypes do this.
+Again, the applications generated by both the xref:helloworld:ROOT:about.adoc[HelloWorld] and xref:simpleapp:ROOT:about.adoc[Simpleapp] Maven archetypes do this.
[WARNING]
diff --git a/antora/components/support/modules/dg/pages/hints-and-tips/enabling-logging.adoc b/antora/components/support/modules/dg/pages/hints-and-tips/enabling-logging.adoc
index 8e27049..1253f78 100644
--- a/antora/components/support/modules/dg/pages/hints-and-tips/enabling-logging.adoc
+++ b/antora/components/support/modules/dg/pages/hints-and-tips/enabling-logging.adoc
@@ -16,7 +16,7 @@ As per the http://www.datanucleus.org/products/accessplatform/logging.html[DN lo
* In the JDBC Driver +
+
Configure `log4jdbc` JDBC rather than the vanilla driver (see `WEB-INF/persistor_datanucleus.properties`) and configure log4j logging (see `WEB-INF/logging.properties`).
-There are examples of both in the xref:arch:simpleapp:about.adoc[SimpleApp archetype].
+There are examples of both in the xref:simpleapp:ROOT:about.adoc[SimpleApp archetype].
* In the database +
+
diff --git a/antora/components/support/modules/dg/pages/hints-and-tips/how-run-fixtures-on-app-startup.adoc b/antora/components/support/modules/dg/pages/hints-and-tips/how-run-fixtures-on-app-startup.adoc
index 5682c25..ba6e001 100644
--- a/antora/components/support/modules/dg/pages/hints-and-tips/how-run-fixtures-on-app-startup.adoc
+++ b/antora/components/support/modules/dg/pages/hints-and-tips/how-run-fixtures-on-app-startup.adoc
@@ -12,7 +12,7 @@ Use events?_
The standard approach is to use xref:ug:tst:fixture-scripts.adoc[fixture scripts].
-These can be run in on start-up typically by being specified in the xref:rg:cms:classes/AppManifest-bootstrapping.adoc[`AppManifest`], see for example the xref:arch:simpleapp:about.adoc[SimpleApp archetype].
+These can be run in on start-up typically by being specified in the xref:rg:cms:classes/AppManifest-bootstrapping.adoc[`AppManifest`], see for example the xref:simpleapp:ROOT:about.adoc[SimpleApp archetype].
Alternatively just set `isis.fixtures` and `isis.persistor.datanucleus.install-fixtures` properties.
diff --git a/antora/components/support/modules/dg/pages/ide/eclipse.adoc b/antora/components/support/modules/dg/pages/ide/eclipse.adoc
index b0b5f5b..f13ab32 100644
--- a/antora/components/support/modules/dg/pages/ide/eclipse.adoc
+++ b/antora/components/support/modules/dg/pages/ide/eclipse.adoc
@@ -36,7 +36,7 @@ To install, download each XML file, then go to `Windows > Preferences > Java > E
== Install Project Lombok
-The xref:arch:simpleapp:about.adoc[SimpleApp archetype] uses link:http://projectlombok.org[Project Lombok] annotations (`@Getter` and `@Setter` and so on) to reduce the boilerplate.
+The xref:simpleapp:ROOT:about.adoc[SimpleApp archetype] uses link:http://projectlombok.org[Project Lombok] annotations (`@Getter` and `@Setter` and so on) to reduce the boilerplate.
For Eclipse IDE this requires an link:https://projectlombok.org/setup/eclipse[installation step]:
* Locate the `lombok.jar` jar file:
@@ -118,7 +118,7 @@ DataNucleus' enhancer uses the domain object model's own classpath to reference
So, even though your domain objects are unlikely to depend on DataNucleus, these references must still be present.
See the section in xref:support:dg:hints-and-tips/datanucleus-enhancer.adoc[DataNucleus enhancer] for details of the contents of the `pom.xml`.
-Chances are it is already set up from running the xref:helloworld:ROOT:about.adoc[HelloWorld] or the xref:arch:simpleapp:about.adoc[SimpleApp] archetype.
+Chances are it is already set up from running the xref:helloworld:ROOT:about.adoc[HelloWorld] or the xref:simpleapp:ROOT:about.adoc[SimpleApp] archetype.
Then, tell DataNucleus to use the project classpath:
diff --git a/antora/components/toc/modules/ROOT/nav.adoc b/antora/components/toc/modules/ROOT/nav.adoc
index da91efd..62757a7 100644
--- a/antora/components/toc/modules/ROOT/nav.adoc
+++ b/antora/components/toc/modules/ROOT/nav.adoc
@@ -8,7 +8,7 @@
* Getting Started
** xref:helloworld:ROOT:about.adoc[HelloWorld archetype]
-** xref:arch:simpleapp:about.adoc[SimpleApp archetype]
+** xref:simpleapp:ROOT:about.adoc[SimpleApp archetype]
** link:https://danhaywood.gitlab.io/isis-petclinic-tutorial-docs/petclinic/1.16.2/intro.html[Petclinic Tutorial]
diff --git a/antora/components/toc/modules/ROOT/pages/about.adoc b/antora/components/toc/modules/ROOT/pages/about.adoc
index f43fe1d..1d553ce 100644
--- a/antora/components/toc/modules/ROOT/pages/about.adoc
+++ b/antora/components/toc/modules/ROOT/pages/about.adoc
@@ -17,7 +17,7 @@ include::_attributes.adoc[]
| *Starter Apps*
* xref:helloworld:ROOT:about.adoc[HelloWorld]
-* xref:arch:simpleapp:about.adoc[SimpleApp]
+* xref:simpleapp:ROOT:about.adoc[SimpleApp]
*Learning by Example*
diff --git a/antora/components/toc/modules/ROOT/pages/more-thanks/more-thanks.adoc b/antora/components/toc/modules/ROOT/pages/more-thanks/more-thanks.adoc
index d61b1fd..aee3937 100644
--- a/antora/components/toc/modules/ROOT/pages/more-thanks/more-thanks.adoc
+++ b/antora/components/toc/modules/ROOT/pages/more-thanks/more-thanks.adoc
@@ -24,7 +24,7 @@ In addition to the http://www.apache.org/foundation/thanks.html[support given to
|image::more-thanks/icons8-logo.png[link="http://icons8.com"]
-|Icons8, for selected icons on this website and in the link:https://github.com/apache/isis/tree/master/example/application/simpleapp/dom/src/main/resources/images[simpleapp] used to generate the xref:arch:simpleapp:about.adoc[simpleapp archetype]
+|Icons8, for selected icons on this website and in the link:https://github.com/apache/isis/tree/master/example/application/simpleapp/dom/src/main/resources/images[simpleapp] used to generate the xref:simpleapp:ROOT:about.adoc[simpleapp archetype]
|===
diff --git a/antora/components/toc/modules/ROOT/pages/what-is-apache-isis/common-use-cases.adoc b/antora/components/toc/modules/ROOT/pages/what-is-apache-isis/common-use-cases.adoc
index 367bcca..37ac535 100644
--- a/antora/components/toc/modules/ROOT/pages/what-is-apache-isis/common-use-cases.adoc
+++ b/antora/components/toc/modules/ROOT/pages/what-is-apache-isis/common-use-cases.adoc
@@ -22,7 +22,7 @@ Once you've sketched out your domain model, you can then either start-over using
One of the original motivations for Apache Isis itself was to be able automatically generate a user interface for a domain object model.
Apache Isis' has a pluggable architecture allowing different user interface technologies.
- The principal implementation (as configured by the xref:arch:simpleapp:about.adoc[SimpleApp archetype]) is the xref:ug:vw:about.adoc[Wicket viewer].
+ The principal implementation (as configured by the xref:simpleapp:ROOT:about.adoc[SimpleApp archetype]) is the xref:ug:vw:about.adoc[Wicket viewer].
This provides an appealing default user interface, with the ability to customize the user interface by writing new http://wicket.apache.org[Apache Wicket] components.
Some third-party components can be found in the (non-ASF) link:http://platform.incode.org[Incode Platform^].
diff --git a/antora/components/toc/modules/ROOT/pages/what-is-apache-isis/screencasts-older.adoc b/antora/components/toc/modules/ROOT/pages/what-is-apache-isis/screencasts-older.adoc
index 196bda7..f51a330 100644
--- a/antora/components/toc/modules/ROOT/pages/what-is-apache-isis/screencasts-older.adoc
+++ b/antora/components/toc/modules/ROOT/pages/what-is-apache-isis/screencasts-older.adoc
@@ -81,7 +81,7 @@ Learn more xref:support:dg:ide/intellij.adoc[here]
|Commands and Auditing (v1.6.0) +
-_Configuring the command and auditing add-on modules for the xref:arch:simpleapp:about.adoc[SimpleApp]._ +
+_Configuring the command and auditing add-on modules for the xref:simpleapp:ROOT:about.adoc[SimpleApp]._ +
Learn more at the (non-ASF) link:http://platform.incode.org[Incode Platform^]'s command and audit SPI modules
@@ -90,7 +90,7 @@ Learn more at the (non-ASF) link:http://platform.incode.org[Incode Platform^]'s
|Security (v1.6.0) +
-_Configuring the security add-on module for for the xref:arch:simpleapp:about.adoc[SimpleApp]._ +
+_Configuring the security add-on module for for the xref:simpleapp:ROOT:about.adoc[SimpleApp]._ +
Learn more at the (non-ASF) link:http://platform.incode.org[Incode Platform^]'s security SPI module.
diff --git a/antora/components/toc/modules/ROOT/pages/what-is-apache-isis/screencasts.adoc b/antora/components/toc/modules/ROOT/pages/what-is-apache-isis/screencasts.adoc
index 088a56a..430acf9 100644
--- a/antora/components/toc/modules/ROOT/pages/what-is-apache-isis/screencasts.adoc
+++ b/antora/components/toc/modules/ROOT/pages/what-is-apache-isis/screencasts.adoc
@@ -45,7 +45,7 @@ Searching and using the Apache Isis docs
|link:https://www.youtube.com/watch?v=OTNHR5EdAs8[001^] +
-Generating an app using the xref:arch:simpleapp:about.adoc[SimpleApp archetype]
+Generating an app using the xref:simpleapp:ROOT:about.adoc[SimpleApp archetype]
|x||||||||||
diff --git a/antora/components/ug/modules/btb/pages/deployment/neo4j.adoc b/antora/components/ug/modules/btb/pages/deployment/neo4j.adoc
index 8506647..7a2dcf3 100644
--- a/antora/components/ug/modules/btb/pages/deployment/neo4j.adoc
+++ b/antora/components/ug/modules/btb/pages/deployment/neo4j.adoc
@@ -44,14 +44,14 @@ Add the following dependency to the `webapp` project's `pom.xml`:
<1> for Isis v1.9.0, use the value shown.
For Isis v1.8.0, use 3.2.3.
-In the xref:arch:simpleapp:about.adoc[SimpleApp archetype] this is defined under the "neo4j" profile so can be activated using `-P neo4j`.
+In the xref:simpleapp:ROOT:about.adoc[SimpleApp archetype] this is defined under the "neo4j" profile so can be activated using `-P neo4j`.
== Try it out!
If you want to quickly try out neo4j for yourself:
-* run the xref:arch:simpleapp:about.adoc[SimpleApp archetype] (v1.8.0)
+* run the xref:simpleapp:ROOT:about.adoc[SimpleApp archetype] (v1.8.0)
* build the app:
diff --git a/antora/components/ug/modules/btb/pages/i18n.adoc b/antora/components/ug/modules/btb/pages/i18n.adoc
index 30d52f9..35c849a 100644
--- a/antora/components/ug/modules/btb/pages/i18n.adoc
+++ b/antora/components/ug/modules/btb/pages/i18n.adoc
@@ -127,7 +127,7 @@ Moreover, these messages must be captured in the `.pot` file such that they can
The first part of the puzzle is tackled by an extension to Apache Isis' programming model.
Whereas previously the `disableXxx()` / `validateXxx()` / `title()` methods could only return a `java.lang.String`, they may now optionally return a `TranslatableString` (defined in Isis applib) instead.
-Here's a (silly) example from the xref:arch:simpleapp:about.adoc[SimpleApp archetype]:
+Here's a (silly) example from the xref:simpleapp:ROOT:about.adoc[SimpleApp archetype]:
[source,java]
----
diff --git a/antora/components/ug/modules/fun/pages/programming-model/properties.adoc b/antora/components/ug/modules/fun/pages/programming-model/properties.adoc
index f0374cd..7bd64b7 100644
--- a/antora/components/ug/modules/fun/pages/programming-model/properties.adoc
+++ b/antora/components/ug/modules/fun/pages/programming-model/properties.adoc
@@ -25,7 +25,7 @@ It's also possible (using annotations) to define a link table to hold foreign ke
Apache Isis recognises some of these annotations for JDO/DataNucleus and JAXB and infers some domain semantics from them (for example, the maximum allowable length of a string property).
Since writing getter and setter methods adds quite a bit of boilerplate, it's common to use link:https://projectlombok.org/[Project Lombok] to code generate these methods at compile time (using Java's annotation processor) simply by adding the `@lombok.Getter` and `@lombok.Setter` annotations to the field.
-The xref:helloworld:ROOT:about.adoc[HelloWorld] and xref:arch:simpleapp:about.adoc[SimpleApp] archetypes use this approach.
+The xref:helloworld:ROOT:about.adoc[HelloWorld] and xref:simpleapp:ROOT:about.adoc[SimpleApp] archetypes use this approach.
== Value vs Reference Types
diff --git a/antora/components/ug/modules/odn/pages/configuring/disabling-persistence-by-reachability.adoc b/antora/components/ug/modules/odn/pages/configuring/disabling-persistence-by-reachability.adoc
index d99e391..ae3c8d6 100644
--- a/antora/components/ug/modules/odn/pages/configuring/disabling-persistence-by-reachability.adoc
+++ b/antora/components/ug/modules/odn/pages/configuring/disabling-persistence-by-reachability.adoc
@@ -26,7 +26,7 @@ We therefore recommend that you disable persistence-by-reachability by adding th
isis.persistor.datanucleus.impl.datanucleus.persistenceByReachabilityAtCommit=false
----
-This change has been made to both the xref:helloworld:ROOT:about.adoc[HelloWorld] and xref:arch:simpleapp:about.adoc[SimpleApp] archetypes.
+This change has been made to both the xref:helloworld:ROOT:about.adoc[HelloWorld] and xref:simpleapp:ROOT:about.adoc[SimpleApp] archetypes.
If you do disable this feature, then you will (of course) need to ensure that you explicitly persist all entities using the `RepositoryService#persist(.)` or `RepositoryService#persistAndFlush(.)` methods.
diff --git a/antora/components/ug/modules/odn/pages/configuring/persistence-xml.adoc b/antora/components/ug/modules/odn/pages/configuring/persistence-xml.adoc
index 6229bbf..370004b 100644
--- a/antora/components/ug/modules/odn/pages/configuring/persistence-xml.adoc
+++ b/antora/components/ug/modules/odn/pages/configuring/persistence-xml.adoc
@@ -8,7 +8,7 @@ DataNucleus will for itself also and read the `META-INF/persistence.xml`.
In theory it can hold mappings and even connection strings.
However, with Apache Isis we tend to use annotations instead and externalize connection strings. so its definition is extremely simply, specifying just the name of the "persistence unit".
-Here's the one provided by the xref:arch:simpleapp:about.adoc[SimpleApp archetype]:
+Here's the one provided by the xref:simpleapp:ROOT:about.adoc[SimpleApp archetype]:
[source,xml]
----
diff --git a/antora/components/ug/modules/sec/pages/about.adoc b/antora/components/ug/modules/sec/pages/about.adoc
index 13f472b..61099bd 100644
--- a/antora/components/ug/modules/sec/pages/about.adoc
+++ b/antora/components/ug/modules/sec/pages/about.adoc
@@ -25,7 +25,7 @@ Isis provides an API for both authentication and authorization, and provides an
Shiro in turn uses the concept of a _realm_ as a source for both authentication and optionally authorization.
Shiro ships with a simple text-based realm -- the `IniRealm` -- which reads users (and password), user roles and role permissions from the `WEB-INF/shiro.ini` file.
-The xref:helloworld:ROOT:about.adoc[HelloWorld] and xref:arch:simpleapp:about.adoc[SimpleApp] archetypes are both configured to use this realm.
+The xref:helloworld:ROOT:about.adoc[HelloWorld] and xref:simpleapp:ROOT:about.adoc[SimpleApp] archetypes are both configured to use this realm.
Shiro also ships with an implementation of an LDAP-based realm; LDAP is often used to manage user/passwords and corresponding user groups.
Apache Isis in turn extends this with its `IsisLdapRealm`, which provides more flexibility for both group/role and role/permissions management.
diff --git a/antora/components/ug/modules/sec/pages/configuring-isis-to-use-shiro.adoc b/antora/components/ug/modules/sec/pages/configuring-isis-to-use-shiro.adoc
index 7748260..0872287 100644
--- a/antora/components/ug/modules/sec/pages/configuring-isis-to-use-shiro.adoc
+++ b/antora/components/ug/modules/sec/pages/configuring-isis-to-use-shiro.adoc
@@ -8,7 +8,7 @@ The Shiro security mechanism is an integration wih Apache Shiro that implements
[TIP]
====
-Both the xref:helloworld:ROOT:about.adoc[HelloWorld] and xref:arch:simpleapp:about.adoc[SimpleApp] archetypes are pre-configured to use Apache Shiro, so much of what follows may well have been set up already.
+Both the xref:helloworld:ROOT:about.adoc[HelloWorld] and xref:simpleapp:ROOT:about.adoc[SimpleApp] archetypes are pre-configured to use Apache Shiro, so much of what follows may well have been set up already.
====
diff --git a/antora/components/ug/modules/sec/pages/shiro-realm-implementations/ini-realm.adoc b/antora/components/ug/modules/sec/pages/shiro-realm-implementations/ini-realm.adoc
index b014f62..5d10030 100644
--- a/antora/components/ug/modules/sec/pages/shiro-realm-implementations/ini-realm.adoc
+++ b/antora/components/ug/modules/sec/pages/shiro-realm-implementations/ini-realm.adoc
@@ -7,7 +7,7 @@ Probably the simplest realm to use is Shiro's built-in `IniRealm`, which reads f
This is suitable for prototyping, but isn't intended for production use, if only because user/password credentials are stored in plain text.
Nevertheless, it's a good starting point.
-The app generated by both the xref:helloworld:ROOT:about.adoc[HelloWorld] and xref:arch:simpleapp:about.adoc[SimpleApp] archetypes are configured to use this realm.
+The app generated by both the xref:helloworld:ROOT:about.adoc[HelloWorld] and xref:simpleapp:ROOT:about.adoc[SimpleApp] archetypes are configured to use this realm.
The diagram below shows the Isis and components involved:
diff --git a/antora/components/ug/modules/tst/pages/bdd-spec-support/maven-configuration.adoc b/antora/components/ug/modules/tst/pages/bdd-spec-support/maven-configuration.adoc
index b0535de..b623270 100644
--- a/antora/components/ug/modules/tst/pages/bdd-spec-support/maven-configuration.adoc
+++ b/antora/components/ug/modules/tst/pages/bdd-spec-support/maven-configuration.adoc
@@ -5,7 +5,7 @@ include::_attributes.adoc[]
-Apache Isis' BDD spec support is automatically configured if you use the xref:arch:simpleapp:about.adoc[SimpleApp archetype].
+Apache Isis' BDD spec support is automatically configured if you use the xref:simpleapp:ROOT:about.adoc[SimpleApp archetype].
To set it up manually, update the `pom.xml` of your domain object model module:
[source,xml]
diff --git a/antora/components/ug/modules/tst/pages/bdd-spec-support/writing-a-bdd-spec.adoc b/antora/components/ug/modules/tst/pages/bdd-spec-support/writing-a-bdd-spec.adoc
index 1489db7..294bd65 100644
--- a/antora/components/ug/modules/tst/pages/bdd-spec-support/writing-a-bdd-spec.adoc
+++ b/antora/components/ug/modules/tst/pages/bdd-spec-support/writing-a-bdd-spec.adoc
@@ -25,7 +25,7 @@ The `glue` attribute of the Cucumber-JVM JUnit runner allows you to indicate whi
There also needs to be one glue class that is used to bootstrap the runtime.
-Here's an example of a feature from the xref:arch:simpleapp:about.adoc[SimpleApp archetype]:
+Here's an example of a feature from the xref:simpleapp:ROOT:about.adoc[SimpleApp archetype]:
[source,java]
----
@@ -68,7 +68,7 @@ public class RunBddSpecs {
----
The JSON formatter allows integration with enhanced reports.
-(Commented out) configuration for this is provided in the xref:arch:simpleapp:about.adoc[SimpleApp archetype].
+(Commented out) configuration for this is provided in the xref:simpleapp:ROOT:about.adoc[SimpleApp archetype].
The bootstrapping of Apache Isis itself lives in a `BootstrappingGlue` step definition:
diff --git a/antora/components/ug/modules/tst/pages/fixture-scripts/api-and-usage.adoc b/antora/components/ug/modules/tst/pages/fixture-scripts/api-and-usage.adoc
index 391dfe4..45b9f5e 100644
--- a/antora/components/ug/modules/tst/pages/fixture-scripts/api-and-usage.adoc
+++ b/antora/components/ug/modules/tst/pages/fixture-scripts/api-and-usage.adoc
@@ -19,7 +19,7 @@ This is annotated to be rendered on the secondary "Prototyping" menu.
The behaviour of this domain menu service can be refined by providing an implementation of the optional xref:rg:svc:testing/FixtureScriptsSpecificationProvider.adoc[`FixtureScriptsSpecificationProvider`] SPI.
-For example, here's the `FixtureScriptsSpecificationProvider` service that's generated by the xref:arch:simpleapp:about.adoc[SimpleApp archetype]:
+For example, here's the `FixtureScriptsSpecificationProvider` service that's generated by the xref:simpleapp:ROOT:about.adoc[SimpleApp archetype]:
[source,java]
----
@@ -70,7 +70,7 @@ If you had defined many fixture scripts then a drop-down might become unwieldy,
----
-You are free, of course, to add additional "convenience" actions into it if you wish for the most commonly used/demo'd setups ; you'll find that the xref:arch:simpleapp:about.adoc[SimpleApp archetype] adds this additional action:
+You are free, of course, to add additional "convenience" actions into it if you wish for the most commonly used/demo'd setups ; you'll find that the xref:simpleapp:ROOT:about.adoc[SimpleApp archetype] adds this additional action:
[source,java]
----
@@ -99,7 +99,7 @@ However, we strongly recommend that you use it to invoke actions on business obj
That way, the fixture script will remain valid even if the underlying implementation of the system changes in the future.
For example, here's a fixture script called `RecreateSimpleObjects`.
-(This used to be part of the xref:arch:simpleapp:about.adoc[SimpleApp archetype], though the archetype now ships with a more sophisticated design, discussed below):
+(This used to be part of the xref:simpleapp:ROOT:about.adoc[SimpleApp archetype], though the archetype now ships with a more sophisticated design, discussed below):
[source,java]
----
@@ -168,7 +168,7 @@ So, in this case, when the fixture script is executed we actually get 6 objects
Fixture scripts can be called from integration tests just the same way that fixture scripts can call one another.
-For example, here's an integration test from the xref:arch:simpleapp:about.adoc[SimpleApp archetype]:
+For example, here's an integration test from the xref:simpleapp:ROOT:about.adoc[SimpleApp archetype]:
[source,java]
----
@@ -250,7 +250,7 @@ public interface PersonaWithFinder<T> {
}
----
-The xref:arch:simpleapp:about.adoc[SimpleApp archetype] provides a sample implementation of these interfaces:
+The xref:simpleapp:ROOT:about.adoc[SimpleApp archetype] provides a sample implementation of these interfaces:
[source,java]
----
diff --git a/antora/components/ug/modules/tst/pages/integ-test-support/bootstrapping.adoc b/antora/components/ug/modules/tst/pages/integ-test-support/bootstrapping.adoc
index 72cf12c..cb74bc3 100644
--- a/antora/components/ug/modules/tst/pages/integ-test-support/bootstrapping.adoc
+++ b/antora/components/ug/modules/tst/pages/integ-test-support/bootstrapping.adoc
@@ -9,7 +9,7 @@ Because (depending on the size of your app) it takes a little time to bootstrap
The recommended way to bootstrapping of integration tests is done using a xref:rg:cms:classes/AppManifest2-bootstrapping.adoc[`Module`] implementation, along with the `IntegrationTestAbstract3` superclass.
-For example, the xref:arch:simpleapp:about.adoc[SimpleApp archetype]'s integration tests all inherit from this class:
+For example, the xref:simpleapp:ROOT:about.adoc[SimpleApp archetype]'s integration tests all inherit from this class:
[source,java]
----
diff --git a/antora/components/ug/modules/tst/pages/integ-test-support/maven-configuration.adoc b/antora/components/ug/modules/tst/pages/integ-test-support/maven-configuration.adoc
index 4208eb3..8fd33d2 100644
--- a/antora/components/ug/modules/tst/pages/integ-test-support/maven-configuration.adoc
+++ b/antora/components/ug/modules/tst/pages/integ-test-support/maven-configuration.adoc
@@ -3,7 +3,7 @@
include::_attributes.adoc[]
-Apache Isis' integration test support is automatically configured if you use the xref:arch:simpleapp:about.adoc[SimpleApp archetype].
+Apache Isis' integration test support is automatically configured if you use the xref:simpleapp:ROOT:about.adoc[SimpleApp archetype].
To set it up manually, update the `pom.xml` of your domain object model module:
[source,xml]
@@ -20,7 +20,7 @@ To set it up manually, update the `pom.xml` of your domain object model module:
[NOTE]
====
-This can also be done by adding a dependency to `org.apache.isis.mavendeps:isis-mavendeps-testing` module; see the xref:arch:simpleapp:about.adoc[SimpleApp archetype].
+This can also be done by adding a dependency to `org.apache.isis.mavendeps:isis-mavendeps-testing` module; see the xref:simpleapp:ROOT:about.adoc[SimpleApp archetype].
====
We also recommend that you configure the `maven-surefire-plugin` to pick up the following class patterns:
@@ -51,5 +51,5 @@ We also recommend that you configure the `maven-surefire-plugin` to pick up the
[NOTE]
====
-This can also be done using mavenmixins; see the xref:arch:simpleapp:about.adoc[SimpleApp archetype].
+This can also be done using mavenmixins; see the xref:simpleapp:ROOT:about.adoc[SimpleApp archetype].
====
diff --git a/antora/components/ug/modules/tst/pages/unit-test-support/maven-configuration.adoc b/antora/components/ug/modules/tst/pages/unit-test-support/maven-configuration.adoc
index 0b82f00..ff8d074 100644
--- a/antora/components/ug/modules/tst/pages/unit-test-support/maven-configuration.adoc
+++ b/antora/components/ug/modules/tst/pages/unit-test-support/maven-configuration.adoc
@@ -3,7 +3,7 @@
include::_attributes.adoc[]
-Apache Isis' unit test support is automatically configured if you use the xref:helloworld:ROOT:about.adoc[HelloWorld] or the xref:arch:simpleapp:about.adoc[SimpleApp] archetypes.
+Apache Isis' unit test support is automatically configured if you use the xref:helloworld:ROOT:about.adoc[HelloWorld] or the xref:simpleapp:ROOT:about.adoc[SimpleApp] archetypes.
To set it up manually, update the `pom.xml` of your domain object model module:
[source,xml]
@@ -19,7 +19,7 @@ To set it up manually, update the `pom.xml` of your domain object model module:
[NOTE]
====
-This can also be done by adding a dependency to `org.apache.isis.mavendeps:isis-mavendeps-testing` module; see the xref:arch:simpleapp:about.adoc[SimpleApp archetype].
+This can also be done by adding a dependency to `org.apache.isis.mavendeps:isis-mavendeps-testing` module; see the xref:simpleapp:ROOT:about.adoc[SimpleApp archetype].
====
@@ -51,5 +51,5 @@ We also recommend that you configure the `maven-surefire-plugin` to pick up the
[NOTE]
====
-This can also be done using mavenmixins; see the xref:arch:simpleapp:about.adoc[SimpleApp archetype].
+This can also be done using mavenmixins; see the xref:simpleapp:ROOT:about.adoc[SimpleApp archetype].
====
diff --git a/antora/components/ug/modules/vw/pages/layout/file-based.adoc b/antora/components/ug/modules/vw/pages/layout/file-based.adoc
index 5fb7f19..eafaed3 100644
--- a/antora/components/ug/modules/vw/pages/layout/file-based.adoc
+++ b/antora/components/ug/modules/vw/pages/layout/file-based.adoc
@@ -458,7 +458,7 @@ Ensure the following is defined in the dom project's `pom.xml`:
</resources>
----
-If using an Apache Isis xref:helloworld:ROOT:about.adoc[HelloWorld] xref:arch:simpleapp:about.adoc[SimpleApp] archetypes, then the POM is already correctly configured.
+If using an Apache Isis xref:helloworld:ROOT:about.adoc[HelloWorld] xref:simpleapp:ROOT:about.adoc[SimpleApp] archetypes, then the POM is already correctly configured.
diff --git a/examples/apps/helloworld/doc/modules/ROOT/pages/about.adoc b/examples/apps/helloworld/doc/modules/ROOT/pages/about.adoc
index 52b4a02..c2881e5 100644
--- a/examples/apps/helloworld/doc/modules/ROOT/pages/about.adoc
+++ b/examples/apps/helloworld/doc/modules/ROOT/pages/about.adoc
@@ -10,7 +10,7 @@ Both the business logic and supporting bootstrapping classes are in a single Mav
[TIP]
====
We don't recommend that you use the helloworld archetype as the basis for your own applications.
-Instead, use the xref:arch:simpleapp:about.adoc[simpleapp archetype].
+Instead, use the xref:simpleapp:ROOT:about.adoc[simpleapp archetype].
This also creates a minimal application, but provides more structure and example tests, useful as you build out your own app.
====
@@ -526,7 +526,7 @@ If you run into issues, please don't hesitate to ask for help on the link:http:/
When you are ready to start working on your own app, we _don't_ recommend building on top of the helloworld app.
-Instead, we suggest that you start with the xref:arch:simpleapp:about.adoc[simpleapp archetype] instead.
+Instead, we suggest that you start with the xref:simpleapp:ROOT:about.adoc[simpleapp archetype] instead.
Although a little more complex, it provides more structure and tests, all of which will help you as your application grows.
diff --git a/site.yml b/site.yml
index e0755a9..196b492 100644
--- a/site.yml
+++ b/site.yml
@@ -11,18 +11,18 @@ content:
- url: .
branches: HEAD
start_path: antora/components/rg
-# - url: .
-# start_path: examples/apps/helloworld/doc
-# branches: HEAD
- url: .
+ start_path: examples/apps/helloworld/doc
branches: HEAD
- start_path: antora/components/extensions
- url: .
+ start_path: examples/apps/simpleapp/doc
branches: HEAD
- start_path: antora/components/demoapp
- url: .
branches: HEAD
- start_path: antora/components/arch
+ start_path: antora/components/extensions
+ - url: .
+ branches: HEAD
+ start_path: antora/components/demoapp
- url: .
branches: HEAD
start_path: antora/components/downloads