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 2011/02/26 12:31:15 UTC
svn commit: r1074828 - in /incubator/isis/trunk/src/site:
apt/documentation.apt apt/quickstart-app.apt apt/where-to-start.apt
resources/archetype-catalogue.xml site.xml
Author: danhaywood
Date: Sat Feb 26 11:31:14 2011
New Revision: 1074828
URL: http://svn.apache.org/viewvc?rev=1074828&view=rev
Log:
added archetype-catalog.xml to site, updates to documentation and site
Added:
incubator/isis/trunk/src/site/apt/documentation.apt
incubator/isis/trunk/src/site/resources/archetype-catalogue.xml
Modified:
incubator/isis/trunk/src/site/apt/quickstart-app.apt
incubator/isis/trunk/src/site/apt/where-to-start.apt
incubator/isis/trunk/src/site/site.xml
Added: incubator/isis/trunk/src/site/apt/documentation.apt
URL: http://svn.apache.org/viewvc/incubator/isis/trunk/src/site/apt/documentation.apt?rev=1074828&view=auto
==============================================================================
--- incubator/isis/trunk/src/site/apt/documentation.apt (added)
+++ incubator/isis/trunk/src/site/apt/documentation.apt Sat Feb 26 11:31:14 2011
@@ -0,0 +1,85 @@
+~~ 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.
+
+
+
+Documentation
+
+ To keep things manageable, all Isis documentation about these components is
+ scoped closest along with that 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).
+
+ If you're just starting out with Isis, we recommend you look first at:
+
+ * the {{{./applib/docbkx/pdf/isis-applib.pdf}applib}} documentation
+
+ * the {{{./core/docbkx/pdf/isis-core.pdf}core}} documentation
+
+ []
+
+ Thereafter you'll want to drill into the documentation for individual
+ components. The table below lists all the documentation guides available,
+ along with their current status.
+
+
+*------------------------------*------------------------------------*-----------------------------------*-------------------------------------------------------------------------------*----------------------------------------------------------------------------------------*----------*--------+
+|<<Module>> |<<Module Description>> |<<Documentation Title/Subject>> |<<PDF>> |<<HTML>> |<<Status>>|<<Owner>> |
+*------------------------------+------------------------------------+-----------------------------------+-------------------------------------------------------------------------------*----------------------------------------------------------------------------------------*----------*--------+
+|applib |Application Library |Programming Model Conventions |{{{./applib/docbkx/pdf/isis-applib.pdf}PDF}} |{{{./applib/docbkx/html/guide/isis-applib.html}HTML}} |Done |Dan |
+*------------------------------+------------------------------------+-----------------------------------+-------------------------------------------------------------------------------*----------------------------------------------------------------------------------------*----------*--------+
+|core |Core Framework |Design, Core APIs and Customization|{{{./core/docbkx/pdf/isis-core.pdf}PDF}} |{{{./core/docbkx/html/guide/isis-core.html}HTML}} |50% |Dan, Rob|
+*------------------------------+------------------------------------+-----------------------------------+-------------------------------------------------------------------------------*----------------------------------------------------------------------------------------*----------*--------+
+|defaults |Default Implementations of Core APIs|Configuration and Deployment Guide |{{{./defaults/docbkx/pdf/isis-defaults.pdf}PDF}} |{{{./defaults/docbkx/html/guide/isis-defaults.html}HTML}} |0% |Dan |
+*------------------------------+------------------------------------+-----------------------------------+-------------------------------------------------------------------------------*----------------------------------------------------------------------------------------*----------*--------+
+|alternatives-objectstore-xml |XML Object Store |Configuration and Deployment Guide |{{{./alternatives/objectstore/xml/docbkx/pdf/isis-xml-objectstore.pdf}PDF}} |{{{./alternatives/objectstore/xml/docbkx/html/guide/isis-xml-objectstore.html}HTML}} |0% |Rob |
+*------------------------------+------------------------------------+-----------------------------------+-------------------------------------------------------------------------------*----------------------------------------------------------------------------------------*----------*--------+
+|alternatives-objectstore-sql |SQL Object Store |Configuration and Deployment Guide |{{{./alternatives/objectstore/sql/docbkx/pdf/isis-sql-objectstore.pdf}PDF}} |{{{./alternatives/objectstore/sql/docbkx/html/guide/isis-sql-objectstore.html}HTML}} |80% |Kevin |
+*------------------------------+------------------------------------+-----------------------------------+-------------------------------------------------------------------------------*----------------------------------------------------------------------------------------*----------*--------+
+|alternatives-objectstore-nosql|NoSQL Object Store |Configuration and Deployment Guide |{{{./alternatives/objectstore/nosql/docbkx/pdf/isis-nosql-objectstore.pdf}PDF}}|{{{./alternatives/objectstore/nosql/docbkx/html/guide/isis-nosql-objectstore.html}HTML}}|Missing |Rob |
+*------------------------------+------------------------------------+-----------------------------------+-------------------------------------------------------------------------------*----------------------------------------------------------------------------------------*----------*--------+
+|alternatives-profilestore-xml |XML Profile Store |Configuration and Deployment Guide |{{{./alternatives/profilestore/xml/docbkx/pdf/isis-xml-profilestore.pdf}PDF}} |{{{./alternatives/profilestore/xml/docbkx/html/guide/isis-xml-profilestore.html}HTML}} |0% |Rob |
+*------------------------------+------------------------------------+-----------------------------------+-------------------------------------------------------------------------------*----------------------------------------------------------------------------------------*----------*--------+
+|alternatives-progmodel-groovy |Groovy Programming Model |Configuration and Deployment Guide |{{{./alternatives/progmodel/groovy/docbkx/pdf/isis-groovy-support.pdf}PDF}} |{{{./alternatives/progmodel/groovy/docbkx/html/guide/isis-groovy-support.html}HTML}} |Missing |Dan |
+*------------------------------+------------------------------------+-----------------------------------+-------------------------------------------------------------------------------*----------------------------------------------------------------------------------------*----------*--------+
+|alternatives-progmodel-wrapper|Wrapper Programming Model |Configuration and Deployment Guide |{{{./alternatives/progmodel/wrapper/docbkx/pdf/isis-wrapper.pdf}PDF}} |{{{./alternatives/progmodel/wrapper/docbkx/html/guide/isis-wrapper.html}HTML}} |Missing |Dan |
+*------------------------------+------------------------------------+-----------------------------------+-------------------------------------------------------------------------------*----------------------------------------------------------------------------------------*----------*--------+
+|alternatives-bytecode |Bytecode Enhancement |Configuration and Deployment Guide |{{{./alternatives/bytecode/docbkx/pdf/isis-alternatives-bytecode.pdf}PDF}} |{{{./alternatives/bytecode/docbkx/html/guide/isis-alternatives-bytecode.html}HTML}} |Missing |Dan |
+*------------------------------+------------------------------------+-----------------------------------+-------------------------------------------------------------------------------*----------------------------------------------------------------------------------------*----------*--------+
+|alternatives-security-file |File Security |Configuration and Deployment Guide |{{{./alternatives/security/file/docbkx/pdf/isis-file-security.pdf}PDF}} |{{{./alternatives/security/file/docbkx/html/guide/isis-file-security.html}HTML}} |Missing |Dan,Rob |
+*------------------------------+------------------------------------+-----------------------------------+-------------------------------------------------------------------------------*----------------------------------------------------------------------------------------*----------*--------+
+|alternatives-security-ldap |LDAP Security |Configuration and Deployment Guide |{{{./alternatives/security/ldap/docbkx/pdf/isis-ldap-security.pdf}PDF}} |{{{./alternatives/security/ldap/docbkx/html/guide/isis-ldap-security.html}HTML}} |Missing |Rob |
+*------------------------------+------------------------------------+-----------------------------------+-------------------------------------------------------------------------------*----------------------------------------------------------------------------------------*----------*--------+
+|alternatives-embedded |Embedded MetaModel Deployment |Configuration and Deployment Guide |{{{./alternatives/embedded/docbkx/pdf/isis-embedded-deployment.pdf}PDF}} |{{{./alternatives/embedded/docbkx/html/guide/isis-embedded-deployment.html}HTML}} |Missing |Dan |
+*------------------------------+------------------------------------+-----------------------------------+-------------------------------------------------------------------------------*----------------------------------------------------------------------------------------*----------*--------+
+|alternatives-remoting |Remoting (Client/Server) Deployment |Configuration and Deployment Guide |{{{./alternatives/remoting/docbkx/pdf/isis-remoting.pdf}PDF}} |{{{./alternatives/remoting/docbkx/html/guide/isis-remoting.html}HTML}} |Missing |Rob |
+*------------------------------+------------------------------------+-----------------------------------+-------------------------------------------------------------------------------*----------------------------------------------------------------------------------------*----------*--------+
+|viewer-dnd |Drag-n-drop Viewer |Configuration and Deployment Guide |{{{./viewer/dnd/docbkx/pdf/isis-dnd-viewer.pdf}PDF}} |{{{./viewer/dnd/docbkx/html/guide/isis-dnd-viewer.html}HTML}} |40% |Rob |
+*------------------------------+------------------------------------+-----------------------------------+-------------------------------------------------------------------------------*----------------------------------------------------------------------------------------*----------*--------+
+|viewer-html |HTML Viewer |Configuration and Deployment Guide |{{{./viewer/html/docbkx/pdf/isis-html-viewer.pdf}PDF}} |{{{./viewer/html/docbkx/html/guide/isis-html-viewer.html}HTML}} |0% |Rob |
+*------------------------------+------------------------------------+-----------------------------------+-------------------------------------------------------------------------------*----------------------------------------------------------------------------------------*----------*--------+
+|viewer-scimpi |Scimpi Viewer |Configuration and Deployment Guide |{{{./viewer/scimpi/docbkx/pdf/isis-scimpi-viewer.pdf}PDF}} |{{{./viewer/scimpi/docbkx/html/guide/isis-scimpi-viewer.html}HTML}} |0% |Rob |
+*------------------------------+------------------------------------+-----------------------------------+-------------------------------------------------------------------------------*----------------------------------------------------------------------------------------*----------*--------+
+|viewer-wicket |Wicket Viewer |Configuration and Deployment Guide |{{{./viewer/wicket/docbkx/pdf/isis-wicket-viewer.pdf}PDF}} |{{{./viewer/wicket/docbkx/html/guide/isis-wicket-viewer.html}HTML}} |Done |Dan |
+*------------------------------+------------------------------------+-----------------------------------+-------------------------------------------------------------------------------*----------------------------------------------------------------------------------------*----------*--------+
+|viewer-restful |Restful Viewer |Configuration and Deployment Guide |{{{./viewer/restful/docbkx/pdf/isis-restful-viewer.pdf}PDF}} |{{{./viewer/restful/docbkx/html/guide/isis-restful-viewer.html}HTML}} |90% |Dan |
+*------------------------------+------------------------------------+-----------------------------------+-------------------------------------------------------------------------------*----------------------------------------------------------------------------------------*----------*--------+
+|viewer-junit |JUnit Support |Configuration and Deployment Guide |{{{./viewer/junit/docbkx/pdf/isis-junit-support.pdf}PDF}} |{{{./viewer/junit/docbkx/html/guide/isis-junit-support.html}HTML}} |0% |Dan |
+*------------------------------+------------------------------------+-----------------------------------+-------------------------------------------------------------------------------*----------------------------------------------------------------------------------------*----------*--------+
+|viewer-bdd |BDD Integration |Configuration and Deployment Guide |{{{./viewer/bdd/docbkx/pdf/isis-bdd-integration.pdf}PDF}} |{{{./viewer/bdd/docbkx/html/guide/isis-bdd-integration.html}HTML}} |Done |Dan |
+*------------------------------+------------------------------------+-----------------------------------+-------------------------------------------------------------------------------*----------------------------------------------------------------------------------------*----------*--------+
Modified: incubator/isis/trunk/src/site/apt/quickstart-app.apt
URL: http://svn.apache.org/viewvc/incubator/isis/trunk/src/site/apt/quickstart-app.apt?rev=1074828&r1=1074827&r2=1074828&view=diff
==============================================================================
--- incubator/isis/trunk/src/site/apt/quickstart-app.apt (original)
+++ incubator/isis/trunk/src/site/apt/quickstart-app.apt Sat Feb 26 11:31:14 2011
@@ -24,13 +24,15 @@ QuickStart App
+------------------------------------------------------------
mvn archetype:generate \
+ -D archetypeCatalog=https://incubator.apache.org/isis \
-D archetypeGroupId=org.apache.isis.support \
- -D archetypeArtifactId=quickstart-archetype \
- -D archetypeCatalog=https://repository.apache.org/content/groups/snapshots-group
+ -D archetypeArtifactId=quickstart-archetype
+
+------------------------------------------------------------
Note: <currently the archetype is only available from the Apache snapshot
- repository; hence the need to specify the archetypeCatalog property.>
+ repository; hence the need to specify the archetypeCatalog property to pick
+ it up.>
You'll prompted for some properties:
@@ -63,18 +65,19 @@ mvn archetype:generate \
The archetype generation process will then run; it only takes a few seconds.
Switch into the root directory of your newly generated app:
+
+------------------------------------------------------------
cd myapp
+------------------------------------------------------------
- Where 'myapp' is the artifactId entered above.
+ where 'myapp' is the artifactId entered above.
App Structure
The generated app is a very simple application consisting of a single domain
object for tracking to-do items. The intention is not to showcase all of
- Isis capabilities; rather it is to allow you to very easily modify the
+ Isis' capabilities; rather it is to allow you to very easily modify the
generated application (eg rename "ToDoItem" to "Customer") without having
to waste time deleting lots of generated code.
@@ -93,9 +96,10 @@ App Structure
| | (in-memory) object store. |
*----------------------+---------------------------------------------------------+
| myapp-quickrun | Run the application during development/prototyping |
-| | using either the |
-| | {{{./viewer/dnd/index.html}drag-n-drop viewer}} or |
-| | using the {{{./viewer/html/index.html}HTML viewer}}. |
+| | using any of the |
+| | {{{./viewer/dnd/index.html}drag-n-drop viewer}}, the |
+| | {{{./viewer/html/index.html}HTML viewer}} or the |
+| | {{{./viewer/restful/index.html}RESTful viewer}}. |
*----------------------+---------------------------------------------------------+
| myapp-tests-bdd | Run domain object tests using Isis' |
| | {{{./viewer/bdd/concordion/index.html}integration}} |
Modified: incubator/isis/trunk/src/site/apt/where-to-start.apt
URL: http://svn.apache.org/viewvc/incubator/isis/trunk/src/site/apt/where-to-start.apt?rev=1074828&r1=1074827&r2=1074828&view=diff
==============================================================================
--- incubator/isis/trunk/src/site/apt/where-to-start.apt (original)
+++ incubator/isis/trunk/src/site/apt/where-to-start.apt Sat Feb 26 11:31:14 2011
@@ -25,9 +25,9 @@ Where to Start?
+------------------------------------------------------------
mvn archetype:generate \
+ -D archetypeCatalog=https://incubator.apache.org/isis \
-D archetypeGroupId=org.apache.isis.support \
- -D archetypeArtifactId=quickstart-archetype \
- -D archetypeCatalog=https://repository.apache.org/content/groups/snapshots-group
+ -D archetypeArtifactId=quickstart-archetype
+------------------------------------------------------------
@@ -35,9 +35,9 @@ mvn archetype:generate \
of the generated application and how to run it.
Note: <currently the archetype is only available from the Apache snapshot
- repository; hence the need to specify the archetypeCatalog property. When
- we get our first release out, the archetype will be available in the
- Maven central repo and this property will not be required>.
+ repository; hence the need to specify the archetypeCatalog property to pick
+ it up. When we get our first release out, the archetype will be available
+ in the Maven central repo and this property will not be required>.
Documentation
@@ -67,6 +67,8 @@ Documentation
more sophisticated and offer more in the way of customization. In either case, you'll find
the information you need in the user guides for each of the components.
+ The documentation for all of the components is listed {{{./documentation.html}here}}.
+
What Else is There?
To speed up your coding we provide some templates and other help for IDEs;
Added: incubator/isis/trunk/src/site/resources/archetype-catalogue.xml
URL: http://svn.apache.org/viewvc/incubator/isis/trunk/src/site/resources/archetype-catalogue.xml?rev=1074828&view=auto
==============================================================================
--- incubator/isis/trunk/src/site/resources/archetype-catalogue.xml (added)
+++ incubator/isis/trunk/src/site/resources/archetype-catalogue.xml Sat Feb 26 11:31:14 2011
@@ -0,0 +1,15 @@
+<archetype-catalog xmlns="http://maven.apache.org/plugins/maven-archetype-plugi
+n/archetype-catalog/1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/plugins/maven-archetype-plugin/arc
+hetype-catalog/1.0.0 http://maven.apache.org/xsd/archetype-catalog-1.0.0.xsd">
+ <archetypes>
+ <archetype>
+ <groupId>org.apache.isis.support</groupId>
+ <artifactId>quickstart-archetype</artifactId>
+ <version>0.1.0-incubating-SNAPSHOT</version>
+ <repository>https://repository.apache.org/content/groups/snapshots-group/
+</repository>
+ <description>Isis Quickstart Archetype</description>
+ </archetype>
+ </archetypes>
+</archetype-catalog>
\ No newline at end of file
Modified: incubator/isis/trunk/src/site/site.xml
URL: http://svn.apache.org/viewvc/incubator/isis/trunk/src/site/site.xml?rev=1074828&r1=1074827&r2=1074828&view=diff
==============================================================================
--- incubator/isis/trunk/src/site/site.xml (original)
+++ incubator/isis/trunk/src/site/site.xml Sat Feb 26 11:31:14 2011
@@ -17,7 +17,7 @@
<menu name="Apache Isis">
<item name="Home" href="index.html" />
- <item name="QuickStart" href="where-to-start.html" />
+ <item name="Quick start" href="where-to-start.html" />
<item name="Who we are" href="who-we-are.html" />
<item name="Roadmap" href="roadmap.html" />
<item name="License" href="license.html" />
@@ -27,6 +27,7 @@
<menu name="Getting Started">
<item name="Downloads" href="downloads.html" />
+ <item name="Documentation" href="documentation.html" />
<item name="IDE Support" href="ide-support.html"/>
<item name="Cheat Sheet" href="IsisCheatSheet.pdf"/>
</menu>
@@ -41,7 +42,9 @@
<item name="Subscribe"
href="mailto:isis-dev-subscribe@incubator.apache.org" />
</item>
+ <!--
<item name="Twitter (#ApacheIsis)" href="http://search.twitter.com/search?q=%23ApacheIsis" />
+ -->
<item name="Wiki" href="https://cwiki.apache.org/confluence/display/ISIS/Index" />
<item name="JIRA" href="https://issues.apache.org/jira/browse/ISIS" />
<item name="CI" href="https://hudson.apache.org/hudson/job/isis-trunk-ubuntu" />