Author: rwatler
Date: Tue Apr 20 11:49:47 2010
New Revision: 935884
URL: http://svn.apache.org/viewvc?rev=935884&view=rev
Log:
JS2-1126: document new ui/min-ui source build targets
Modified:
portals/site/jetspeed/jetspeed-2.2/jetspeed-guide-build/src/site/xdoc/jetspeed-unpack-plugin.xml
portals/site/jetspeed/jetspeed-2.2/jetspeed-guide-build/src/site/xdoc/maven-2-build.xml
Modified:
portals/site/jetspeed/jetspeed-2.2/jetspeed-guide-build/src/site/xdoc/jetspeed-unpack-plugin.xml
URL:
http://svn.apache.org/viewvc/portals/site/jetspeed/jetspeed-2.2/jetspeed-guide-build/src/site/xdoc/jetspeed-unpack-plugin.xml?rev=935884&r1=935883&r2=935884&view=diff
==============================================================================
---
portals/site/jetspeed/jetspeed-2.2/jetspeed-guide-build/src/site/xdoc/jetspeed-unpack-plugin.xml
(original)
+++
portals/site/jetspeed/jetspeed-2.2/jetspeed-guide-build/src/site/xdoc/jetspeed-unpack-plugin.xml
Tue Apr 20 11:49:47 2010
@@ -83,6 +83,7 @@
<flat>...</flat>
<include>...</include>
<exclude>...</exclude>
+ <name>...</name>
</resource>
...
</resources>
@@ -325,6 +326,14 @@
<source><![CDATA[<exclude>security-spi*.xml,security-managers.xml</exclude>]]></source>
</td>
</tr>
+ <tr>
+ <td>name</td>
+ <td>
+ <code>default: <em>none</em></code><br/>
+ New file name for single resource extracted from the resource
archive:
+ <source><![CDATA[<name>j2-seed.xml</name>]]></source>
+ </td>
+ </tr>
</table>
<p>
As can be determined from the above, as all resource configuration
elements are optional, specifying an empty <resource/> definition will
simply
@@ -462,4 +471,4 @@
</subsection>
</section>
</body>
-</document>
\ No newline at end of file
+</document>
Modified:
portals/site/jetspeed/jetspeed-2.2/jetspeed-guide-build/src/site/xdoc/maven-2-build.xml
URL:
http://svn.apache.org/viewvc/portals/site/jetspeed/jetspeed-2.2/jetspeed-guide-build/src/site/xdoc/maven-2-build.xml?rev=935884&r1=935883&r2=935884&view=diff
==============================================================================
---
portals/site/jetspeed/jetspeed-2.2/jetspeed-guide-build/src/site/xdoc/maven-2-build.xml
(original)
+++
portals/site/jetspeed/jetspeed-2.2/jetspeed-guide-build/src/site/xdoc/maven-2-build.xml
Tue Apr 20 11:49:47 2010
@@ -279,213 +279,135 @@
<subsection name="Overview">
<p>Using the jetspeed:mvn plugin, several defined custom build
and installation tasks (targets) are provided for the Jetspeed Portal project
itself.</p>
<p>
- The complete list of available targets can be queried using
the special <strong><code>-Dlist</code></strong> commandline parameter:
+ The complete list of available targets can be queried using
the special <strong><code>-Dlist</code></strong> command line parameter:
<source>$mvn -o jetspeed:mvn -Dlist</source>
- which for the Jetspeed 2.2.1 release will show the following
output:
- <source>
-[INFO] [jetspeed:mvn]
-
-Available jetspeed:mvn targets:
- testdb [testdb]
- test [test]
- proddb [proddb]
- demo-install [demo-install]
- demo-seed [demo-seed]
- min-seed [min-seed]
- demo-deploy [demo-deploy]
- demo-deploy-min [demo-deploy-min]
- demo-deploy-dbpsml [demo-deploy-dbpsml]
- test-install [testdb, test-install]
- demo-seed-dbpsml [proddb, demo-seed, demo-db, demo-seed-dbpsml]
- min-seed-dbpsml [proddb, demo-seed, demo-db, min-seed-dbpsml]
- demo-db [proddb, demo-seed, demo-db]
- min-db [proddb, min-seed, min-db]
- demo-db-psml [proddb, demo-seed, demo-db, demo-seed-dbpsml,
demo-db-psml]
- demo [demo-install, proddb, demo-seed, demo-db, demo-deploy,
demo]
- min [demo-install, proddb, demo-seed, demo-db,
demo-deploy-min, min]
- min-dbpsml [demo-install, proddb, demo-seed, demo-db,
demo-deploy-min, demo-deploy-dbpsml, min-seed-dbpsml, min-dbpsml]
- demo-dbpsml [proddb, demo-seed, demo-db, demo-seed-dbpsml,
demo-db-psml, demo-deploy, demo-deploy-dbpsml, demo-dbpsml]</source>
- </p>
- <p>
- The left column above shows the available targets to be
executed using the <strong><code>-Dtarget=<target id></code></strong>
commandline parameter.<br/>
- The right column shows the actual chained set of targets
which will be executed in order as result.
- </p>
- <p>
- Each of these jetspeed:mvn targets is described in detail
below. Please see the <a href="jetspeed-mvn-plugin.html">Mvn Plugin</a>
configuration
- documentation for further reference.
+ The primary jetspeed:mvn targets are described in detail
below. Please see the <a href="jetspeed-mvn-plugin.html">Mvn Plugin</a>
configuration
+ documentation and the root project <code>pom.xml</code>
build file for further reference.
</p>
</subsection>
-
- <subsection name="target test">
- <source><![CDATA[
-<target>
- <id>test</id>
- <dir>.</dir>
- <goals>test</goals>
- <profiles>test</profiles>
-</target>]]></source>
- <p>
- Executing the <strong><code>test</code></strong> target will
simply execute the standard Maven test goal within the current (sub module)
project folder, <em>and</em>
- enables the <strong><code>test</code></strong> profile.
- </p>
- <p>
- Of course the same effect can be achieved by just executing
<strong><code>$mvn test -P test</code></strong> but the primary reason for this
target definition is
- to be used as dependent target for other targets (see below).
- </p>
- </subsection>
-
- <subsection name="targets testdb, proddb">
- <source><![CDATA[
-<target>
- <id>testdb</id>
- <name>db-init</name>
- <properties>
- <database.type>test</database.type>
- </properties>
-</target>
-<target>
- <id>proddb</id>
- <name>db-init</name>
- <properties>
- <database.type>production</database.type>
- </properties>
-</target>]]></source>
- <p>
- Executing one of these targets will (re)create either a test
or production database (schema), using the database configuration properties
from
- the <strong><code>jetspeed-mvn-settings.xml</code></strong>
file.<br/>
- <em>Note: this target can be executed from within any (sub)
module folder within the project.</em>
- </p>
- <p>
- The actual configuration of these tasks is defined in the
custom <strong><code>jetspeed-mvn-db-init-pom.xml</code></strong> file in the
project root
- which is selected through the
<strong><code><name>db-init</name></code></strong>
configuration.<br/>
- The <strong><code>database.type</code></strong> property
value (test or production) is used for variable replacement within this file to
<em>select</em>
- the set of properties to use from
<strong><code>jetspeed-mvn-settings.xml</code></strong>.
- </p>
- </subsection>
-
- <subsection name="targets demo-seed, min-seed and demo-db, min-db">
- <source><![CDATA[
-<target>
- <id>demo-seed</id>
- <name>demo</name>
- <dir>@rootdir@/applications/jetspeed-demo</dir>
- <profiles>seed</profiles>
- <properties>
- <seed.file>j2-seed.xml</seed.file>
- </properties>
-</target>
-<target>
- <id>min-seed</id>
- <name>demo</name>
- <dir>@rootdir@/applications/jetspeed-demo</dir>
- <profiles>seed</profiles>
- <properties>
- <seed.file>min/j2-seed.xml</seed.file>
- </properties>
-</target>
-
-<target>
- <id>demo-db</id>
- <depends>proddb,demo-seed</depends>
-</target>
-<target>
- <id>min-db</id>
- <depends>proddb,min-seed</depends>
-</target>]]></source>
- <p>
- Besides (re)creation a (production) database using the
<strong><code>proddb</code></strong> target, the Jetspeed database also needs
some initial data to be seeded
- first to be able to run the Jetspeed Portal. The
<strong><code>demo-seed, min-seed</code></strong> targets will take care of
that using either a more complete demo
- <strong><code>j2-seed.xml</code></strong> file or a minimal
<strong><code>min/j2-seed.xml</code></strong> file.
- </p>
- <p>
- These seed files are dynamically retrieved from a previously
build and installed or downloaded
<strong><code>jetspeed-portal-resouces:jar</code></strong> artifact where
- the configured seed files are references relative to a
specific folder within this resources artifact.
- </p>
- <p>
- The actual seeding task is defined in the custom
<strong><code>applications/jetspeed-demo/jetspeed-mvn-demo-pom.xml</code></strong>
Maven project file, explicitely specified
- relative from the project root folder using the special and
buildin @rootdir@ variable.<br/>
- This allows executing these targets from within any
(sub)module project folder of the Jetspeed project.
- </p>
- <p>
- As the <strong><code>proddb</code></strong> target and either
the <strong><code>demo-seed</code></strong> or
<strong><code>demo-seed</code></strong> targets usually are
- executed together, the <strong><code>demo-db</code></strong>
and the <strong><code>demo-db</code></strong> targets are also defined to allow
execution those
- as a single target.
- </p>
- <p>
- The following command therefore can be used to both
(re)create and seed the Jetspeed Demo Portal database:
- <source>$mvn jetspeed:mvn -Dtarget=demo-db</source>
- </p>
- </subsection>
-
- <subsection name="target demo-install">
- <source><![CDATA[
-<target>
- <id>demo-install</id>
- <dir>@rootdir@/applications/jetspeed-demo</dir>
-</target>]]></source>
- <p>
- This target will simply invoke the default Maven goal against
the <strong><code>applications/jetspeed-demo</code></strong> module pom.xml
(which is <em>install</em>).<br/>
- The primary reason for this target definition is to be used
as dependent target for the "deploy" targets (described below).
- </p>
- </subsection>
-
- <subsection name="targets demo-deploy, demo-deploy-min">
- <source><![CDATA[
-<target>
- <id>demo-deploy</id>
- <name>demo</name>
- <dir>@rootdir@/applications/jetspeed-demo</dir>
- <profiles>deploy</profiles>
-</target>
-<target>
- <id>demo-deploy</id>
- <name>demo</name>
- <dir>@rootdir@/applications/jetspeed-demo</dir>
- <profiles>deploy-min</profiles>
-</target>]]></source>
- <p>
- These targets will perform the actual deployment of the
Jetspeed Portal (-demo or -min) to the Tomcat installation using the <a
href="jetspeed-deploy-plugin.html">Deploy Plugin</a>
- as configured in the custom
<strong><code>applications/jetspeed-demo/jetspeed-mvn-demo-pom.xml</code></strong>
Maven project file using either the <strong><code>deploy</code></strong>
- or <strong><code>deploy-min</code></strong> profile.<br/>
- </p>
- <p>
- <em>Note: executing these targets directly assumes all the
required Jetspeed artifacts already are build and installed.</em>
- </p>
- <p>
- For most cases the <em>demo</em> or <em>min</em> targets
described below are more convenient to be used as those also take care of
creating and initializing the database for instance.
- </p>
- </subsection>
-
- <subsection name="targets demo, min">
- <source><![CDATA[
-<target>
- <id>demo</id>
- <depends>demo-install,demo-db,demo-deploy</depends>
-</target>
-<target>
- <id>min</id>
- <depends>demo-install,demo-db,demo-deploy-min</depends>
-</target>]]></source>
- <p>
- These targets take care of most of the gruntwork of
building/installing the main Jetspeed Portal war, (re)creating the database,
seeding it and finally deploying everything,
- using only a single command.
- </p>
- </subsection>
-
- <subsection name="targets *-dbpsml">
- <p>
- Besides the already described targets, there are also
corresponding <code><strong>-dbpsml</strong></code> variant targets of most of
these.
- </p>
- <p>
- By default Jetspeed Portal uses file based PSML management
but it also can be configured to database based PSML management.<br/>
- Besides setting up this custom configuration, the
<code><strong>*-dbpsml</strong></code> targets also take care of importing the
demo (or min) set of file system PSML
- into the database.
- </p>
- <p>
- [TBD]
- </p>
+ <subsection name="Primary jetspeed:mvn Targets">
+ <p>
+ There are four major modes the portal can be built and
deployed under:
+ <ul>
+ <li>ui: full ui pipeline demo build</li>
+ <li>min-ui: minimal ui pipeline demo build</li>
+ <li>demo: full portal pipeline demo build</li>
+ <li>min: minimal portal pipeline demo build</li>
+ </ul>
+ Additionally, there are two Page Manager variants for each
mode:
+ <ul>
+ <li>XML file system based PSML</li>
+ <li>Database PSML</li>
+ </ul>
+ The primary build targets that can be used to build and
deploy all or parts of the portal are outlined here:
+ </p>
+ <div><table>
+ <tbody>
+ <tr>
+ <td>
+ <p><strong><tt>test</tt></strong></p>
+ </td>
+ <td>
+ <p>
+ Executing the
<strong><code>test</code></strong> target will simply execute the standard
Maven test goal within the current (sub module) project folder, <em>and</em>
+ enables the <strong><code>test</code></strong>
profile.
+ </p>
+ <p>
+ Of course the same effect can be achieved by
just executing <strong><code>$mvn test -P test</code></strong> but the primary
reason for this target definition is
+ to be used as dependent target for other
targets (see below).
+ </p>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <p><strong><tt>testdb, proddb</tt></strong></p>
+ </td>
+ <td>
+ <p>
+ Executing one of these targets will (re)create
either a test or production database (schema), using the database configuration
properties from
+ the
<strong><code>jetspeed-mvn-settings.xml</code></strong> file.<br/>
+ </p>
+ <p>
+ <em>Note: this target can be executed from
within any (sub) module folder within the project.</em>
+ </p>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <p><strong><tt>ui-seed, min-ui-seed,
demo-seed, min-seed and ui-db, min-ui-db, demo-db, min-db</tt></strong></p>
+ </td>
+ <td>
+ <p>
+ Besides (re)creation a (production) database
using the <strong><code>proddb</code></strong> target, the Jetspeed database
also needs some initial data to be seeded
+ first to be able to run the Jetspeed Portal.
The <strong><code>ui-seed, min-ui-seed, demo-seed, min-seed</code></strong>
targets will take care of that using specific
<strong><code>j2-seed.xml</code></strong> files.
+ </p>
+ <p>
+ These seed files are dynamically retrieved
from a previously build and installed or downloaded
<strong><code>jetspeed-portal-resouces:jar</code></strong> artifact where
+ the configured seed files are references
relative to a specific folder within this resources artifact.
+ </p>
+ <p>
+ As the <strong><code>proddb</code></strong>
target and the <strong><code>*-seed</code></strong> targets usually are
+ executed together, the <strong><code>ui-db,
min-ui-db, demo-db, min-db</code></strong> targets are also defined to allow
execution those
+ as a single target.
+ </p>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <p><strong><tt>demo-install</tt></strong></p>
+ </td>
+ <td>
+ <p>
+ This target will simply invoke the default
Maven goal, (which is <em>install</em>), against the
<strong><code>applications/jetspeed-demo</code></strong> module pom.xml.
+ </p>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <p><strong><tt>ui, min-ui, demo,
min</tt></strong></p>
+ </td>
+ <td>
+ <p>
+ These targets will perform the actual
deployment of the Jetspeed Portal to the Tomcat installation along with all
database configuration and seeding. The XML file system based PSML
implementation is used and its pages (re)deployed by default.
+ </p>
+ <p>
+ <em>Note: executing these targets directly
assumes all the required Jetspeed artifacts already are build and
installed.</em>
+ </p>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <p><strong><tt>ui-nodb, min-ui-nodb,
demo-nodb, min-nodb</tt></strong></p>
+ </td>
+ <td>
+ <p>
+ These targets only perform the deployment of
the Jetspeed Portal. The database is left untouched, (the XML file system based
PSML pages are redeployed).
+ </p>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <p><strong><tt>ui-dbpsml, min-ui-dbpsml,
demo-dbpsml, min-dbpsml</tt></strong></p>
+ </td>
+ <td>
+ <p>
+ These targets are variants of the
<strong><code>ui, min-ui, demo, min</code></strong> targets for the Database
PSML configuration, (its pages are seeded into the database);
+ </p>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <p><strong><tt>ui-dbpsml-nodb,
min-ui-dbpsml-nodb, demo-dbpsml-nodb, min-dbpsml-nodb</tt></strong></p>
+ </td>
+ <td>
+ <p>
+ These targets are variants of the
<strong><code>ui-nodb, min-ui-nodb, demo-nodb, min-nodb</code></strong> targets
for the Database PSML configuration, (its pages are not seeded into the
database);
+ </p>
+ </td>
+ </tr>
+ </tbody>
+ </table></div>
</subsection>
-
</section>
<section name="Test building Jetspeed Portal">
