[isis] 15/19: ISIS-2062: docs

[da...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

danhaywood pushed a commit to branch ISIS-2062
in repository https://gitbox.apache.org/repos/asf/isis.git

commit 0dd7911f45ff5e6e121e145800a35d7585a0005c
Author: danhaywood <da...@haywood-associates.co.uk>
AuthorDate: Wed Jan 29 09:25:56 2020 +0000

    ISIS-2062: docs
---
 antora/supplemental-ui/css/site-custom.css         |   1 +
 .../modules/parent-pom/attachments/parent-pom.pptx | Bin 51655 -> 51613 bytes
 .../adoc/modules/parent-pom/images/parent-pom.png  | Bin 68515 -> 68900 bytes
 starters/adoc/modules/parent-pom/pages/about.adoc  |  54 ++++++++++++++++++++-
 4 files changed, 54 insertions(+), 1 deletion(-)

diff --git a/antora/supplemental-ui/css/site-custom.css b/antora/supplemental-ui/css/site-custom.css
index 9be8476..9c15656 100644
--- a/antora/supplemental-ui/css/site-custom.css
+++ b/antora/supplemental-ui/css/site-custom.css
@@ -17,3 +17,4 @@ div.paragraph code {
 .content .ulist .ulist ul {
     padding-left: 1rem;
 }
+
diff --git a/starters/adoc/modules/parent-pom/attachments/parent-pom.pptx b/starters/adoc/modules/parent-pom/attachments/parent-pom.pptx
index c664667..c424c3d 100644
Binary files a/starters/adoc/modules/parent-pom/attachments/parent-pom.pptx and b/starters/adoc/modules/parent-pom/attachments/parent-pom.pptx differ
diff --git a/starters/adoc/modules/parent-pom/images/parent-pom.png b/starters/adoc/modules/parent-pom/images/parent-pom.png
index da8feee..3794f7e 100644
Binary files a/starters/adoc/modules/parent-pom/images/parent-pom.png and b/starters/adoc/modules/parent-pom/images/parent-pom.png differ
diff --git a/starters/adoc/modules/parent-pom/pages/about.adoc b/starters/adoc/modules/parent-pom/pages/about.adoc
index 4dd7686..afa7c59 100644
--- a/starters/adoc/modules/parent-pom/pages/about.adoc
+++ b/starters/adoc/modules/parent-pom/pages/about.adoc
@@ -2,5 +2,57 @@
 :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 [...]
 
 
-TODO: to document
+The starter app parent POM is provided as a convenience to act as the `<parent>` for Apache Isis applications.
+It builds upon a similar POM provided by the Spring Boot framework, which ensures a consistent set of dependencies, as well as configuring various build plugins.
+
+To use it, just add:
+
+[source,xml]
+.pom.xml
+----
+<parent>
+    <groupId>org.apache.isis.app</groupId>
+    <artifactId>isis-app-starter-parent</artifactId>
+    <version>2.0.0</version>                            <!--1-->
+</parent>
+----
+<1> update as required for new versions of the framework.
+
+You'll see that it is used by both the xref:starters:helloworld:about.adoc[HelloWorld] and xref:starters:simpleapp:about.adoc[SimpleApp] starter apps.
+
+The link:{attachmentsdir}/parent-pom.pptx[diagram] below shows how the parent POM relates to other POMs:
+
+image::parent-pom.png[width="600px",link="{imagesdir}/parent-pom.png"]
+
+In more detail, the parent POM:
+
+* inherits from `org.springframework.boot:spring-boot-starter-parent`
++
+which configures various `<build>/<plugins>` and `<resources`>
+
+* transitively inherits from `org.springframework.boot:spring-boot-dependencies`
++
+which defines numerous `xxx.version` properties for various third party applications, and sets up corresponding `<dependencyManagement>/<dependencies>`.
+These have been validated as being compatible with each other by the Spring Boot team.
+
+* imports `org.apache.isis.core:isis` (using scope=import, type=pom)
++
+\... setting up `<dependencyManagement>/<dependencies>` entries for all of the core modules.
++
+TIP: The two core modules most commonly referenced in domain applications are `o.a.i.core:isis-applib` and `o.a.i.core:isis-schema`.
+
+* similarly imports `o.a.i.testing:isis-testing`, for the `isis-testing-xxx` modules
+
+* imports `o.a.i.extensions:isis-extensions`, for `isis-extension-xxx` modules
+
+* imports `o.a.i.subdomains:isis-subdomains`, for `isis-subdomain-xxx` modules
+
+* imports `o.a.i.mappings:isis-mappings`, for `isis-mappings-xxx` modules
+
+* imports `o.a.i.valuetypes:isis-valuetypes`, for `isis-valuetypes-xxx` modules
+
+* imports `o.a.i.incubator:isis-incubator`, for `isis-incubator-xxx` modules
+
+* imports `o.a.i.legacy:isis-legacy`, for `isis-legacy-xxx` modules
+