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 2019/06/02 17:44:11 UTC
[isis] 01/04: ISIS-2062: reorg dg pages
This is an automated email from the ASF dual-hosted git repository.
danhaywood pushed a commit to branch ISIS-2062-antora
in repository https://gitbox.apache.org/repos/asf/isis.git
commit 5a964f241243daeb5c8948b13ed1b8808310bcbd
Author: danhaywood <da...@haywood-associates.co.uk>
AuthorDate: Sun Jun 2 18:03:10 2019 +0100
ISIS-2062: reorg dg pages
---
antora/components/support/modules/cgcom/nav.adoc | 4 +-
.../modules/cgcom/pages/policies/_attributes.adoc | 4 ++
antora/components/support/modules/dg/nav.adoc | 47 ++++++++++++++-
.../modules/{cgcom => dg}/pages/_partials/x.sh | 4 +-
.../{_partials/_dg_agilej.adoc => agilej.adoc} | 0
...g_asciidoc-syntax.adoc => asciidoc-syntax.adoc} | 0
...idoc-templates.adoc => asciidoc-templates.adoc} | 0
.../{_partials/_dg_asciidoc.adoc => asciidoc.adoc} | 5 --
.../modules/dg/pages/asciidoc/_attributes.adoc | 4 ++
.../build-and-review.adoc} | 0
.../instant-rebuild.adoc} | 0
.../naming-conventions.adoc} | 0
.../publish-procedure.adoc} | 0
.../writing-the-docs.adoc} | 0
.../_dg_building-isis.adoc => building-isis.adoc} | 0
.../{_partials/_dg_cmd-line.adoc => cmd-line.adoc} | 0
.../_dg_contributing.adoc => contributing.adoc} | 0
antora/components/support/modules/dg/pages/dg.adoc | 68 ----------------------
.../_dg_git-cookbook.adoc => git-cookbook.adoc} | 0
..._dg_hints-and-tips.adoc => hints-and-tips.adoc} | 8 ---
.../dg/pages/hints-and-tips/_attributes.adoc | 4 ++
.../datanucleus-enhancer.adoc} | 0
.../enabling-logging.adoc} | 0
.../enhance-only.adoc} | 0
.../how-run-fixtures-on-app-startup.adoc} | 0
.../dg/pages/{_partials/_dg_ide.adoc => ide.adoc} | 2 -
.../support/modules/dg/pages/ide/_attributes.adoc | 4 ++
.../_dg_ide_eclipse.adoc => ide/eclipse.adoc} | 0
.../_dg_ide_intellij.adoc => ide/intellij.adoc} | 0
..._dg_project-lombok.adoc => project-lombok.adoc} | 0
...any-repos.adoc => working-with-many-repos.adoc} | 0
.../components/toc/modules/ROOT/pages/about.adoc | 2 +-
.../pages/hints-and-tips/diagnosing-n-plus-1.adoc | 2 +-
33 files changed, 65 insertions(+), 93 deletions(-)
diff --git a/antora/components/support/modules/cgcom/nav.adoc b/antora/components/support/modules/cgcom/nav.adoc
index c53839c..64ee7fe 100644
--- a/antora/components/support/modules/cgcom/nav.adoc
+++ b/antora/components/support/modules/cgcom/nav.adoc
@@ -1,6 +1,4 @@
-* Committers' Guide
-
-** xref:about.adoc[About]
+* xref:about.adoc[Committers' Guide]
** xref:applying-patches.adoc[Applying Patches]
diff --git a/antora/components/support/modules/cgcom/pages/policies/_attributes.adoc b/antora/components/support/modules/cgcom/pages/policies/_attributes.adoc
new file mode 100644
index 0000000..d011536
--- /dev/null
+++ b/antora/components/support/modules/cgcom/pages/policies/_attributes.adoc
@@ -0,0 +1,4 @@
+ifndef::env-site,env-github[]
+:moduledir: ../..
+include::{moduledir}/_attributes.adoc[]
+endif::[]
diff --git a/antora/components/support/modules/dg/nav.adoc b/antora/components/support/modules/dg/nav.adoc
index e82d1b6..5accd87 100644
--- a/antora/components/support/modules/dg/nav.adoc
+++ b/antora/components/support/modules/dg/nav.adoc
@@ -1,5 +1,46 @@
-* Developers' Guide
+* xref:about.adoc[Developers' Guide]
+
+** xref:ide.adoc[IDE]
+*** xref:ide/intellij.adoc[IntelliJ]
+*** xref:ide/eclipse.adoc[Eclipse]
+
+
+** xref:hints-and-tips.adoc[Hints-n-Tips]
+*** xref:hints-and-tips/datanucleus-enhancer.adoc[Datanucleus Enhancer]
+*** xref:hints-and-tips/enabling-logging.adoc[Enabling Logging]
+*** xref:hints-and-tips/enhance-only.adoc[Enhance Only]
+*** xref:hints-and-tips/how-run-fixtures-on-app-startup.adoc[How to run Fixtures on App Startup]
+
+
+** xref:building-isis.adoc[Building Isis]
+
+
+** xref:asciidoc.adoc[Asciidoc]
+*** xref:asciidoc/naming-conventions.adoc[Naming Conventions]
+*** xref:asciidoc/writing-the-docs.adoc[Writing the Cods]
+*** xref:asciidoc/build-and-review.adoc[Build and Review]
+*** xref:asciidoc/instant-rebuild.adoc[Instant Rebuild]
+*** xref:asciidoc/publish-procedure.adoc[Publish Procedure]
+
+
+** xref:contributing.adoc[Contributing]
+
+
+** xref:git-cookbook.adoc[Git Cookbook]
+
+
+** xref:working-with-many-repos.adoc[Working with many Repos]
+
+
+** xref:asciidoc-syntax.adoc[Asciidoc Syntax]
+
+
+//** xref:asciidoc-templates.adoc[Asciidoc Templates]
+
+
+** xref:project-lombok.adoc[Project Lombok]
+
+
+** xref:agilej.adoc[AgileJ]
-** xref:about.adoc[About]
-** xref:dg.adoc[Guide]
diff --git a/antora/components/support/modules/cgcom/pages/_partials/x.sh b/antora/components/support/modules/dg/pages/_partials/x.sh
similarity index 57%
rename from antora/components/support/modules/cgcom/pages/_partials/x.sh
rename to antora/components/support/modules/dg/pages/_partials/x.sh
index cfa0bf2..065a6a6 100644
--- a/antora/components/support/modules/cgcom/pages/_partials/x.sh
+++ b/antora/components/support/modules/dg/pages/_partials/x.sh
@@ -1,7 +1,7 @@
#!/usr/bin/env bash
-for a in `ls | grep _cgcom`
+for a in `ls | grep _dg`
do
- b=$(echo $a | cut -c8- | sed 's|_|/|g')
+ b=$(echo $a | cut -c5- | sed 's|_|/|g')
d=$(dirname $b)
f=$(basename $b)
mkdir -p ../$d
diff --git a/antora/components/support/modules/dg/pages/_partials/_dg_agilej.adoc b/antora/components/support/modules/dg/pages/agilej.adoc
similarity index 100%
rename from antora/components/support/modules/dg/pages/_partials/_dg_agilej.adoc
rename to antora/components/support/modules/dg/pages/agilej.adoc
diff --git a/antora/components/support/modules/dg/pages/_partials/_dg_asciidoc-syntax.adoc b/antora/components/support/modules/dg/pages/asciidoc-syntax.adoc
similarity index 100%
rename from antora/components/support/modules/dg/pages/_partials/_dg_asciidoc-syntax.adoc
rename to antora/components/support/modules/dg/pages/asciidoc-syntax.adoc
diff --git a/antora/components/support/modules/dg/pages/_partials/_dg_asciidoc-templates.adoc b/antora/components/support/modules/dg/pages/asciidoc-templates.adoc
similarity index 100%
rename from antora/components/support/modules/dg/pages/_partials/_dg_asciidoc-templates.adoc
rename to antora/components/support/modules/dg/pages/asciidoc-templates.adoc
diff --git a/antora/components/support/modules/dg/pages/_partials/_dg_asciidoc.adoc b/antora/components/support/modules/dg/pages/asciidoc.adoc
similarity index 87%
rename from antora/components/support/modules/dg/pages/_partials/_dg_asciidoc.adoc
rename to antora/components/support/modules/dg/pages/asciidoc.adoc
index 73689d7..391fafc 100644
--- a/antora/components/support/modules/dg/pages/_partials/_dg_asciidoc.adoc
+++ b/antora/components/support/modules/dg/pages/asciidoc.adoc
@@ -25,11 +25,6 @@ The (Asciidoc) source code can be found at `adocs/documentation` (relative to ro
-include::_dg_asciidoc_naming-conventions.adoc[leveloffset=+1]
-include::_dg_asciidoc_writing-the-docs.adoc[leveloffset=+1]
-include::_dg_asciidoc_build-and-review.adoc[leveloffset=+1]
-include::_dg_asciidoc_instant-rebuild.adoc[leveloffset=+1]
-include::_dg_asciidoc_publish-procedure.adoc[leveloffset=+1]
diff --git a/antora/components/support/modules/dg/pages/asciidoc/_attributes.adoc b/antora/components/support/modules/dg/pages/asciidoc/_attributes.adoc
new file mode 100644
index 0000000..d011536
--- /dev/null
+++ b/antora/components/support/modules/dg/pages/asciidoc/_attributes.adoc
@@ -0,0 +1,4 @@
+ifndef::env-site,env-github[]
+:moduledir: ../..
+include::{moduledir}/_attributes.adoc[]
+endif::[]
diff --git a/antora/components/support/modules/dg/pages/_partials/_dg_asciidoc_build-and-review.adoc b/antora/components/support/modules/dg/pages/asciidoc/build-and-review.adoc
similarity index 100%
rename from antora/components/support/modules/dg/pages/_partials/_dg_asciidoc_build-and-review.adoc
rename to antora/components/support/modules/dg/pages/asciidoc/build-and-review.adoc
diff --git a/antora/components/support/modules/dg/pages/_partials/_dg_asciidoc_instant-rebuild.adoc b/antora/components/support/modules/dg/pages/asciidoc/instant-rebuild.adoc
similarity index 100%
rename from antora/components/support/modules/dg/pages/_partials/_dg_asciidoc_instant-rebuild.adoc
rename to antora/components/support/modules/dg/pages/asciidoc/instant-rebuild.adoc
diff --git a/antora/components/support/modules/dg/pages/_partials/_dg_asciidoc_naming-conventions.adoc b/antora/components/support/modules/dg/pages/asciidoc/naming-conventions.adoc
similarity index 100%
rename from antora/components/support/modules/dg/pages/_partials/_dg_asciidoc_naming-conventions.adoc
rename to antora/components/support/modules/dg/pages/asciidoc/naming-conventions.adoc
diff --git a/antora/components/support/modules/dg/pages/_partials/_dg_asciidoc_publish-procedure.adoc b/antora/components/support/modules/dg/pages/asciidoc/publish-procedure.adoc
similarity index 100%
rename from antora/components/support/modules/dg/pages/_partials/_dg_asciidoc_publish-procedure.adoc
rename to antora/components/support/modules/dg/pages/asciidoc/publish-procedure.adoc
diff --git a/antora/components/support/modules/dg/pages/_partials/_dg_asciidoc_writing-the-docs.adoc b/antora/components/support/modules/dg/pages/asciidoc/writing-the-docs.adoc
similarity index 100%
rename from antora/components/support/modules/dg/pages/_partials/_dg_asciidoc_writing-the-docs.adoc
rename to antora/components/support/modules/dg/pages/asciidoc/writing-the-docs.adoc
diff --git a/antora/components/support/modules/dg/pages/_partials/_dg_building-isis.adoc b/antora/components/support/modules/dg/pages/building-isis.adoc
similarity index 100%
rename from antora/components/support/modules/dg/pages/_partials/_dg_building-isis.adoc
rename to antora/components/support/modules/dg/pages/building-isis.adoc
diff --git a/antora/components/support/modules/dg/pages/_partials/_dg_cmd-line.adoc b/antora/components/support/modules/dg/pages/cmd-line.adoc
similarity index 100%
rename from antora/components/support/modules/dg/pages/_partials/_dg_cmd-line.adoc
rename to antora/components/support/modules/dg/pages/cmd-line.adoc
diff --git a/antora/components/support/modules/dg/pages/_partials/_dg_contributing.adoc b/antora/components/support/modules/dg/pages/contributing.adoc
similarity index 100%
rename from antora/components/support/modules/dg/pages/_partials/_dg_contributing.adoc
rename to antora/components/support/modules/dg/pages/contributing.adoc
diff --git a/antora/components/support/modules/dg/pages/dg.adoc b/antora/components/support/modules/dg/pages/dg.adoc
deleted file mode 100644
index 08055c9..0000000
--- a/antora/components/support/modules/dg/pages/dg.adoc
+++ /dev/null
@@ -1,68 +0,0 @@
-= Developers' Guide
-: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 [...]
-include::_attributes.adoc[]
-:numbered:
-:generate_pdf:
-
-
-== Developers' Guide
-
-This developers' guide is for:
-
-* programmers who want to just use Apache Isis to build applications, and want help setting up their development
-environment or to build their code from the command line (eg to execute within a continuous integration server such
-as Jenkins)
-
-* programmers who want to contribute back patches (bug fixes, new features) either to the codebase or the framework's documentation
-
-* committers of Apache Isis itself who want guidance on release process, publishing documents and other related procedures.
-
-
-
-=== Other Guides
-
-Apache Isis documentation is broken out into a number of user, reference and "supporting procedures" guides.
-
-The user guides available are:
-
-* xref:ug:fun:about.adoc#[Fundamentals]
-* xref:ug:vw:about.adoc[Wicket viewer]
-* xref:ug:vro:about.adoc[Restful Objects viewer]
-* xref:ug:odn:about.adoc#[DataNucleus object store]
-* xref:ug:sec:about.adoc#[Security]
-* xref:ug:tst:about.adoc#[Testing]
-* xref:ug:btb:about.adoc#[Beyond the Basics]
-
-The reference guides are:
-
-* xref:rg:ant:about.adoc#[Annotations]
-* xref:rg:svc:about.adoc#[Domain Services]
-* xref:rg:cfg:about.adoc#[Configuration Properties]
-* xref:rg:cms:about.adoc#[Classes, Methods and Schema]
-* xref:rg:mvn:about.adoc#[Apache Isis Maven plugin]
-* xref:rg:fis:about.adoc#[Framework Internal Services]
-
-The remaining guides are:
-
-* xref:support:dg:dg.adoc#[Developers' Guide] (this guide)
-* xref:support:cgcom:cgcom.adoc#[Committers' Guide] (release procedures and related practices)
-
-
-
-include::partial$_dg_ide.adoc[leveloffset=+1]
-
-include::partial$_dg_hints-and-tips.adoc[leveloffset=+1]
-
-include::partial$_dg_building-isis.adoc[leveloffset=+1]
-
-include::partial$_dg_asciidoc.adoc[leveloffset=+1]
-
-include::partial$_dg_contributing.adoc[leveloffset=+1]
-
-include::partial$_dg_git-cookbook.adoc[leveloffset=+1]
-include::partial$_dg_working-with-many-repos.adoc[leveloffset=+1]
-include::partial$_dg_asciidoc-syntax.adoc[leveloffset=+1]
-//include::partial$_dg_asciidoc-templates.adoc[leveloffset=+1]
-include::partial$_dg_project-lombok.adoc[leveloffset=+1]
-include::partial$_dg_agilej.adoc[leveloffset=+1]
-
diff --git a/antora/components/support/modules/dg/pages/_partials/_dg_git-cookbook.adoc b/antora/components/support/modules/dg/pages/git-cookbook.adoc
similarity index 100%
rename from antora/components/support/modules/dg/pages/_partials/_dg_git-cookbook.adoc
rename to antora/components/support/modules/dg/pages/git-cookbook.adoc
diff --git a/antora/components/support/modules/dg/pages/_partials/_dg_hints-and-tips.adoc b/antora/components/support/modules/dg/pages/hints-and-tips.adoc
similarity index 81%
rename from antora/components/support/modules/dg/pages/_partials/_dg_hints-and-tips.adoc
rename to antora/components/support/modules/dg/pages/hints-and-tips.adoc
index 01555e6..225192e 100644
--- a/antora/components/support/modules/dg/pages/_partials/_dg_hints-and-tips.adoc
+++ b/antora/components/support/modules/dg/pages/hints-and-tips.adoc
@@ -21,11 +21,3 @@ See also hints-n-tips chapters in the:
* the xref:ug:btb:hints-and-tips.adoc[Beyond the Basics] guide.
-// tag::inclusions[]
-
-include::_dg_hints-and-tips_datanucleus-enhancer.adoc[leveloffset=+1]
-include::_dg_hints-and-tips_enabling-logging.adoc[leveloffset=+1]
-include::_dg_hints-and-tips_enhance-only.adoc[leveloffset=+1]
-include::_dg_hints-and-tips_how-run-fixtures-on-app-startup.adoc[leveloffset=+1]
-
-// end::inclusions[]
diff --git a/antora/components/support/modules/dg/pages/hints-and-tips/_attributes.adoc b/antora/components/support/modules/dg/pages/hints-and-tips/_attributes.adoc
new file mode 100644
index 0000000..d011536
--- /dev/null
+++ b/antora/components/support/modules/dg/pages/hints-and-tips/_attributes.adoc
@@ -0,0 +1,4 @@
+ifndef::env-site,env-github[]
+:moduledir: ../..
+include::{moduledir}/_attributes.adoc[]
+endif::[]
diff --git a/antora/components/support/modules/dg/pages/_partials/_dg_hints-and-tips_datanucleus-enhancer.adoc b/antora/components/support/modules/dg/pages/hints-and-tips/datanucleus-enhancer.adoc
similarity index 100%
rename from antora/components/support/modules/dg/pages/_partials/_dg_hints-and-tips_datanucleus-enhancer.adoc
rename to antora/components/support/modules/dg/pages/hints-and-tips/datanucleus-enhancer.adoc
diff --git a/antora/components/support/modules/dg/pages/_partials/_dg_hints-and-tips_enabling-logging.adoc b/antora/components/support/modules/dg/pages/hints-and-tips/enabling-logging.adoc
similarity index 100%
rename from antora/components/support/modules/dg/pages/_partials/_dg_hints-and-tips_enabling-logging.adoc
rename to antora/components/support/modules/dg/pages/hints-and-tips/enabling-logging.adoc
diff --git a/antora/components/support/modules/dg/pages/_partials/_dg_hints-and-tips_enhance-only.adoc b/antora/components/support/modules/dg/pages/hints-and-tips/enhance-only.adoc
similarity index 100%
rename from antora/components/support/modules/dg/pages/_partials/_dg_hints-and-tips_enhance-only.adoc
rename to antora/components/support/modules/dg/pages/hints-and-tips/enhance-only.adoc
diff --git a/antora/components/support/modules/dg/pages/_partials/_dg_hints-and-tips_how-run-fixtures-on-app-startup.adoc b/antora/components/support/modules/dg/pages/hints-and-tips/how-run-fixtures-on-app-startup.adoc
similarity index 100%
rename from antora/components/support/modules/dg/pages/_partials/_dg_hints-and-tips_how-run-fixtures-on-app-startup.adoc
rename to antora/components/support/modules/dg/pages/hints-and-tips/how-run-fixtures-on-app-startup.adoc
diff --git a/antora/components/support/modules/dg/pages/_partials/_dg_ide.adoc b/antora/components/support/modules/dg/pages/ide.adoc
similarity index 92%
rename from antora/components/support/modules/dg/pages/_partials/_dg_ide.adoc
rename to antora/components/support/modules/dg/pages/ide.adoc
index f5aaec6..d633d5f 100644
--- a/antora/components/support/modules/dg/pages/_partials/_dg_ide.adoc
+++ b/antora/components/support/modules/dg/pages/ide.adoc
@@ -11,6 +11,4 @@ Apache Isis is built with Maven, and all modern IDEs can import Maven projects.
This chapter shows how to setup and use two of the most popular IDEs, IntelliJ IDEA and Eclipse.
-include::_dg_ide_intellij.adoc[leveloffset=+1]
-include::_dg_ide_eclipse.adoc[leveloffset=+1]
diff --git a/antora/components/support/modules/dg/pages/ide/_attributes.adoc b/antora/components/support/modules/dg/pages/ide/_attributes.adoc
new file mode 100644
index 0000000..d011536
--- /dev/null
+++ b/antora/components/support/modules/dg/pages/ide/_attributes.adoc
@@ -0,0 +1,4 @@
+ifndef::env-site,env-github[]
+:moduledir: ../..
+include::{moduledir}/_attributes.adoc[]
+endif::[]
diff --git a/antora/components/support/modules/dg/pages/_partials/_dg_ide_eclipse.adoc b/antora/components/support/modules/dg/pages/ide/eclipse.adoc
similarity index 100%
rename from antora/components/support/modules/dg/pages/_partials/_dg_ide_eclipse.adoc
rename to antora/components/support/modules/dg/pages/ide/eclipse.adoc
diff --git a/antora/components/support/modules/dg/pages/_partials/_dg_ide_intellij.adoc b/antora/components/support/modules/dg/pages/ide/intellij.adoc
similarity index 100%
rename from antora/components/support/modules/dg/pages/_partials/_dg_ide_intellij.adoc
rename to antora/components/support/modules/dg/pages/ide/intellij.adoc
diff --git a/antora/components/support/modules/dg/pages/_partials/_dg_project-lombok.adoc b/antora/components/support/modules/dg/pages/project-lombok.adoc
similarity index 100%
rename from antora/components/support/modules/dg/pages/_partials/_dg_project-lombok.adoc
rename to antora/components/support/modules/dg/pages/project-lombok.adoc
diff --git a/antora/components/support/modules/dg/pages/_partials/_dg_working-with-many-repos.adoc b/antora/components/support/modules/dg/pages/working-with-many-repos.adoc
similarity index 100%
rename from antora/components/support/modules/dg/pages/_partials/_dg_working-with-many-repos.adoc
rename to antora/components/support/modules/dg/pages/working-with-many-repos.adoc
diff --git a/antora/components/toc/modules/ROOT/pages/about.adoc b/antora/components/toc/modules/ROOT/pages/about.adoc
index af9362d..062916c 100644
--- a/antora/components/toc/modules/ROOT/pages/about.adoc
+++ b/antora/components/toc/modules/ROOT/pages/about.adoc
@@ -55,7 +55,7 @@ include::_attributes.adoc[]
|*Get involved!*
* *xref:support:dg:dg.adoc[Developers' Guide]*
-** xref:support:dg:dg.adoc#developing-using-intellij-idea[IntelliJ] & xref:support:dg:dg.adoc#eclipse[Eclipse]
+** xref:support:dg:ide/intellij.adoc[IntelliJ] & xref:support:dg:ide/eclipse.adoc[Eclipse]
** xref:support:dg:dg.adoc#contributing[Pull requests]
** xref:support:dg:dg.adoc#asciidoc-syntax[Asciidoc syntax]
diff --git a/antora/components/ug/modules/odn/pages/hints-and-tips/diagnosing-n-plus-1.adoc b/antora/components/ug/modules/odn/pages/hints-and-tips/diagnosing-n-plus-1.adoc
index ff5e09b..c188db7 100644
--- a/antora/components/ug/modules/odn/pages/hints-and-tips/diagnosing-n-plus-1.adoc
+++ b/antora/components/ug/modules/odn/pages/hints-and-tips/diagnosing-n-plus-1.adoc
@@ -11,4 +11,4 @@ The "Variables" pane will tell you which field(s) are being loaded, and the stac
For example, it may be that an object is being loaded in a table and the initial query did not eagerly load that field.
In such a case, consider using fetch groups in the initial repository query to bring the required data into memory with just one SQL call.
-See xref:ugodb.adoc#_ugodn_hints-and-tips_typesafe-queries-and-fetchgroups[this hint/tip] for further details.
\ No newline at end of file
+See xref:ug:odn:hints-and-tips/typesafe-queries-and-fetchgroups.adoc[this hint/tip] for further details.
\ No newline at end of file