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 2016/01/04 16:22:58 UTC
[3/9] isis git commit: ISIS-1287: splitting out contributors vs
committers guides
http://git-wip-us.apache.org/repos/asf/isis/blob/49ccfd90/adocs/documentation/src/main/asciidoc/guides/cg.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/cg.adoc b/adocs/documentation/src/main/asciidoc/guides/cg.adoc
deleted file mode 100644
index b294bab..0000000
--- a/adocs/documentation/src/main/asciidoc/guides/cg.adoc
+++ /dev/null
@@ -1,63 +0,0 @@
-[[cg]]
-= Contributors 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 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:
-
-
-[[_cg]]
-== Contributors' Guide
-
-This contributors' guide has three related audiences:
-
-* 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 and reference guides.
-
-The user guides available are:
-
-* xref:ugfun.adoc#[Fundamentals]
-* xref:ugvw.adoc#[Wicket viewer]
-* xref:ugvro.adoc#[Restful Objects viewer]
-* 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]
-
-In addition, there is (this) xref:cg.adoc#_cg[Contributors' Guide] describing development practices for contributors and committers alike.
-
-
-
-
-include::_cg_ide.adoc[leveloffset=+1]
-include::_cg_ide-templates.adoc[leveloffset=+1]
-include::_cg_cmd-line.adoc[leveloffset=+1]
-include::_cg_isis-maven-plugin.adoc[leveloffset=+1]
-
-include::_cg_building-isis.adoc[leveloffset=+1]
-include::_cg_contributing.adoc[leveloffset=+1]
-include::_cg_policies.adoc[leveloffset=+1]
-
-include::_cg_asciidoc.adoc[leveloffset=+1]
-
-include::_cg_committers.adoc[leveloffset=+1]
-
-include::_cg_git-cookbook.adoc[leveloffset=+1]
-include::_cg_asciidoc-templates.adoc[leveloffset=+1]
http://git-wip-us.apache.org/repos/asf/isis/blob/49ccfd90/adocs/documentation/src/main/asciidoc/guides/cgcom.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/cgcom.adoc b/adocs/documentation/src/main/asciidoc/guides/cgcom.adoc
new file mode 100644
index 0000000..c48343e
--- /dev/null
+++ b/adocs/documentation/src/main/asciidoc/guides/cgcom.adoc
@@ -0,0 +1,61 @@
+[[cgcom]]
+= Committers' 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 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
+
+
+[[_cgcom]]
+== Committers' Guide
+
+This committers' guide is for 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:ugfun.adoc#[Fundamentals]
+* xref:ugvw.adoc#[Wicket viewer]
+* xref:ugvro.adoc#[Restful Objects viewer]
+* 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]
+
+The "supporting procedures" guides are:
+
+* xref:cgcon.adoc#[Contributors' Guide] (how to set up a development environment for Apache Isis and contribute back to the project)
+* xref:cgcon.adoc#[Committers' Guide] (this guide)
+
+
+
+This guide provides guidance for Apache Isis' own committers.
+
+// for some reason this doesn't seem to include:: correctly; that said, it's incomplete anyway
+//include::_cgcom_applying-patches.adoc[leveloffset=+1]
+
+include::_cgcom_merging-a-pull-request.adoc[leveloffset=+1]
+include::_cgcom_cutting-a-release.adoc[leveloffset=+1]
+include::_cgcom_verifying-releases.adoc[leveloffset=+1]
+include::_cgcom_post-release-successful.adoc[leveloffset=+1]
+include::_cgcom_post-release-unsuccessful.adoc[leveloffset=+1]
+include::_cgcom_release-process-for-snapshots.adoc[leveloffset=+1]
+
+
+include::_cgcom_key-generation.adoc[leveloffset=+1]
+
+include::_cgcom_release-process-prereqs.adoc[leveloffset=+1]
+
+include::_cgcom_pmc-notes.adoc[leveloffset=+1]
+
http://git-wip-us.apache.org/repos/asf/isis/blob/49ccfd90/adocs/documentation/src/main/asciidoc/guides/cgcon.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/cgcon.adoc b/adocs/documentation/src/main/asciidoc/guides/cgcon.adoc
new file mode 100644
index 0000000..7de978f
--- /dev/null
+++ b/adocs/documentation/src/main/asciidoc/guides/cgcon.adoc
@@ -0,0 +1,64 @@
+[[cgcon]]
+= Contributors 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 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:
+
+
+[[_cgcon]]
+== Contributors' Guide
+
+This contributors' 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:ugfun.adoc#[Fundamentals]
+* xref:ugvw.adoc#[Wicket viewer]
+* xref:ugvro.adoc#[Restful Objects viewer]
+* 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]
+
+The "supporting procedures" guides are:
+
+* xref:cgcon.adoc#[Contributors' Guide] (this guide)
+* xref:cgcon.adoc#[Committers' Guide] (release procedures and related practices)
+
+
+
+
+include::_cgcon_ide.adoc[leveloffset=+1]
+include::_cgcon_ide-templates.adoc[leveloffset=+1]
+include::_cgcon_cmd-line.adoc[leveloffset=+1]
+include::_cgcon_isis-maven-plugin.adoc[leveloffset=+1]
+
+include::_cgcon_building-isis.adoc[leveloffset=+1]
+include::_cgcon_contributing.adoc[leveloffset=+1]
+include::_cgcon_policies.adoc[leveloffset=+1]
+
+include::_cgcon_asciidoc.adoc[leveloffset=+1]
+
+include::_cgcon_git-cookbook.adoc[leveloffset=+1]
+include::_cgcon_asciidoc-templates.adoc[leveloffset=+1]
http://git-wip-us.apache.org/repos/asf/isis/blob/49ccfd90/adocs/documentation/src/main/asciidoc/guides/rg.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rg.adoc b/adocs/documentation/src/main/asciidoc/guides/rg.adoc
index 8197779..fceaed5 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rg.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rg.adoc
@@ -24,4 +24,6 @@ The reference guides are:
* xref:rgcfg.adoc#[Configuration Properties]
* xref:rgcms.adoc#[Classes, Methods and Schema]
-In addition, there is a xref:cg.adoc#_cg[Contributors' Guide] describing development practices for contributors and committers alike.
+In addition, there is a xref:cgcon.adoc#[Contributors' Guide] (that describes how to set up a development environment
+for Apache Isis and contribute back to the project), and a xref:cgcon.adoc#[Committers' Guide] (that describes release
+procedures and related practices).
http://git-wip-us.apache.org/repos/asf/isis/blob/49ccfd90/adocs/documentation/src/main/asciidoc/guides/rgant.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgant.adoc b/adocs/documentation/src/main/asciidoc/guides/rgant.adoc
index e0259b1..5454e12 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgant.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgant.adoc
@@ -15,7 +15,7 @@ annotations that are now deprecated, and indicates their replacement.
=== Other Guides
-Apache Isis documentation is broken out into a number of user and reference guides.
+Apache Isis documentation is broken out into a number of user, reference and "supporting procedures" guides.
The user guides available are:
@@ -33,7 +33,11 @@ The reference guides are:
* xref:rgcfg.adoc#[Configuration Properties]
* xref:rgcms.adoc#[Classes, Methods and Schema]
-In addition, there is a xref:cg.adoc#_cg[Contributors' Guide] describing development practices for contributors and committers alike.
+The "supporting procedures" guides are:
+
+* xref:cgcon.adoc#[Contributors' Guide] (how to set up a development environment
+for Apache Isis and contribute back to the project)
+* xref:cgcon.adoc#[Committers' Guide] (release procedures and related practices)
=== Examples
http://git-wip-us.apache.org/repos/asf/isis/blob/49ccfd90/adocs/documentation/src/main/asciidoc/guides/rgcfg.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcfg.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcfg.adoc
index 09ab94e..f10e6be 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcfg.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcfg.adoc
@@ -25,7 +25,7 @@ xref:ugbtb.adoc#_ugbtb_deployment[Beyond the Basics] guide, (deployment chapter)
=== Other Guides
-Apache Isis documentation is broken out into a number of user and reference guides.
+Apache Isis documentation is broken out into a number of user, reference and "supporting procedures" guides.
The user guides available are:
@@ -43,7 +43,11 @@ The reference guides are:
* xref:rgcfg.adoc#[Configuration Properties] (this guide)
* xref:rgcms.adoc#[Classes, Methods and Schema]
-In addition, there is a xref:cg.adoc#_cg[Contributors' Guide] describing development practices for contributors and committers alike.
+The "supporting procedures" guides are:
+
+* xref:cgcon.adoc#[Contributors' Guide] (how to set up a development environment
+for Apache Isis and contribute back to the project)
+* xref:cgcon.adoc#[Committers' Guide] (release procedures and related practices)
http://git-wip-us.apache.org/repos/asf/isis/blob/49ccfd90/adocs/documentation/src/main/asciidoc/guides/rgcms.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgcms.adoc b/adocs/documentation/src/main/asciidoc/guides/rgcms.adoc
index 92dc334..41c9875 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgcms.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgcms.adoc
@@ -18,7 +18,7 @@ JAXB serialization of view models.
=== Other Guides
-Apache Isis documentation is broken out into a number of user and reference guides.
+Apache Isis documentation is broken out into a number of user, reference and "supporting procedures" guides.
The user guides available are:
@@ -36,7 +36,11 @@ The reference guides are:
* xref:rgcfg.adoc#[Configuration Properties]
* xref:rgcms.adoc#[Classes, Methods and Schema] (this guide)
-In addition, there is a xref:cg.adoc#_cg[Contributors' Guide] describing development practices for contributors and committers alike.
+The "supporting procedures" guides are:
+
+* xref:cgcon.adoc#[Contributors' Guide] (how to set up a development environment
+for Apache Isis and contribute back to the project)
+* xref:cgcon.adoc#[Committers' Guide] (release procedures and related practices)
http://git-wip-us.apache.org/repos/asf/isis/blob/49ccfd90/adocs/documentation/src/main/asciidoc/guides/rgsvc.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/rgsvc.adoc b/adocs/documentation/src/main/asciidoc/guides/rgsvc.adoc
index c1f2508..3918f7b 100644
--- a/adocs/documentation/src/main/asciidoc/guides/rgsvc.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/rgsvc.adoc
@@ -15,7 +15,7 @@ xref:rgsvc.adoc#_rgsvc_spi[SPI] (implemented by your domain application and whic
=== Other Guides
-Apache Isis documentation is broken out into a number of user and reference guides.
+Apache Isis documentation is broken out into a number of user, reference and "supporting procedures" guides.
The user guides available are:
@@ -33,7 +33,11 @@ The reference guides are:
* xref:rgcfg.adoc#[Configuration Properties]
* xref:rgcms.adoc#[Classes, Methods and Schema]
-In addition, there is a xref:cg.adoc#_cg[Contributors' Guide] describing development practices for contributors and committers alike.
+The "supporting procedures" guides are:
+
+* xref:cgcon.adoc#[Contributors' Guide] (how to set up a development environment
+for Apache Isis and contribute back to the project)
+* xref:cgcon.adoc#[Committers' Guide] (release procedures and related practices)
include::_rgsvc_api.adoc[leveloffset=+1]
http://git-wip-us.apache.org/repos/asf/isis/blob/49ccfd90/adocs/documentation/src/main/asciidoc/guides/simpleapp-archetype.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/simpleapp-archetype.adoc b/adocs/documentation/src/main/asciidoc/guides/simpleapp-archetype.adoc
index 9954b39..315668c 100644
--- a/adocs/documentation/src/main/asciidoc/guides/simpleapp-archetype.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/simpleapp-archetype.adoc
@@ -171,7 +171,7 @@ The app itself is configured to run using shiro security, as configured in the `
Once you are familiar with the generated app, you'll want to start modifying it. Check out our the link:.guides/ug.html[Users' Guide], which has how-tos and a complete reference guide (as well as some background concepts and discussion of more advanced techniques).
-If you use IntelliJ or Eclipse, you'll also want to set up your IDE; this is also described in the link:cg.adoc#_cg_ide[Contributors' Guide].
+If you use IntelliJ or Eclipse, you'll also want to set up your IDE; this is also described in the link:cgcon.adoc#_cgcon_ide[Contributors' Guide].
== App Structure
http://git-wip-us.apache.org/repos/asf/isis/blob/49ccfd90/adocs/documentation/src/main/asciidoc/guides/ug.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/ug.adoc b/adocs/documentation/src/main/asciidoc/guides/ug.adoc
index 90ddfb3..6b07136 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ug.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ug.adoc
@@ -6,7 +6,7 @@
:numbered:
-Apache Isis documentation is broken out into a number of user and reference guides.
+Apache Isis documentation is broken out into a number of user, reference and "supporting procedures" guides.
The user guides available are:
@@ -24,4 +24,8 @@ The reference guides are:
* xref:rgcfg.adoc#[Configuration Properties]
* xref:rgcms.adoc#[Classes, Methods and Schema]
-In addition, there is a xref:cg.adoc#_cg[Contributors' Guide] describing development practices for contributors and committers alike.
+The "supporting procedures" guides are:
+
+* xref:cgcon.adoc#[Contributors' Guide] (how to set up a development environment
+for Apache Isis and contribute back to the project)
+* xref:cgcon.adoc#[Committers' Guide] (release procedures and related practices)
http://git-wip-us.apache.org/repos/asf/isis/blob/49ccfd90/adocs/documentation/src/main/asciidoc/guides/ugbtb.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugbtb.adoc b/adocs/documentation/src/main/asciidoc/guides/ugbtb.adoc
index 072e978..bb1ba14 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugbtb.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugbtb.adoc
@@ -16,7 +16,7 @@ Later chapters discuss how to xref:ugbtb.adoc#_ugbtb_deployment[deploy] your app
=== Other Guides
-Apache Isis documentation is broken out into a number of user and reference guides.
+Apache Isis documentation is broken out into a number of user, reference and "supporting procedures" guides.
The user guides available are:
@@ -34,7 +34,11 @@ The reference guides are:
* xref:rgcfg.adoc#[Configuration Properties]
* xref:rgcms.adoc#[Classes, Methods and Schema]
-In addition, there is a xref:cg.adoc#_cg[Contributors' Guide] describing development practices for contributors and committers alike.
+The "supporting procedures" guides are:
+
+* xref:cgcon.adoc#[Contributors' Guide] (how to set up a development environment
+for Apache Isis and contribute back to the project)
+* xref:cgcon.adoc#[Committers' Guide] (release procedures and related practices)
include::_ugbtb_view-models.adoc[leveloffset=+1]
http://git-wip-us.apache.org/repos/asf/isis/blob/49ccfd90/adocs/documentation/src/main/asciidoc/guides/ugfun.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugfun.adoc b/adocs/documentation/src/main/asciidoc/guides/ugfun.adoc
index ddda6ff..bae562f 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugfun.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugfun.adoc
@@ -18,7 +18,7 @@ xref:ugfun.adoc#_ugfun_object-layout[UI layout] of your domain objects (this is
=== Other Guides
-Apache Isis documentation is broken out into a number of user and reference guides.
+Apache Isis documentation is broken out into a number of user, reference and "supporting procedures" guides.
The user guides available are:
@@ -36,7 +36,11 @@ The reference guides are:
* xref:rgcfg.adoc#[Configuration Properties]
* xref:rgcms.adoc#[Classes, Methods and Schema]
-In addition, there is a xref:cg.adoc#_cg[Contributors' Guide] describing development practices for contributors and committers alike.
+The "supporting procedures" guides are:
+
+* xref:cgcon.adoc#[Contributors' Guide] (how to set up a development environment
+for Apache Isis and contribute back to the project)
+* xref:cgcon.adoc#[Committers' Guide] (release procedures and related practices)
http://git-wip-us.apache.org/repos/asf/isis/blob/49ccfd90/adocs/documentation/src/main/asciidoc/guides/ugsec.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugsec.adoc b/adocs/documentation/src/main/asciidoc/guides/ugsec.adoc
index 4a3f46a..0baf9ee 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugsec.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugsec.adoc
@@ -14,7 +14,7 @@ This guide describes the authentication and authorization features available to
=== Other Guides
-Apache Isis documentation is broken out into a number of user and reference guides.
+Apache Isis documentation is broken out into a number of user, reference and "supporting procedures" guides.
The user guides available are:
@@ -32,7 +32,11 @@ The reference guides are:
* xref:rgcfg.adoc#[Configuration Properties]
* xref:rgcms.adoc#[Classes, Methods and Schema]
-In addition, there is a xref:cg.adoc#_cg[Contributors' Guide] describing development practices for contributors and committers alike.
+The "supporting procedures" guides are:
+
+* xref:cgcon.adoc#[Contributors' Guide] (how to set up a development environment
+for Apache Isis and contribute back to the project)
+* xref:cgcon.adoc#[Committers' Guide] (release procedures and related practices)
=== Terminology
http://git-wip-us.apache.org/repos/asf/isis/blob/49ccfd90/adocs/documentation/src/main/asciidoc/guides/ugtst.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugtst.adoc b/adocs/documentation/src/main/asciidoc/guides/ugtst.adoc
index c558cc2..76cfbec 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugtst.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugtst.adoc
@@ -19,7 +19,7 @@ This guide describes those features available to you for testing your Apache Isi
=== Other Guides
-Apache Isis documentation is broken out into a number of user and reference guides.
+Apache Isis documentation is broken out into a number of user, reference and "supporting procedures" guides.
The user guides available are:
@@ -37,7 +37,11 @@ The reference guides are:
* xref:rgcfg.adoc#[Configuration Properties]
* xref:rgcms.adoc#[Classes, Methods and Schema]
-In addition, there is a xref:cg.adoc#_cg[Contributors' Guide] describing development practices for contributors and committers alike.
+The "supporting procedures" guides are:
+
+* xref:cgcon.adoc#[Contributors' Guide] (how to set up a development environment
+for Apache Isis and contribute back to the project)
+* xref:cgcon.adoc#[Committers' Guide] (release procedures and related practices)
http://git-wip-us.apache.org/repos/asf/isis/blob/49ccfd90/adocs/documentation/src/main/asciidoc/guides/ugvro.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugvro.adoc b/adocs/documentation/src/main/asciidoc/guides/ugvro.adoc
index a6529c9..5a648d9 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugvro.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugvro.adoc
@@ -24,7 +24,7 @@ This user guide discuss features, configuration and also how to extend the Restf
=== Other Guides
-Apache Isis documentation is broken out into a number of user and reference guides.
+Apache Isis documentation is broken out into a number of user, reference and "supporting procedures" guides.
The user guides available are:
@@ -42,7 +42,11 @@ The reference guides are:
* xref:rgcfg.adoc#[Configuration Properties]
* xref:rgcms.adoc#[Classes, Methods and Schema]
-In addition, there is a xref:cg.adoc#_cg[Contributors' Guide] describing development practices for contributors and committers alike.
+The "supporting procedures" guides are:
+
+* xref:cgcon.adoc#[Contributors' Guide] (how to set up a development environment
+for Apache Isis and contribute back to the project)
+* xref:cgcon.adoc#[Committers' Guide] (release procedures and related practices)
http://git-wip-us.apache.org/repos/asf/isis/blob/49ccfd90/adocs/documentation/src/main/asciidoc/guides/ugvw.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/guides/ugvw.adoc b/adocs/documentation/src/main/asciidoc/guides/ugvw.adoc
index 29add35..9c00e4b 100644
--- a/adocs/documentation/src/main/asciidoc/guides/ugvw.adoc
+++ b/adocs/documentation/src/main/asciidoc/guides/ugvw.adoc
@@ -38,7 +38,9 @@ The reference guides are:
* xref:rgcfg.adoc#[Configuration Properties]
* xref:rgcms.adoc#[Classes, Methods and Schema]
-In addition, there is a xref:cg.adoc#_cg[Contributors' Guide] describing development practices for contributors and committers alike.
+In addition, there is a xref:cgcon.adoc#[Contributors' Guide] (that describes how to set up a development environment
+for Apache Isis and contribute back to the project), and a xref:cgcon.adoc#[Committers' Guide] (that describes release
+procedures and related practices).
http://git-wip-us.apache.org/repos/asf/isis/blob/49ccfd90/adocs/documentation/src/main/asciidoc/help.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/help.adoc b/adocs/documentation/src/main/asciidoc/help.adoc
index 10d1367..aef3ff6 100644
--- a/adocs/documentation/src/main/asciidoc/help.adoc
+++ b/adocs/documentation/src/main/asciidoc/help.adoc
@@ -16,7 +16,7 @@ pass:[<br/><br/><br/>]
* link:https://issues.apache.org/jira/browse/ISIS[JIRA]
* link:http://github.com/apache/isis[Github mirror]
* link:http://stackoverflow.com/questions/tagged/isis[Stack Overflow] (tagged=isis)
-* link:guides/cg.html#_cg_contributing[How to contribute]
+* link:guides/cgcon.html#_cgcon_contributing[How to contribute]
http://git-wip-us.apache.org/repos/asf/isis/blob/49ccfd90/adocs/documentation/src/main/asciidoc/resources/templates/isis-asciidoc-templates-idea.xml
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/resources/templates/isis-asciidoc-templates-idea.xml b/adocs/documentation/src/main/asciidoc/resources/templates/isis-asciidoc-templates-idea.xml
index d765df1..0a2c9f9 100644
--- a/adocs/documentation/src/main/asciidoc/resources/templates/isis-asciidoc-templates-idea.xml
+++ b/adocs/documentation/src/main/asciidoc/resources/templates/isis-asciidoc-templates-idea.xml
@@ -290,7 +290,7 @@
<option name="AsciiDoc" value="true" />
</context>
</template>
- <template name="adcg" value="xref:cg.adoc#$bookmark$[$DisplayText$]" description="x-ref to contributors guide" toReformat="false" toShortenFQNames="true">
+ <template name="adcgcon" value="xref:cgcon.adoc#$bookmark$[$DisplayText$]" description="x-ref to contributors guide" toReformat="false" toShortenFQNames="true">
<variable name="bookmark" expression="" defaultValue="" alwaysStopAt="true" />
<variable name="DisplayText" expression="" defaultValue="Contributors guide" alwaysStopAt="true" />
<context>
@@ -325,4 +325,18 @@
<option name="AsciiDoc" value="true" />
</context>
</template>
+ <template name="adugvro" value="xref:ugvro.adoc#$bookmark$[$DisplayText$]" description="x-ref to user guide restful objects viewer" toReformat="false" toShortenFQNames="true">
+ <variable name="bookmark" expression="" defaultValue="" alwaysStopAt="true" />
+ <variable name="DisplayText" expression="" defaultValue="Wicket viewer" alwaysStopAt="true" />
+ <context>
+ <option name="AsciiDoc" value="true" />
+ </context>
+ </template>
+ <template name="adcgcom" value="xref:cgcom.adoc#$bookmark$[$DisplayText$]" description="x-ref to committers guide" toReformat="false" toShortenFQNames="true">
+ <variable name="bookmark" expression="" defaultValue="" alwaysStopAt="true" />
+ <variable name="DisplayText" expression="" defaultValue="Contributors guide" alwaysStopAt="true" />
+ <context>
+ <option name="AsciiDoc" value="true" />
+ </context>
+ </template>
</templateSet>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/isis/blob/49ccfd90/adocs/documentation/src/main/asciidoc/screencasts.adoc
----------------------------------------------------------------------
diff --git a/adocs/documentation/src/main/asciidoc/screencasts.adoc b/adocs/documentation/src/main/asciidoc/screencasts.adoc
index 909c933..a90eb66 100644
--- a/adocs/documentation/src/main/asciidoc/screencasts.adoc
+++ b/adocs/documentation/src/main/asciidoc/screencasts.adoc
@@ -53,7 +53,7 @@ _How to import an Apache Isis maven-based application into Eclipse and configure
NB: when configuring DataNucleus for the *dom* project, make sure you are in the 'Java perspective', not the 'Java EE perspective'). +
-Learn more link:./guides/cg.html#_cg_ide_eclipse[here]
+Learn more link:./guides/cgcon.html#_cgcon_ide_eclipse[here]
|video::RgcYfjQ8yJA[youtube,width="420px",height="315px"]
@@ -63,7 +63,7 @@ Learn more link:./guides/cg.html#_cg_ide_eclipse[here]
_How to import an Apache Isis maven-based application into IntelliJ and run the app._ +
-Learn more link:./guides/cg.html#_cg_ide_intellij[here]
+Learn more link:./guides/cgcon.html#_cgcon_ide_intellij[here]
|video::lwKsyTbTSnA[youtube,width="420px",height="315px"]