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 2023/01/05 16:07:58 UTC
[isis] branch ISIS-3255 updated: ISIS-3255: fixes up docs
This is an automated email from the ASF dual-hosted git repository.
danhaywood pushed a commit to branch ISIS-3255
in repository https://gitbox.apache.org/repos/asf/isis.git
The following commit(s) were added to refs/heads/ISIS-3255 by this push:
new 3a833f2ded ISIS-3255: fixes up docs
3a833f2ded is described below
commit 3a833f2dedc318dd3b33e282a4c558f66f1de9f6
Author: danhaywood <da...@haywood-associates.co.uk>
AuthorDate: Thu Jan 5 16:07:46 2023 +0000
ISIS-3255: fixes up docs
---
antora/components/conguide/antora.yml | 1 +
.../images/image-2023-01-03-08-31-58-018.png | Bin
.../images/image-2023-01-03-17-58-33-718.png | Bin
.../images/image-2023-01-03-18-07-57-499.png | Bin
.../images/image-2023-01-03-18-10-33-567.png | Bin
.../images/image-2023-01-03-18-16-01-614.png | Bin
.../images/image-2023-01-03-18-22-59-542.png | Bin
.../images/image-2023-01-03-18-27-32-832.png | Bin
.../images/image-2023-01-03-18-33-23-116.png | Bin
.../images/image-2023-01-04-06-23-41-099.png | Bin
.../images/image-2023-01-04-06-25-56-926.png | Bin
.../images/image-2023-01-04-06-26-42-960.png | Bin
.../images/image-2023-01-04-06-29-02-083.png | Bin
.../images/image-2023-01-04-06-31-36-293.png | Bin
.../images/image-2023-01-05-11-44-09-855.png | Bin
.../{nightlies => nightly-deploys}/nav.adoc | 2 +-
.../pages/about.adoc | 23 ++++++++-------------
.../partials/az-containerapp-create.adoc | 0
18 files changed, 11 insertions(+), 15 deletions(-)
diff --git a/antora/components/conguide/antora.yml b/antora/components/conguide/antora.yml
index 057398dd70..41acb00ea0 100644
--- a/antora/components/conguide/antora.yml
+++ b/antora/components/conguide/antora.yml
@@ -22,6 +22,7 @@ start_page: ROOT:about.adoc
nav:
- modules/ROOT/nav.adoc
- modules/documentation/nav.adoc
+- modules/nightly-deploys/nav.adoc
- modules/intellij/nav.adoc
- modules/eclipse/nav.adoc
- modules/git/nav.adoc
diff --git a/antora/components/conguide/modules/nightlies/images/image-2023-01-03-08-31-58-018.png b/antora/components/conguide/modules/nightly-deploys/images/image-2023-01-03-08-31-58-018.png
similarity index 100%
rename from antora/components/conguide/modules/nightlies/images/image-2023-01-03-08-31-58-018.png
rename to antora/components/conguide/modules/nightly-deploys/images/image-2023-01-03-08-31-58-018.png
diff --git a/antora/components/conguide/modules/nightlies/images/image-2023-01-03-17-58-33-718.png b/antora/components/conguide/modules/nightly-deploys/images/image-2023-01-03-17-58-33-718.png
similarity index 100%
rename from antora/components/conguide/modules/nightlies/images/image-2023-01-03-17-58-33-718.png
rename to antora/components/conguide/modules/nightly-deploys/images/image-2023-01-03-17-58-33-718.png
diff --git a/antora/components/conguide/modules/nightlies/images/image-2023-01-03-18-07-57-499.png b/antora/components/conguide/modules/nightly-deploys/images/image-2023-01-03-18-07-57-499.png
similarity index 100%
rename from antora/components/conguide/modules/nightlies/images/image-2023-01-03-18-07-57-499.png
rename to antora/components/conguide/modules/nightly-deploys/images/image-2023-01-03-18-07-57-499.png
diff --git a/antora/components/conguide/modules/nightlies/images/image-2023-01-03-18-10-33-567.png b/antora/components/conguide/modules/nightly-deploys/images/image-2023-01-03-18-10-33-567.png
similarity index 100%
rename from antora/components/conguide/modules/nightlies/images/image-2023-01-03-18-10-33-567.png
rename to antora/components/conguide/modules/nightly-deploys/images/image-2023-01-03-18-10-33-567.png
diff --git a/antora/components/conguide/modules/nightlies/images/image-2023-01-03-18-16-01-614.png b/antora/components/conguide/modules/nightly-deploys/images/image-2023-01-03-18-16-01-614.png
similarity index 100%
rename from antora/components/conguide/modules/nightlies/images/image-2023-01-03-18-16-01-614.png
rename to antora/components/conguide/modules/nightly-deploys/images/image-2023-01-03-18-16-01-614.png
diff --git a/antora/components/conguide/modules/nightlies/images/image-2023-01-03-18-22-59-542.png b/antora/components/conguide/modules/nightly-deploys/images/image-2023-01-03-18-22-59-542.png
similarity index 100%
rename from antora/components/conguide/modules/nightlies/images/image-2023-01-03-18-22-59-542.png
rename to antora/components/conguide/modules/nightly-deploys/images/image-2023-01-03-18-22-59-542.png
diff --git a/antora/components/conguide/modules/nightlies/images/image-2023-01-03-18-27-32-832.png b/antora/components/conguide/modules/nightly-deploys/images/image-2023-01-03-18-27-32-832.png
similarity index 100%
rename from antora/components/conguide/modules/nightlies/images/image-2023-01-03-18-27-32-832.png
rename to antora/components/conguide/modules/nightly-deploys/images/image-2023-01-03-18-27-32-832.png
diff --git a/antora/components/conguide/modules/nightlies/images/image-2023-01-03-18-33-23-116.png b/antora/components/conguide/modules/nightly-deploys/images/image-2023-01-03-18-33-23-116.png
similarity index 100%
rename from antora/components/conguide/modules/nightlies/images/image-2023-01-03-18-33-23-116.png
rename to antora/components/conguide/modules/nightly-deploys/images/image-2023-01-03-18-33-23-116.png
diff --git a/antora/components/conguide/modules/nightlies/images/image-2023-01-04-06-23-41-099.png b/antora/components/conguide/modules/nightly-deploys/images/image-2023-01-04-06-23-41-099.png
similarity index 100%
rename from antora/components/conguide/modules/nightlies/images/image-2023-01-04-06-23-41-099.png
rename to antora/components/conguide/modules/nightly-deploys/images/image-2023-01-04-06-23-41-099.png
diff --git a/antora/components/conguide/modules/nightlies/images/image-2023-01-04-06-25-56-926.png b/antora/components/conguide/modules/nightly-deploys/images/image-2023-01-04-06-25-56-926.png
similarity index 100%
rename from antora/components/conguide/modules/nightlies/images/image-2023-01-04-06-25-56-926.png
rename to antora/components/conguide/modules/nightly-deploys/images/image-2023-01-04-06-25-56-926.png
diff --git a/antora/components/conguide/modules/nightlies/images/image-2023-01-04-06-26-42-960.png b/antora/components/conguide/modules/nightly-deploys/images/image-2023-01-04-06-26-42-960.png
similarity index 100%
rename from antora/components/conguide/modules/nightlies/images/image-2023-01-04-06-26-42-960.png
rename to antora/components/conguide/modules/nightly-deploys/images/image-2023-01-04-06-26-42-960.png
diff --git a/antora/components/conguide/modules/nightlies/images/image-2023-01-04-06-29-02-083.png b/antora/components/conguide/modules/nightly-deploys/images/image-2023-01-04-06-29-02-083.png
similarity index 100%
rename from antora/components/conguide/modules/nightlies/images/image-2023-01-04-06-29-02-083.png
rename to antora/components/conguide/modules/nightly-deploys/images/image-2023-01-04-06-29-02-083.png
diff --git a/antora/components/conguide/modules/nightlies/images/image-2023-01-04-06-31-36-293.png b/antora/components/conguide/modules/nightly-deploys/images/image-2023-01-04-06-31-36-293.png
similarity index 100%
rename from antora/components/conguide/modules/nightlies/images/image-2023-01-04-06-31-36-293.png
rename to antora/components/conguide/modules/nightly-deploys/images/image-2023-01-04-06-31-36-293.png
diff --git a/antora/components/conguide/modules/nightlies/images/image-2023-01-05-11-44-09-855.png b/antora/components/conguide/modules/nightly-deploys/images/image-2023-01-05-11-44-09-855.png
similarity index 100%
rename from antora/components/conguide/modules/nightlies/images/image-2023-01-05-11-44-09-855.png
rename to antora/components/conguide/modules/nightly-deploys/images/image-2023-01-05-11-44-09-855.png
diff --git a/antora/components/conguide/modules/nightlies/nav.adoc b/antora/components/conguide/modules/nightly-deploys/nav.adoc
similarity index 93%
rename from antora/components/conguide/modules/nightlies/nav.adoc
rename to antora/components/conguide/modules/nightly-deploys/nav.adoc
index 744f63c485..e61de46b3e 100644
--- a/antora/components/conguide/modules/nightlies/nav.adoc
+++ b/antora/components/conguide/modules/nightly-deploys/nav.adoc
@@ -1,4 +1,4 @@
: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 [...]
-* xref:conguide:nightlies:about.adoc[Nightlies]
+* xref:nightly-deploys:about.adoc[Nightly Deploys]
diff --git a/antora/components/conguide/modules/nightlies/pages/about.adoc b/antora/components/conguide/modules/nightly-deploys/pages/about.adoc
similarity index 94%
rename from antora/components/conguide/modules/nightlies/pages/about.adoc
rename to antora/components/conguide/modules/nightly-deploys/pages/about.adoc
index 692e995778..dd4b108d19 100644
--- a/antora/components/conguide/modules/nightlies/pages/about.adoc
+++ b/antora/components/conguide/modules/nightly-deploys/pages/about.adoc
@@ -1,14 +1,12 @@
[[nightlies]]
-= Nightlies
+= Nightly Deploys
: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 [...]
:page-partial:
-This page describes how we deploy the xref:docs:starters:simpleapp.adoc[], xref:docs:starters:helloworld.adoc[HelloWorld App] and the xref:docs:demo:about.adoc[] each night.
+This page describes how we deploy the xref:docs:starters:simpleapp.adoc[], xref:docs:starters:helloworld.adoc[HelloWorld App] and the xref:docs:demo:about.adoc[] each night, to a Azure App Container Apps (a PaaS based on top of k8s).
-WARNING: work in progress
-
-The intention is to use link:https://learn.microsoft.com/en-gb/azure/container-apps/[Azure Container Apps] (hereafter ACA).
+The actual CI jobs can be found in the link:https://github.com/apache-causeway-committers/causeway-nightly-deploys[apache-causeway-committers/causeway-nightly-deploys] repo.
== Azure Container Apps
@@ -296,9 +294,6 @@ APP_NAME="demo-wicket-jpa-snapshot"
IMAGE_NAME="apacheisis/demo-wicket-jpa"
IMAGE_VERSION="latest"
----
-+
-NOTE: Hmm, looks like there's an issue with our generation of the image version, missing the sha Id suffix.
-But this image _does_ exist.
* Deploy
+
@@ -353,9 +348,6 @@ APP_NAME="demo-wicket-jdo-snapshot"
IMAGE_NAME="apacheisis/demo-wicket-jdo"
IMAGE_VERSION="latest"
----
-+
-NOTE: Hmm, looks like there's an issue with our generation of the image version, missing the sha Id suffix.
-But this image _does_ exist.
* Deploy
+
@@ -577,8 +569,8 @@ to `helloworld-jdo-snapshot.apps.causeway.dev`
== Automation
-The nightly automation simply needs to update the apps with new images, using `az container revision copy`.
-There is no need to create ACA environments etc from scratch.
+With all of the applications created above, the nightly automation simply needs to update the apps with new images, using `az container revision copy`.
+There is *_no need_* to create ACA environments etc from scratch.
=== Prereqs
@@ -622,12 +614,15 @@ The output includes credentials that you must protect. Be sure that you do not i
=== CI Jobs
-The CI jobs can be found in link:https://github.com/apache-causeway-committers/causeway-nightly-deploys[apache-causeway-committers/causeway-nightly-deploys].
+The actual CI jobs can be found in the link:https://github.com/apache-causeway-committers/causeway-nightly-deploys[apache-causeway-committers/causeway-nightly-deploys] repo.
The main script consists of these commands:
[source,bash]
----
+# ... derive $APPNAME
+# ... derive $IMAGE
+
TIMESTAMP=$(date "+%Y%m%d-%H%M%S")
REVISION_SUFFIX="r${TIMESTAMP}"
diff --git a/antora/components/conguide/modules/nightlies/partials/az-containerapp-create.adoc b/antora/components/conguide/modules/nightly-deploys/partials/az-containerapp-create.adoc
similarity index 100%
rename from antora/components/conguide/modules/nightlies/partials/az-containerapp-create.adoc
rename to antora/components/conguide/modules/nightly-deploys/partials/az-containerapp-create.adoc