ISIS-1465: factors out a new user guide for DN object store

apache · Sep 21, 2016 · 019b692 · 019b692
1 parent 469751d
commit 019b692
Show file tree

Hide file tree

Showing 19 changed files with 82 additions and 28 deletions.
diff --git a/adocs/documentation/src/main/asciidoc/documentation.adoc b/adocs/documentation/src/main/asciidoc/documentation.adoc
@@ -62,6 +62,7 @@ pass:[<br/>]
 * *link:./guides/ugfun.html[Fundamentals^]*  image:{_imagesdir}PDF-50.png[width="20px" link="./guides/ugfun.pdf"]
 * link:./guides/ugvw.html[Wicket Viewer^]  image:{_imagesdir}PDF-50.png[width="20px" link="./guides/ugvw.pdf"]
 * link:./guides/ugvro.html[Restful Objects Viewer^]  image:{_imagesdir}PDF-50.png[width="20px" link="./guides/ugvro.pdf"]
+* link:./guides/ugodn.html[DataNucleus Object Store^]  image:{_imagesdir}PDF-50.png[width="20px" link="./guides/ugvro.pdf"]
 * link:./guides/ugsec.html[Security^]  image:{_imagesdir}PDF-50.png[width="20px" link="./guides/ugsec.pdf"]
 * *link:./guides/ugtst.html[Testing^]*  image:{_imagesdir}PDF-50.png[width="20px" link="./guides/ugtst.pdf"]
 * link:./guides/ugbtb.html[Beyond the Basics^]  image:{_imagesdir}PDF-50.png[width="20px" link="./guides/ugbtb.pdf"]

diff --git a/adocs/documentation/src/main/asciidoc/guides/_ugbtb_datanucleus.adoc b/adocs/documentation/src/main/asciidoc/guides/_ugbtb_datanucleus.adoc
diff --git a/...idoc/guides/_ugbtb_datanucleus_java8.adoc → ...rc/main/asciidoc/guides/_ugodn_java8.adoc b/...idoc/guides/_ugbtb_datanucleus_java8.adoc → ...rc/main/asciidoc/guides/_ugodn_java8.adoc
@@ -1,4 +1,4 @@
-[[_ugbtb_datanucleus_java8]]
+[[_ugodn_java8]]
 = Java8
 :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 agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR  CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
 :_basedir: ../

diff --git a/...tanucleus_overriding-jdo-annotations.adoc → ...es/_ugodn_overriding-jdo-annotations.adoc b/...tanucleus_overriding-jdo-annotations.adoc → ...es/_ugodn_overriding-jdo-annotations.adoc
@@ -1,4 +1,4 @@
-[[_ugbtb_datanucleus_overriding-jdo-annotations]]
+[[_ugodn_overriding-jdo-annotations]]
 = Overriding JDO Annotations
 :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 agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR  CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
 :_basedir: ../

diff --git a/adocs/documentation/src/main/asciidoc/guides/cgcom.adoc b/adocs/documentation/src/main/asciidoc/guides/cgcom.adoc
@@ -20,8 +20,9 @@ Apache Isis documentation is broken out into a number of user, reference and "su
 The user guides available are:
 
 * xref:ugfun.adoc#[Fundamentals]
-* xref:ugvw.adoc#[Wicket viewer] (this guide)
+* xref:ugvw.adoc#[Wicket viewer]
 * xref:ugvro.adoc#[Restful Objects viewer]
+* xref:ugvro.adoc#[DataNucleus object store]
 * xref:ugsec.adoc#[Security]
 * xref:ugtst.adoc#[Testing]
 * xref:ugbtb.adoc#[Beyond the Basics]

diff --git a/adocs/documentation/src/main/asciidoc/guides/dg.adoc b/adocs/documentation/src/main/asciidoc/guides/dg.adoc
@@ -30,6 +30,7 @@ The user guides available are:
 * xref:ugfun.adoc#[Fundamentals]
 * xref:ugvw.adoc#[Wicket viewer]
 * xref:ugvro.adoc#[Restful Objects viewer]
+* xref:ugvro.adoc#[DataNucleus object store]
 * xref:ugsec.adoc#[Security]
 * xref:ugtst.adoc#[Testing]
 * xref:ugbtb.adoc#[Beyond the Basics]

diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant.adoc
@@ -22,6 +22,7 @@ The user guides available are:
 * xref:ugfun.adoc#[Fundamentals]
 * xref:ugvw.adoc#[Wicket viewer]
 * xref:ugvro.adoc#[Restful Objects viewer]
+* xref:ugvro.adoc#[DataNucleus object store]
 * xref:ugsec.adoc#[Security]
 * xref:ugtst.adoc#[Testing]
 * xref:ugbtb.adoc#[Beyond the Basics]

diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcfg.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcfg.adoc
@@ -32,6 +32,7 @@ The user guides available are:
 * xref:ugfun.adoc#[Fundamentals]
 * xref:ugvw.adoc#[Wicket viewer]
 * xref:ugvro.adoc#[Restful Objects viewer]
+* xref:ugvro.adoc#[DataNucleus object store]
 * xref:ugsec.adoc#[Security]
 * xref:ugtst.adoc#[Testing]
 * xref:ugbtb.adoc#[Beyond the Basics]

diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms.adoc
@@ -25,6 +25,7 @@ The user guides available are:
 * xref:ugfun.adoc#[Fundamentals]
 * xref:ugvw.adoc#[Wicket viewer]
 * xref:ugvro.adoc#[Restful Objects viewer]
+* xref:ugvro.adoc#[DataNucleus object store]
 * xref:ugsec.adoc#[Security]
 * xref:ugtst.adoc#[Testing]
 * xref:ugbtb.adoc#[Beyond the Basics]

diff --git a/adocs/documentation/src/main/asciidoc/guides/rgfis.adoc b/adocs/documentation/src/main/asciidoc/guides/rgfis.adoc
@@ -30,6 +30,7 @@ The user guides available are:
 * xref:ugfun.adoc#[Fundamentals]
 * xref:ugvw.adoc#[Wicket viewer]
 * xref:ugvro.adoc#[Restful Objects viewer]
+* xref:ugvro.adoc#[DataNucleus object store]
 * xref:ugsec.adoc#[Security]
 * xref:ugtst.adoc#[Testing]
 * xref:ugbtb.adoc#[Beyond the Basics]

diff --git a/adocs/documentation/src/main/asciidoc/guides/rgmvn.adoc b/adocs/documentation/src/main/asciidoc/guides/rgmvn.adoc
@@ -21,6 +21,7 @@ The user guides available are:
 * xref:ugfun.adoc#[Fundamentals]
 * xref:ugvw.adoc#[Wicket viewer]
 * xref:ugvro.adoc#[Restful Objects viewer]
+* xref:ugvro.adoc#[DataNucleus object store]
 * xref:ugsec.adoc#[Security]
 * xref:ugtst.adoc#[Testing]
 * xref:ugbtb.adoc#[Beyond the Basics]

diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc.adoc
@@ -25,6 +25,7 @@ The user guides available are:
 * xref:ugfun.adoc#[Fundamentals]
 * xref:ugvw.adoc#[Wicket viewer]
 * xref:ugvro.adoc#[Restful Objects viewer]
+* xref:ugvro.adoc#[DataNucleus object store]
 * xref:ugsec.adoc#[Security]
 * xref:ugtst.adoc#[Testing]
 * xref:ugbtb.adoc#[Beyond the Basics]

diff --git a/adocs/documentation/src/main/asciidoc/guides/ugbtb.adoc b/adocs/documentation/src/main/asciidoc/guides/ugbtb.adoc
@@ -23,6 +23,7 @@ The user guides available are:
 * xref:ugfun.adoc#[Fundamentals]
 * xref:ugvw.adoc#[Wicket viewer]
 * xref:ugvro.adoc#[Restful Objects viewer]
+* xref:ugvro.adoc#[DataNucleus object store]
 * xref:ugsec.adoc#[Security]
 * xref:ugtst.adoc#[Testing]
 * xref:ugbtb.adoc#[Beyond the Basics] (this guide)
@@ -47,7 +48,6 @@ include::_ugbtb_view-models.adoc[leveloffset=+1]
 include::_ugbtb_decoupling.adoc[leveloffset=+1]
 include::_ugbtb_i18n.adoc[leveloffset=+1]
 include::_ugbtb_headless-access.adoc[leveloffset=+1]
-include::_ugbtb_datanucleus.adoc[leveloffset=+1]
 include::_ugbtb_other-techniques.adoc[leveloffset=+1]
 include::_ugbtb_programming-model.adoc[leveloffset=+1]
 include::_ugbtb_deployment.adoc[leveloffset=+1]

diff --git a/adocs/documentation/src/main/asciidoc/guides/ugfun.adoc b/adocs/documentation/src/main/asciidoc/guides/ugfun.adoc
@@ -25,6 +25,7 @@ The user guides available are:
 * xref:ugfun.adoc#[Fundamentals] (this guide)
 * xref:ugvw.adoc#[Wicket viewer]
 * xref:ugvro.adoc#[Restful Objects viewer]
+* xref:ugvro.adoc#[DataNucleus object store]
 * xref:ugsec.adoc#[Security]
 * xref:ugtst.adoc#[Testing]
 * xref:ugbtb.adoc#[Beyond the Basics]

