[isis] branch master updated: ISIS-2484: docs: add notes on how to maintain simpleapp

[ah...@apache.org]

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 46a7d03  ISIS-2484: docs: add notes on how to maintain simpleapp
46a7d03 is described below

commit 46a7d0344fab78478cc7380f456e0342bceff4df
Author: Andi Huber <ah...@apache.org>
AuthorDate: Thu Apr 22 19:58:28 2021 +0200

    ISIS-2484: docs: add notes on how to maintain simpleapp
---
 .../comguide/modules/ROOT/pages/about.adoc         |  2 +-
 .../comguide/modules/ROOT/pages/starter-apps.adoc  | 33 ++++++++++++++++++++++
 2 files changed, 34 insertions(+), 1 deletion(-)

diff --git a/antora/components/comguide/modules/ROOT/pages/about.adoc b/antora/components/comguide/modules/ROOT/pages/about.adoc
index 290bed3..0cd55b9 100644
--- a/antora/components/comguide/modules/ROOT/pages/about.adoc
+++ b/antora/components/comguide/modules/ROOT/pages/about.adoc
@@ -30,4 +30,4 @@ This committers' guide is for committers of Apache Isis itself who want guidance
 //
 //include::pmc-notes.adoc[leveloffset=+1]
 
-
+//include::starter-apps.adoc[leveloffset=+1]
diff --git a/antora/components/comguide/modules/ROOT/pages/starter-apps.adoc b/antora/components/comguide/modules/ROOT/pages/starter-apps.adoc
new file mode 100644
index 0000000..dadcff3
--- /dev/null
+++ b/antora/components/comguide/modules/ROOT/pages/starter-apps.adoc
@@ -0,0 +1,33 @@
+[[starter-apps]]
+= Starter Apps
+:page-role: -toc
+
+: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 [...]
+
+== Simpleapp Maintenance (JDO and JPA)
+
+When making updates for simpleapp, use the following process:
+
+=== If the change applies to released (M5):
+
+. make change to jdo, then merge down to jdo-SNAPSHOT
+. also merge jdo -> jpa, and fix any persistence differences if nec.
+. then merge jpa -> jpa-SNAPSHOT
+. finally, merge jdo-SNAPSHOT -> jpa-SNAPSHOT (should be a no-op)
+
+Doing it this way makes it easy to keep the branches in sync.
+
+=== If the change applies to snapshot (M6), then its similar but shorter:
+
+. make change to jdo-SNAPSHOT
+. merge jdo-SNAPSHOT to jpa-SNAPSHOT, and fix any persistence differences
+
+[Note]
+----
+If you do want to update the antora docs and have them updated on-line, 
+then the procedure is to check out the released branch (M5) 
+and make changes there. Then we build and copy over to the 
+apache/isis-site repo to publish up to isis.apache.org.
+----
+
+