You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hivemind.apache.org by ah...@apache.org on 2007/02/08 15:36:09 UTC

svn commit: r504914 - in /hivemind/hivemind2/trunk: ./ annotations/src/site/ annotations/src/site/xdoc/ framework/src/site/ jmx/ jmx/src/documentation/ jmx/src/site/ jmx/src/site/images/ jmx/src/site/xdoc/ jmx/src/site/xdoc/hivemind-jmx/ library/ libra...

Author: ahuegen
Date: Thu Feb  8 06:36:07 2007
New Revision: 504914

URL: http://svn.apache.org/viewvc?view=rev&rev=504914
Log:
Overhaul of documentation.
Mvn site target is working now. mvn stage generates a site that contains links to all modules.

Added:
    hivemind/hivemind2/trunk/annotations/src/site/
    hivemind/hivemind2/trunk/annotations/src/site/site.xml
    hivemind/hivemind2/trunk/annotations/src/site/xdoc/
    hivemind/hivemind2/trunk/annotations/src/site/xdoc/index.xml
    hivemind/hivemind2/trunk/jmx/src/site/
    hivemind/hivemind2/trunk/jmx/src/site/images/
      - copied from r504554, hivemind/hivemind2/trunk/jmx/src/documentation/resources/images/
    hivemind/hivemind2/trunk/jmx/src/site/site.xml
    hivemind/hivemind2/trunk/jmx/src/site/xdoc/
      - copied from r504554, hivemind/hivemind2/trunk/jmx/src/documentation/content/xdocs/
    hivemind/hivemind2/trunk/jmx/src/site/xdoc/index.xml   (with props)
    hivemind/hivemind2/trunk/xml/src/site/
    hivemind/hivemind2/trunk/xml/src/site/site.xml
    hivemind/hivemind2/trunk/xml/src/site/xdoc/
    hivemind/hivemind2/trunk/xml/src/site/xdoc/index.xml
Removed:
    hivemind/hivemind2/trunk/jmx/src/documentation/
    hivemind/hivemind2/trunk/jmx/src/site/images/jConsoleConnectLocal.png
    hivemind/hivemind2/trunk/jmx/src/site/images/jConsoleLoggerMBean.png
    hivemind/hivemind2/trunk/jmx/src/site/images/loggerMBeansView.png
    hivemind/hivemind2/trunk/jmx/src/site/images/loggerView.png
    hivemind/hivemind2/trunk/jmx/src/site/images/performanceInterceptorMBean.png
    hivemind/hivemind2/trunk/jmx/src/site/xdoc/hivemind-jmx/
    hivemind/hivemind2/trunk/library/src/site/resources/images/PipelineCallingSequence.png
    hivemind/hivemind2/trunk/library/src/site/xdoc/BeanFactoryBuilder.xml
    hivemind/hivemind2/trunk/library/src/site/xdoc/ChainBuilder.xml
    hivemind/hivemind2/trunk/library/src/site/xdoc/ChainFactory.xml
    hivemind/hivemind2/trunk/library/src/site/xdoc/DefaultImplementationBuilder.xml
    hivemind/hivemind2/trunk/library/src/site/xdoc/EJBProxyFactory.xml
    hivemind/hivemind2/trunk/library/src/site/xdoc/MethodInterceptorFactory.xml
    hivemind/hivemind2/trunk/library/src/site/xdoc/NameLookup.xml
    hivemind/hivemind2/trunk/library/src/site/xdoc/PipelineFactory.xml
    hivemind/hivemind2/trunk/library/src/site/xdoc/PlaceholderFactory.xml
    hivemind/hivemind2/trunk/library/src/site/xdoc/RemoteExceptionCoordinator.xml
    hivemind/hivemind2/trunk/library/src/site/xdoc/ServicePropertyFactory.xml
    hivemind/hivemind2/trunk/library/src/site/xdoc/SpringLookupFactory.xml
    hivemind/hivemind2/trunk/library/src/site/xdoc/StrategyFactory.xml
