This is an automated email from the ASF dual-hosted git repository.
danhaywood pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/causeway.git
The following commit(s) were added to refs/heads/master by this push:
new 7b3dfb5663 parameterizes docs for starter apps, different fwk versions
7b3dfb5663 is described below
commit 7b3dfb566332d5c63088b733730d8c771d30e981
Author: Dan Haywood <[email protected]>
AuthorDate: Wed Jun 5 12:20:00 2024 +0100
parameterizes docs for starter apps, different fwk versions
---
starters/adoc/antora.yml | 9 +++++++++
.../adoc/modules/starters/pages/helloworld-script-jdo.adoc | 4 ++--
.../adoc/modules/starters/pages/helloworld-script-jpa.adoc | 4 ++--
starters/adoc/modules/starters/pages/helloworld.adoc | 10 +++++-----
starters/adoc/modules/starters/pages/simpleapp-script-jdo.adoc | 4 ++--
starters/adoc/modules/starters/pages/simpleapp-script-jpa.adoc | 4 ++--
starters/adoc/modules/starters/pages/simpleapp.adoc | 10 +++++-----
7 files changed, 27 insertions(+), 18 deletions(-)
diff --git a/starters/adoc/antora.yml b/starters/adoc/antora.yml
index 072c382aa9..8dd4e4a4ad 100644
--- a/starters/adoc/antora.yml
+++ b/starters/adoc/antora.yml
@@ -17,3 +17,12 @@
name: docs
version: latest
+
+asciidoc:
+ attributes:
+# fwk-version: '2'
+# fwk-jdk-version: '11'
+# jdk-version: '11'
+ fwk-version: '3'
+ fwk-jdk-version: '17'
+ jdk-version: '21'
diff --git a/starters/adoc/modules/starters/pages/helloworld-script-jdo.adoc
b/starters/adoc/modules/starters/pages/helloworld-script-jdo.adoc
index f8cfb2cabe..42dc8e7253 100644
--- a/starters/adoc/modules/starters/pages/helloworld-script-jdo.adoc
+++ b/starters/adoc/modules/starters/pages/helloworld-script-jdo.adoc
@@ -3,8 +3,8 @@
[source,bash,subs="attributes+"]
----
-curl https://codeload.github.com/apache/causeway-app-helloworld/zip/v3-jdo |
jar xv
-cd causeway-app-helloworld-3-jdo
+curl
https://codeload.github.com/apache/causeway-app-helloworld/zip/v{fwk-version}-jdo
| jar xv
+cd causeway-app-helloworld-{fwk-version}-jdo
mvn clean install
mvn spring-boot:run
diff --git a/starters/adoc/modules/starters/pages/helloworld-script-jpa.adoc
b/starters/adoc/modules/starters/pages/helloworld-script-jpa.adoc
index 3e427780a2..ad4441ef83 100644
--- a/starters/adoc/modules/starters/pages/helloworld-script-jpa.adoc
+++ b/starters/adoc/modules/starters/pages/helloworld-script-jpa.adoc
@@ -3,8 +3,8 @@
[source,bash,subs="attributes+"]
----
-curl https://codeload.github.com/apache/causeway-app-helloworld/zip/v3-jpa |
jar xv
-cd causeway-app-helloworld-3-jpa
+curl
https://codeload.github.com/apache/causeway-app-helloworld/zip/v{fwk-version}-jpa
| jar xv
+cd causeway-app-helloworld-{fwk-version}-jpa
mvn clean install
mvn spring-boot:run
diff --git a/starters/adoc/modules/starters/pages/helloworld.adoc
b/starters/adoc/modules/starters/pages/helloworld.adoc
index 3034b344d6..b2c12f45af 100644
--- a/starters/adoc/modules/starters/pages/helloworld.adoc
+++ b/starters/adoc/modules/starters/pages/helloworld.adoc
@@ -10,12 +10,12 @@ One variation uses JDO as the ORM, the other uses JPA, so
you can focus on which
The application is also built nightly as a docker image, so you can quickly
try it out:
-[source,bash]
+[source,bash,subs="attributes+"]
----
-docker run -d -p 8080:8080 apache/causeway-app-helloworld:v3-jpa-SNAPSHOT
+docker run -d -p 8080:8080
apache/causeway-app-helloworld:v{fwk-version}-jpa-SNAPSHOT
----
-Replace "v3-jpa" with "v3-jdo" if using the JDO ORM.
+Replace "v{fwk-version}-jpa" with "v{fwk-version}-jdo" if using the JDO ORM.
Using the instructions <<Downloading & Running,below>>, you can download a
minimal Apache Causeway app, consisting of a single domain entity
(`HelloWorldObject`) with supporting domain services.
@@ -32,9 +32,9 @@ It also creates a minimal application, but provides more
structure along with te
Apache Causeway is a Java based framework, so in terms of prerequisites,
you'll need to install:
-* Java 21 JDK (or later)
+* Java {jdk-version} JDK (or later)
+
-Apache Causeway v3 requires Java 17, and the helloworld app itself is
currently configured for Java 21.
+Apache Causeway v{fwk-version} requires Java {fwk-jdk-version}, and the
helloworld app itself is currently configured for Java {jdk-version}.
* link:http://maven.apache.org[Apache Maven] 3.9.7+
diff --git a/starters/adoc/modules/starters/pages/simpleapp-script-jdo.adoc
b/starters/adoc/modules/starters/pages/simpleapp-script-jdo.adoc
index 346506c4a9..cf42d34cdd 100644
--- a/starters/adoc/modules/starters/pages/simpleapp-script-jdo.adoc
+++ b/starters/adoc/modules/starters/pages/simpleapp-script-jdo.adoc
@@ -4,8 +4,8 @@
[source,bash,subs="attributes+"]
----
-curl https://codeload.github.com/apache/causeway-app-simpleapp/zip/v3-jdo |
jar xv
-cd causeway-app-simpleapp-3-jdo
+curl
https://codeload.github.com/apache/causeway-app-simpleapp/zip/v{fwk-version}-jdo
| jar xv
+cd causeway-app-simpleapp-{fwk-version}-jdo
mvn clean install
mvn -pl webapp spring-boot:run
diff --git a/starters/adoc/modules/starters/pages/simpleapp-script-jpa.adoc
b/starters/adoc/modules/starters/pages/simpleapp-script-jpa.adoc
index 0873816ed6..097cc54f6d 100644
--- a/starters/adoc/modules/starters/pages/simpleapp-script-jpa.adoc
+++ b/starters/adoc/modules/starters/pages/simpleapp-script-jpa.adoc
@@ -4,8 +4,8 @@
[source,bash,subs="attributes+"]
----
-curl https://codeload.github.com/apache/causeway-app-simpleapp/zip/v3-jpa |
jar xv
-cd causeway-app-simpleapp-3-jpa
+curl
https://codeload.github.com/apache/causeway-app-simpleapp/zip/v{fwk-version}-jpa
| jar xv
+cd causeway-app-simpleapp-{fwk-version}-jpa
mvn clean install
mvn -pl webapp spring-boot:run
diff --git a/starters/adoc/modules/starters/pages/simpleapp.adoc
b/starters/adoc/modules/starters/pages/simpleapp.adoc
index 9731c22d76..b62b55f304 100644
--- a/starters/adoc/modules/starters/pages/simpleapp.adoc
+++ b/starters/adoc/modules/starters/pages/simpleapp.adoc
@@ -9,12 +9,12 @@ One variation uses JPA as the ORM, the other uses JDO, so you
can focus on which
The application is also built nightly as a docker image, so you can quickly
try it out:
-[source,bash]
+[source,bash,subs="attributes+"]
----
-docker run -d -p 8080:8080 apache/causeway-app-simpleapp:v3-jpa-SNAPSHOT
+docker run -d -p 8080:8080
apache/causeway-app-simpleapp:v{fwk-version}-jpa-SNAPSHOT
----
-Replace "v3-jpa" with "v3-jdo" if using the JDO ORM.
+Replace "v{fwk-version}-jpa" with "v{fwk-version}-jdo" if using the JDO ORM.
As with the xref:docs:starters:helloworld.adoc[HelloWorld] starter app, the
instructions <<Downloading & Running,below>> will download a minimal Apache
Causeway app consisting of a single entity (`SimpleObject`) with supporting
domain services.
@@ -38,9 +38,9 @@ You can use them as a reference once your ideas have
solidifid and you need to s
Apache Causeway is a Java based framework, so in terms of prerequisites,
you'll need to install:
-* Java 21 JDK (or later)
+* Java {jdk-version} JDK (or later)
+
-Apache Causeway v3 requires Java 17, and the simpleapp itself is currently
configured for Java 21.
+Apache Causeway v{fwk-version} requires Java {fwk-jdk-version}, and the
simpleapp itself is currently configured for Java {jdk-version}.
* link:http://maven.apache.org[Apache Maven] 3.9.7+
