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 2017/03/31 07:10:48 UTC
[12/51] [partial] isis git commit: ISIS-1521: reorganizes asciidoc
documentation, moves into subdirs (both guides and other pages)
http://git-wip-us.apache.org/repos/asf/isis/blob/2669a971/adocs/documentation/src/main/asciidoc/guides/dg/_dg_asciidoc-templates.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/dg/_dg_asciidoc-templates.adoc b/adocs/documentation/src/main/asciidoc/guides/dg/_dg_asciidoc-templates.adoc
new file mode 100644
index 0000000..b8147ce
--- /dev/null
+++ b/adocs/documentation/src/main/asciidoc/guides/dg/_dg_asciidoc-templates.adoc
@@ -0,0 +1,749 @@
+[[_dg_asciidoc-templates]]
+= Appendix: Asciidoc Templates
+: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/
+:toc: right
+
+
+
+This appendix lists the (IntelliJ) live templates available for xref:dg.adoc#_dg_asciidoc[writing documentation] using Asciidoc. Instructions for installing the templates can be found xref:dg.adoc#__dg_ide_intellij_live-templates[here].
+
+In the examples below the text `xxx`, `yyy`, `zzz` are correspond to template variables (ie placeholders).
+
+== Admonitions (Callouts)
+
+
+[cols="1,4a,2a", options="header"]
+|===
+| Abbrev.
+| Produces
+| Example
+
+|`adadmimportant`
+|....
+[IMPORTANT]
+====
+xxx
+====
+....
+
+|[IMPORTANT]
+====
+xxx
+====
+
+|`adadmnote`
+|....
+[NOTE]
+====
+xxx
+====
+....
+
+|[NOTE]
+====
+xxx
+====
+....
+
+|`adadmtip`
+|....
+[TIP]
+====
+xxx
+====
+....
+
+|[TIP]
+====
+xxx
+====
+....
+
+|`adadmwarning`
+|....
+[WARNING]
+====
+xxx
+====
+....
+
+|[WARNING]
+====
+xxx
+====
+
+|===
+
+
+== TODO notes
+
+Add as a placeholder for documentation still to be written or which is work-in-progress.
+
+[cols="1,4a,2a", options="header"]
+|===
+| Abbrev.
+| Produces
+| Example
+
+|`adtodo`
+|....
+NOTE: TODO
+....
+
+|NOTE: TODO
+
+|`adwip`
+|....
+NOTE: WIP - xxx
+....
+
+where:
+
+* `xxx` is additional explanatory text
+
+|NOTE: WIP - cool new feature
+
+|===
+
+
+
+
+== Xref to Guides
+
+Cross-references (links) to the various guides
+
+[cols="1,4a,2a", options="header"]
+|===
+| Abbrev.
+| Produces
+| Example
+
+
+|`adcgcom`
+|`\xref:cgcom.adoc#xxx[ttt]`
+
+a hyperlink to a bookmark within the committers' guide, where:
+
+* `xxx` is the bookmark's anchor
+* `ttt` is the text to display as the hyperlink
+
+for example:
+
+`\xref:dg.adoc#_cgcom_cutting-a-release[Cutting a release\]`
+
+|`addg`
+|`\xref:dg.adoc#xxx[ttt]`
+
+a hyperlink to a bookmark within the developers' guide, where:
+
+* `xxx` is the bookmark's anchor
+* `ttt` is the text to display as the hyperlink
+
+for example:
+
+`\xref:dg.adoc#_dg_asciidoc-templates[Asciidoc templates\]`
+
+|xref:dg.adoc#_dg_asciidoc-templates[Asciidoc templates]
+
+
+
+|`adrgant`
+|`\xref:rgant.adoc#xxx[ttt]`
+
+a hyperlink to a bookmark within the reference guide for annotations, where:
+
+* `xxx` is the bookmark
+* `ttt` is the text to display as the hyperlink
+
+for example:
+
+`\xref:rgant.adoc#_rgant-aaa_main[Core annotations]`
+
+|xref:rgant.adoc#_rgant-aaa_main[Core annotations]
+
+
+
+|`adrgcfg`
+|`\xref:rgcfg.adoc#xxx[ttt]`
+
+a hyperlink to a bookmark within the reference guide for configuration properties guide, where:
+
+* `xxx` is the bookmark
+* `ttt` is the text to display as the hyperlink
+
+for example:
+
+`\xref:rgcfg.adoc#_rgcfg_configuring-core[Configuring Core]`
+
+|xref:rgcfg.adoc#_rgcfg_configuring-core[Configuring Core]
+
+
+
+|`adrgcms`
+|`\xref:rgcms.adoc#xxx[ttt]`
+
+a hyperlink to a bookmark within the reference guide for classes, methods and schema, where:
+
+* `xxx` is the bookmark
+* `ttt` is the text to display as the hyperlink
+
+for example:
+
+`\xref:rgcms.adoc#_rgcms_classes_super_AbstractService[`AbstractService`]`
+
+|xref:rgcms.adoc#_rgcms_classes_super_AbstractService[`AbstractService`]
+
+
+
+|`adrgsvc`
+|`\xref:rgsvc.adoc#xxx[ttt]`
+
+a hyperlink to a bookmark within the reference guide for domain services, where:
+
+* `xxx` is the bookmark
+* `ttt` is the text to display as the hyperlink
+
+for example:
+
+`\xref:rgsvc.adoc#_rgcms_classes_AppManifest-bootstrapping[`AppManifest` bootstrapping]`
+
+|xref:rgsvc.adoc#_rgcms_classes_AppManifest-bootstrapping[`AppManifest` bootstrapping]
+
+
+
+|`adrgmvn`
+|`\xref:rgmvn.adoc#xxx[ttt]`
+
+a hyperlink to a bookmark within the reference guide for the maven plugin, where:
+
+* `xxx` is the bookmark
+* `ttt` is the text to display as the hyperlink
+
+for example:
+
+`\xref:rgmvn.adoc#_rgmvn_validate[validate goal]`
+
+|xref:rgmvn.adoc#_rgmvn_validate[validate goal]
+
+
+
+|`adrgna`
+|`\xref:rgant.adoc#_rgant-xxx[`@xxx`]`
+
+a hyperlink to the "man page" for an annotation within the reference guide for annotations, where:
+
+* `xxx` is the annotation type (eg `@Action`)
+
+for example:
+
+`\xref:rgant.adoc#_rgant-Action[`@Action`]`
+
+|xref:rgant.adoc#_rgant-Action[`@Action`]
+
+
+
+|`adrgnt`
+|`\xref:rgant.adoc#_rgant-xxx_ttt[`@xxx#ttt()`]`
+
+a hyperlink to the "man page" for the specific attribute (field) of an annotation within the reference guide for annotations, where:
+
+* `xxx` is the annotation type (eg `@Action`)
+* `ttt` is the attribute (eg `@semantics`)
+
+for example:
+
+`\xref:rgant.adoc#_rgant-Action_semantics[`@Action#semantics()`]`
+
+|xref:rgant.adoc#_rgant-Action_semantics[`@Action#semantics()`]
+
+
+
+|`adrgsa`
+|`\xref:rgsvc.adoc#_rgsvc_api_xxx[`xxx`]`
+
+a hyperlink to the "man page" for an (API) domain service within the reference guide for domain services, where:
+
+* `xxx` is the domain service (eg `DomainObjectContainer`)
+
+for example:
+
+`\xref:rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`DomainObjectContainer`]`
+
+|xref:rgsvc.adoc#_rgsvc_api_DomainObjectContainer[`DomainObjectContainer`]
+
+
+
+|`adrgss`
+|`\xref:rgsvc.adoc#_rgsvc_spi_xxx[`xxx`]`
+
+a hyperlink to the "man page" for an (SPI) domain service within the reference guide for domain services, where:
+
+* `xxx` is the domain service (eg `ContentMappingService`)
+
+for example:
+
+`\xref:rgsvc.adoc#_rgsvc_spi_ContentMappingService[`ContentMappingService`]`
+
+|xref:rgsvc.adoc#_rgsvc_spi_ContentMappingService[`ContentMappingService`]
+
+
+
+
+|`adugfun`
+|`\xref:ugfun.adoc#xxx[ttt]`
+
+a hyperlink to a bookmark within the fundamentals users' guide, where:
+
+* `xxx` is the bookmark's anchor
+* `ttt` is the text to display as the hyperlink
+
+for example:
+
+`\xref:ugfun.adoc#_ugfun_core-concepts[Core concepts]`
+
+|xref:ugfun.adoc#_ugfun_core-concepts[Core concepts]
+
+
+
+
+|`adugvw`
+|`\xref:ugvw.adoc#xxx[ttt]`
+
+A hyperlink to a bookmark within the Wicket viewer guide, where:
+
+* `xxx` is the bookmark's anchor
+* `ttt` is the text to display as the hyperlink.
+
+for example:
+
+`\xref:ugvw.adoc#_ugvw_customisation[Customisation]`
+
+|xref:ugvw.adoc#_ugvw_customisation[Customisation]
+
+
+|`adugvro`
+|`\xref:ugvro.adoc#xxx[ttt]`
+
+A hyperlink to a bookmark within the Restful Objects viewer guide, where:
+
+* `xxx` is the bookmark's anchor
+* `ttt` is the text to display as the hyperlink.
+
+for example:
+
+`\xref:ugvro.adoc#_ugvro_ro-spec[RestfulObjects specification]`
+
+|xref:ugvro.adoc#_ugvro_ro-spec[RestfulObjects specification]
+
+
+
+|`adugsec`
+|`\xref:ugsec.adoc#xxx[ttt]`
+
+A hyperlink to a bookmark within the Secrurity guide, where:
+
+* `xxx` is the bookmark's anchor
+* `ttt` is the text to display as the hyperlink.
+
+for example:
+
+`\xref:ugsec.adoc#_ugsec_shiro-caching[Caching and other Shiro Features]`
+
+|xref:ugsec.adoc#_ugsec_shiro-caching[Caching and other Shiro Features]
+
+
+|`adugtst`
+|`\xref:ugtst.adoc#xxx[ttt]`
+
+A hyperlink to a bookmark within the Testing guide, where:
+
+* `xxx` is the bookmark's anchor
+* `ttt` is the text to display as the hyperlink.
+
+for example:
+
+`\xref:ugtst.adoc#_ugtst_bdd-spec-support[BDD Spec Support]`
+
+|xref:ugtst.adoc#_ugtst_bdd-spec-support[BDD Spec Support]
+
+
+|`adugbtb`
+|`\xref:ugbtb.adoc#xxx[ttt]`
+
+A hyperlink to a bookmark within the 'Beyond the Basics' user guide, where:
+
+* `xxx` is the bookmark's anchor
+* `ttt` is the text to display as the hyperlink.
+
+for example:
+
+`\xref:ugbtb.adoc#_ugbtb_deployment_externalized-configuration[Externalized Configuration]`
+
+|xref:ugbtb.adoc#_ugbtb_deployment_externalized-configuration[Externalized Configuration]
+
+
+
+
+|===
+
+
+
+
+== Link to Isis Addons
+
+Links to (non-ASF) link:http://isisaddons.org[Isis Addons]
+
+[cols="1,4a,2a", options="header"]
+|===
+| Abbrev.
+| Produces
+| Example
+
+
+|`adlinkaddons`
+|`(non-ASF) \link:\http://isisaddons.org[[Isis Addons]]`
+
+link to the Isis Addons website.
+
+|(non-ASF) link:http://isisaddons.org[Isis Addons]
+
+
+
+|`adlinkaddonsapp`
+|`(non-ASF) \link:\http://github.com/isisaddons/isis-app-xxx[[Isis addons' xxx]]`
+
+link to the github repo for an example app from the Isis addons; where:
+
+* `xxx` is the name of the example app being linked to
+
+for example:
+
+pass:[<pre>(non-ASF) http://github.com/isisaddons/isis-app-todoapp[Isis addons' todoapp]`
+
+|(non-ASF) http://github.com/isisaddons/isis-app-todoapp[Isis addons' todoapp]
+
+
+
+|`adlinkaddonsmodule`
+|`(non-ASF) \http://github.com/isisaddons/isis-module-xxx[[Isis addons' xxx]] module`
+
+link to the github repo for a module from the Isis addons; where:
+
+* `xxx` is the name of the module being linked to
+
+for example:
+
+`(non-ASF) \http://github.com/isisaddons/isis-module-security[[Isis addons' security]] module`
+
+|(non-ASF) http://github.com/isisaddons/isis-module-security[Isis addons' security] module
+
+
+
+|`adlinkaddonswicket`
+|`(non-ASF) \http://github.com/isisaddons/isis-wicket-xxx[[Isis addons' xxx]] wicket extension`
+
+link to the github repo for a wicket UI component from the Isis addons; where:
+
+* `xxx` is the name of the wicket UI component being linked to
+
+for example:
+
+`(non-ASF) \http://github.com/isisaddons/isis-wicket-gmap3[[Isis addons' gmap3]] wicket extension`
+
+
+|(non-ASF) http://github.com/isisaddons/isis-wicket-gmap3[Isis addons' gmap3 ] wicket extension
+
+|===
+
+
+
+
+== Source code
+
+[cols="1,4a,2a", options="header"]
+|===
+| Abbrev.
+| Produces
+| Example
+
+|`adsrcjava`
+|....
+[source,java]
+----
+xxx
+----
+....
+
+where:
+
+* `xxx` is the source code snippet.
+
+|[source,java]
+----
+public class Foo {
+ ...
+}
+----
+
+
+|`adsrcjavac`
+|as for `adsrcjava`, but with a caption above
+|
+
+
+
+|`adsrcjavascript`
+|....
+[source,javascript]
+----
+xxx
+----
+....
+
+where:
+
+* `xxx` is the source code snippet.
+
+|[source,javascript]
+----
+$(document).ready(function() {
+ ...
+});
+----
+
+
+
+|`adsrcjavascriptc`
+|as for `adsrcjavascript`, but with a caption above
+
+|
+
+|`adsrcother`
+|....
+[source,nnn]
+----
+xxx
+---
+....
+
+where:
+
+* `nnn` is the programming language
+* `xxx` is the source code snippet.
+
+|
+
+|`adsrcotherc`
+|as for `adsrcother`, but with a caption above
+
+
+|
+
+|`adsrcxml`
+|....
+[source,javascript]
+----
+xxx
+----
+....
+
+
+where:
+
+* `xxx` is the source code snippet.
+
+|[source,xml]
+----
+<html>
+ <title>
+ hello world!
+ </title>
+</html>
+----
+
+
+|`adsrcxmlc`
+|as for `adsrcxml`, but with a caption above
+|
+
+|===
+
+
+== Images
+
+[cols="1,4a,2a", options="header"]
+|===
+| Abbrev.
+| Produces
+| Example
+
+|`adimgfile`
+|`\image:{_imagesdir}xxx/yyy.png[width="WWWpx",link="{_imagesdir}xxx/yyy.png"]`
+
+embeds specified image, where:
+
+* `xxx` is the subdirectory under the `images/` directory
+* `yyy` is the image
+* `WWW` is the width, in pixels.
+
+for example:
+
+`\image:{_imagesdir}wicket-viewer/layouts/estatio-Lease.png[width="300px",link="{_imagesdir}wicket-viewer/layouts/estatio-Lease.png"]`
+
+|image:{_imagesdir}wicket-viewer/layouts/estatio-Lease.png[width="300px",link="{_imagesdir}wicket-viewer/layouts/estatio-Lease.png"]
+
+
+
+|`adimgfilec`
+|as for `adimgfile`, but with a caption above
+|
+
+
+|`adimgurl`
+|`\image:xxx[width="WWWpx",link="xxx"]`
+
+embeds image from specified URL, where:
+
+* `xxx` is the URL to the image
+* `WWW` is the width, in pixels.
+
+|
+
+
+
+|`adimgurlc`
+|as for `adimgurl`, but with a caption above
+|
+
+
+|===
+
+
+
+== YouTube (screencasts)
+
+Embedded youtube screencasts. (Don't use these in guides, as they cannot be rendered as PDF).
+
+[cols="1,4a,2a", options="header"]
+|===
+| Abbrev.
+| Produces
+| Example
+
+|`adyoutube`
+|`video:xxx[youtube,width="WWWpx",height="HHHpx"]`
+
+where:
+
+* `xxx` is the youtube reference
+* `WWW` is the width, in pixels
+* `HHH` is the height, in pixels
+
+for example:
+
+`video::bj8735nBRR4[youtube,width="210px",height="118px"]`
+
+|video::bj8735nBRR4[youtube,width="210px",height="118px"]
+
+
+|`adyoutubec`
+|as for `youtube`, but with a caption above
+|
+
+|===
+
+
+== Tables
+
+[cols="1,4a,2a", options="header"]
+|===
+| Abbrev.
+| Produces
+| Example
+
+|`adtbl3`
+|Table with 3 columns, 3 rows.
+|
+
+
+|===
+
+
+== Misc.
+
+[cols="1,4a,2a", options="header"]
+|===
+| Abbrev.
+| Produces
+| Example
+
+|`adai`
+|`Apache Isis` +
+
+That is, the literal text "Apache Isis".
+|Apache Isis
+
+
+
+|`adlink`
+|`\link:xxx[ttt]`
+
+, where:
+
+* `xxx` is
+* `ttt` is the text to display as the hyperlink
+
+for example:
+
+`\link:\http://isis.apache.org[[Apache Isis website]]`
+
+|link:http://isis.apache.org[Apache Isis website]
+
+
+
+
+|`adanchany`
+|`= anchor:[xxx]`
+
+defines an inline anchor to any heading, where:
+
+* `xxx` is the anchor text.
+
+For example:
+
+`= anchor:[_ugfun_i18n] Internationalization`
+
+An alternative (more commonly used in our documentation) is to use the `[[...]]` directly above the heading:
+
+....
+[[_ugfun_i18n]]
+= Internationalization
+....
+
+|
+
+
+|`adxrefany`
+|`\xref:[xxx]`
+
+cross-reference to any document/anchor, where:
+
+* `xxx` is the fully qualified document with optional anchor
+
+|
+
+
+|`adfootnote`
+|`\footnote:[xxx]`
+
+defines a footnote
+
+|footnote:[this is a footnote]
+
+
+
+|===
+
+
http://git-wip-us.apache.org/repos/asf/isis/blob/2669a971/adocs/documentation/src/main/asciidoc/guides/dg/_dg_asciidoc.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/dg/_dg_asciidoc.adoc b/adocs/documentation/src/main/asciidoc/guides/dg/_dg_asciidoc.adoc
new file mode 100644
index 0000000..cc55355
--- /dev/null
+++ b/adocs/documentation/src/main/asciidoc/guides/dg/_dg_asciidoc.adoc
@@ -0,0 +1,40 @@
+[[_dg_asciidoc]]
+= AsciiDoc Documentation
+
+: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/
+:toc: right
+
+
+
+Apache Isis' documentation (meaning the website and the users' guide, the reference guide and this contributors' guide) is written using link:http://www.methods.co.nz/asciidoc/[Asciidoc], specifically the link:asciidoctor.org/[Asciidoctor] implementation.
+
+The website and guides are created by running build tools (documented below) which create the HTML version of the site and guides.
+You can therefore easily check the documentation before raising a pull request (as a contributor) or publishing the site (if a committer).
+
+To help write the Asciidoc text itself, we provide some xref:dg.adoc#_dg_asciidoc-templates[Asciidoc templates].
+
+Publishing is performed by copying the generated HTML to a different git repository (link:https://git-wip-us.apache.org/repos/asf?p=isis-site.git[isis-site]).
+Since this can only be done by Apache Isis committers, the process for doing this is described in the xref:cgcom.adoc#_cgcom_asciidoc-publish-procedure[committers' guide].
+This is synced by ASF infrastructure over to link:http://isis.apache.org[isis.apache.org].
+
+
+
+== Where to find the Docs
+
+The (Asciidoc) source code can be found at `adocs/documentation` (relative to root). Online you'll find it link:https://github.com/apache/isis/tree/master/adocs/documentation[cloned to github here].
+
+
+
+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]
+
+
+
+
+
+
http://git-wip-us.apache.org/repos/asf/isis/blob/2669a971/adocs/documentation/src/main/asciidoc/guides/dg/_dg_asciidoc_build-and-review.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/dg/_dg_asciidoc_build-and-review.adoc b/adocs/documentation/src/main/asciidoc/guides/dg/_dg_asciidoc_build-and-review.adoc
new file mode 100644
index 0000000..6e46097
--- /dev/null
+++ b/adocs/documentation/src/main/asciidoc/guides/dg/_dg_asciidoc_build-and-review.adoc
@@ -0,0 +1,22 @@
+[[_dg_asciidoc_build-and-review]]
+= Build and Review (using Maven)
+
+: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/
+:toc: right
+
+
+
+
+To (re)build the documentation locally prior to release, change into the `adocs/documentation` directory and use:
+
+[source]
+----
+mvn clean compile
+----
+
+The site will be generated at `target/site/index.html`.
+
+You could then use a web server such as Python's SimpleHTTPServer to preview (so that all Javascript works correctly). However, instead we recommend using instant preview, described next.
+
http://git-wip-us.apache.org/repos/asf/isis/blob/2669a971/adocs/documentation/src/main/asciidoc/guides/dg/_dg_asciidoc_instant-rebuild.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/dg/_dg_asciidoc_instant-rebuild.adoc b/adocs/documentation/src/main/asciidoc/guides/dg/_dg_asciidoc_instant-rebuild.adoc
new file mode 100644
index 0000000..ac7c140
--- /dev/null
+++ b/adocs/documentation/src/main/asciidoc/guides/dg/_dg_asciidoc_instant-rebuild.adoc
@@ -0,0 +1,56 @@
+[[_dg_asciidoc_instant-rebuild]]
+= Instant Rebuild (using Ruby)
+
+: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/
+:toc: right
+
+
+
+
+The ruby script, `monitor.rb` emulates the `mvn compile` command, regenerating any changed Asciidoctor files to the relevant `target/site` directory. Moreover if any included files are changed then it rebuilds the parent (per the above naming convention).
+
+== One-time setup
+
+To setup:
+
+* download and install ruby 2.0.0, from link:rubyinstaller.org/downloads[http://rubyinstaller.org/downloads/]
+* download devkit for the Ruby 2.0 installation, also from link:rubyinstaller.org/downloads[http://rubyinstaller.org/downloads/]. Then follow the link:https://github.com/oneclick/rubyinstaller/wiki/Development-Kit[installation instructions] on their wiki
+
+
+[NOTE]
+====
+We use Ruby 2.0 rather than 2.1 because the wdm gem (required to monitor the filesystem if running on Windows) is not currently compatible with Ruby 2.1.
+====
+
+To download the required Ruby dependencies, use:
+
+[source,bash]
+----
+gem install bundler
+bundle install
+----
+
+== Instant Rebuild
+
+To run, we typically just use:
+
+[source,bash]
+----
+sh preview-html.sh
+----
+
+This script just runs `mvn compile` for HTML files only, then calls `python` to start the web browser and run a simple web server (on port 8000).
+
+If you want to double-check the PDFs also, then use:
+
+[source,bash]
+----
+sh preview-pdf.sh
+----
+
+
+
+
+
http://git-wip-us.apache.org/repos/asf/isis/blob/2669a971/adocs/documentation/src/main/asciidoc/guides/dg/_dg_asciidoc_naming-conventions.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/dg/_dg_asciidoc_naming-conventions.adoc b/adocs/documentation/src/main/asciidoc/guides/dg/_dg_asciidoc_naming-conventions.adoc
new file mode 100644
index 0000000..ae92b10
--- /dev/null
+++ b/adocs/documentation/src/main/asciidoc/guides/dg/_dg_asciidoc_naming-conventions.adoc
@@ -0,0 +1,47 @@
+[[_dg_asciidoc_naming-conventions]]
+= Naming Conventions
+
+: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/
+:toc: right
+
+
+
+
+
+For documents with inclusions, use '_' to separate out the logical hierarchy:
+
+[source]
+----
+xxx-xxx/xxx-xxx.adoc
+ _xxx-xxx_ppp-ppp.adoc
+ _xxx-xxx_qqq-qqq.adoc
+ _xxx-xxx_qqq-qqq_mmm-mmm.adoc
+ _xxx-xxx_qqq-qqq_nnn-nnn.adoc
+----
+
+Any referenced images should be in subdirectories of the `images` directory:
+
+[source]
+----
+xxx-xxx/images/.
+ /ppp-ppp/.
+ /qqq-qqq/.
+ /mmm-mmm
+ /nnn-nnn
+----
+
+And similarly any resources should be in the `resources` subdirectory:
+
+[source]
+----
+xxx-xxx/resources/.
+ ppp-ppp/.
+ qqq-qqq/.
+ /mmm-mmm/
+ /nnn-nnn/
+----
+
+
+
http://git-wip-us.apache.org/repos/asf/isis/blob/2669a971/adocs/documentation/src/main/asciidoc/guides/dg/_dg_asciidoc_publish-procedure.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/dg/_dg_asciidoc_publish-procedure.adoc b/adocs/documentation/src/main/asciidoc/guides/dg/_dg_asciidoc_publish-procedure.adoc
new file mode 100644
index 0000000..f7dcc2e
--- /dev/null
+++ b/adocs/documentation/src/main/asciidoc/guides/dg/_dg_asciidoc_publish-procedure.adoc
@@ -0,0 +1,13 @@
+[[_dg_asciidoc_publish-procedure]]
+= Publish procedure
+
+: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/
+:toc: right
+
+
+
+Only Apache Isis committers can publish to link:http://isis.apache.org[isis.apache.org].
+See the xref:cgcom.adoc#_cgcom_publishing-the-docs[committers' guide] for further details.
+
http://git-wip-us.apache.org/repos/asf/isis/blob/2669a971/adocs/documentation/src/main/asciidoc/guides/dg/_dg_asciidoc_writing-the-docs.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/dg/_dg_asciidoc_writing-the-docs.adoc b/adocs/documentation/src/main/asciidoc/guides/dg/_dg_asciidoc_writing-the-docs.adoc
new file mode 100644
index 0000000..51da1b0
--- /dev/null
+++ b/adocs/documentation/src/main/asciidoc/guides/dg/_dg_asciidoc_writing-the-docs.adoc
@@ -0,0 +1,14 @@
+[[_dg_asciidoc_writing-the-docs]]
+= Writing the docs
+
+: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/
+:toc: right
+
+
+
+
+We highly recommend that you install the (IntelliJ) live templates for Asciidoctor, as described in xref:dg.adoc#__dg_ide_intellij_live-templates[IDE templates]. These provide a large number of helper templates.
+
+An xref:dg.adoc#_dg_appendix_asciidoc-templates[appendix] lists all the templates available, demonstrating their intended usage and output.
http://git-wip-us.apache.org/repos/asf/isis/blob/2669a971/adocs/documentation/src/main/asciidoc/guides/dg/_dg_building-isis.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/dg/_dg_building-isis.adoc b/adocs/documentation/src/main/asciidoc/guides/dg/_dg_building-isis.adoc
new file mode 100644
index 0000000..e92b0f1
--- /dev/null
+++ b/adocs/documentation/src/main/asciidoc/guides/dg/_dg_building-isis.adoc
@@ -0,0 +1,293 @@
+[[_dg_building-isis]]
+= Building Apache Isis
+: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/
+:toc: right
+
+
+
+
+[[__dg_building-isis_git]]
+== Git
+
+The Apache Isis source code lives in a git repo.
+
+
+[[__dg_building-isis_git_installation]]
+=== Installation
+
+The easiest place to get hold of command-line git is probably the http://git-scm.com/downloads[github download page].
+
+On Windows, this also installs the rather good mSysGit Unix shell. We recommend that you enable git for both the mSysgit and the Windows command prompt:
+
+image::{_imagesdir}building-isis/setting-up-git.png[width="350px",link="{_imagesdir}building-isis/setting-up-git.png"]
+
+Once git is installed, the two main command line tools to note are:
+
+* `git` command line tool
+* `gitk` for viewing the commit history
+
+If using Windows, note that github also have a dedicated https://help.github.com/articles/set-up-git[Windows client]. With a little http://haacked.com/archive/2012/05/30/using-github-for-windows-with-non-github-repositories.aspx[hacking around], it can also be made to work with non-github repositories.
+
+If using Mac, you might also want to check out Atlassian's http://www.atlassian.com/software/sourcetree/overview[Sourcetree].
+
+
+
+[[__dg_building-isis_git_installation_cloning-the-apache-isis-repo]]
+==== Cloning the Apache Isis repo
+
+First, clone the Apache Isis repo.
+
+If you are a *committer*, then clone from the Apache read/write repo:
+
+[source,bash]
+----
+git clone https://git-wip-us.apache.org/repos/asf/isis.git
+----
+
+
+If you are *not a committer*, please see the xref:dg.adoc#_dg_contributing[contributing] page for details on which repo to clone from.
+
+
+[[__dg_building-isis_git_installation_configuring-git]]
+==== Configuring Git
+
+Next up is to configure your user name and password; see also https://git-wip-us.apache.org/[Apache's git] docs:
+
+[source,bash]
+----
+git config user.name "<i>My Name Here</i>"
+git config user.email <i>myusername@apache.org</i>
+----
+
+Next, configure the `core.autocrlf` so that line endings are normalized to LF (Unix style) in the rep; again see https://git-wip-us.apache.org/[Apache's git] page:
+
+
+* on Windows, use: +
++
+[source,bash]
+----
+git config core.autocrlf true
+----
+
+* on Mac/Linux, use: +
++
+[source,bash]
+----
+git config core.autocrlf input
+----
+
+
+The Windows setting means that files are converted back to CRLF on checkout; the Mac/Linux setting means that the file is left as LF on checkout.
+
+We also recommend setting `core.safecrlf`, which aims to ensure that any line ending conversion is repeatable. Do this on all platforms:
+
+[source,bash]
+----
+git config core.safecrlf true
+----
+
+
+Note that these settings are supplemented in the repo by the `.gitattributes` file and that explicitly specifies line handling treatment for most of the common file types that we have.
+
+Next, we recommend you setup this a refspec so that you can distinguish remote tags from local ones. To do that, locate the `[remote "origin"]` section in your `.git/config` and add the third entry shown below:
+
+
+[source,bash]
+----
+[remote "origin"]
+ url = ... whatever ...
+ fetch = ... whatever ...
+ fetch = +refs/tags/*:refs/tags/origin/*
+----
+
+
+This will ensure that a `git fetch` or `git pull` places any remote tags under `origin/xxx. For example, the`isis-1.0.0`tag on the origin will appear under`origin/isis-1.0.0`.
+
+
+If you don't use git outside of Apache, you can add the `--global` flag so that the above settings apply for all repos managed by git on your PC.
+
+
+
+[[__dg_building-isis_git_getting-help]]
+=== Getting help
+
+Three commands of git that in particular worth knowing:
+
+* `git help _command_` +
++
+will open the man page in your web browser
+
+* `git gui` +
++
+will open up a basic GUI client to staging changes and making commits.
+
+* `gitk --all` +
++
+will open the commit history for all branches. In particular, you should be able to see the local `master`, which branch you are working on (the `HEAD`), and also the last known position of the `master` branch from the central repo, called `origin/master`.
+
+You might also want to explore using a freely available equivalent such as link:https://www.sourcetreeapp.com/[Atlassian SourceTree].
+
+For further reading, see:
+
+* http://www.kernel.org/pub/software/scm/git/docs/git-config.html[git config man page]
+* http://www.kernel.org/pub/software/scm/git/docs/gitattributes.html[.gitattributes man page]
+* http://git-scm.com/docs/gitattributes[.gitattributes git-scm.com docs]
+
+
+[[__dg_building-isis_installing-java]]
+== Installing Java
+
+Apache Isis is compatible with Java 7 and Java 8. For every-day use, the framework is usually compiled against Java 8.
+
+Releases however are xref:_cgcom_cutting-a-release[cut] using Java 7, leveraging the link:http://maven.apache.org/plugins/maven-toolchains-plugin/[Maven toolchains plugin]).
+
+Therefore install either/both of Java 7 JDK and Java 8 JDK. Note that the JRE is _not_ sufficient.
+
+[TIP]
+====
+If you intend to contribute back patches to Apache Isis, note that while you can develop using Java 8 within your IDE,
+be sure not to use any Java 8 APIs.
+====
+
+[[__dg_building-isis_configure-maven-toolchains-plugin]]
+=== Configure Maven toolchains plugin
+
+If you are a committer that will be performing releases of Apache Isis, then you _must_ configure the
+link:http://maven.apache.org/plugins/maven-toolchains-plugin/[toolchains] plugin so that releases can be built using
+Java 7.
+
+This is done by placing the `toolchains.xml` file in `~/.m2` directory. Use the following file as a template,
+adjusting paths for your platform:
+
+[source,xml]
+----
+<?xml version="1.0" encoding="UTF8"?>
+<toolchains>
+ <toolchain>
+ <type>jdk</type>
+ <provides>
+ <version>1.8</version>
+ <vendor>oracle</vendor>
+ </provides>
+ <configuration>
+ <jdkHome>/usr/lib64/jvm/jdk1.8.0_65</jdkHome>
+ <!--
+ <jdkHome>c:\Program Files\Java\jdk1.8.0_65</jdkHome>
+ -->
+ </configuration>
+ </toolchain>
+ <toolchain>
+ <type>jdk</type>
+ <provides>
+ <version>1.7</version> <!--1-->
+ <vendor>oracle</vendor>
+ </provides>
+ <configuration>
+ <jdkHome>/usr/lib64/jvm/jdk1.7.0_79</jdkHome>
+ <!--
+ <jdkHome>c:\Program Files\Java\jdk1.7.0_79</jdkHome>
+ -->
+ </configuration>
+ </toolchain>
+</toolchains>
+----
+<1> The Apache Isis build is configured to search for the (`1.7, oracle`) JDK toolchain.
+
+The Apache Isis parent `pom.xml` activates this plugin whenever the `apache-release` profile is enabled.
+
+
+
+
+[[__dg_building-isis_installing-maven]]
+== Installing Maven
+
+Install Maven 3.0.x, downloadable http://maven.apache.org/download.html[here].
+
+Set `MAVEN_OPTS` environment variable:
+
+[source,bash]
+----
+export MAVEN_OPTS="-Xms512m -Xmx1024m"
+----
+
+
+[NOTE]
+====
+Previously we suggested `-XX:MaxPermSize=256m`, but this option has been removed in Java 8. (As of 1.9.0, Apache Isis is built using Java 8 but with source and target set to JDK 1.7).
+====
+
+
+[[__dg_building-isis_building-all-of-apache-isis]]
+== Building all of Apache Isis
+
+To build the source code from the command line, simply go to the root directory and type:
+
+[source,bash]
+----
+mvn clean install
+----
+
+
+The first time you do this, you'll find it takes a while since Maven needs to download all of the Apache Isis prerequisites.
+
+Thereafter you can speed up the build by adding the `-o` (offline flag). To save more time still, we also recommend that you build in parallel. (Per this link:http://zeroturnaround.com/rebellabs/your-maven-build-is-slow-speed-it-up/[blog post]), you could also experiment with a number of JDK parameters that we've found also speed up Maven:
+
+[source,bash]
+----
+export MAVEN_OPTS="-Xms512m -Xmx1024m -XX:+TieredCompilation -XX:TieredStopAtLevel=1"
+mvn clean install -o -T1C
+----
+
+For the most part, though, you may want to rely on an IDE such as Eclipse to build the codebase for you. Both Eclipse and Idea (12.0+) support incremental background compilation.
+
+When using Eclipse, a Maven profile is configured such that Eclipse compiles to `target-ide` directory rather than the usual `target` directory. You can therefore switch between Eclipse and Maven command line without one interfering with the other.
+
+
+
+[[__dg_building-isis_checking-for-vulnerabilities]]
+== Checking for Vulnerabilities
+
+Apache Isis configures the link:https://www.owasp.org/index.php/Main_Page[OWASP] link:https://www.owasp.org/index.php/OWASP_Dependency_Check[dependency check] link:http://jeremylong.github.io/DependencyCheck/dependency-check-maven/index.html[Maven plugin] to determine whether the framework uses libraries that are known to have security vulnerabilities.
+
+To check, run:
+
+[source,bash]
+----
+mvn org.owasp:dependency-check-maven:aggregate -Dowasp
+----
+
+This will generate a single report under `target/dependency-check-report.html`.
+
+
+[NOTE]
+====
+The first time this runs can take 10~20 minutes to download the NVD data feeds.
+====
+
+To disable, either run in offline mode (add `-o` or `--offline`) or omit the `owasp` property.
+
+
+
+[[__dg_building-isis_checking-for-use-of-internal-jdk-apis]]
+== Checking for use of internal JDK APIs
+
+Apache Isis configures the link:https://maven.apache.org/plugins-archives/maven-jdeps-plugin-3.0.0/[jdeps maven plugin] to check for any usage of internal JDK APIs. This is in preparation for Java 9 module system (Jigsaw) which will prevent such usage of APIs.
+
+To check, run:
+
+[source,bash]
+----
+mvn clean install -Djdeps
+----
+
+This will fail the build on any module that currently uses an internal JDK API.
+
+
+[WARNING]
+====
+At the time of writing the `isis-core-schema` module fails the build.
+====
+
+
http://git-wip-us.apache.org/repos/asf/isis/blob/2669a971/adocs/documentation/src/main/asciidoc/guides/dg/_dg_cmd-line.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/dg/_dg_cmd-line.adoc b/adocs/documentation/src/main/asciidoc/guides/dg/_dg_cmd-line.adoc
new file mode 100644
index 0000000..a28a910
--- /dev/null
+++ b/adocs/documentation/src/main/asciidoc/guides/dg/_dg_cmd-line.adoc
@@ -0,0 +1,9 @@
+[[_dg_cmd-line]]
+= Command Line and CI
+: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/
+:toc: right
+
+NOTE: TODO
+
http://git-wip-us.apache.org/repos/asf/isis/blob/2669a971/adocs/documentation/src/main/asciidoc/guides/dg/_dg_contributing.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/dg/_dg_contributing.adoc b/adocs/documentation/src/main/asciidoc/guides/dg/_dg_contributing.adoc
new file mode 100644
index 0000000..88a01eb
--- /dev/null
+++ b/adocs/documentation/src/main/asciidoc/guides/dg/_dg_contributing.adoc
@@ -0,0 +1,255 @@
+[[_dg_contributing]]
+= Contributing
+: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/
+:toc: right
+
+
+
+This page explains how you can contribute to Apache Isis. You'll probably also want xref:dg.adoc#_dg_ide[set up your IDE] and learn xref:dg.adoc#_dg_building-isis[how to build Apache Isis].
+
+Thanks for considering to help out, your contributions are appreciated!
+
+
+== Recommended Workflow (github)
+
+Apache Isis' source code is hosted in an Apache git repo (https://git-wip-us.apache.org/repos/asf/isis.git[https], http://git-wip-us.apache.org/repos/asf/isis.git[http]), with a clone on github (https://github.com/apache/isis.git[https], or ssh: `git@github.com:apache/isis.git`.
+
+As you might imagine, only committers are permitted to push changes to the central git repo. As a contributor, we recommend that you fork the https://github.com/apache/isis.git[apache/isis] repo in github, and then use your fork as a way of publishing your patches for the Apache Isis committers to apply.
+
+The diagram below illustrates the process:
+
+image::{_imagesdir}contributing/git-workflow.png[width="600px",link="{_imagesdir}contributing/git-workflow.png"]
+
+
+That is:
+
+. as a one-time activity, you fork the https://github.com/apache/isis.git[github.com/apache/isis] repo into your own fork on github.com
+. as a one-time activity, you clone your fork to your local computer
+. you set the https://github.com/apache/isis.git[github.com/apache/isis] as your upstream branch; this will allow you to keep your local clone up-to-date with new commits
+* note the asymmetry here: the `upstream` repo (the Apache github repo) is *not* the same as the `origin` repo (your fork).
+. you work on your changes locally; when done, you push them to your github fork
+. to contribute back a change, raise a https://issues.apache.org/jira/browse/ISIS[JIRA] ticket, and ensure your commit message is in the form: `ISIS-nnnn: ...` so that changes can be tracked (more discussion on this point below). In any case, before you decide to start hacking with Apache Isis, it's always worth creating a ticket in JIRA and then have a discussion about it on the http://isis.apache.org/support.html[mailing lists].
+. Use github to raise a https://help.github.com/articles/using-pull-requests/[pull request] for your feature
+. An Apache Isis committer will review your change, and apply it if suitable.
+
+
+
+
+== Alternative Workflow (JIRA patches)
+
+As an alternative, you may decide to clone directly from https://github.com/apache/isis.git[github.com/apache/isis] rather than create your own fork:
+
+
+image::{_imagesdir}contributing/git-workflow-2.png[width="600px",link="{_imagesdir}contributing/git-workflow-2.png"]
+
+In this case your `upstream` repo is the same as your `origin` repo, which might seem more straightforward. On the other hand, if you go this route then you'll need create patches locally and attach them to the JIRA ticket.
+
+For the Apache Isis committers it really doesn't matter which route you take, so go with whatever's most comfortable.
+
+
+
+
+== Setting up your fork/clone
+
+If you choose to create your own fork then you'll need an account on https://github.com[github.com]. You then fork simply by pressing the "Fork" button:
+
+
+image::{_imagesdir}contributing/github-forking.png[width="600px",link="{_imagesdir}contributing/github-forking.png"]
+
+
+
+An account isn't needed if you just clone straight from the http://github.com/apache/isis[github.com/apache/isis].
+
+Whether you've forked or not, you then need to clone the repo onto your computer. Github makes this very easy to do:
+
+* for Windows users, we suggest you use github's 'Clone in Windows' feature
+* for Mac/Linux users, create a clone from the command line:
+
+Again, the info is easily found in the github page:
+
+
+
+image::{_imagesdir}contributing/github-cloning.png[width="600px",link="{_imagesdir}contributing/github-cloning.png"]
+
+If you've created your own fork, then you need to add the `upstream` remote to the https://github.com/apache/isis[github.com/apache/isis]. This remote is traditionally called `upstream`. You should then arrange for your `master` branch to track the `upstream/master` remote branch:
+
+If you didn't create your own fork, you can omit the above step. Either way around, you can now fetch new commits using simply:
+
+
+[source,bash]
+----
+git fetch
+----
+
+
+For more info on tracking branches http://git-scm.com/book/en/Git-Branching-Remote-Branches[here] and http://gitready.com/beginner/2009/03/09/remote-tracking-branches.html[here].
+
+
+
+
+
+== Commit messages
+
+Although with git your commits are always performed on your local repo, those commit messages become public when the patch is applied by an Apache Isis committer. You should take time to write a meaningful commit message that helps explain what the patch refers to; if you don't then there's a chance that your patch may be rejected and not applied. No-one likes hard work to go to waste!
+
+We therefore recommend that your commit messages are as follows [1]:
+
+[source,other]
+----
+ISIS-999: Make the example in CONTRIBUTING imperative and concrete
+
+Without this patch applied the example commit message in the CONTRIBUTING
+document is not a concrete example. This is a problem because the
+contributor is left to imagine what the commit message should look like
+based on a description rather than an example. This patch fixes the
+problem by making the example concrete and imperative.
+
+The first line is a real life imperative statement with a ticket number
+from our issue tracker. The body describes the behavior without the patch,
+why this is a problem, and how the patch fixes the problem when applied.
+----
+
+
+
+Once your git repo is setup, the next thing you'll most likely want to do is to setup your development environment. See link:development-environment.html[here] for more details.
+
+
+
+
+
+== Creating the patch file
+
+If you are working without a github fork of Apache Isis, then you can create the patches from your own local git repository.
+
+As per http://stackoverflow.com/questions/6658313/generate-a-git-patch-for-a-specific-commit[this stackoverflow question], create the patch using `git format-patch`:
+
+[source,bash]
+----
+git format-patch -10 HEAD --stdout > 0001-last-10-commits.patch
+----
+
+Here `-10` is the last 10 commits you have done. You need to change that integer according to the commits you need to apply into the patch.
+
+
+
+
+== Sample Contribution Workflow
+
+Assuming you're development environment is all setup, let's walk through how you might make contribute a patch. In this example, suppose that you've decided to work on JIRA ticket #123, an enhancement to support Blob/Clob datatypes.
+
+=== Update your master branch
+
+The first thing to do is to make sure your local clone is up-to-date. We do this by retrieving new commits from upstream repo and then merging them as a fast-forward into your local branch.
+
+Irrespective of whether you are using a github fork, the upstream for your local `master` branch will be tracking the appropriate remote's `master` branch. So n either case, the same commands work:
+
+Alternatively, you can combine the `git fetch` and `git merge` and just use `git pull`:
+<pre>
+git checkout master
+git pull \u2013ff-only
+</pre>
+
+If the `merge` or `pull` fails, it means that you must have made commits and there have been changes meanwhile on the remote `master`'s branch. You can use `gitk --all` to confirm. If this fails, see our link:git-cookbook.html[git cookbook] page for a procedure to retrospectively sort out this situation.
+
+
+
+=== Create a topic branch
+
+We recommend you name topic branches by the JIRA ticket, ie <tt>ISIS-nnn-description</tt>. So let's create a new branch based off `master` and call it "ISIS-123-blobs"
+
+You can confirm the branch is there and is your new `HEAD` using either `gitk --all`. Alternatively, use the command line:
+
+
+[source,bash]
+----
+$ git checkout -b ISIS-123-blobs
+----
+
+
+The command line prompt should also indicate you are on a branch, isolated from any changes that might happen on the `master` branch.
+
+=== Make File Changes and Commit
+
+Next, make changes to your files using the usual commands (see also our xref:dg.adoc#_dg_git-cookbook[git cookbook] section):
+
+* `git add`
+* `git mv`
+* `git rm`
+* `git commit`
+* `git status`
+
+and so on.
+
+Continue this way until happy with the change. Remember to run all your tests on the topic branch (including a full `mvn clean install`).
+
+
+
+
+=== Rebasing with `master`
+
+Before you can share your change, you should rebase (in other words replay) your changes on top of the `master` branch.
+
+The first thing to do is to pull down any changes made in upstream remote's `master` since you started your topic branch:
+
+These are the same commands that you would have run before you created your topic branch. If you use `gitk --all`, there's a good chance that new commits have come in.
+
+Next, we reintegrate our topic branch by rebasing onto `master`:
+<pre>
+git checkout ISIS-123-blobs
+git rebase master
+</pre>
+
+This takes all of the commits in your branch, and applies them on top of the new `master` branch. When your change is eventually integrated back in, it will result in a nice clear linear history on the public repo.
+
+If the rebase fails because of a conflict, then you'll be dumped into REBASE mode. Edit the file that has the conflict, and make the appropriate edits. Once done:
+
+Once the rebase has completed, re-run your tests to confirm that everything is still good.
+
+
+
+=== Raising a pull request
+
+If you have your own fork, you can now simply push the changes you've made locally to your fork:
+
+This will create a corresponding branch in the remote github repo. If you use `gitk --all`, you'll also see a `remotes/origin/ISIS-123-blobs` branch.
+
+Then, use github to raise a https://help.github.com/articles/using-pull-requests/[pull request]. Pull requests sent to the Apache GitHub repositories will forward a pull request e-mail to the link:../support.html[dev mailing list]. You'll probably want to sign up to the dev mailing list first before issuing your first pull request (though that isn't mandatory).
+
+The process to raise the pull request, broadly speaking:
+
+* Open a web browser to your github fork of isis
+* Select your topic branch (pushed in the previous step) so that the pull request references the topic branch.
+* Click the `Pull Request` button.
+* Check that the Apache Isis mailing list email came through.
+
+
+
+== If your pull request is accepted
+
+To double check that your pull request is accepted, update your `master` branch from the `upstream` remote:
+
+You can then use `gitk --all` (or `git log` if you prefer the command line) to check your contribution has been added.
+
+You can now delete your topic branch and remove the branch in your github:
+
+Finally, you might want to push the latest changes in master back up to your github fork. If so, use:
+
+
+
+=== If your pull request is rejected
+
+If your pull request is rejected, then you'll need to update your branch from the main repository and then address the rejection reason.
+
+You'll probably also want to remove the remote branch on github:
+
+[source,bash]
+----
+git push origin \u2013delete ISIS-123-blobs
+----
+
+
+\u2026 and continue as before until you are ready to resubmit your change.
+
+[1] inspiration for the recommended commit format comes from the https://github.com/puppetlabs/puppet[puppet] project's https://github.com/puppetlabs/puppet/blob/master/CONTRIBUTING.md[contributing] page.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/isis/blob/2669a971/adocs/documentation/src/main/asciidoc/guides/dg/_dg_git-cookbook.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/dg/_dg_git-cookbook.adoc b/adocs/documentation/src/main/asciidoc/guides/dg/_dg_git-cookbook.adoc
new file mode 100644
index 0000000..53a126b
--- /dev/null
+++ b/adocs/documentation/src/main/asciidoc/guides/dg/_dg_git-cookbook.adoc
@@ -0,0 +1,258 @@
+[[_dg_git-cookbook]]
+= Appendix: Git Cookbook
+: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/
+:toc: right
+
+
+
+
+This appendix describes the commands often used while working with git. In addition to these basic commands, please make sure you have read:
+
+* xref:dg.adoc#_dg_building-isis[building Apache Isis]
+* xref:dg.adoc#_dg_contributing[Contributing]
+* xref:dg.adoc#_cgcom_policies_git-policy[Git policy]
+
+
+
+
+== Modifying existing files
+
+To modify existing files:
+
+[source,bash]
+----
+git add filename
+git commit -m "ISIS-nnn: yada yada"
+----
+
+The `git add` command adds the changes to the file(s) to the git index (aka staging area). If you were to make subsequent changes to the file these would not be committed.
+
+The `git commit` takes all the staged changes and commits them locally. Note that these changes are not shared public with Apache Isis' central git repo.
+
+You can combine these two commands using `-am` flag to git commit:
+
+[source,bash]
+----
+git commit -am "ISIS-nnn: yada yada"
+----
+
+
+
+
+== Adding new files
+
+To add a new file:
+
+[source,bash]
+----
+git add .
+git commit -m "ISIS-nnn: yada yada"
+----
+
+
+Note that this sequence of commands is identical to modifying an existing file. However, it isn't possible to combine the two steps using `git commit -am`; the `git add` is always needed when adding new files to the repo.
+
+
+
+
+== Deleting files
+
+To delete a file:
+
+[source,bash]
+----
+git rm filename
+git commit -m "ISIS-nnn: yada yada"
+----
+
+
+
+== Renaming or moving files
+
+To rename or move a file:
+
+
+[source,bash]
+----
+git mv <i>filename</i> <i>newfilename</i>
+git commit -m "ISIS-nnn: yada yada"
+----
+
+
+
+
+== Common Workflows
+
+The xref:dg.adoc#_dg_contributing[contributing] page describes the workflow for non-committers. The xref:cgcom.adoc#_cgcom_policies_git-policy[Git policy] page describes a workflow for Apache Isis **committers**.
+
+
+
+
+
+== Backing up a local branch
+
+If committing to a local branch, the changes are still just that: local, and run risk of a disk failure or other disaster.
+
+To create a new, similarly named branch on the central repo, use:
+
+[source,bash]
+----
+git push -u origin <i>branchname</i>
+----
+
+Using `gitk --all` will show you this new branch, named *origin/branchname*.
+
+Thereafter, you can push subsequent commits using simply:
+
+[source,bash]
+----
+git push
+----
+
+
+Doing this also allows others to collaborate on this branch, just as they would for `master`.
+
+When, eventually, you have reintegrated this branch, you can delete the remote branch using:
+
+[source,bash]
+----
+git push origin --delete <i>branchname</i>
+----
+
+
+For more detail, see these blogs/posts link:http://www.mariopareja.com/blog/archive/2010/01/11/how-to-push-a-new-local-branch-to-a-remote.aspx[here] and link:http://stackoverflow.com/questions/2003505/how-do-i-delete-a-git-branch-both-locally-and-in-github[here].
+
+
+
+== Quick change: stashing changes
+
+If you are working on something but are not ready to commit, then use:
+
+[source,bash]
+----
+git stash
+----
+
+
+If you use `gitk --all` then you'll see new commits are made that hold the current state of your working directory and staging area.
+
+You can then, for example, pull down the latest changes using `git pull --rebase` (see above).
+
+To reapply your stash, then use:
+
+[source,bash]
+----
+git stash pop
+----
+
+Note that stashing works even if switching branches
+
+
+## Ignoring files
+
+Put file patterns into `.gitignore`. There is one at the root of the git repo, but they can additionally appear in subdirectories (the results are cumulative).
+
+See also:
+
+- link:https://help.github.com/articles/ignoring-files[github's help page]
+- link:http://www.kernel.org/pub/software/scm/git/docs/gitignore.html[man page]
+
+
+
+
+== More advanced use cases
+
+=== If accidentally push to remote
+
+Suppose you committed to `master`, and then pushed the change, and then decided that you didn't intend to do that:
+
+[source,bash]
+----
+C1 - C2 - C3 - C4 - C5 - C6 - C7
+ ^
+ master
+ ^
+ origin/master
+----
+
+To go back to an earlier commit, first we wind back the local `master`:
+
+[source,bash]
+----
+git reset --hard C5
+----
+
+where `C5` is the long sha-id for that commit.
+
+This gets us to:
+
+[source,bash]
+----
+C1 - C2 - C3 - C4 - C5 - C6 - C7
+ ^
+ master
+ ^
+ origin/master
+----
+
+Then, do a force push:
+
+[source,bash]
+----
+git push origin master --force
+----
+
+If this doesn't work, it may be that the remote repo has disabled this feature. There are other hacks to get around this, see for example link:http://stackoverflow.com/questions/1377845/git-reset-hard-and-a-remote-repository[here].
+
+
+
+
+== If you've accidentally worked on `master` branch
+
+If at any time the `git pull` from your upstream fails, it most likely means that you must have made commits on the `master` branch. You can use `gitk --all` to confirm; at some point in time both `master` and `origin\master` will have a common ancestor.
+
+You can retrospectively create a topic branch for the work you've accidentally done on `master`.
+
+First, create a branch for your current commit:
+
+[source,bash]
+----
+git branch <i>newbranch</i>
+----
+
+
+Next, make sure you have no outstanding edits. If you do, you should commit them or stash them:
+
+
+[source,bash]
+----
+git stash
+----
+
+
+Finally, locate the shaId of the commit you want to roll back to (easily obtained in `gitk -all`), and wind `master` branch back to that commit:
+
+
+[source,bash]
+----
+git checkout master
+git reset --hard <i>shaId</i> # move master branch shaId of common ancestor
+----
+
+
+
+== If you've forgotten to prefix your commits (but not pushed)
+
+One of our committers, Alexander Krasnukhin, has put together some git scripts to help his workflow. Using one of these, `git prefix`, you can just commit with proper message without bothering about prefix and add prefix only in the end *before* the final push.
+
+For example, to prefix all not yet prefixed commits `master..isis/666` with `ISIS-666` prefix, use:
+
+[source,bash]
+----
+git prefix ISIS-666 master..isis/666
+----
+
+
+You can grab this utility, and others, from link:https://github.com/themalkolm/git-boots[this repo].
http://git-wip-us.apache.org/repos/asf/isis/blob/2669a971/adocs/documentation/src/main/asciidoc/guides/dg/_dg_ide.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/dg/_dg_ide.adoc b/adocs/documentation/src/main/asciidoc/guides/dg/_dg_ide.adoc
new file mode 100644
index 0000000..db76f89
--- /dev/null
+++ b/adocs/documentation/src/main/asciidoc/guides/dg/_dg_ide.adoc
@@ -0,0 +1,17 @@
+[[_dg_ide]]
+= Using an IDE
+: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/
+:toc: right
+
+
+
+The vast majority of Java developers use an IDE to assist with developing their code, and we highly recommend that you do like wise as you develop your Apache Isis applications using an IDE. 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]
+
http://git-wip-us.apache.org/repos/asf/isis/blob/2669a971/adocs/documentation/src/main/asciidoc/guides/dg/_dg_ide_eclipse.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/dg/_dg_ide_eclipse.adoc b/adocs/documentation/src/main/asciidoc/guides/dg/_dg_ide_eclipse.adoc
new file mode 100644
index 0000000..f2a3e5b
--- /dev/null
+++ b/adocs/documentation/src/main/asciidoc/guides/dg/_dg_ide_eclipse.adoc
@@ -0,0 +1,175 @@
+[[_dg_ide_eclipse]]
+= Developing using Eclipse
+: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/
+:toc: right
+
+
+[NOTE]
+====
+This material does not constitute an endorsement; Eclipse foundation is not affiliated to Apache Software Foundation in any way.
+====
+
+If you are an http://www.eclipse.org[Eclipse] user, then we recommend you download the "Eclipse JEE package" configuration.
+
+When running an Apache Isis application, it's necessary to setup the development environment so that the Java bytecode can be enhanced by the link:http://www.datanucleus.org[DataNucleus] enhancer. If working in Eclipse, then JDO enhancement is most easily done by installing the http://www.datanucleus.org/products/datanucleus/jdo/guides/eclipse.html[DataNucleus' Eclipse plugin]. This hooks the bytecode enhancement of your domain objects into Eclipse's normal incremental compilation.
+
+This plugin needs to be configured for each of your domain modules (usually just one in any given app). The steps are therefore:
+
+* import the project into Eclipse
+* configure the DataNucleus enhancer
+* run the app from the `.launch` file
+
+
+
+
+[[__dg_ide_eclipse_screencast]]
+== Screencast
+
+This link:https://www.youtube.com/watch?v=RgcYfjQ8yJA[screencast] shows how to import an Apache Isis maven-based
+application into Eclipse and configure to use with the JDO Objectstore.
+
+
+
+[[__dg_ide_eclipse_editor-templates]]
+== Editor Templates
+
+We provide a set of editor templates. These are used to add new methods to existing classes. (These are equivalent to the xref:dg.adoc#__dg_ide_intellij_live-templates[IntelliJ live templates]):
+
+* `is` (Apache Isis domain objects). link:./resources/appendices/dev-env/eclipse/isis-templates.xml[Download]
+* `ju` (for JUnit tests) link:./resources/appendices/dev-env/eclipse/junit4-templates.xml[Download]
+* `jm` (for JMock mocks or libraries) link:./resources/appendices/dev-env/eclipse/jmock2-templates.xml[Download]
+
+
+To install, download each XML file, then go to `Windows > Preferences > Java > Editor > Templates` and choose `Import`.
+
+
+
+
+[[__dg_ide_eclipse_importing-the-project]]
+== Importing the Project
+
+Use File > Import, then Maven > Existing Maven Projects.
+
+
+
+
+== Add DataNucleus support
+
+[TIP]
+====
+Make sure you are in the 'Java' Perspective, not the 'Java EE' Perspective.
+====
+
+
+In Eclipse, for the _domain object model_ project, first add DataNucleus support:
+
+image::{_imagesdir}appendices/dev-env/eclipse/eclipse-100-project-support.png[width="600px",link="{_imagesdir}appendices/dev-env/eclipse/eclipse-100-project-support.png"]
+
+
+Then turn on Auto-Enhancement:
+
+image::{_imagesdir}appendices/dev-env/eclipse/eclipse-110-project-support.png[width="600px",link="{_imagesdir}appendices/dev-env/eclipse/eclipse-110-project-support.png"]
+
+
+=== Update the classpath
+
+DataNucleus' enhancer uses the domain object model's own classpath to reference DataNucleus JARs. So, even though your domain objects are unlikely to depend on DataNucleus, these references must still be present.
+
+See the earlier section on xref:ugfun.adoc#_ugfun_getting-started_datanucleus-enhancer[DataNucleus enhancer] for details of the contents of the `pom.xml`. Chances are it is already set up from running the xref:ugfun.adoc#_ugfun_getting-started_simpleapp-archetype[SimpleApp archetype].
+
+
+Then, tell DataNucleus to use the project classpath:
+
+
+image::{_imagesdir}/appendices/dev-env/eclipse/eclipse-010-windows-preferences.png[width="750px",link="{_imagesdir}/appendices/dev-env/eclipse/eclipse-010-windows-preferences.png"]
+
+When the enhancer runs, it will print out to the console:
+
+image::{_imagesdir}/appendices/dev-env/eclipse/eclipse-120-console.png[width="500px",link="{_imagesdir}/appendices/dev-env/eclipse/eclipse-120-console.png"]
+
+
+
+=== Workaround for path limits (the DN plugin to use the persistence.xml)
+
+If running on Windows then the DataNucleus plugin is very likely to hit the Windows path limit.
+
+To fix this, we configure the enhancer to read from the `persistence.xml` file.
+
+As a prerequisite, first make sure that your domain object model has a `persistence.xml` file. Then specify the `persistence-unit` in the project properties:
+
+image::{_imagesdir}/appendices/dev-env/eclipse/eclipse-025-project-properties.png[width="750px",link="{_imagesdir}/appendices/dev-env/eclipse/eclipse-025-project-properties.png"]
+
+
+=== Workaround: If the enhancer fails
+
+On occasion it appears that Eclipse can attempt to run two instances of the DataNucleus enhancer. This is probably due to multiple Eclipse builders being defined; we've noticed multiple entries in the Eclipse's `Debug` view:
+
+
+image::{_imagesdir}/appendices/dev-env/eclipse/eclipse-210-enhancer-fails-duplicates.png[width="600px",link="{_imagesdir}/appendices/dev-env/eclipse/eclipse-210-enhancer-fails-duplicates.png"]
+
+
+At any rate, you'll know you've encountered this error if you see the following in the console:
+
+
+image::{_imagesdir}/appendices/dev-env/eclipse/eclipse-200-enhancer-fails-duplicates.png[width="600px",link="{_imagesdir}/appendices/dev-env/eclipse/eclipse-200-enhancer-fails-duplicates.png"]
+
+
+
+The best solution is to remove DataNucleus support and then to re-add it:
+
+
+image::{_imagesdir}/appendices/dev-env/eclipse/eclipse-220-enhancer-fails-duplicates.png[width="600px",link="{_imagesdir}/appendices/dev-env/eclipse/eclipse-220-enhancer-fails-duplicates.png"]
+
+
+If you consistently hit problems, then the final recourse is to disable the automatic enhancement and to remember to manually enhance your domain object model before each run.
+
+Not ideal, we know. Please feel free to contribute a better solution :-)
+
+
+
+
+== Running the App
+
+The simpleapp archetype automatically provides a `.launch` configurations in the `webapp` module. You can therefore very simply run the application by right-clicking on one of these files, and choosing "Run As\u2026" or "Debug As\u2026".
+
+
+[NOTE]
+====
+The screencast above shows this in action.
+====
+
+
+
+
+
+== Other domain projects.
+
+There is nothing to prevent you having multiple domain projects. You might want to do such that each domain project corresponds to a http://www.methodsandtools.com/archive/archive.php?id=97p2[DDD module], thus guaranteeing that there are no cyclic dependencies between your modules.
+
+If you do this, make sure that each project has its own `persistence.xml` file.
+
+And, remember also to configure Eclipse's DataNucleus plugin for these other domain projects.
+
+
+
+== Advanced
+
+In this section are a couple of options that will reduce the length of the change code/build/deploy/review feedback loop.
+
+
+=== Setting up DCEVM
+
+link:github.com/dcevm/dcevm[DCEVM] enhances the JVM with true hot-swap adding/removing of methods as well as more
+reliable hot swapping of the implementation of existing methods.
+
+In the context of Apache Isis, this is very useful for contributed actions and mixins and also view models; you should
+then be able to write these actions and have them be picked up without restarting the application.
+
+Changing persisting domain entities is more problematic, for two reasons: the JDO/DataNucleus enhancer needs to run on
+domain entities, and also at runtime JDO/DataNucleus would need to rebuild its own metamodel. You may find that adding
+actions will work, but adding new properties or collections is much less likely to.
+
+For details of setting up DCEVM, see the xref:dg.adoc#__dg_ide_intellij_advanced_dcevm[corresponding section] in the IntelliJ documentation.
+