Modified:
    hivemind/hivemind2/trunk/framework/src/site/site.xml
    hivemind/hivemind2/trunk/jmx/pom.xml
    hivemind/hivemind2/trunk/library/pom.xml
    hivemind/hivemind2/trunk/library/src/site/site.xml
    hivemind/hivemind2/trunk/library/src/site/xdoc/index.xml
    hivemind/hivemind2/trunk/pom.xml

Added: hivemind/hivemind2/trunk/annotations/src/site/site.xml
URL: http://svn.apache.org/viewvc/hivemind/hivemind2/trunk/annotations/src/site/site.xml?view=auto&rev=504914
==============================================================================
--- hivemind/hivemind2/trunk/annotations/src/site/site.xml (added)
+++ hivemind/hivemind2/trunk/annotations/src/site/site.xml Thu Feb  8 06:36:07 2007
@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<project name="HiveMind Annotations">
+    <body>
+        ${reports} 
+    </body>
+</project>

Added: hivemind/hivemind2/trunk/annotations/src/site/xdoc/index.xml
URL: http://svn.apache.org/viewvc/hivemind/hivemind2/trunk/annotations/src/site/xdoc/index.xml?view=auto&rev=504914
==============================================================================
--- hivemind/hivemind2/trunk/annotations/src/site/xdoc/index.xml (added)
+++ hivemind/hivemind2/trunk/annotations/src/site/xdoc/index.xml Thu Feb  8 06:36:07 2007
@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="utf-8"?><!-- 
+   Copyright 2004, 2005 The Apache Software Foundation
+
+   Licensed 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.
+-->
+<document>
+   <properties>
+      <title>HiveMind Annotations</title>
+   </properties>
+   <body>
+	  <section name="HiveMind Annotations" >
+        <p>
+			The HiveMind Annotations library, provides 
+			functionality to define HiveMind modules by xml descriptors.
+		</p>
+	  </section>
+   </body>
+</document>
\ No newline at end of file

Modified: hivemind/hivemind2/trunk/framework/src/site/site.xml
URL: http://svn.apache.org/viewvc/hivemind/hivemind2/trunk/framework/src/site/site.xml?view=diff&rev=504914&r1=504913&r2=504914
==============================================================================
--- hivemind/hivemind2/trunk/framework/src/site/site.xml (original)
+++ hivemind/hivemind2/trunk/framework/src/site/site.xml Thu Feb  8 06:36:07 2007
@@ -1,17 +1,6 @@
 <?xml version="1.0" encoding="ISO-8859-1"?>
-<project name="Maven">
-    <bannerLeft>
-        <name>Jakarta</name>
-        <href>http://jakarta.apache.org/</href>
-    </bannerLeft>
-    <bannerRight>
-        <name>HiveMind Framework</name>
-        <href>http://jakarta.apache.org/hivemind/hivemind/</href>
-    </bannerRight>
+<project name="HiveMind Framework">
     <body>
-        <links>
-            <item name="Apache" href="http://www.apache.org/"/>
-        </links>
         <menu name="HiveMind Framework">
             <item name="Introduction" href="index.html"/>
             <item name="ApplicationDefaults" href="ApplicationDefaults.html"/>
@@ -26,5 +15,7 @@
             <item name="ThreadLocale" href="ThreadLocale.html"/>
             <item name="ThreadLocalStorage" href="ThreadLocalStorage.html"/>
             <item name="Translators" href="Translators.html"/>
-        </menu> ${reports} </body>
+        </menu> 
+        ${reports} 
+   </body>
 </project>

