Author: danhaywood
Date: Mon Nov 26 17:51:27 2012
New Revision: 1413747
URL: http://svn.apache.org/viewvc?rev=1413747&view=rev
Log:
working on isis documentation page
Modified:
isis/site/trunk/content/learning-more/isis-reference-documentation.md
Modified: isis/site/trunk/content/learning-more/isis-reference-documentation.md
URL:
http://svn.apache.org/viewvc/isis/site/trunk/content/learning-more/isis-reference-documentation.md?rev=1413747&r1=1413746&r2=1413747&view=diff
==============================================================================
--- isis/site/trunk/content/learning-more/isis-reference-documentation.md
(original)
+++ isis/site/trunk/content/learning-more/isis-reference-documentation.md Mon
Nov 26 17:51:27 2012
@@ -1,9 +1,61 @@
-Title: Isis Module Documentation
+Title: Isis Reference Documentation
{stub
-This page is a stub.
+This documentation refers to the 0.2.0-incubating release on the original
incubator site.
}
-Isis graduated from the Apache incubator in October 2012; we are currently
setting ourselves up as a top-level project.
+### Documentation
-In the meantime you can access our original incubator website
[here](http://incubator.apache.org/isis "Apache Isis (incubator website)").
+If you're just starting out with Isis, we recommend you look first at:
+
+- the applib documentation
([PDF](http://incubator.apache.org/isis/applib/docbkx/pdf/isis-applib.pdf),
[HTML](http://incubator.apache.org/isis/applib/docbkx/html/guide/isis-applib.html))
+- the core documentation
([PDF](http://incubator.apache.org/isis/core/docbkx/pdf/isis-core.pdf),
[HTML](http://incubator.apache.org/isis/core/docbkx/html/guide/isis-core.html))
+
+If you're looking to contribute to Isis, we also recommend you look at the
contributors documentation
([PDF](http://incubator.apache.org/isis/docbkx/pdf/isis-contributors-guide.pdf),
[HTML](http://incubator.apache.org/isis/docbkx/html/guide/isis-contributors-guide.html)).
+
+Thereafter, we've broken Isis documentation out by component. That means that
any given documentation is likely to have just the information you require to
use or configure that component. It also makes it easier for us to maintain
those documents. The table below lists all the documentation guides available,
along with their current status.
+
+<table>
+<tr>
+<td>Module</td><td>Module</td><td>Description</td><td>Documentation</td><td>Title/Subject</td><td>v0.2.0-incubating
Links</td><td>Status</td><td>Owner</td>
+</tr>
+<tr>
+<td>applib</td><td>Application Library</td><td>Developing domain driven
applications</td><td><a
href="http://incubator.apache.org/isis/applib/docbkx/pdf/isis-applib.pdf";>PDF</a> <a
href="http://incubator.apache.org/isis/applib/docbkx/html/guide/isis-applib.html";>HTML</a></td><td>Done</td><td>Dan,Kevin</td>
+</tr>
+<tr>
+<td>core</td><td>Core Framework</td><td>Architecture, APIs and
Customization</td><td><a
href="http://incubator.apache.org/isis/core/docbkx/pdf/isis-core.pdf";>PDF</a> <a
href="http://incubator.apache.org/isis/core/docbkx/html/guide/isis-core.html";>HTML</a></td><td>95%</td><td>Dan,
Rob</td>
+</tr>
+<tr>
+<td>runtimes:dflt</td><td>Default Runtime</td><td>Programming, Configuration
and Deployment Guide</td><td><a
href="http://incubator.apache.org/isis/runtimes/dflt/docbkx/pdf/isis-default-runtime.pdf";>PDF</a> <a
href="http://incubator.apache.org/isis/runtimes/dflt/docbkx/html/guide/isis-default-runtime.html";>HTML</a></td><td>20%</td><td>Dan,Rob</td>
+</tr>
+<tr>
+<td>viewers:wicket</td><td>Wicket Viewer</td><td>Configuration, Customization
and Deployment Guide</td><td><a
href="http://incubator.apache.org/isis/viewer/wicket/docbkx/pdf/isis-wicket-viewer.pdf";>PDF</a> <a
href="http://incubator.apache.org/isis/viewer/wicket/docbkx/html/guide/isis-wicket-viewer.html";>HTML</a></td><td>95%</td><td>Dan</td>
+</tr>
+<tr>
+<td>viewers:scimpi</td><td>Scimpi Viewer</td><td>Configuration, Customization
and Deployment Guide</td><td><a
href="http://incubator.apache.org/isis/viewer/scimpi/docbkx/pdf/isis-scimpi-viewer.pdf";>PDF</a> <a
href="http://incubator.apache.org/isis/viewer/scimpi/docbkx/html/guide/isis-scimpi-viewer.html";>HTML</a></td><td>80%</td><td>Rob</td>
+</tr>
+<tr>
+<td>viewers:restfulobjects</td><td>RestfulObjects
Viewer</td><td>Configuration, Customization and Deployment Guide</td><td><a
href="http://incubator.apache.org/isis/viewer/json/docbkx/pdf/isis-json-viewer.pdf";>PDF</a> <a
href="http://incubator.apache.org/isis/viewer/json/docbkx/html/guide/isis-json-viewer.html";>HTML</a></td><td>50%</td><td>Dan</td>
+</tr>
+<tr>
+<td>runtimes.dflt.objectstores:jdo</td><td>JDO Object
Store</td><td>Configuration and
Deployment</td><td>none</td><td>0%</td><td>Dan</td>
+</tr>
+<tr>
+<td>runtimes.dflt.objectstores:nosql</td><td>NoSQL Object
Store</td><td>Configuration and Deployment Guide</td><td>none<td>Rob</td>
+</tr>
+<tr>
+<td>runtimes.dflt.objectstores:sql</td><td>SQL Object
Store</td><td>Configuration and Deployment Guide</td><td><a
href="http://incubator.apache.org/isis/runtimes/dflt/objectstores/sql/docbkx/pdf/isis-sql-objectstore.pdf";>PDF</a> <a
href="http://incubator.apache.org/isis/runtimes/dflt/objectstores/sql/docbkx/html/guide/isis-sql-objectstore.html";>HTML</a></td><td>Done</td><td>Kevin</td>
+</tr>
+<tr>
+<td>security</td><td>Security</td><td>Configuration and Deployment
Guide</td><td><a
href="http://incubator.apache.org/isis/security/docbkx/pdf/isis-security.pdf";>PDF</a> <a
href="http://incubator.apache.org/isis/security/docbkx/html/guide/isis-security.html";>HTML</a></td><td>60%</td><td>Dan,Rob</td>
+</tr>
+<tr>
+<td>progmodels</td><td>Programming Models</td><td>Configuration and
Customization Guide</td><td><a
href="http://incubator.apache.org/isis/progmodels/docbkx/pdf/isis-progmodels.pdf";>PDF</a> <a
href="http://incubator.apache.org/isis/progmodels/docbkx/html/guide/isis-progmodels.html";>HTML</a></td><td>40%</td><td>Dan</td>
+</tr>
+<tr>
+<td>viewers:junit</td><td>JUnit Support</td><td>Acceptance Testing using
JUnit</td><td><a
href="http://incubator.apache.org/isis/viewer/junit/docbkx/pdf/isis-junit-support.pdf";>PDF</a> <a
href="http://incubator.apache.org/isis/viewer/junit/docbkx/html/guide/isis-junit-support.html";>HTML</a></td><td>20%</td><td>Dan</td>
+</tr>
+<tr>
+<td>viewers:bdd</td><td>BDD Integration</td><td>Acceptance Testing using BDD
Frameworks</td><td><a
href="http://incubator.apache.org/isis/viewer/bdd/docbkx/pdf/isis-bdd-integration.pdf";>PDF</a> <a
href="http://incubator.apache.org/isis/viewer/bdd/docbkx/html/guide/isis-bdd-integration.html";>HTML</a></td><td>Done</td><td>Dan</td>
+</tr>
+</table>
\ No newline at end of file
