portals-jetspeed-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From woon...@apache.org
Subject svn commit: r722405 [14/17] - in /portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade: ./ src/ src/site/ src/site/resources/ src/site/resources/css/ src/site/resources/images/ src/site/resources/images/layouts/ src/site/resources/images/portle...
Date Tue, 02 Dec 2008 08:53:28 GMT
Added: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/maven-2-build.xml
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/maven-2-build.xml?rev=722405&view=auto
==============================================================================
--- portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/maven-2-build.xml
(added)
+++ portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/maven-2-build.xml
Tue Dec  2 00:53:22 2008
@@ -0,0 +1,314 @@
+<?xml version="1.0"?>
+<!--
+	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.
+-->
+<document>
+	<properties>
+		<title>
+			Building Jetspeed 2.2 from Source with Maven-2
+		</title>
+		<subtitle>How-to for Building from Source with Maven-2 and Jetspeed 2.2</subtitle>
+		<authors>
+			<person name="David Sean Taylor" email="taylor@apache.org" />
+			<person name="Ate Douma" email="ate@apache.org" />
+			<person name="Woonsan Ko" email="woonsan@apache.org" />
+		</authors>
+	</properties>
+	<body>
+		<section name="Simple Guide to Jetspeed Demo Portal Build &amp; Deployment">
+            <subsection name="Overview">
+                <p>With Maven2 and Jetspeed Maven Plugins, you can build Jetspeed 2.2
and deploy Jetspeed Demo Portal very easily. In most cases, just following this section could
be enough to build and deploy Jetspeed 2.2.</p>
+                <p>You need the following prerequisites:
+                    <ul>
+                        <li>Java Development Kit 1.5</li>
+                        <li><a class="externalLink" href="http://maven.apache.org/">Apache
Maven</a> 2.0.9 or higher</li>
+                        <li><a class="externalLink" href="http://tomcat.apache.org/">Apache
Tomcat</a> 5.5.26 or higher</li>
+                        <li>
+                            With a SVN client tool, you can checkout the sources from here:
+                            <a href='http://svn.apache.org/repos/asf/portals/jetspeed-2/portal/trunk/'
target='_blank'>http://svn.apache.org/repos/asf/portals/jetspeed-2/portal/trunk/</a>
+                        </li>
+                    </ul>
+                </p>
+            </subsection>
+            <subsection name="Configuring your environment">
+                <p>
+                    All the settings needed during the build (and the jetspeed-demo Portal
deployment) are isolated in one single file in the root folder
+                    of the project: <strong><code>jetspeed-mvn-setttings.xml</code></strong>.
+                </p>
+                <p>
+                    To make it easy to create your own jetspeed-mvn-settings.xml, a sample
file, <strong><code>jetspeed-mvn-setttings-sample.xml</code></strong>
+                    is provided which you can simply copy to <strong><code>jetspeed-mvn-setttings.xml</code></strong>
and modify only
+                    the properties you'll need.
+                </p>
+                <p>
+                    The <strong><code>jetspeed-mvn-setttings-sample.xml</code></strong>
provides a default configuration using an Embbedded Derby database, and if that
+                    suites you, probably the only changes needed will be for the location
of the Derby database(s) and the deployment target directory for the
+                    jetspeed-demo Portal:
+                    <div class="source"><pre>&lt;properties&gt;
+    ...
+    &lt;!-- Your Tomcat Installation Path --&gt;
+    &lt;org.apache.jetspeed.server.home>/home/demo/tomcat-5.5&lt;/org.apache.jetspeed.server.home&gt;
+
+    &lt;!-- Production jdbc driver artifact properties --&gt;
+    &lt;org.apache.jetspeed.production.jdbc.driver.groupId&gt;org.apache.derby&lt;/org.apache.jetspeed.production.jdbc.driver.groupId&gt;
+    &lt;org.apache.jetspeed.production.jdbc.driver.artifactId&gt;derby&lt;/org.apache.jetspeed.production.jdbc.driver.artifactId&gt;
+    &lt;org.apache.jetspeed.production.jdbc.driver.version&gt;10.3.2.1&lt;/org.apache.jetspeed.production.jdbc.driver.version&gt;
+    
+    &lt;!-- Production database name, JDBC url, JDBC driver name and connection information
--&gt;
+    &lt;org.apache.jetspeed.production.database.default.name&gt;derby&lt;/org.apache.jetspeed.production.database.default.name&gt;
+    &lt;org.apache.jetspeed.production.database.url&gt;jdbc:derby:/tmp/derby/productiondb;create=true&lt;/org.apache.jetspeed.production.database.url&gt;
+    &lt;org.apache.jetspeed.production.database.driver&gt;org.apache.derby.jdbc.EmbeddedDriver&lt;/org.apache.jetspeed.production.database.driver&gt;
+    &lt;org.apache.jetspeed.production.database.user&gt;&lt;/org.apache.jetspeed.production.database.user&gt;
+    &lt;org.apache.jetspeed.production.database.password&gt;&lt;/org.apache.jetspeed.production.database.password&gt;
+    ...
+&lt;/properties&gt;</pre>
+                    </div>
+                </p>
+                <p>
+                    <em>Note: depending on your database platform, the value of 'org.apache.jetspeed.production.database.default.name'
property can be one of the followings:</em>
+                    <ul>
+                        <li>db2</li>
+                        <li>db2v8</li>
+                        <li>derby</li>
+                        <li>mssql</li>
+                        <li>mysql</li>
+                        <li>mysql5</li>
+                        <li>oracle9</li>
+                        <li>oracle10</li>
+                        <li>postgresql</li>
+                        <li>sapdb</li>
+                    </ul>
+                </p>
+                <p>
+                    The following <strong><code>jetspeed-mvn-settings.xml</code></strong>
provides a sample configuration using a MySQL database.
+                    <div class="source"><pre>&lt;properties&gt;
+    ...
+    &lt;!-- Your Tomcat Installation Path --&gt;
+    &lt;org.apache.jetspeed.server.home>/home/demo/tomcat-5.5&lt;/org.apache.jetspeed.server.home&gt;
+
+    &lt;!-- Production jdbc driver artifact properties --&gt;
+    &lt;org.apache.jetspeed.production.jdbc.driver.groupId&gt;mysql&lt;/org.apache.jetspeed.production.jdbc.driver.groupId&gt;
+    &lt;org.apache.jetspeed.production.jdbc.driver.artifactId&gt;mysql-connector-java&lt;/org.apache.jetspeed.production.jdbc.driver.artifactId&gt;
+    &lt;org.apache.jetspeed.production.jdbc.driver.version&gt;5.1.6&lt;/org.apache.jetspeed.production.jdbc.driver.version&gt;
+    
+    &lt;!-- Production database name, JDBC url, JDBC driver name and connection information
--&gt;
+    &lt;org.apache.jetspeed.production.database.default.name&gt;mysql5&lt;/org.apache.jetspeed.production.database.default.name&gt;
+    &lt;org.apache.jetspeed.production.database.url&gt;jdbc:mysql://localhost:3306/j2&lt;/org.apache.jetspeed.production.database.url&gt;
+    &lt;org.apache.jetspeed.production.database.driver&gt;com.mysql.jdbc.Driver&lt;/org.apache.jetspeed.production.database.driver&gt;
+    &lt;org.apache.jetspeed.production.database.user&gt;j2&lt;/org.apache.jetspeed.production.database.user&gt;
+    &lt;org.apache.jetspeed.production.database.password&gt;j2&lt;/org.apache.jetspeed.production.database.password&gt;
+    ...
+&lt;/properties&gt;</pre>
+                    </div>
+                </p>
+            </subsection>
+            <subsection name="Optional: Building and Installing Jetspeed-2 Maven Plugins">
+                <p>
+                    If, and only if, no (full) build has been done yet, a subset of the build
has to be performed <em>once</em> first:
+                    <div class="source"><pre>$mvn install -P init</pre>
+                    </div>
+                </p>
+                <p>
+                    This will ensure the required Jetspeed-2 Maven plugins are build and
installed as well as the jetspeed-portal-resources artifact.
+                </p>
+            </subsection>
+            <subsection name="Building Jetspeed-2">
+                <p>
+                    Performing a full build of all the Jetspeed-2 components, as well as
the jetspeed-demo Portal is plain Maven-2 simple:
+                    <div class="source"><pre>$mvn install</pre>
+                    </div>
+                </p>
+            </subsection>
+            <subsection name="Deploying the jetspeed-demo Portal">
+                <p>
+                    This requires downloading and installing your own <a class="externalLink"
href="http://tomcat.apache.org">Tomcat</a>
+                    (<em>for Jetspeed-2.2 at least version 5.5.26 is now required!</em>)<br
/>
+                    Once you've installed Tomcat, adjust the <strong><code>org.apache.jetspeed.server.home</code></strong>
property
+                    in the jetspeed-mvn-settings.xml file to point at the installation directory.
+                </p>
+                <p>
+                    You can deploy the Jetspeed Demo Portal to your Tomcat installation by
using the following command:
+                    <div class="source"><pre>$mvn org.apache.portals.jetspeed-2:jetspeed-mvn-maven-plugin:mvn
-Dtarget=demo</pre>
+                    </div>
+                    You can shorten the above command by adding the Jetspeed Maven Plugin's
groupId to the list of groupIds searched by default.
+                    To do this, you need to add the following to your ${user.home}/.m2/settings.xml
file:
+                    <div class="source"><pre>&lt;settings xmlns="http://maven.apache.org/POM/4.0.0"&gt;
+  &lt;pluginGroups&gt;
+    &lt;!-- add the following line to shorten the command invoking the Jetspeed Maven
Plugin. --&gt;
+    &lt;pluginGroup&gt;org.apache.portals.jetspeed-2&lt;/pluginGroup&gt;
+  &lt;/pluginGroups&gt;
+&lt;/settings&gt;</pre></div>
+                    Now you can use a shorter command like the following:
+                    <div class="source"><pre>$mvn jetspeed:mvn -Dtarget=demo</pre>
+                    </div>
+                </p>
+                <p>
+                    Start your Tomcat:
+                    <div class="source"><pre>$ $TOMCAT_HOME/bin/catalina.sh run</pre>
+                    </div>
+                </p>
+                <p>
+                    Use the jetspeed-demo Portal:
+                    <a class="externalLink" href="http://localhost:8080/jetspeed">http://localhost:8080/jetspeed</a>
+                </p>
+                <p>
+                    For login, use one of the following username/password combinations: admin/admin,
user/user, jetspeed/jetspeed
+                </p>
+            </subsection>
+        </section>
+		<section name='Maven Profiles'>
+            <p>The following profiles can be supplied when building </p>
+            <div>
+                <table>
+                    <tbody>
+                        <tr>
+                            <td>
+                                <p> <strong><tt>mvn -P all</tt></strong>
</p>
+                            </td>
+                            <td>
+                                <p> specified that all modules (the API, plugins, portal
resources, commons, components and applications) be built.</p>
+                            </td>
+                        </tr>
+                        <tr>
+                            <td>
+                                <p> <strong><tt>mvn -P init</tt></strong>
</p>
+                            </td>
+                            <td>
+                                <p> specified some modules to be initialized first
(the API, plugins and portal resources) </p>
+                            </td>
+                        </tr>
+                        <tr>
+                            <td>
+                                <p> <strong><tt>mvn -P test</tt></strong>
</p>
+                            </td>
+                            <td>
+                                <p> specified that all modules (the API, plugins, portal
resources, commons, components and applications) be built, with the property setting, <b>-Dmaven.test.skip=false</b></p>
+                            </td>
+                        </tr>
+                    </tbody>
+                </table>
+            </div>
+    		<subsection name='Additional Notes'>
+        		<ul>
+            		<li><b>mvn -P test</b> and <b>mvn -Dmaven.test.skip=false</b>
are equivalent.</li>
+            		<li><b>mvn -P test -Dtest=MyTest</b> will execute a single
test or matching tests if Ant wildcards are used. </li>		
+            		<li>Due to forking bugs in the Surefire Maven2 test runner plugin, test
output, (e.g. System.out.println()), is not echoed to the build shell. If you wish to see
console output for component tests, temporarily comment out the &lt;forkMode&gt;
+            		 elements in the components/pom.xml and the components pom.xml and run single
tests. Note: the forking is required to run multiple tests. 
+                    </li>
+                    <li><p> The <strong><tt>-o</tt></strong>
offline option can be specified with the commands documented here to force Maven2 to use only
the local repository. This can be invaluable in the event the main Maven2 repositories are
down and the build insists upon validating a missing or troublesome POM. </p>
+                   </li>
+        		</ul>
+    		</subsection>	
+		</section>
+        <section name="More detailed building options">
+            <subsection name="Overview">
+                <p>With the new jetspeed-mvn  plugin, building the Jetspeed-2 Portal
itself from source as well as building and deploying the default jetspeed-demo portal is now
extremely easy.</p>
+                <p>In most cases, just following the first section could be enough,
but because Jetspeed Maven Plugins provide many optional tasks, you can make use of those
useful options.</p>
+            </subsection>
+            <subsection name="Running the test-cases during a build">
+                <p>By default, running test-cases is disabled for Jetspeed-2 because
it is very time-consuming and also requires the setup and initialization of a dedicated test
database <strong><em>every time!</em></strong> </p>
+                <p>But if you are a Jetspeed committer or otherwise would like to run
the test-cases anyway, the following command is used to setup and initialize the test database:
+                    <div class="source"><pre>$mvn jetspeed:mvn -Dtarget=testdb</pre>
+                    </div>
+                </p>
+                <p>Thereafter, enabling the test-cases during a build is done by using
profile <strong><code>test</code></strong>:
+                    <div class="source"><pre>$mvn install -P test</pre>
+                    </div>
+                </p>
+                <p>But, to make it even a little more easier, another jetspeed:mvn
target is provided which already combines the above two steps in one:
+                    <div class="source"><pre>$mvn jetspeed:mvn -Dtarget=test-install</pre>
+                    </div>
+                </p>
+                <em>Note: Running the test-cases requires (and only for this) the proper
configuration of the org.apache.jetspeed.test.database.* properties in jetspeed-mvn-settings.xml</em>
+            </subsection>
+            <subsection name="Initializing the production database">
+                <p>The production database configuration provided by the Jetspeed-2
Portal project itself is primarly intended to be used by the developers using the jetspeed-demo
Portal.</p>
+                <p>Manual initializing or reinitializing of the production database
is done using the following command:
+                    <div class="source"><pre>$mvn jetspeed:mvn -Dtarget=proddb</pre>
+                    </div>
+                </p>
+                <p>The above command however will only created the required database
tables, not seed it with (demo) data, for which the following command is needed:
+                    <div class="source"><pre>$mvn jetspeed:mvn -Dtarget=demo-seed</pre>
+                    </div>
+                </p>
+                <p>As the above two commands usually goes together, the following command
can be used instead to automatically invoke both: 
+                    <div class="source"><pre>$mvn jetspeed:mvn -Dtarget=demo-db</pre>
+                    </div>
+                </p>
+            </subsection>
+            <subsection name="Using the Jetspeed Demo Portal">
+                <p>The jetspeed-demo Portal is an example custom Portal project used
by the Jetspeed-2 committers for development and testing, but can of course also be used as
real "demo" for other purposes.</p>
+                <p>The full setup and usage of the jetspeed-demo Portal requires the
following steps: </p>
+                <table>
+                    <tr>
+                        <th>Task</th>
+                        <th>Command</th>
+                    </tr>
+                    <tr>
+                        <td>building and installing the jetspeed-demo war</td>
+                        <td>
+                            <div class="source"><pre>$mvn jetspeed:mvn -Dtarget=demo-install</pre></div>
+                        </td>
+                    </tr>
+                    <tr>
+                        <td>database initialization and seeding</td>
+                        <td>
+                            <div class="source"><pre>$mvn jetspeed:mvn -Dtarget=demo-db</pre></div>
+                        </td>
+                    </tr>
+                    <tr>
+                        <td>setting up a (clean) Tomcat server</td>
+                        <td>
+                            This requires downloading and installing your own <a class="externalLink"
href="http://tomcat.apache.org/">Tomcat</a> (for Jetspeed-2.2 at least version 5.5.26
is now required!)
+Once you've installed Tomcat, adjust the <strong><code>org.apache.jetspeed.server.home
property</code></strong> in the jetspeed-mvn-settings.xml file to point at the
installation directory. 
+                        </td>
+                    </tr>
+                    <tr>
+                        <td>deploying the jetspeed-demo Portal</td>
+                        <td>
+                            <div class="source"><pre>$mvn jetspeed:mvn -Dtarget=demo-deploy</pre></div>
+                        </td>
+                    </tr>
+                    <tr>
+                        <td>performing everything above (except Tomcat installation)
with a single command instead</td>
+                        <td>
+                            <div class="source"><pre>$mvn jetspeed:mvn -Dtarget=demo</pre></div>
+                        </td>
+                    </tr>
+                    <tr>
+                        <td>starting Tomcat</td>
+                        <td>
+                            <div class="source"><pre>$ $TOMCAT_HOME/bin/catalina.sh
run</pre></div>
+                        </td>
+                    </tr>
+                    <tr>
+                        <td>Using the jetspeed-demo Portal</td>
+                        <td>
+                            <p><a class="externalLink" href="http://localhost:8080/jetspeed">http://localhost:8080/jetspeed</a></p>
+                            <p>For login, use one of the following username/password
combinations: admin/admin, user/user, jetspeed/jetspeed</p>
+                        </td>
+                    </tr>
+                </table>
+                <p>There is one optional feature for building and deploying the jetspeed-demo
Portal: storing and using PSML in the database. This requires using an additional profile,
dbpsml, during building the jetspeed-demo war as well as slightly different jetspeed:mvn targets
to execute. To execute all of that with one command, use:
+                    <div class="source"><pre>$mvn jetspeed:mvn -Dtarget=demo-dbpsml</pre>
+                    </div>
+                    instead of using the -Dtarget=demo as shown above.
+                </p>
+                <p>Further detail of the different jetspeed:mvn targets and configurations
used for the dbpsml demo can be found in the jetspeed-mvn-plugin configuration within the
root pom.xml.</p>
+            </subsection>
+        </section>
+	</body>
+</document>

