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/29 14:43:43 UTC
[isis] 02/19: ISIS-2062: docs
This is an automated email from the ASF dual-hosted git repository.
danhaywood pushed a commit to branch ISIS-2062
in repository https://gitbox.apache.org/repos/asf/isis.git
commit a06c413c81bf122686cbdae7321900b7bb08f706
Author: danhaywood <da...@haywood-associates.co.uk>
AuthorDate: Mon Jan 27 09:25:55 2020 +0000
ISIS-2062: docs
---
.gitignore | 2 ++
antora/playbooks/{site-toc.yml => site-starters.yml} | 4 ++--
antora/playbooks/site-toc.yml | 9 ---------
antora/playbooks/site.yml | 2 +-
mavendeps/adoc/antora.yml | 2 +-
mavendeps/adoc/modules/mavendeps/nav.adoc | 2 +-
mavendeps/adoc/modules/mavendeps/partials/module-nav.adoc | 1 +
.../jdo/src/main/adoc/modules/ROOT/partials/module-nav.adoc | 8 ++++----
starters/adoc/antora.yml | 2 --
starters/adoc/modules/ROOT/nav.adoc | 2 +-
starters/adoc/modules/ROOT/pages/about.adoc | 1 +
starters/adoc/modules/ROOT/partials/component-nav.adoc | 7 +++++++
.../adoc/modules/ROOT/{nav.adoc => partials/module-nav.adoc} | 0
starters/adoc/modules/helloworld/nav.adoc | 3 +--
starters/adoc/modules/helloworld/partials/module-nav.adoc | 2 ++
starters/adoc/modules/simpleapp/nav.adoc | 3 +--
starters/adoc/modules/simpleapp/partials/module-nav.adoc | 2 ++
17 files changed, 27 insertions(+), 25 deletions(-)
diff --git a/.gitignore b/.gitignore
index c2042d5..3d0c84e 100644
--- a/.gitignore
+++ b/.gitignore
@@ -51,3 +51,5 @@ rebel.xml
/site*.yml
/.antora-cache-dir/
+
+_commit.sh
diff --git a/antora/playbooks/site-toc.yml b/antora/playbooks/site-starters.yml
similarity index 91%
copy from antora/playbooks/site-toc.yml
copy to antora/playbooks/site-starters.yml
index f062f5a..276e313 100644
--- a/antora/playbooks/site-toc.yml
+++ b/antora/playbooks/site-starters.yml
@@ -13,12 +13,12 @@ content:
# mavendeps
- url: .
- start_path: mavendeps/adoc # toc
+ start_path: mavendeps/adoc # starters
branches: HEAD
# starters
- url: .
- start_path: starters/adoc # toc
+ start_path: starters/adoc # starters
branches: HEAD
diff --git a/antora/playbooks/site-toc.yml b/antora/playbooks/site-toc.yml
index f062f5a..eb65104 100644
--- a/antora/playbooks/site-toc.yml
+++ b/antora/playbooks/site-toc.yml
@@ -11,15 +11,6 @@ content:
start_path: antora/components/toc # toc
branches: HEAD
-# mavendeps
- - url: .
- start_path: mavendeps/adoc # toc
- branches: HEAD
-
-# starters
- - url: .
- start_path: starters/adoc # toc
- branches: HEAD
ui:
diff --git a/antora/playbooks/site.yml b/antora/playbooks/site.yml
index 9bdee76..5c49877 100644
--- a/antora/playbooks/site.yml
+++ b/antora/playbooks/site.yml
@@ -168,7 +168,7 @@ content:
# mavendeps
- url: .
- start_path: mavendeps/adoc # toc
+ start_path: mavendeps/adoc # starters
branches: HEAD
# security
diff --git a/mavendeps/adoc/antora.yml b/mavendeps/adoc/antora.yml
index 92f67d2..8c24760 100644
--- a/mavendeps/adoc/antora.yml
+++ b/mavendeps/adoc/antora.yml
@@ -1,2 +1,2 @@
-name: toc
+name: starters
version: master
diff --git a/mavendeps/adoc/modules/mavendeps/nav.adoc b/mavendeps/adoc/modules/mavendeps/nav.adoc
index 567a472..77d9496 100644
--- a/mavendeps/adoc/modules/mavendeps/nav.adoc
+++ b/mavendeps/adoc/modules/mavendeps/nav.adoc
@@ -1 +1 @@
-// unused - referenced directly by toc/nav.adoc
\ No newline at end of file
+include::starters:ROOT:partial$component-nav.adoc[]
diff --git a/mavendeps/adoc/modules/mavendeps/partials/module-nav.adoc b/mavendeps/adoc/modules/mavendeps/partials/module-nav.adoc
new file mode 100644
index 0000000..f99271c
--- /dev/null
+++ b/mavendeps/adoc/modules/mavendeps/partials/module-nav.adoc
@@ -0,0 +1 @@
+* xref:starters:mavendeps:about.adoc[Maven Dependencies]
diff --git a/persistence/jdo/src/main/adoc/modules/ROOT/partials/module-nav.adoc b/persistence/jdo/src/main/adoc/modules/ROOT/partials/module-nav.adoc
index a0b16ee..5f95188 100644
--- a/persistence/jdo/src/main/adoc/modules/ROOT/partials/module-nav.adoc
+++ b/persistence/jdo/src/main/adoc/modules/ROOT/partials/module-nav.adoc
@@ -1,4 +1,4 @@
-* xref:configuring.adoc[Configuring]
-* xref:jdo-mappings.adoc[JDO Mappings]
-* xref:db-schemas.adoc[DB Schemas]
-* xref:hints-and-tips.adoc[Hints-n-Tips]
+* xref:pjdo:ROOT:configuring.adoc[Configuring]
+* xref:pjdo:ROOT:jdo-mappings.adoc[JDO Mappings]
+* xref:pjdo:ROOT:db-schemas.adoc[DB Schemas]
+* xref:pjdo:ROOT:hints-and-tips.adoc[Hints-n-Tips]
diff --git a/starters/adoc/antora.yml b/starters/adoc/antora.yml
index 5bb5084..23ad419 100644
--- a/starters/adoc/antora.yml
+++ b/starters/adoc/antora.yml
@@ -4,5 +4,3 @@ version: master
start_page: ROOT:about.adoc
nav:
- modules/ROOT/nav.adoc
-- modules/helloworld/nav.adoc
-- modules/simpleapp/nav.adoc
diff --git a/starters/adoc/modules/ROOT/nav.adoc b/starters/adoc/modules/ROOT/nav.adoc
index 579c69c..cf57def 100644
--- a/starters/adoc/modules/ROOT/nav.adoc
+++ b/starters/adoc/modules/ROOT/nav.adoc
@@ -1,4 +1,4 @@
-* xref:about.adoc[Starter Parent]
+include::starters:ROOT:partial$component-nav.adoc[]
diff --git a/starters/adoc/modules/ROOT/pages/about.adoc b/starters/adoc/modules/ROOT/pages/about.adoc
index e736389..dc813d2 100644
--- a/starters/adoc/modules/ROOT/pages/about.adoc
+++ b/starters/adoc/modules/ROOT/pages/about.adoc
@@ -3,3 +3,4 @@
TODO: to document
+
diff --git a/starters/adoc/modules/ROOT/partials/component-nav.adoc b/starters/adoc/modules/ROOT/partials/component-nav.adoc
new file mode 100644
index 0000000..173b4df
--- /dev/null
+++ b/starters/adoc/modules/ROOT/partials/component-nav.adoc
@@ -0,0 +1,7 @@
+include::starters:ROOT:partial$module-nav.adoc[]
+include::starters:helloworld:partial$module-nav.adoc[]
+include::starters:simpleapp:partial$module-nav.adoc[]
+include::starters:mavendeps:partial$module-nav.adoc[]
+
+
+
diff --git a/starters/adoc/modules/ROOT/nav.adoc b/starters/adoc/modules/ROOT/partials/module-nav.adoc
similarity index 100%
copy from starters/adoc/modules/ROOT/nav.adoc
copy to starters/adoc/modules/ROOT/partials/module-nav.adoc
diff --git a/starters/adoc/modules/helloworld/nav.adoc b/starters/adoc/modules/helloworld/nav.adoc
index 557c8a5..77d9496 100644
--- a/starters/adoc/modules/helloworld/nav.adoc
+++ b/starters/adoc/modules/helloworld/nav.adoc
@@ -1,2 +1 @@
-* xref:about.adoc[Hello World]
-
+include::starters:ROOT:partial$component-nav.adoc[]
diff --git a/starters/adoc/modules/helloworld/partials/module-nav.adoc b/starters/adoc/modules/helloworld/partials/module-nav.adoc
new file mode 100644
index 0000000..f4129f8
--- /dev/null
+++ b/starters/adoc/modules/helloworld/partials/module-nav.adoc
@@ -0,0 +1,2 @@
+* xref:starters:helloworld:about.adoc[Hello World]
+
diff --git a/starters/adoc/modules/simpleapp/nav.adoc b/starters/adoc/modules/simpleapp/nav.adoc
index f63c990..77d9496 100644
--- a/starters/adoc/modules/simpleapp/nav.adoc
+++ b/starters/adoc/modules/simpleapp/nav.adoc
@@ -1,2 +1 @@
-* xref:about.adoc[SimpleApp]
-
+include::starters:ROOT:partial$component-nav.adoc[]
diff --git a/starters/adoc/modules/simpleapp/partials/module-nav.adoc b/starters/adoc/modules/simpleapp/partials/module-nav.adoc
new file mode 100644
index 0000000..ed5e981
--- /dev/null
+++ b/starters/adoc/modules/simpleapp/partials/module-nav.adoc
@@ -0,0 +1,2 @@
+* xref:starters:simpleapp:about.adoc[SimpleApp]
+