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 6f67e68 ISIS-2158: polishing demo about.adoc 6f67e68 is described below commit 6f67e68dafd94361d2f87e220916b2081a83ab91 Author: Andi Huber <ahu...@apache.org> AuthorDate: Thu Jan 16 07:59:49 2020 +0100 ISIS-2158: polishing demo about.adoc --- examples/demo/README.adoc | 5 ++- .../src/main/adoc/modules/ROOT/pages/about.adoc | 36 ++++++++-------------- 2 files changed, 14 insertions(+), 27 deletions(-) diff --git a/examples/demo/README.adoc b/examples/demo/README.adoc index dbc99b7..f6a4535 100644 --- a/examples/demo/README.adoc +++ b/examples/demo/README.adoc @@ -1,5 +1,4 @@ -:module_root: src/main/adoc/modules/ROOT +:demo_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"] -\include::{module_root}/pages/about.adoc[] - +include::{demo_module_root}/pages/about.adoc[] \ No newline at end of file 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 2af50c9..114fec0 100644 --- a/examples/demo/src/main/adoc/modules/ROOT/pages/about.adoc +++ b/examples/demo/src/main/adoc/modules/ROOT/pages/about.adoc @@ -6,8 +6,6 @@ It allows you to learn the very basics and also to discover some of the more adv == 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 @@ -16,57 +14,47 @@ Install https://www.docker.com/community-edition[Docker] on your computer. === Pulling the Docker Image -Pull the demo image using: - -[source] +.pull the Demo image ---- docker pull apacheisis/demo-springboot:<tag> ---- === Running the Docker Image -Run the demo image using: - -[source] +.run the Demo image ---- docker run --name demo --detach -p8080:8080 apacheisis/demo-springboot:<tag> ---- -This will start a new Docker container named 'demo'. +This will start a new Docker container named `demo`. -The demo-app can then be accessed at http://localhost:8080/wicket/[]. +The Demo can then be accessed at http://localhost:8080/wicket/[]. Login with `sven:pass`. -To stop and remove the container named 'demo' use: - -[source] +.stop and remove the container named `demo` ---- docker stop demo && docker rm demo ---- -=== Customization - ContextPath - -To run the _Demo_ using a _context-path_, add an environment variable eg. `ContextPath=/demo`. +=== Customization (Context Path) -[source] +.run using a _context-path_, add an environment variable eg. `ContextPath=/demo` ---- 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`. +=== Customization (Prototyping) -[source] +.run in _prototyping_ mode, add an environment variable `PROTOTYPING=true`. ---- docker run --name demo --detach -p8080:8080 -ePROTOTYPING=true apacheisis/demo-springboot:<tag> ---- -=== Customization - Attached Console +=== Customization (Attached Console) -To run the container with your console attached, replace the '--detach' argument with '-it'. (Use CTRL-C to stop and detach.) +To run the container with your console attached, replace the '--detach' argument with '-it'. -[source] +.use CTRL-C to stop and detach ---- docker run --name demo -it -p8080:8080 apacheisis/demo-springboot:<tag> ----