Propchange: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/maven-2-build.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/maven-2-build.xml
------------------------------------------------------------------------------
    svn:keywords = Id

Added: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/maven/index.xml
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/maven/index.xml?rev=722405&view=auto
==============================================================================
--- portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/maven/index.xml
(added)
+++ portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/maven/index.xml
Tue Dec  2 00:53:22 2008
@@ -0,0 +1,115 @@
+<?xml version="1.0"?>
+<!--
+  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.
+
+  $Id$
+-->
+<document>
+  <properties>
+    <title>Building and developing Jetspeed-2 using Maven-2</title>
+    <authors>
+      <person name="Ate Douma" email="ate@douma.nu" />
+    </authors>
+  </properties>
+  <body>
+    <section name="Introduction">
+      <p>
+        The Jetspeed-2 build system is, as of version 2.2, fully based upon <a href="http://maven.apache.org">Apache
Maven 2.0</a>.
+      </p>
+      <p>
+        This means the Jetspeed project developers as well as custom portal developers and
system integrators are provided with a standardized and very
+        pluggable and configurable build environment which follows the standard guidelines
of the Maven 2 build framework.
+      </p>
+      <p>
+        The Jetspeed-2 Portal itself is an application based upon a very flexible component
architecture which is "assembled" and configured at runtime using
+        <a href="http://www.springframework.org">Spring Framework</a>.
+        One of the primary features of Jetspeed-2 Portal is that it can be adapted and configured
for very divers and specific requirements. To be able to <em>leverage</em>
+        this feature for custom portal projects, configuring how Jetspeed-2 is to be assembled
and integrated for the target environment(s) requires a very flexible build and
+        configuration toolset as well.
+      </p>
+      <subsection name="Maven Plugins">
+        <p>
+          The "standard" Maven-2 toolset is capable enough to <em>build</em>
and <em>dynamically resolve</em>
+          most components and artifacts needed for a (custom) Jetspeed-2 Portal. But <em>configuring</em>
and <em>integrating</em> Jetspeed-2 within <em>your</em>
+          specific project environment usually goes far beyond just <em>building</em>.
+        </p>
+        <p>
+          Setting up and interacting with back-end databases, creating and maintaining portal
configurations for a specific target deployment environment, and
+          deploying not only "just" a portal war but everything required at runtime, is mostly
"out-of-scope" of the standard Maven-2 toolset.
+        </p>
+        <p>
+          To be able to meet the myriad of possible integration requirements (from a Jetspeed-2
project POV) and still leverage the Maven 2 toolset, a few custom
+          Maven "plugins" have been written providing features like database initialization,
portal configuration and portal deployment which can be configured
+          and used within a standard Maven 2 build environment.          
+        </p>
+        <p>
+          The rationale for the main Jetspeed Maven Plugin, jetspeed:mvn, orchestrating the
usage of the other Jetspeed plugins is described in
+          <a href="the-need-for-a-custom-lifecycle.html">The Need for a custom Maven
lifecycle</a>. 
+        </p>
+        <p>
+          Detailed documentation and configuration of each of the Maven plugins is available
from the <a href="jetspeed-maven-plugins.html">Jetspeed Maven Plugins Overview</a>
+          menu and its subpages. Example usages and build instructions for Jetspeed-2 (which
leverages these plugins too) are also available from the side menu.
+        </p>
+      </subsection>
+      <subsection name="Maven Archetypes">
+        <p>
+          As will become clear from the more detailed descriptions and their usages provided
with each plugin, manually
+          setting up and configuring a complete (custom) Jetspeed Portal project is far from
trivial and requires quite a few steps to perform.
+        </p>
+        <p>
+          The basic <a href="project-structure.html">project structure and configuration</a>
however will be in most cases the same,
+          and a standard way of setting up such an initial build project configuration is
using a Maven archetype plugin.
+          Jetspeed-2 provides its own jetspeed-archetype Maven plugin which can be used as
a quickstart for creating a new custom portal project.
+          Detailed description and usage for the Jetspeed-2 Archetype plugin is provided
<a href="jetspeed-archetype.html">here</a>.
+        </p>
+      </subsection>
+      <subsection name="IMPORTANT: required configuration of the Maven Settings pluginGroups">
+        <p>
+          Using non standard Maven Plugins (e.g. not from the Maven or CodeHaus Plugin projects)
from the command line by default requires one to specify the full
+          coordinates of the intended plugin goal.
+        </p>
+        <p>
+          For the Jetspeed-2 Maven Plugins, this would mean for example for invoking the
<a href="jetspeed-maven-plugins.html">jetspeed:mvn</a> plugin something like:
+          <source>$mvn org.apache.portals.jetspeed-2:jetspeed:mvn -Dtarget=demo</source>
+        </p>
+        <p>
+          However this can be simplified by telling Maven which additional plugin groups
it should search through when the groupId is not specified on the command.<br/>
+          See also the main documentation for the <a href="http://maven.apache.org/settings.html">Maven
Settings</a>.
+        </p>
+        <p>
+          Adding the Jetspeed-2 Maven Plugins groupId to the pluginGroups in your Maven settings.xml
is therefore recommended and assumed by all example usages given
+          throughout the Jetspeed-2 documentation. 
+        </p>
+        <p>
+          The current user Maven settings.xml can be found at: <strong><code>${user.home}/.m2/settings.xml</code></strong>
(create one if it doesn't exist yet).
+        </p>
+        <p>
+          The Jetspeed-2 groupId should be added to the pluginGroups within the settings.xml
as follows:
+        <source><![CDATA[<?xml version="1.0" encoding="UTF-8"?>
+<settings xmlns="http://maven.apache.org/POM/4.0.0">
+  <pluginGroups>
+    <pluginGroup>org.apache.portals.jetspeed-2</pluginGroup>
+    ...
+  </pluginGroups>
+  ...
+</settings>]]></source>
+          Once the above pluginGroup is configured, the same example from above can be shorted
as follows:
+          <source>$mvn jetspeed:mvn -Dtarget=demo</source>            
+        </p>
+      </subsection>
+    </section>
+  </body>
+</document>
\ No newline at end of file

Propchange: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/maven/index.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/maven/index.xml
------------------------------------------------------------------------------
    svn:keywords = Id

Added: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/maven/jetspeed-archetype.xml
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/maven/jetspeed-archetype.xml?rev=722405&view=auto
==============================================================================
--- portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/maven/jetspeed-archetype.xml
(added)
+++ portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/maven/jetspeed-archetype.xml
Tue Dec  2 00:53:22 2008
@@ -0,0 +1,33 @@
+<?xml version="1.0"?>
+<!--
+  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.
+
+  $Id$
+-->
+<document>
+  <properties>
+    <title>Quickstart a new custom Jetspeed Portal project using the jetspeed-archetype
Maven Plugin</title>
+    <authors>
+      <person name="Ate Douma" email="ate@douma.nu" />
+    </authors>
+  </properties>
+  <body>
+    <section name="Using the jetspeed-archetype Maven Plugin">
+      <p>
+      </p>
+    </section>
+  </body>
+</document>
\ No newline at end of file

Propchange: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/maven/jetspeed-archetype.xml
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/maven/jetspeed-archetype.xml
------------------------------------------------------------------------------
    svn:keywords = Id



---------------------------------------------------------------------
To unsubscribe, e-mail: jetspeed-dev-unsubscribe@portals.apache.org
For additional commands, e-mail: jetspeed-dev-help@portals.apache.org


Mime
View raw message