Modified: hivemind/hivemind2/trunk/jmx/pom.xml
URL: http://svn.apache.org/viewvc/hivemind/hivemind2/trunk/jmx/pom.xml?view=diff&rev=504914&r1=504913&r2=504914
==============================================================================
--- hivemind/hivemind2/trunk/jmx/pom.xml (original)
+++ hivemind/hivemind2/trunk/jmx/pom.xml Thu Feb  8 06:36:07 2007
@@ -75,5 +75,23 @@
     <scm>
         <connection>svn:http://svn.apache.org/repos/asf/jakarta/hivemind/trunk/jmx</connection>
         <url>http://svn.apache.org/viewvc/jakarta/hivemind/trunk/jmx</url>
-    </scm>
+    </scm>
+    <reporting>
+		<plugins>
+			<plugin>
+	          <groupId>org.apache.maven.plugins</groupId>
+	          <artifactId>maven-project-info-reports-plugin</artifactId>
+	          <reportSets>
+	             <reportSet>
+	                <reports>
+	                   <report>dependencies</report>
+	                   <report>license</report>
+	                   <report>scm</report>
+	                </reports>
+	             </reportSet>
+	          </reportSets>
+	        </plugin>
+		</plugins>
+    </reporting>
+                  
 </project>

Added: hivemind/hivemind2/trunk/jmx/src/site/site.xml
URL: http://svn.apache.org/viewvc/hivemind/hivemind2/trunk/jmx/src/site/site.xml?view=auto&rev=504914
==============================================================================
--- hivemind/hivemind2/trunk/jmx/src/site/site.xml (added)
+++ hivemind/hivemind2/trunk/jmx/src/site/site.xml Thu Feb  8 06:36:07 2007
@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<project name="HiveMind JMX">
+    <body>
+        ${reports} 
+    </body>
+</project>

Added: hivemind/hivemind2/trunk/jmx/src/site/xdoc/index.xml
URL: http://svn.apache.org/viewvc/hivemind/hivemind2/trunk/jmx/src/site/xdoc/index.xml?view=auto&rev=504914
==============================================================================
--- hivemind/hivemind2/trunk/jmx/src/site/xdoc/index.xml (added)
+++ hivemind/hivemind2/trunk/jmx/src/site/xdoc/index.xml Thu Feb  8 06:36:07 2007
@@ -0,0 +1,47 @@
+<?xml version="1.0"?>
+<!-- 
+   Copyright 2004, 2005 The Apache Software Foundation
+
+   Licensed 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.
+-->
+
+<document>
+
+  <properties>
+    <title>HiveMind JMX</title>
+  </properties>
+	
+  <body>
+	<section name="HiveMind JMX" >
+	    <p>
+		The HiveMind JMX library (module <a href="hivedocs/module/hivemind.jmx.html">hivemind.jmx</a>) 
+		brings the benefits of mature application management 
+		and monitoring to your HiveMind based applications by integration of
+		the  <a href="http://java.sun.com/products/JavaManagement">Java Management Extension (JMX)</a>.
+		</p>
+		<p>With minimal effort you get access to these features: </p>
+		<ul>
+			<li>Change log levels in your running application via a web based interface
+				or by use of a management console</li>
+			<li>Measure the performance of middleware calls and view the data online</li>
+			<li>Make your services configurable at runtime. Change database urls or cache sizes</li>
+		</ul>	
+	
+		<p>
+			The services of this library are implemented in the module 
+		    <link href="hivemind.management.html">hivemind.management</link>.
+		    The module is defined by a xml module descriptor.
+		</p>
+	</section>
+  </body>
+</document>

Propchange: hivemind/hivemind2/trunk/jmx/src/site/xdoc/index.xml
------------------------------------------------------------------------------
    cvs2svn:cvs-rev = 1.1

Propchange: hivemind/hivemind2/trunk/jmx/src/site/xdoc/index.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: hivemind/hivemind2/trunk/jmx/src/site/xdoc/index.xml
------------------------------------------------------------------------------
    svn:keywords = Author Date Id Revision

