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 2020/01/20 17:59:40 UTC

[isis] 01/09: ISIS-2267: moves existing stub documents for flywayjdo to flyway, move under userguide.

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/isis.git

commit 2670ee1aa2410a7c982f29b16c860d7601c3aa95
Author: danhaywood <da...@haywood-associates.co.uk>
AuthorDate: Mon Jan 20 10:25:26 2020 +0000

    ISIS-2267: moves existing stub documents for flywayjdo to flyway, move under userguide.
---
 .../modules/ROOT/partials/component-nav.adoc       |  2 +-
 .../refguide/modules/ROOT/partials/module-nav.adoc |  1 +
 .../userguide/modules/ROOT/pages/about.adoc        | 14 ++----------
 .../modules/ROOT/partials/component-nav.adoc       |  8 +++++++
 .../modules/ROOT/partials/module-nav.adoc          |  0
 antora/components/userguide/modules/btb/nav.adoc   |  9 +-------
 .../btb/{nav.adoc => partials/module-nav.adoc}     |  0
 antora/components/userguide/modules/fun/nav.adoc   | 25 +---------------------
 .../fun/{nav.adoc => partials/module-nav.adoc}     |  0
 antora/playbooks/site-refguide.yml                 |  5 +++++
 antora/playbooks/site.yml                          |  2 +-
 .../jdo/flywayjdo => core/flyway}/adoc/antora.yml  |  2 +-
 .../core/flyway/adoc/modules/flyway/nav.adoc       |  1 +
 .../flyway/adoc/modules/flyway}/pages/about.adoc   |  5 ++++-
 .../adoc/modules/flyway/partials/module-nav.adoc   |  3 +++
 .../jdo/flywayjdo => core/flyway}/impl/pom.xml     |  0
 .../flywayjdo/dom/IsisModuleExtFlywayJdo.java      |  0
 .../jdo/flywayjdo/adoc/modules/flywayjdo/nav.adoc  |  2 --
 .../modules/flywayjdo/partials/module-nav.adoc     |  3 ---
 19 files changed, 29 insertions(+), 53 deletions(-)

diff --git a/antora/components/refguide/modules/ROOT/partials/component-nav.adoc b/antora/components/refguide/modules/ROOT/partials/component-nav.adoc
index 5843a52..07389e3 100644
--- a/antora/components/refguide/modules/ROOT/partials/component-nav.adoc
+++ b/antora/components/refguide/modules/ROOT/partials/component-nav.adoc
@@ -3,4 +3,4 @@ include::refguide:applib-ant:partial$module-nav.adoc[]
 include::refguide:applib-svc:partial$module-nav.adoc[]
 include::refguide:applib-cm:partial$module-nav.adoc[]
 include::refguide:config:partial$module-nav.adoc[]
-include::refguide:schema:partial$module-nav.adoc[]
\ No newline at end of file
+include::refguide:schema:partial$module-nav.adoc[]
diff --git a/antora/components/refguide/modules/ROOT/partials/module-nav.adoc b/antora/components/refguide/modules/ROOT/partials/module-nav.adoc
index e69de29..283450e 100644
--- a/antora/components/refguide/modules/ROOT/partials/module-nav.adoc
+++ b/antora/components/refguide/modules/ROOT/partials/module-nav.adoc
@@ -0,0 +1 @@
+* Reference Guide
diff --git a/antora/components/userguide/modules/ROOT/pages/about.adoc b/antora/components/userguide/modules/ROOT/pages/about.adoc
index 75848d9..8910fbe 100644
--- a/antora/components/userguide/modules/ROOT/pages/about.adoc
+++ b/antora/components/userguide/modules/ROOT/pages/about.adoc
@@ -7,17 +7,7 @@ The user guide breaks into two main sections:
 * xref:userguide:fun:about.adoc[Fundamentals]
 * xref:userguide:btb:about.adoc[Beyond the Basics]
 
-There are a number of other guides:
-
-* xref:refguide:ROOT:about.adoc[Reference Guide]
-* xref:security:ROOT:about.adoc[Security Guide]
-* xref:testing:ROOT:about.adoc[Testing Guide]
-
-\... as well as components guides:
-
-* xref:vw:ROOT:about.adoc[Wicket viewer]
-* xref:vro:ROOT:about.adoc[Restful Objects viewer]
-* xref:pjdo:ROOT:about.adoc[DataNucleus object store]
-
+It also includes some extensions:
 
+* xref:userguide:flyway:about.adoc[Flyway]
 
