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 2020/01/29 14:43:48 UTC
[isis] 07/19: ISIS-2062: docs
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 6acf019ee45a82fea79bae8031bbe594e4562c01
Author: danhaywood <da...@haywood-associates.co.uk>
AuthorDate: Tue Jan 28 18:42:23 2020 +0000
ISIS-2062: docs
---
.../components/toc/modules/ROOT/pages/about.adoc | 2 +-
.../ROOT/pages/landing-page/quick-start.adoc | 47 ----------------------
.../modules/ROOT/pages/landing-page/releases.adoc | 2 +-
.../modules/ROOT/pages/landing-page/support.adoc | 2 +-
antora/supplemental-ui/index.html | 2 +-
starters/adoc/modules/ROOT/pages/about.adoc | 46 +++++++++++++++++----
6 files changed, 43 insertions(+), 58 deletions(-)
diff --git a/antora/components/toc/modules/ROOT/pages/about.adoc b/antora/components/toc/modules/ROOT/pages/about.adoc
index 30ced5c..0db1dd1 100644
--- a/antora/components/toc/modules/ROOT/pages/about.adoc
+++ b/antora/components/toc/modules/ROOT/pages/about.adoc
@@ -19,7 +19,7 @@
|
[discrete]
-== xref:starters:ROOT:about.adoc[Starter Apps]
+== Starter Apps
* xref:starters:helloworld:about.adoc[Hello World]
* xref:starters:simpleapp:about.adoc[SimpleApp]
diff --git a/antora/components/toc/modules/ROOT/pages/landing-page/quick-start.adoc b/antora/components/toc/modules/ROOT/pages/landing-page/quick-start.adoc
deleted file mode 100644
index 7643cca..0000000
--- a/antora/components/toc/modules/ROOT/pages/landing-page/quick-start.adoc
+++ /dev/null
@@ -1,47 +0,0 @@
-= Quick Start
-: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 [...]
-
-To get started with a new application, use one of the two git repos on Github that provide a starter app.
-
-== HelloWorld
-
-The helloworld app is very minimal app, intended just as a starting point to learn what the framework is all about.
-
-include::starters:helloworld:page$script.adoc[]
-
-
-Notes:
-
-* more on the structure of the Hello World app can be found xref:starters:helloworld:about.adoc[here]
-* the source code can be found in this link:https://github.com/apache/isis-app-helloworld[git repo]
-
-
-
-== Simple App
-
-This app has the same functionality as _HelloWorld_, but is structured so it can be used as a starting point for developing your own applications.
-
-include::starters:simpleapp:page$script.adoc[]
-
-It also includes some xref:testing:integtestsupport:about.adoc[integration tests], xref:testing:fixtures:about.adoc[fixtures], and xref:testing:specsupport[BDD (Cucumber)] specs.
-
-Notes:
-
-* more on the structure of the Simple App app can be found xref:starters:simpleapp:about.adoc[here]
-* the source code can be found in this link:https://github.com/apache/isis-app-simpleapp[git repo]
-
-
-== Updating to Newer Versions
-
-For both apps you can bump to newer versions of the framework just by updating the `<version>` of the `<parent>`:
-
-[source,bash]
-.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.
diff --git a/antora/components/toc/modules/ROOT/pages/landing-page/releases.adoc b/antora/components/toc/modules/ROOT/pages/landing-page/releases.adoc
index ff59da4..f09fd78 100644
--- a/antora/components/toc/modules/ROOT/pages/landing-page/releases.adoc
+++ b/antora/components/toc/modules/ROOT/pages/landing-page/releases.adoc
@@ -2,7 +2,7 @@
: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 [...]
-The easiest way to consume the framework is to use one of the xref:toc:ROOT:landing-page/quick-start.adoc[starter apps].
+The easiest way to consume the framework is to use one of the xref:starters:ROOT:about.adoc[starter apps].
Then, just update the `<version>` of the parent starter:
[source,xml]
diff --git a/antora/components/toc/modules/ROOT/pages/landing-page/support.adoc b/antora/components/toc/modules/ROOT/pages/landing-page/support.adoc
index 27b6df4..4aca004 100644
--- a/antora/components/toc/modules/ROOT/pages/landing-page/support.adoc
+++ b/antora/components/toc/modules/ROOT/pages/landing-page/support.adoc
@@ -27,7 +27,7 @@ Some other places that might be useful are:
[discrete]
== Releases
-It's usually easiest to work with the xref:toc:ROOT:landing-page/quick-start.adoc[quick start apps].
+It's usually easiest to work with the xref:starters:ROOT:about.adoc[starter apps].
But you can also download the framework and built it yourself:
* xref:toc:ROOT:downloads/how-to.adoc[Downloads]
diff --git a/antora/supplemental-ui/index.html b/antora/supplemental-ui/index.html
index dde9d77..a5b7879 100644
--- a/antora/supplemental-ui/index.html
+++ b/antora/supplemental-ui/index.html
@@ -100,7 +100,7 @@
<ul>
<li><a href="toc/about.html">Table of Contents</a></li>
<li><hr/></li>
- <li><a href="toc/landing-page/quick-start.html">Quick Start</a></li>
+ <li><a href="starters/about.html">Starter Apps</a></li>
<li><a href="toc/landing-page/guides.html">Guides</a></li>
<li><a href="toc/landing-page/components.html">Components</a></li>
<li><a href="toc/landing-page/releases.html">Releases</a></li>
diff --git a/starters/adoc/modules/ROOT/pages/about.adoc b/starters/adoc/modules/ROOT/pages/about.adoc
index 625d74c..78537f3 100644
--- a/starters/adoc/modules/ROOT/pages/about.adoc
+++ b/starters/adoc/modules/ROOT/pages/about.adoc
@@ -2,15 +2,47 @@
: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
+To get started with a new application, use one of the two git repos on Github that provide a starter app.
+== HelloWorld
-Starter Apps:
+The helloworld app is very minimal app, intended just as a starting point to learn what the framework is all about.
-* xref:starters:helloworld:about.adoc[Hello World]
-* xref:starters:simpleapp:about.adoc[SimpleApp]
+include::starters:helloworld:page$script.adoc[]
-Maven:
-* xref:starters:parent-pom:about.adoc[Parent POM]
-* xref:starters:mavendeps:about.adoc[Maven Deps]
+Notes:
+
+* more on the structure of the Hello World app can be found xref:starters:helloworld:about.adoc[here]
+* the source code can be found in this link:https://github.com/apache/isis-app-helloworld[git repo]
+
+
+
+== Simple App
+
+This app has the same functionality as _HelloWorld_, but is structured so it can be used as a starting point for developing your own applications.
+
+include::starters:simpleapp:page$script.adoc[]
+
+It also includes some xref:testing:integtestsupport:about.adoc[integration tests], xref:testing:fixtures:about.adoc[fixtures], and xref:testing:specsupport:about.adoc[BDD (Cucumber)] specs.
+
+Notes:
+
+* more on the structure of the Simple App app can be found xref:starters:simpleapp:about.adoc[here]
+* the source code can be found in this link:https://github.com/apache/isis-app-simpleapp[git repo]
+
+
+== Updating to Newer Versions
+
+For both apps you can bump to newer versions of the framework just by updating the `<version>` of the xref:starters:parent-pom:about.adoc[parent POM]:
+
+[source,bash]
+.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.