Modified: hivemind/hivemind2/trunk/library/pom.xml
URL: http://svn.apache.org/viewvc/hivemind/hivemind2/trunk/library/pom.xml?view=diff&rev=504914&r1=504913&r2=504914
==============================================================================
--- hivemind/hivemind2/trunk/library/pom.xml (original)
+++ hivemind/hivemind2/trunk/library/pom.xml Thu Feb  8 06:36:07 2007
@@ -81,4 +81,21 @@
         <connection>svn:http://svn.apache.org/repos/asf/jakarta/hivemind/trunk/library</connection>
         <url>http://svn.apache.org/viewvc/jakarta/hivemind/trunk/library</url>
     </scm>
+    <reporting>
+		<plugins>
+			<plugin>
+	          <groupId>org.apache.maven.plugins</groupId>
+	          <artifactId>maven-project-info-reports-plugin</artifactId>
+	          <reportSets>
+	             <reportSet>
+	                <reports>
+	                   <report>dependencies</report>
+	                   <report>license</report>
+	                   <report>scm</report>
+	                </reports>
+	             </reportSet>
+	          </reportSets>
+	        </plugin>
+		</plugins>
+    </reporting>
 </project>

Modified: hivemind/hivemind2/trunk/library/src/site/site.xml
URL: http://svn.apache.org/viewvc/hivemind/hivemind2/trunk/library/src/site/site.xml?view=diff&rev=504914&r1=504913&r2=504914
==============================================================================
--- hivemind/hivemind2/trunk/library/src/site/site.xml (original)
+++ hivemind/hivemind2/trunk/library/src/site/site.xml Thu Feb  8 06:36:07 2007
@@ -1,29 +1,6 @@
 <?xml version="1.0" encoding="ISO-8859-1"?>
-<project name="Maven">
-    <bannerLeft>
-        <name>Jakarta</name>
-        <href>http://jakarta.apache.org/</href>
-    </bannerLeft>
-    <bannerRight>
-        <name>HiveMind Library</name>
-        <href>http://jakarta.apache.org/hivemind/library/</href>
-    </bannerRight>
+<project name="HiveMind Library">
     <body>
-        <links>
-            <item name="Apache" href="http://www.apache.org/"/>
-        </links>
-        <menu name="HiveMind Library">
-            <item name="Introduction" href="index.html"/>
-            <item name="BeanFactoryBuilder" href="BeanFactoryBuilder.html"/>
-            <item name="ChainBuilder" href="ChainBuilder.html"/>
-            <item name="ChainFactory" href="ChainFactory.html"/>
-            <item name="DefaultImplementationBuilder" href="DefaultImplementationBuilder.html"/>
-            <item name="EJBProxyFactory" href="EJBProxyFactory.html"/>
-            <item name="MethodInterceptorFactory" href="MethodInterceptorFactory.html"/>
-            <item name="NameLookup" href="NameLookup.html"/>
-            <item name="PipelineFactory" href="PipelineFactory.html"/>
-            <item name="RemoteExceptionCoordinator" href="RemoteExceptionCoordinator.html"/>
-            <item name="ServicePropertyFactory" href="ServicePropertyFactory.html"/>
-            <item name="StrategyFactory" href="StrategyFactory.html"/>
-        </menu> ${reports} </body>
+        ${reports} 
+    </body>
 </project>

Modified: hivemind/hivemind2/trunk/library/src/site/xdoc/index.xml
URL: http://svn.apache.org/viewvc/hivemind/hivemind2/trunk/library/src/site/xdoc/index.xml?view=diff&rev=504914&r1=504913&r2=504914
==============================================================================
--- hivemind/hivemind2/trunk/library/src/site/xdoc/index.xml (original)
+++ hivemind/hivemind2/trunk/library/src/site/xdoc/index.xml Thu Feb  8 06:36:07 2007
@@ -18,15 +18,13 @@
       <title>Module: hivemind.lib</title>
    </properties>
    <body>