diff --git a/antora/components/userguide/modules/ROOT/partials/component-nav.adoc b/antora/components/userguide/modules/ROOT/partials/component-nav.adoc
new file mode 100644
index 0000000..32bd5e9
--- /dev/null
+++ b/antora/components/userguide/modules/ROOT/partials/component-nav.adoc
@@ -0,0 +1,8 @@
+include::userguide:fun:partial$module-nav.adoc[]
+include::userguide:btb:partial$module-nav.adoc[]
+
+* Extensions
+
+include::refguide:flyway:partial$module-nav.adoc[]
+
+
diff --git a/antora/components/refguide/modules/ROOT/partials/module-nav.adoc b/antora/components/userguide/modules/ROOT/partials/module-nav.adoc
similarity index 100%
copy from antora/components/refguide/modules/ROOT/partials/module-nav.adoc
copy to antora/components/userguide/modules/ROOT/partials/module-nav.adoc
diff --git a/antora/components/userguide/modules/btb/nav.adoc b/antora/components/userguide/modules/btb/nav.adoc
index eacedee..dba32e5 100644
--- a/antora/components/userguide/modules/btb/nav.adoc
+++ b/antora/components/userguide/modules/btb/nav.adoc
@@ -1,8 +1 @@
-* xref:about.adoc[Beyond the Basics]
-
-** xref:i18n.adoc[i18n]
-** xref:headless-access.adoc[Headless Access]
-** xref:hints-and-tips.adoc[Hints-n-Tips]
-** xref:programming-model.adoc[Programming Model]
-** xref:deployment.adoc[Deployment]
-** xref:web-xml.adoc[web.xml]
+include::userguide:ROOT:partial$component-nav.adoc[]
diff --git a/antora/components/userguide/modules/btb/nav.adoc b/antora/components/userguide/modules/btb/partials/module-nav.adoc
similarity index 100%
copy from antora/components/userguide/modules/btb/nav.adoc
copy to antora/components/userguide/modules/btb/partials/module-nav.adoc
diff --git a/antora/components/userguide/modules/fun/nav.adoc b/antora/components/userguide/modules/fun/nav.adoc
index bfa3115..dba32e5 100644
--- a/antora/components/userguide/modules/fun/nav.adoc
+++ b/antora/components/userguide/modules/fun/nav.adoc
@@ -1,24 +1 @@
-* xref:about.adoc[Fundamentals]
-
-
-** xref:core-concepts.adoc[Core Concepts]
-
-** xref:userguide:fun:building-blocks.adoc[Building Blocks]
-
-** xref:programming-model.adoc[Programming Model]
-
-** xref:ui-hints.adoc[UI Hints]
-
-** xref:crud.adoc[CRUD]
-
-** xref:business-rules.adoc[Business Rules]
-
-** xref:drop-downs-and-defaults.adoc[Drop downs and Defaults]
-
-** xref:available-domain-services.adoc[Available Domain Services]
-
-
-
-
-
-
+include::userguide:ROOT:partial$component-nav.adoc[]
diff --git a/antora/components/userguide/modules/fun/nav.adoc b/antora/components/userguide/modules/fun/partials/module-nav.adoc
similarity index 100%
copy from antora/components/userguide/modules/fun/nav.adoc
copy to antora/components/userguide/modules/fun/partials/module-nav.adoc
diff --git a/antora/playbooks/site-refguide.yml b/antora/playbooks/site-refguide.yml
index 8157431..673e7f4 100644
--- a/antora/playbooks/site-refguide.yml
+++ b/antora/playbooks/site-refguide.yml
@@ -28,6 +28,11 @@ content:
       start_path: core/config/src/main/adoc # refguide
       branches: HEAD
 
+# extensions
+    - url: .
+      start_path: extensions/core/flyway/adoc # refguide
+      branches: HEAD
+
 
 ui:
   bundle:
diff --git a/antora/playbooks/site.yml b/antora/playbooks/site.yml
index dffc82a..0c7a399 100644
--- a/antora/playbooks/site.yml
+++ b/antora/playbooks/site.yml
@@ -104,7 +104,7 @@ content:
 
 # extensions
     - url: .
-      start_path: extensions/persistence/jdo/flywayjdo/adoc # extensions
+      start_path: extensions/core/flyway/adoc # refguide
       branches: HEAD
 
     - url: .
