You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by ah...@apache.org on 2020/01/16 06:47:57 UTC
[isis] branch master updated: ISIS-2158: antora: updates link to
demo sources
This is an automated email from the ASF dual-hosted git repository.
ahuber pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/isis.git
The following commit(s) were added to refs/heads/master by this push:
new cdd7294 ISIS-2158: antora: updates link to demo sources
cdd7294 is described below
commit cdd7294108997cced073b96daace6ccaaa8fc7db
Author: Andi Huber <ah...@apache.org>
AuthorDate: Thu Jan 16 07:12:11 2020 +0100
ISIS-2158: antora: updates link to demo sources
also include demo's about.adoc with README
---
.../modules/mignotes/pages/migrating-to-2.0.0.adoc | 6 +-
examples/demo/README.adoc | 82 +---------------------
.../src/main/adoc/modules/ROOT/pages/about.adoc | 76 +++++++++++++++++++-
3 files changed, 80 insertions(+), 84 deletions(-)
diff --git a/antora/components/toc/modules/mignotes/pages/migrating-to-2.0.0.adoc b/antora/components/toc/modules/mignotes/pages/migrating-to-2.0.0.adoc
index eb2e4f5..1874a22 100644
--- a/antora/components/toc/modules/mignotes/pages/migrating-to-2.0.0.adoc
+++ b/antora/components/toc/modules/mignotes/pages/migrating-to-2.0.0.adoc
@@ -15,7 +15,7 @@ Search also for: "TODO: v2: " in the .adoc documentation.
=== Server-Sent-Event (SSE) Support (ISIS-2102)
-Experimental feature to allow for submission of background-tasks, that themselfes may fire UI-events to update eg. a progress-bar.
+Experimental feature to allow for submission of background-tasks, that themselves may fire UI-events to update eg. a progress-bar.
To make this work we introduce following components:
@@ -24,7 +24,7 @@ To make this work we introduce following components:
- An EventStreamSource interface for any designated background task to implement.
- An EventStreamService, that allows for such EventStreamSource objects to be submitted for execution on a thread-pool.
- An EventStreamSource is associated with an EventStream on which it may fire update events.
-- These update events are propagated to the SSE Servlet, which informs its listenening clients with the update event's payload data.
+- These update events are propagated to the SSE Servlet, which informs its listening clients with the update event's payload data.
A first prototypical implementation of this mechanism also introduces a programming model extension, which for now only works for 'Markup' properties.
@@ -212,7 +212,7 @@ tree.expand(TreePath.of(0)); // expand the root node
tree.expand(TreePath.of(0, 1)); // expand the second child of the root node
----
-A full example is showcased in the https://github.com/andi-huber/isis-2-demo/tree/master/src/main/java/domainapp/dom/tree[isis-2-demo] ...
+A full example is showcased in the https://github.com/apache/isis/tree/master/examples/demo/src/main/java/demoapp/dom/tree[isis-demo] ...
Implementation of `TreeAdapter`
diff --git a/examples/demo/README.adoc b/examples/demo/README.adoc
index 38439ac..dbc99b7 100644
--- a/examples/demo/README.adoc
+++ b/examples/demo/README.adoc
@@ -1,83 +1,5 @@
+:module_root: src/main/adoc/modules/ROOT
image:https://github.com/apache-isis-committers/isis-nightly/workflows/Nightly/badge.svg[link="https://github.com/apache-isis-committers/isis-nightly/actions?query=workflow%3A%22Nightly%22"]
-= Demo App
+\include::{module_root}/pages/about.adoc[]
-The Demo App is an introduction to the features and components available in Apache Isis.
-
-It allows you to learn the very basics and also to discover some of the more advanced features, the framework has to offer. See the Docker section below on how to get started.
-
-== Docker
-
-NOTE: Further on *<tag>* is used as a placeholder for the docker image tag of your choice. When omitted the latest version is used. Actual tag names might be changed without notice. Currently we have tag *nightly*. See https://hub.docker.com/r/apacheisis/demo-springboot/tags/[apacheisis/demo-springboot] (Docker-Hub)
-
-=== Prereqs
-
-Install https://www.docker.com/community-edition[Docker] on your computer.
-
-=== Pulling the Docker Image
-
-Pull the demo image using:
-
-[source]
-----
-docker pull apacheisis/demo-springboot:<tag>
-----
-
-=== Running the Docker Image
-
-Run the demo image using:
-
-[source]
-----
-docker run --name demo --detach -p8080:8080 apacheisis/demo-springboot:<tag>
-----
-
-This will start a new Docker container named 'demo'.
-
-The demo-app can then be accessed at http://localhost:8080/wicket/[].
-Login with `sven:pass`.
-
-To stop and remove the container named 'demo' use:
-
-[source]
-----
-docker stop demo && docker rm demo
-----
-
-=== Customization - ContextPath
-
-To run the _Demo App_ using a _context-path_, add an environment variable eg. `ContextPath=/demo`.
-
-[source]
-----
-docker run --name demo --detach -p8080:8080 -eContextPath=/demo apacheisis/demo-springboot:<tag>
-----
-
-=== Customization - Prototyping
-
-To run the _Demo App_ in _prototyping_ mode, add an environment variable `PROTOTYPING=true`.
-
-[source]
-----
-docker run --name demo --detach -p8080:8080 -ePROTOTYPING=true apacheisis/demo-springboot:<tag>
-----
-
-=== Customization - Attached Console
-
-To run the container with your console attached, replace the '--detach' argument with '-it'. (Use CTRL-C to stop and detach.)
-
-[source]
-----
-docker run --name demo -it -p8080:8080 apacheisis/demo-springboot:<tag>
-----
-
-== Contributing
-
-If you like to get involved quickly, please feel free to open new pull requests (at github) or just join the discussion and provide feedback.
-
-If you are interested in contributing to Apache Isis, see the https://isis.apache.org/guides/dg/dg.html[Developers' Guide] for details.
-
-== Credits
-
-This Demo App uses icons made by http://www.freepik.com[Freepik] and
- https://www.flaticon.com/authors/smashicons[Smashicons] from https://www.flaticon.com/[www.flaticon.com] which are licensed by http://creativecommons.org/licenses/by/3.0/[CC 3.0 BY]. We use https://github.com/vsch/flexmark-java[flexmark] for markdown rendering.
diff --git a/examples/demo/src/main/adoc/modules/ROOT/pages/about.adoc b/examples/demo/src/main/adoc/modules/ROOT/pages/about.adoc
index 3701a9d..2af50c9 100644
--- a/examples/demo/src/main/adoc/modules/ROOT/pages/about.adoc
+++ b/examples/demo/src/main/adoc/modules/ROOT/pages/about.adoc
@@ -1,7 +1,81 @@
= Demo
-CAUTION: TODO ... isis-2-demo
+The Demo provides an introduction to the features and components available in Apache Isis.
+It allows you to learn the very basics and also to discover some of the more advanced features, the framework has to offer. See the Docker section below on how to get started.
+
+== Getting Started (Docker)
+
+== Docker
+
+NOTE: Further on *<tag>* is used as a placeholder for the docker image tag of your choice. When omitted the latest version is used. Actual tag names might be changed without notice. Currently we have tag *nightly*. See https://hub.docker.com/r/apacheisis/demo-springboot/tags/[apacheisis/demo-springboot] (Docker-Hub)
+
+=== Prereqs
+
+Install https://www.docker.com/community-edition[Docker] on your computer.
+
+=== Pulling the Docker Image
+
+Pull the demo image using:
+
+[source]
+----
+docker pull apacheisis/demo-springboot:<tag>
+----
+
+=== Running the Docker Image
+
+Run the demo image using:
+
+[source]
+----
+docker run --name demo --detach -p8080:8080 apacheisis/demo-springboot:<tag>
+----
+
+This will start a new Docker container named 'demo'.
+
+The demo-app can then be accessed at http://localhost:8080/wicket/[].
+Login with `sven:pass`.
+
+To stop and remove the container named 'demo' use:
+
+[source]
+----
+docker stop demo && docker rm demo
+----
+
+=== Customization - ContextPath
+
+To run the _Demo_ using a _context-path_, add an environment variable eg. `ContextPath=/demo`.
+
+[source]
+----
+docker run --name demo --detach -p8080:8080 -eContextPath=/demo apacheisis/demo-springboot:<tag>
+----
+
+=== Customization - Prototyping
+
+To run the _Demo_ in _prototyping_ mode, add an environment variable `PROTOTYPING=true`.
+
+[source]
+----
+docker run --name demo --detach -p8080:8080 -ePROTOTYPING=true apacheisis/demo-springboot:<tag>
+----
+
+=== Customization - Attached Console
+
+To run the container with your console attached, replace the '--detach' argument with '-it'. (Use CTRL-C to stop and detach.)
+
+[source]
+----
+docker run --name demo -it -p8080:8080 apacheisis/demo-springboot:<tag>
+----
+
+== Contributing
+
+If you like to get involved quickly, please feel free to open new pull requests (at github) or just join the discussion and provide feedback.
+
+If you are interested in contributing to Apache Isis, see the https://isis.apache.org/guides/dg/dg.html[Developers' Guide] for details.
== Credits