10:36 p.m.
Author: rhauch
Date: 2008-09-25 23:36:03 -0400 (Thu, 25 Sep 2008)
New Revision: 544
Added:
trunk/build/assembly/all.xml
Modified:
trunk/build/assembly/dist.xml
trunk/build/assembly/examples.xml
trunk/docs/gettingstarted/pom.xml
trunk/docs/reference/src/main/docbook/en-US/content/development_tools.xml
trunk/docs/reference/src/main/docbook/en-US/content/introduction.xml
trunk/pom.xml
Log:
DNA-214 Update documentation to describe the repository, federation, JCR and other 0.2
features
https://jira.jboss.org/jira/browse/DNA-214
Documented the release build process, and added another 'all' assembly that
contains all of the code
Added: trunk/build/assembly/all.xml
===================================================================
--- trunk/build/assembly/all.xml (rev 0)
+++ trunk/build/assembly/all.xml 2008-09-26 03:36:03 UTC (rev 544)
@@ -0,0 +1,21 @@
+<assembly>
+ <id>all</id>
+ <formats>
+ <!--<format>tar.gz</format>
+ <format>tar.bz2</format-->
+ <format>zip</format>
+ </formats>
+ <fileSets>
+ <fileSet>
+ <!--
+ Gather into the distribution the various text files for inclusion
+ -->
+ <directory></directory>
+ <outputDirectory></outputDirectory>
+ <excludes>
+ <exclude>target/**</exclude>
+ <exclude>**/target/**</exclude>
+ </excludes>
+ </fileSet>
+ </fileSets>
+</assembly>
Modified: trunk/build/assembly/dist.xml
===================================================================
--- trunk/build/assembly/dist.xml 2008-09-25 21:52:52 UTC (rev 543)
+++ trunk/build/assembly/dist.xml 2008-09-26 03:36:03 UTC (rev 544)
@@ -33,6 +33,13 @@
<directory>docs/gettingstarted/target/docbook/publish/en-US</directory>
<outputDirectory>manuals/gettingstarted</outputDirectory>
</fileSet>
+ <fileSet>
+ <!--
+ Gather into the distribution the Getting Started document
+ -->
+ <directory>docs/reference/target/docbook/publish/en-US</directory>
+ <outputDirectory>manuals/reference</outputDirectory>
+ </fileSet>
</fileSets>
<moduleSets>
<moduleSet>
Modified: trunk/build/assembly/examples.xml
===================================================================
--- trunk/build/assembly/examples.xml 2008-09-25 21:52:52 UTC (rev 543)
+++ trunk/build/assembly/examples.xml 2008-09-26 03:36:03 UTC (rev 544)
@@ -34,6 +34,16 @@
<!--
Gather into the distribution the examples
-->
+ <directory>docs/examples/gettingstarted/repositories</directory>
+ <outputDirectory>examples/repositories</outputDirectory>
+ <excludes>
+ <exclude>target/**</exclude>
+ </excludes>
+ </fileSet>
+ <fileSet>
+ <!--
+ Gather into the distribution the examples
+ -->
<directory>docs/examples/gettingstarted</directory>
<outputDirectory>examples</outputDirectory>
<includes>
Modified: trunk/docs/gettingstarted/pom.xml
===================================================================
--- trunk/docs/gettingstarted/pom.xml 2008-09-25 21:52:52 UTC (rev 543)
+++ trunk/docs/gettingstarted/pom.xml 2008-09-26 03:36:03 UTC (rev 544)
@@ -54,12 +54,12 @@
<stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource>
<finalName>index.html</finalName>
</format>
- -->
<format>
<formatName>pdf</formatName>
<stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource>
<finalName>userguide_en.pdf</finalName>
</format>
+ -->
</formats>
<options>
<xincludeSupported>true</xincludeSupported>
Modified: trunk/docs/reference/src/main/docbook/en-US/content/development_tools.xml
===================================================================
--- trunk/docs/reference/src/main/docbook/en-US/content/development_tools.xml 2008-09-25
21:52:52 UTC (rev 543)
+++ trunk/docs/reference/src/main/docbook/en-US/content/development_tools.xml 2008-09-26
03:36:03 UTC (rev 544)
@@ -209,6 +209,30 @@
</tbody>
</tgroup>
</table>
+ <sect2 id="build-releases">
+ <title>Building releases</title>
+ <para>
+ The process of building JBoss DNA releases involves running a Maven build with some
extra parameters.
+ Building these artifacts, including all documentation and JavaDocs, does take extra
time, which is why
+ they are not included in the default parameters.
+ </para>
+ <para>
+ To build the release, issue the following command while in the
<code>target/</code> directory:
+ </para>
+ <programlisting>mvn -P assembly clean javadoc:javadoc
install</programlisting>
+ <para>
+ This command runs "clean", "javadoc:javadoc", and
"install" goals using the "assembly" profile,
+ which adds the production JavaDocs, the Getting Started document, the Reference Guide
document,
+ the Getting Started examples, and several ZIP archives. The order of the goals is
important,
+ since the "install" goal attempts to include the JavaDoc in the archives.
+ </para>
+ <note>
+ <para>
+ Before running the above command, increase the memory available to Maven with this
command:
+ </para>
+ <programlisting>export MAVEN_OPTS=-Xmx256m</programlisting>
+ </note>
+ </sect2>
</sect1>
<sect1 id="hudson">
<title>Continuous integration with Hudson</title>
Modified: trunk/docs/reference/src/main/docbook/en-US/content/introduction.xml
===================================================================
--- trunk/docs/reference/src/main/docbook/en-US/content/introduction.xml 2008-09-25
21:52:52 UTC (rev 543)
+++ trunk/docs/reference/src/main/docbook/en-US/content/introduction.xml 2008-09-26
03:36:03 UTC (rev 544)
@@ -250,7 +250,7 @@
and several other guidelines. Lean software development can be thought of as an
evolution of agile techniques
in the same way that behavior-driven development is an evolution of test-driven
development. Lean techniques
help the developer to recognize and understand how and why features, bugs, and even
their processes impact the development
- of software - and JBoss DNA.
+ of software.
</para>
</listitem>
</itemizedlist>
Modified: trunk/pom.xml
===================================================================
--- trunk/pom.xml 2008-09-25 21:52:52 UTC (rev 543)
+++ trunk/pom.xml 2008-09-26 03:36:03 UTC (rev 544)
@@ -191,23 +191,26 @@
</execution>
</executions>
<configuration>
- <finalName>
- jboss-dna-${project.version}
- </finalName>
- <descriptors>
- <descriptor>
- build/assembly/examples.xml
- </descriptor>
- <descriptor>
- build/assembly/javadoc.xml
- </descriptor>
- <descriptor>
- build/assembly/dist.xml
- </descriptor>
- <descriptor>
- build/assembly/src.xml
- </descriptor>
- </descriptors>
+ <finalName>
+ jboss-dna-${project.version}
+ </finalName>
+ <descriptors>
+ <descriptor>
+ build/assembly/examples.xml
+ </descriptor>
+ <descriptor>
+ build/assembly/javadoc.xml
+ </descriptor>
+ <descriptor>
+ build/assembly/dist.xml
+ </descriptor>
+ <descriptor>
+ build/assembly/src.xml
+ </descriptor>
+ <descriptor>
+ build/assembly/all.xml
+ </descriptor>
+ </descriptors>
</configuration>
</plugin>
</plugins>
@@ -216,6 +219,19 @@
<module>docs</module>
<module>docs/examples/gettingstarted</module>
</modules>
+ <reporting>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <configuration>
+ <aggregate>true</aggregate>
+ <show>public</show>
+ <title>JBoss DNA ${project.version}</title>
+ </configuration>
+ </plugin>
+ </plugins>
+ </reporting>
</profile>
</profiles>
<build>
@@ -234,28 +250,26 @@
<version>2.2</version>
<configuration>
<aggregate>true</aggregate>
- <doclet>net.gleamynode.apiviz.APIviz</doclet>
- <docletArtifact>
- <groupId>net.gleamynode.apiviz</groupId>
- <artifactId>apiviz</artifactId>
- <version>1.1.1</version>
- </docletArtifact>
- <additionalparam>
- -charset UTF-8
- -docencoding UTF-8
- -version
- -author
- -breakiterator
- -linksource
- -sourcetab 4
- -windowtitle "${project.name} ${project.version} API Reference"
- -doctitle "${project.name} ${project.version} API Reference"
- -bottom "Copyright © ${project.inceptionYear}-Present JBoss a
division of Red Hat. All Rights Reserved."
- -link http://java.sun.com/javase/6/docs/api/
- </additionalparam>
- <encoding>UTF-8</encoding>
-
-
+ <doclet>net.gleamynode.apiviz.APIviz</doclet>
+ <docletArtifact>
+ <groupId>net.gleamynode.apiviz</groupId>
+ <artifactId>apiviz</artifactId>
+ <version>1.1.1</version>
+ </docletArtifact>
+ <additionalparam>
+ -charset UTF-8
+ -docencoding UTF-8
+ -version
+ -author
+ -breakiterator
+ -linksource
+ -sourcetab 4
+ -windowtitle "${project.name} ${project.version} API Reference"
+ -doctitle "${project.name} ${project.version} API Reference"
+ -bottom "Copyright © ${project.inceptionYear}-Present JBoss a
division of Red Hat. All Rights Reserved."
+ -link http://java.sun.com/javase/6/docs/api/
+ </additionalparam>
+ <encoding>UTF-8</encoding>
</configuration>
</plugin>
</plugins>