diff --git a/extensions/persistence/jdo/flywayjdo/adoc/antora.yml b/extensions/core/flyway/adoc/antora.yml
similarity index 50%
rename from extensions/persistence/jdo/flywayjdo/adoc/antora.yml
rename to extensions/core/flyway/adoc/antora.yml
index e805b25..b12174d 100644
--- a/extensions/persistence/jdo/flywayjdo/adoc/antora.yml
+++ b/extensions/core/flyway/adoc/antora.yml
@@ -1,2 +1,2 @@
-name: pjdo
+name: userguide
 version: master
diff --git a/extensions/core/flyway/adoc/modules/flyway/nav.adoc b/extensions/core/flyway/adoc/modules/flyway/nav.adoc
new file mode 100644
index 0000000..dba32e5
--- /dev/null
+++ b/extensions/core/flyway/adoc/modules/flyway/nav.adoc
@@ -0,0 +1 @@
+include::userguide:ROOT:partial$component-nav.adoc[]
diff --git a/extensions/persistence/jdo/flywayjdo/adoc/modules/flywayjdo/pages/about.adoc b/extensions/core/flyway/adoc/modules/flyway/pages/about.adoc
similarity index 77%
rename from extensions/persistence/jdo/flywayjdo/adoc/modules/flywayjdo/pages/about.adoc
rename to extensions/core/flyway/adoc/modules/flyway/pages/about.adoc
index 2dd682b..14b8bef 100644
--- a/extensions/persistence/jdo/flywayjdo/adoc/modules/flywayjdo/pages/about.adoc
+++ b/extensions/core/flyway/adoc/modules/flyway/pages/about.adoc
@@ -1,5 +1,8 @@
-= Flyway for JDO
+= Flyway (Extension)
 :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 [...]
 
 TODO
 
+https://docs.spring.io/spring-boot/docs/current/reference/html/howto.html#howto-execute-flyway-database-migrations-on-startup
+
+https://www.baeldung.com/spring-boot-configure-data-source-programmatic
diff --git a/extensions/core/flyway/adoc/modules/flyway/partials/module-nav.adoc b/extensions/core/flyway/adoc/modules/flyway/partials/module-nav.adoc
new file mode 100644
index 0000000..8dc6c56
--- /dev/null
+++ b/extensions/core/flyway/adoc/modules/flyway/partials/module-nav.adoc
@@ -0,0 +1,3 @@
+** xref:userguide:flyway:about.adoc[Flyway (Extension)]
+
+
diff --git a/extensions/persistence/jdo/flywayjdo/impl/pom.xml b/extensions/core/flyway/impl/pom.xml
similarity index 100%
rename from extensions/persistence/jdo/flywayjdo/impl/pom.xml
rename to extensions/core/flyway/impl/pom.xml
diff --git a/extensions/persistence/jdo/flywayjdo/impl/src/main/java/org/apache/isis/extensions/flywayjdo/dom/IsisModuleExtFlywayJdo.java b/extensions/core/flyway/impl/src/main/java/org/apache/isis/extensions/flywayjdo/dom/IsisModuleExtFlywayJdo.java
similarity index 100%
rename from extensions/persistence/jdo/flywayjdo/impl/src/main/java/org/apache/isis/extensions/flywayjdo/dom/IsisModuleExtFlywayJdo.java
rename to extensions/core/flyway/impl/src/main/java/org/apache/isis/extensions/flywayjdo/dom/IsisModuleExtFlywayJdo.java
diff --git a/extensions/persistence/jdo/flywayjdo/adoc/modules/flywayjdo/nav.adoc b/extensions/persistence/jdo/flywayjdo/adoc/modules/flywayjdo/nav.adoc
deleted file mode 100644
index 4763d68..0000000
--- a/extensions/persistence/jdo/flywayjdo/adoc/modules/flywayjdo/nav.adoc
+++ /dev/null
@@ -1,2 +0,0 @@
-include::pjdo:ROOT:partial$component-nav.adoc[]
-
diff --git a/extensions/persistence/jdo/flywayjdo/adoc/modules/flywayjdo/partials/module-nav.adoc b/extensions/persistence/jdo/flywayjdo/adoc/modules/flywayjdo/partials/module-nav.adoc
deleted file mode 100644
index dd0d54b..0000000
--- a/extensions/persistence/jdo/flywayjdo/adoc/modules/flywayjdo/partials/module-nav.adoc
+++ /dev/null
@@ -1,3 +0,0 @@
-** xref:pjdo:flywayjdo:about.adoc[Flyway for JDO]
-
-