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 2018/08/22 11:34:25 UTC
[isis] branch maint-2.0.0-M1 updated: ISIS-1810: doc updates
This is an automated email from the ASF dual-hosted git repository.
danhaywood pushed a commit to branch maint-2.0.0-M1
in repository https://gitbox.apache.org/repos/asf/isis.git
The following commit(s) were added to refs/heads/maint-2.0.0-M1 by this push:
new 968814d ISIS-1810: doc updates
968814d is described below
commit 968814d0a3893f9199738eda6f3386e7c0ae1341
Author: danhaywood <da...@haywood-associates.co.uk>
AuthorDate: Wed Aug 22 12:34:11 2018 +0100
ISIS-1810: doc updates
---
.travis.yml | 6 -
.../src/main/asciidoc/documentation.adoc | 37 ++-
.../src/main/asciidoc/guides/ad/ad.adoc | 364 +++++++++++++++++++++
core/webdocker/pom.xml | 1 -
4 files changed, 386 insertions(+), 22 deletions(-)
diff --git a/.travis.yml b/.travis.yml
deleted file mode 100644
index ae5c5a7..0000000
--- a/.travis.yml
+++ /dev/null
@@ -1,6 +0,0 @@
-language: java
-jdk:
- - oraclejdk8
-install:
- -
-script: "mvn clean install -Dskip.app -Dskip.arch"
diff --git a/adocs/documentation/src/main/asciidoc/documentation.adoc b/adocs/documentation/src/main/asciidoc/documentation.adoc
index d514a1b..12304ae 100644
--- a/adocs/documentation/src/main/asciidoc/documentation.adoc
+++ b/adocs/documentation/src/main/asciidoc/documentation.adoc
@@ -8,7 +8,7 @@
[.documentation-page]
--
-[cols="1a,1a,1a",frame="none", grid="none"]
+[cols="1a,1a,1a",frame="none", grid="none", stripe="none"]
|===
| *What is Apache Isis?*
@@ -16,7 +16,7 @@
* *link:pages/isis-in-pictures/isis-in-pictures.html[Apache Isis in pictures^]*
* link:pages/common-use-cases/common-use-cases.html[Common Use Cases^]
* link:pages/how-isis-works/how-isis-works.html[How Apache Isis Works^] image:{_imagesdir}tv_show-25.png[width="25px" link="pages/how-isis-works/how-isis-works.html"]
-* Learning more: link:pages/screencasts/screencasts.html[Screencasts^] image:{_imagesdir}tv_show-25.png[width="25px" link="./pages/screencasts/screencasts.html"] + link:pages/tg/tg.html[Tutorials^]
+* Learning more: link:pages/screencasts/screencasts.html[Screencasts^] image:{_imagesdir}tv_show-25.png[width="25px" link="./pages/screencasts/screencasts.html"] & link:pages/tg/tg.html[Tutorials^]
|*Releases:*
@@ -26,17 +26,17 @@
|*Developer Resources:*
-* *link:pages/cheat-sheet/cheat-sheet.html[Cheat Sheet^]* + *link:guides/htg.html[Hints-n-Tips^]*
-* Getting started: link:guides/ugfun/ugfun.html#_ugfun_getting-started_helloworld-archetype[Hello-World archetype^]
-* Getting started+: link:guides/ugfun/ugfun.html#_ugfun_getting-started_simpleapp-archetype[Simple-App archetype^]
+* *link:pages/cheat-sheet/cheat-sheet.html[Cheat Sheet^]* & *link:guides/htg.html[Hints-n-Tips^]*
+* link:guides/ugfun/ugfun.html#_ugfun_getting-started_helloworld-archetype[Hello-World archetype^]
+* link:guides/ugfun/ugfun.html#_ugfun_getting-started_simpleapp-archetype[Simple-App archetype^]
* How to get link:pages/icons/icons.html[Icons^]
-* Extension modules: http://platform.incode.org[Incode Platform^] footnoteref:[ASF,Not an Apache Software Foundation project.]
+* Extension modules: http://platform.incode.org[Incode Platform^] footnoteref:[ASF, Not Apache Software Foundation projects.]
|===
***
-[cols="1a,1a,1a",frame="none", grid="none"]
+[cols="1a,1a,1a",frame="none", grid="none", stripes="none"]
|===
|*User Guides:*
@@ -64,14 +64,15 @@
|*Get involved!*
* *link:guides/dg/dg.html[Developers' Guide^]*
-** link:guides/dg/dg.html#_dg_ide_intellij[IntelliJ^] + link:guides/dg/dg.html#_dg_ide_eclipse[Eclipse^]
+** link:guides/dg/dg.html#_dg_ide_intellij[IntelliJ^] & link:guides/dg/dg.html#_dg_ide_eclipse[Eclipse^]
** link:guides/dg/dg.html#_dg_contributing[Pull requests^]
-** link:guides/dg/dg.html#_dg_asciidoc-syntax[Asciidoc syntax^]
* link:guides/cgcom/cgcom.html[Committers' Guide^]
-** link:guides/cgcom/cgcom.html#_cgcom_cutting-a-release[Cutting^] + link:guides/cgcom/cgcom.html#_cgcom_verifying-releases[Verifying^]
+** link:guides/cgcom/cgcom.html#_cgcom_cutting-a-release[Cutting^] & link:guides/cgcom/cgcom.html#_cgcom_verifying-releases[Verifying^]
-* For bug-reports and feature-requests see: *link:https://issues.apache.org/jira/secure/RapidBoard.jspa?rapidView=87[Kanban board^]* (JIRA)
+* link:guides/ad/ad.html[Architecture & Design^]
+
+3+|For bug reports and feature requests see: *link:https://issues.apache.org/jira/secure/RapidBoard.jspa?rapidView=87[Kanban board^]* (JIRA)
|===
@@ -79,7 +80,7 @@
***
-[cols="1a,1a,1a",frame="none", grid="none"]
+[cols="1a,1a,1a",frame="none", grid="none", stripes="none"]
|===
@@ -97,13 +98,19 @@
|*Example Apps:*
* https://github.com/estatio/estatio[Estatio^] footnoteref:[ASF,Not an Apache Software Foundation project.]
+* https://github.com/incodehq/contactapp[ContactApp^] footnoteref:[ASF]
+* https://github.com/incodehq/ecpcrm[ECP CRM^] footnoteref:[ASF]
* https://github.com/isisaddons/isis-app-todoapp[TodoApp^] footnoteref:[ASF]
* https://github.com/isisaddons/isis-app-kitchensink[Kitchensink^] footnoteref:[ASF]
-* https://github.com/isisaddons/isis-app-neoapp[Neo4J Example^] footnoteref:[ASF]
+* https://github.com/incodehq/incode-examples[Incode Domain Examples^] footnoteref:[ASF]
+* https://github.com/incodehq/incode-camel[Incode Camel App^] footnoteref:[ASF]
* https://github.com/isisaddons/isis-app-quickstart[Quickstart^] footnoteref:[ASF]
-* https://github.com/isisaddons/isis-app-simpledsl[Isis DSL Example^] footnoteref:[ASF]
-* https://github.com/andi-huber/isis-2-demo[Demo Showcase]footnoteref:[ASF]
+* https://github.com/andi-huber/isis-2-demo[Isis 2.x Demo Showcase]footnoteref:[ASF]
+*Experiments:*
+
+* https://github.com/isisaddons/isis-app-neoapp[Neo4J Example^] footnoteref:[ASF]
+* https://github.com/isisaddons/isis-app-simpledsl[Isis DSL Example^] footnoteref:[ASF]
|====
diff --git a/adocs/documentation/src/main/asciidoc/guides/ad/ad.adoc b/adocs/documentation/src/main/asciidoc/guides/ad/ad.adoc
new file mode 100644
index 0000000..90aa712
--- /dev/null
+++ b/adocs/documentation/src/main/asciidoc/guides/ad/ad.adoc
@@ -0,0 +1,364 @@
+[[ad]]
+= Architecture and Design
+: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/
+:numbered:
+:generate_pdf:
+
+
+This guide describes the internal architecture and design of the framework.
+
+[[__ad_modules]]
+== Maven modules
+
+[monotree]
+----
+> adocs/
+>> documentation/
+>> template/
+> core/ # see 'core', below
+> example/ # see 'archetypes', below
+> scripts/
+----
+
+
+=== core
+
+The core modules ....
+
+All of these have the same Maven `groupId`, namely `org.apache.isis.core`.
+
+[monotree]
+----
+> core/
+>> .m2/ # used in gitlab CI
+>> applib/ # isis-core-applib
+>> commons/ # isis-core-commons
+>> integtestsupport/ # isis-core-integtestsupport
+>> legacy/ # legacy, see below
+>> log4j/ # isis-core-log4j
+>> maven-plugin/ # see 'maven plugins', below
+>> mavendeps/ # see 'mavendeps', below
+>> plugins/ # see 'plugins', below
+>> runtime/ # isis-core-runtime
+>> schema/ # isis-core-schema
+>> security/ # isis-core-security
+>> security-shiro/ # isis-core-security-shiro
+>> specsupport/ # isis-core-specsupport
+>> unittestsupport/ # isis-core-unittestsupport
+>> unittestsupport-test/ # isis-core-unittestsupport-test
+>> viewer-restfulobjects-applib/ # isis-core-viewer-restfulobjects-applib
+>> viewer-restfulobjects-rendering/ # isis-core-viewer-restfulobjects-rendering
+>> viewer-restfulobjects-server/ # isis-core-viewer-restfulobjects-server
+>> viewer-wicket-applib/ # isis-core-viewer-wicket-applib
+>> viewer-wicket-impl/ # isis-core-viewer-wicket-impl
+>> viewer-wicket-model/ # isis-core-viewer-wicket-model
+>> viewer-wicket-ui/ # isis-core-viewer-wicket-ui
+>> webdocker/ # isis-webdocker
+>> webserver/ # isis-core-webserver
+>> wrapper/ # isis-core-wrapper
+----
+
+.core maven modules
+[cols="2a,4a", options="header"]
+|===
+
+| Module
+| Description
+
+| `isis-core-applib`
+| Core application library.
+
+| `isis-core-commons`
+| Commons library
+
+
+| `isis-core-integtestsupport`
+|
+
+| `isis-core-log4j`
+|
+
+| `isis-maven-plugin`
+|
+
+| `isis-core-metamodel`
+|
+
+| `isis-core-runtime`
+|
+
+| `isis-core-schema`
+|
+
+| `isis-core-security`
+|
+
+| `isis-core-security-shiro`
+|
+
+| `isis-core-specsupport`
+|
+
+| `isis-core-unittestsupport`
+|
+
+| `isis-core-unittestsupport-test`
+|
+
+| `isis-core-viewer-restfulobjects-applib`
+|
+
+| `isis-core-viewer-restfulobjects-rendering`
+|
+
+| `isis-core-viewer-restfulobjects-server`
+|
+
+| `isis-core-viewer-wicket-applib`
+|
+
+| `isis-core-viewer-wicket-impl`
+|
+
+| `isis-core-viewer-wicket-model`
+|
+
+| `isis-core-viewer-wicket-ui`
+|
+
+| `isis-webdocker`
+|
+
+| `isis-core-webserver`
+|
+
+| `isis-core-wrapper`
+|
+
+
+|===
+
+
+=== core/plugins
+
+The `core/plugins` modules ...
+
+All of these have the same Maven `groupId`, namely `org.apache.isis.core`.
+
+.Plugin Modules
+[monotree]
+----
+> core/
+>> plugins/
+>>> codegen-bytebuddy/ # isis-core-plugins-codegen-bytebuddy
+>>> codegen-javassist/ # isis-core-plugins-codegen-javassist
+>>> discovery-reflections/ # isis-core-plugins-discovery-reflections
+>>> eventbus-axon/ # isis-core-plugins-eventbus-axon
+>>> eventbus-guava/ # isis-core-plugins-eventbus-guava
+>>> jaxrs-resteasy-3/ # isis-core-plugins-jaxrs-resteasy-3
+>>> jaxrs-resteasy-4/ # isis-core-plugins-jaxrs-resteasy-4
+>>> jdo-datanucleus-4/ # isis-core-plugins-jdo-datanucleus-4
+>>> jdo-datanucleus-5/ # isis-core-plugins-jdo-datanucleus-5
+----
+
+.core/mavendeps maven modules
+[cols="2a,4a", options="header"]
+|===
+
+| Module
+| Description
+| `isis-core-plugins-codegen-bytebuddy`
+|
+
+| `isis-core-plugins-codegen-javassist`
+|
+
+| `isis-core-plugins-discovery-reflections`
+|
+
+| `isis-core-plugins-eventbus-axon`
+|
+
+| `isis-core-plugins-eventbus-guava`
+|
+
+| `isis-core-plugins-jaxrs-resteasy-3`
+|
+
+| `isis-core-plugins-jaxrs-resteasy-4`
+|
+
+| `isis-core-plugins-jdo-datanucleus-4`
+|
+
+| `isis-core-plugins-jdo-datanucleus-5`
+|
+
+|===
+
+
+=== core/mavendeps
+
+The `core/mavendeps` modules ...
+
+All of these have the same Maven `groupId`, namely `org.apache.isis.mavendeps`.
+
+.mavendeps Modules
+[monotree]
+----
+> core
+>> mavendeps/
+>>> isis-mavendeps-intellij/ # isis-mavendeps-intellij
+>>> isis-mavendeps-testing/ # isis-mavendeps-testing
+>>> isis-mavendeps-webapp/ # isis-mavendeps-webapp
+----
+
+.core/mavendeps maven modules
+[cols="2a,4a", options="header"]
+|===
+
+| Module
+| Description
+
+| `isis-mavendeps-intellij`
+| Defunct.
+
+| `isis-mavendeps-testing`
+|
+
+| `isis-mavendeps-webapp`
+|
+
+|===
+
+
+
+=== core/legacy
+
+The `core/legacy` modules ...
+
+All of these have the same Maven `groupId`, namely `org.apache.isis.core`.
+
+.Legacy Modules
+[monotree]
+----
+> core/
+>> legacy/
+>>> applib-legacy/ # isis-core-applib-legacy
+>>> integtestsupport-legacy/ # isis-core-integtestsupport-legacy
+>>> metamodel-legacy/ # isis-core-metamodel-legacy
+>>> runtime-legacy/ # isis-core-runtime-legacy
+>>> transition-1-2/ # isis-core-transition-1-2
+>>> unittestsupport-legacy/ # isis-core-unittestsupport-legacy
+>>> viewer-wicket-ui-legacy/ # isis-core-viewer-wicket-ui-legacy
+----
+
+
+[cols="2a,4a", options="header"]
+|===
+
+| Module
+| Description
+
+
+| `isis-core-applib-legacy`
+|
+
+| `isis-core-integtestsupport-legacy`
+|
+
+| `isis-core-metamodel-legacy`
+|
+
+| `isis-core-runtime-legacy`
+|
+
+| `isis-core-transition-1-2`
+|
+
+| `isis-core-unittestsupport-legacy`
+|
+
+| `isis-core-viewer-wicket-ui-legacy`
+|
+
+|===
+
+
+=== core/mavenplugins
+
+There is a single Maven plugin module.
+Its Maven `groupId` is `org.apache.isis.tools`.
+
+.Plugin Modules
+[monotree]
+----
+> core/
+>> maven-plugin/ # isis-maven-plugin
+----
+
+
+[cols="2a,4a", options="header"]
+|===
+| Module
+| Description
+
+| `isis-maven-plugin`
+|
+
+
+|===
+
+
+
+=== archetypes
+
+[monotree]
+----
+> example/
+>> application/
+>>> helloworld/ # org.apache.isis.example.application:helloworld
+>>> simpleapp/ # org.apache.isis.example.application:simpleapp
+>>>> application/ # org.apache.isis.example.application:simpleapp-application
+>>>> module-simple/ # org.apache.isis.example.application:simpleapp-module-simple
+>>>> webapp/ # org.apache.isis.example.application:simpleapp-webapp
+>> archetype/
+>>> helloworld/ # org.apache.isis.archetype:helloworld-archetype
+>>> simpleapp/ # org.apache.isis.archetype:simpleapp-archetype
+----
+
+[cols="2a,4a", options="header"]
+|===
+| Module
+| Description
+
+| `helloworld`
+|
+
+| `simpleapp`
+|
+
+| `simpleapp-application`
+|
+
+| `simpleapp-module-simple`
+|
+
+| `simpleapp-webapp`
+|
+
+| `helloworld-archetype`
+|
+
+| `simpleapp-archetype`
+|
+
+|===
+
+
+
+[[__ad_plugins]]
+== Plugins
+
diff --git a/core/webdocker/pom.xml b/core/webdocker/pom.xml
index 3a93733..19e5366 100644
--- a/core/webdocker/pom.xml
+++ b/core/webdocker/pom.xml
@@ -27,7 +27,6 @@
<version>${revision}</version>
</parent>
- <groupId>org.apache.isis.core</groupId>
<artifactId>isis-webdocker</artifactId>
<name>Apache Isis WebDocker</name>