diff --git a/adocs/documentation/src/main/asciidoc/guides/ugodn.adoc b/adocs/documentation/src/main/asciidoc/guides/ugodn.adoc
@@ -0,0 +1,64 @@
+[[ugdnos]]
+= DataNucleus Object Store
+: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 agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR  CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+:_basedir: ../
+:_imagesdir: images/
+:numbered:
+
+
+
+
+[[_ugdnos]]
+== DataNucleus Object Store
+
+The DataNucleus Object Store enables domain objects to be persisted to relational as well as NoSQL databases.  The object store is implemented using link:http://datanuclues.org[DataNucleus].
+
+This user guide discuss end-user features, configuration and customization of the DataNucleus object store.
+
+
+
+[NOTE]
+====
+DataNucleus as a product also supports the JPA API; Apache Isis is likely to also support JPA in the future.
+====
+
+
+include::_ugbtb_datanucleus_overriding-jdo-annotations.adoc[leveloffset=+1]
+include::_ugbtb_datanucleus_java8.adoc[leveloffset=+1]
+
+
+
+=== Other Guides
+
+Apache Isis documentation is broken out into a number of user and reference guides.
+
+The user guides available are:
+
+* xref:ugfun.adoc#[Fundamentals]
+* xref:ugvw.adoc#[Wicket viewer]
+* xref:ugvro.adoc#[Restful Objects viewer]
+* xref:ugvro.adoc#[DataNucleus object store] (this guide)
+* xref:ugsec.adoc#[Security]
+* xref:ugtst.adoc#[Testing]
+* xref:ugbtb.adoc#[Beyond the Basics]
+
+The reference guides are:
+
+* xref:rgant.adoc#[Annotations]
+* xref:rgsvc.adoc#[Domain Services]
+* xref:rgcfg.adoc#[Configuration Properties]
+* xref:rgcms.adoc#[Classes, Methods and Schema]
+* xref:rgmvn.adoc#[Apache Isis Maven plugin]
+* xref:rgfis.adoc#[Framework Internal Services]
+
+The remaining guides are:
+
+* xref:dg.adoc#[Developers' Guide] (how to set up a development environment
+for Apache Isis and contribute back to the project)
+* xref:cgcom.adoc#[Committers' Guide] (release procedures and related practices)
+
+
+
+include::_ugodn_overriding-jdo-annotations.adoc[leveloffset=+1]
+include::_ugodn_java8.adoc[leveloffset=+1]
+
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugsec.adoc b/adocs/documentation/src/main/asciidoc/guides/ugsec.adoc
@@ -21,6 +21,7 @@ The user guides available are:
 * xref:ugfun.adoc#[Fundamentals]
 * xref:ugvw.adoc#[Wicket viewer]
 * xref:ugvro.adoc#[Restful Objects viewer]
+* xref:ugvro.adoc#[DataNucleus object store]
 * xref:ugsec.adoc#[Security] (this guide)
 * xref:ugtst.adoc#[Testing]
 * xref:ugbtb.adoc#[Beyond the Basics]

diff --git a/adocs/documentation/src/main/asciidoc/guides/ugtst.adoc b/adocs/documentation/src/main/asciidoc/guides/ugtst.adoc
@@ -26,6 +26,7 @@ The user guides available are:
 * xref:ugfun.adoc#[Fundamentals]
 * xref:ugvw.adoc#[Wicket viewer]
 * xref:ugvro.adoc#[Restful Objects viewer]
+* xref:ugvro.adoc#[DataNucleus object store]
 * xref:ugsec.adoc#[Security]
 * xref:ugtst.adoc#[Testing] (this guide)
 * xref:ugbtb.adoc#[Beyond the Basics]

diff --git a/adocs/documentation/src/main/asciidoc/guides/ugvro.adoc b/adocs/documentation/src/main/asciidoc/guides/ugvro.adoc
@@ -31,6 +31,7 @@ The user guides available are:
 * xref:ugfun.adoc#[Fundamentals]
 * xref:ugvw.adoc#[Wicket viewer]
 * xref:ugvro.adoc#[Restful Objects viewer] (this guide)
+* xref:ugvro.adoc#[DataNucleus object store]
 * xref:ugsec.adoc#[Security]
 * xref:ugtst.adoc#[Testing]
 * xref:ugbtb.adoc#[Beyond the Basics]

diff --git a/adocs/documentation/src/main/asciidoc/guides/ugvw.adoc b/adocs/documentation/src/main/asciidoc/guides/ugvw.adoc
@@ -27,6 +27,7 @@ The user guides available are:
 * xref:ugfun.adoc#[Fundamentals]
 * xref:ugvw.adoc#[Wicket viewer] (this guide)
 * xref:ugvro.adoc#[Restful Objects viewer]
+* xref:ugvro.adoc#[DataNucleus object store]
 * xref:ugsec.adoc#[Security]
 * xref:ugtst.adoc#[Testing]
 * xref:ugbtb.adoc#[Beyond the Basics]