-
-
-      <p>
-The HiveMind standard library (module 
-<a href="hivedocs/module/hivemind.lib.html">hivemind.lib</a>), provides common
-functionality used in most HiveMind applications.
-</p>
-
-    
-  
+	  <section name="HiveMind Standard Library" >
+        <p>
+			The HiveMind standard library (module 
+			<a href="hivedocs/module/hivemind.lib.html">hivemind.lib</a>), provides common
+			functionality used in most HiveMind applications.
+			The module and its extension points are defined by a xml module descriptor.
+		</p>
+	  </section>
    </body>
 </document>

Modified: hivemind/hivemind2/trunk/pom.xml
URL: http://svn.apache.org/viewvc/hivemind/hivemind2/trunk/pom.xml?view=diff&rev=504914&r1=504913&r2=504914
==============================================================================
--- hivemind/hivemind2/trunk/pom.xml (original)
+++ hivemind/hivemind2/trunk/pom.xml Thu Feb  8 06:36:07 2007
@@ -17,7 +17,7 @@
         <module>jmx</module>
         <module>examples</module>
     </modules>
-    <url>http://jakarta.apache.org/hivemind/</url>
+    <url>http://hivemind.apache.org/hivemind2/</url>
     <developers>
         <developer>
             <id>HLS</id>
@@ -244,7 +244,7 @@
         <!-- Alas, this doesn't work yet -->
         <site>
             <id>apache.org</id>
-            <url>ssh://cvs.apache.org/jakarta/hivemind/%{pom.artifactId}</url>
+            <url>ssh://svn.apache.org/hivemind/</url>
         </site>
         <repository>
             <!-- The "maven" login id, specified in settings.xml, ensures that the Maven
@@ -259,7 +259,7 @@
         <url>http://www.apache.org/</url>
     </organization>
     <scm>
-        <connection>svn:http://svn.apache.org/repos/asf/jakarta/hivemind/trunk/</connection>
-        <url>http://svn.apache.org/viewvc/jakarta/hivemind/trunk/</url>
+        <connection>svn:http://svn.apache.org/repos/asf/hivemind/hivemind2/trunk/</connection>
+        <url>http://svn.apache.org/viewvc/hivemind/hivemind2/trunk/</url>
     </scm>
 </project>

Added: hivemind/hivemind2/trunk/xml/src/site/site.xml
URL: http://svn.apache.org/viewvc/hivemind/hivemind2/trunk/xml/src/site/site.xml?view=auto&rev=504914
==============================================================================
--- hivemind/hivemind2/trunk/xml/src/site/site.xml (added)
+++ hivemind/hivemind2/trunk/xml/src/site/site.xml Thu Feb  8 06:36:07 2007
@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<project name="HiveMind XML">
+    <body>
+        ${reports} 
+    </body>
+</project>

Added: hivemind/hivemind2/trunk/xml/src/site/xdoc/index.xml
URL: http://svn.apache.org/viewvc/hivemind/hivemind2/trunk/xml/src/site/xdoc/index.xml?view=auto&rev=504914
==============================================================================
--- hivemind/hivemind2/trunk/xml/src/site/xdoc/index.xml (added)
+++ hivemind/hivemind2/trunk/xml/src/site/xdoc/index.xml Thu Feb  8 06:36:07 2007
@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="utf-8"?><!-- 
+   Copyright 2004, 2005 The Apache Software Foundation
+
+   Licensed 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.
+-->
+<document>
+   <properties>
+      <title>Module: hivemind.xml</title>
+   </properties>
+   <body>
+	  <section name="HiveMind XML" >
+        <p>
+			The HiveMind XML library (module 
+			<a href="hivedocs/module/hivemind.xml.html">hivemind.xml</a>), provides 
+			functionality to define HiveMind modules by xml descriptors.
+		</p>
+	  </section>
+   </body>
+</document>
\ No newline at end of file