portals-jetspeed-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From dlest...@apache.org
Subject svn commit: r216057 - in /portals/jetspeed-2/trunk/xdocs: database.xml getting-started.xml
Date Wed, 13 Jul 2005 00:47:18 GMT
Author: dlestrat
Date: Tue Jul 12 17:47:18 2005
New Revision: 216057

URL: http://svn.apache.org/viewcvs?rev=216057&view=rev
Log:
http://issues.apache.org/jira/browse/JS2-304?page=comments#action_12315646 

Modified:
    portals/jetspeed-2/trunk/xdocs/database.xml
    portals/jetspeed-2/trunk/xdocs/getting-started.xml

Modified: portals/jetspeed-2/trunk/xdocs/database.xml
URL: http://svn.apache.org/viewcvs/portals/jetspeed-2/trunk/xdocs/database.xml?rev=216057&r1=216056&r2=216057&view=diff
==============================================================================
--- portals/jetspeed-2/trunk/xdocs/database.xml (original)
+++ portals/jetspeed-2/trunk/xdocs/database.xml Tue Jul 12 17:47:18 2005
@@ -20,6 +20,7 @@
     <subtitle>Welcome to Jetspeed 2</subtitle>
     <authors>
       <person name="David Sean Taylor" email="taylor@apache.org"/>
+      <person name="David Le Strat" email="dlestrat@apache.org"/>
     </authors>
   </properties>
   <body>
@@ -110,14 +111,14 @@
 <p>
 Only for the first time you create the database for Oracle, there is an issue with the drop
statements.
 To get around this problem, set your properties as above in your $HOME/build.properties,
and then 
-run these commands:
+run these commands using the <a href="j2-maven-plugin.html">Jetspeed 2 Maven plugin</a>:
 </p>
 <source test=""><![CDATA[
 
-maven db.scripts.gen
-maven dropdrops
-maven db.create.test (only when running unit tests)
-maven db.create.production
+maven j2:db.scripts.gen
+maven j2:dropdrops
+maven j2:db.create.test (only when running unit tests)
+maven j2:db.create.production
 
 ]]></source>
 </subsection>

Modified: portals/jetspeed-2/trunk/xdocs/getting-started.xml
URL: http://svn.apache.org/viewcvs/portals/jetspeed-2/trunk/xdocs/getting-started.xml?rev=216057&r1=216056&r2=216057&view=diff
==============================================================================
--- portals/jetspeed-2/trunk/xdocs/getting-started.xml (original)
+++ portals/jetspeed-2/trunk/xdocs/getting-started.xml Tue Jul 12 17:47:18 2005
@@ -1,163 +1,300 @@
 <?xml version="1.0"?>
 <!--
-Copyright 2004 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
-
+    Copyright 2004 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.
+    
+    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>Getting Started with Jetspeed 2</title>
-    <subtitle>Getting up and running quickly</subtitle>
-    <authors>
-      <person name="David Sean Taylor" email="taylor@apache.org"/>
-      <person name="Ate Douma" email="ate@apache.org"/>
-    </authors>
-  </properties>
-  <body>
-<section name="Requirements">
-<p>
-It is expected that the user is familiar with both the <a href="http://maven.apache.org">Apache
Maven</a>
- project tool and the <a href="http://ant.apache.org">Apache Ant</a> build tool.
-</p>
-<ul>
-  <li><a href="http://ant.apache.org/bindownload.cgi">Ant 1.5</a> or higher</li>
-  <li><a href="http://maven.apache.org/start/download.html">Maven 1.0</a>
or higher</li>
-  <li>Java 1.4.2_02 or higher</li>
-  <li>Servlet 2.3:<br/>
-  Tomcat 5.0.30 (or higher)<br/>
-  <b>or</b> <br/>
-  Tomcat 5.5.8 (or higher)</li>
-</ul>
-</section>
-<section name='1. Get Maven Ready'>
-<p>If you have not already done so, download and install Maven.</p>
-</section>
-<section name='2. Build Properties'>
-<p>Please set these values in your ${USER_HOME}/<code>build.properties</code>
file:</p>
-<table>
-  <tr> 
-    <th>property</th>
-    <th>example</th>
-    <th>what is it?</th>
-  </tr>
-  <tr> 
-    <td>org.apache.jetspeed.project.home</td>
-    <td>/home/apache/jetspeed-2/</td>
-    <td>The root of your Jetspeed-2 source installation (see example on left).</td>
-  </tr>  
-  <tr> 
-    <td>org.apache.jetspeed.server.home</td>
-    <td>${CATALINA_HOME}/</td>
-    <td>The root of your Tomcat server installation.</td>
-  </tr>
-  <tr> 
-    <td>org.apache.jetspeed.catalina.version.major</td>
-    <td>5</td>
-    <td>Are you using Tomcat 5.0.x (use: 5) or 5.5.x? (use: 5.5)</td>
-  </tr>
-  <tr> 
-    <td>org.apache.jetspeed.server.shared</td>
-    <td>${org.apache.jetspeed.server.home}/shared/lib/</td>
-    <td>The location of the shared jars in your Tomcat installation.</td>
-  </tr>
-  <tr> 
-    <td>org.apache.jetspeed.deploy.war.dir</td>
-    <td>${org.apache.jetspeed.server.home}/webapps/</td>
-    <td>The location to deploy web application in Tomcat.</td>
-  </tr>
-  <tr>
-    <td>org.apache.jetspeed.services.autodeployment.user</td>
-    <td>your-tomcat-manager-user</td>
-    <td>a Tomcat user with the manager role.
-        See the Tomcat Configuration section below.
-    </td>
-  </tr>
-  <tr>
-    <td>org.apache.jetspeed.services.autodeployment.password</td>
-    <td>your-tomcat-manager-user-password</td>
-    <td>The password of the Tomcat manager user.</td>
-  </tr>
-</table>
-<p>
-To develop or deploy Jetspeed with another database (not the default HSQL), see the property
configuration in the 
-<a href='database.html'>Database Configuration documentation</a>.
-</p>
-</section>
-<section name="3. Tomcat Configuration">
-<p>
-Jetspeed 2 now can use the Tomcat manager application for managing portlet applications through
-its new Portlet Application Lifecycle Manager Portlet.
-To be able to do so it needs a configured Tomcat user with the predefined 'manager' role
in
-the ${CATALINA_HOME}/conf/tomcat-users.xml.
-</p>
-<p>
-A minimal example tomcat-users.xml could look like:
-  <source><![CDATA[
-    <?xml version='1.0' encoding='utf-8'?>
-    <tomcat-users>
-      <role rolename="manager"/>
-      <user username="j2deployer" password="j2deployer" roles="manager"/>
-    </tomcat-users>]]>
-  </source>
-Make sure to use a more appropriate username and password. <br/>
-With the above example the required autodeployment properties should be set as:
-  <pre>
-    org.apache.jetspeed.services.autodeployment.user=j2deployer
-    org.apache.jetspeed.services.autodeployment.password=j2deployer
-  </pre>
-</p>
-<subsection name="Tomcat 5.5.9 on Windows">
-<p>
-To have redeployment and undeployment working properly when using Tomcat 5.5.9 on Windows
you have to set the global Context
-attribute "antiJARLocking" to true.
-</p>
-<p>
-Thus, in $CATALINA_HOME\conf\context.xml use:
-  <source><![CDATA[
+    <properties>
+        <title>Getting Started with Jetspeed 2</title>
+        <subtitle>Getting up and running quickly</subtitle>
+        <authors>
+            <person name="David Sean Taylor" email="taylor@apache.org" />
+            <person name="Ate Douma" email="ate@apache.org" />
+            <person name="David Le Strat" email="dlestrat@apache.org" />
+        </authors>
+    </properties>
+    <body>
+        <section name="Requirements">
+            <p>
+                It is expected that the user is familiar with both the
+                <a href="http://maven.apache.org">Apache Maven</a>
+                project tool and the
+                <a href="http://ant.apache.org">Apache Ant</a>
+                build tool.
+            </p>
+            <ul>
+                <li>
+                    <a href="http://ant.apache.org/bindownload.cgi">Ant 1.5</a>
+                    or higher
+                </li>
+                <li>
+                    <a href="http://maven.apache.org/start/download.html">Maven 1.0</a>
+                    or higher
+                </li>
+                <li>Java 1.4.2_02 or higher</li>
+                <li>
+                    Servlet 2.3:
+                    <br />
+                    Tomcat 5.0.30 (or higher)
+                    <br />
+                    <b>or</b>
+                    <br />
+                    Tomcat 5.5.8 (or higher)
+                </li>
+            </ul>
+        </section>
+        <section name='1. Get Maven Ready'>
+            <p>If you have not already done so, download and install Maven.</p>
+        </section>
+        <section name='2. Build Properties'>
+            <p>
+                Please set these values in your ${USER_HOME}/
+                <code>build.properties</code>
+                file:
+            </p>
+            <table>
+                <tr>
+                    <th>property</th>
+                    <th>example</th>
+                    <th>what is it?</th>
+                </tr>
+                <tr>
+                    <td>org.apache.jetspeed.portal.name</td>
+                    <td>jetspeed</td>
+                    <td>
+                        The name of the portal application. When using j2:genapp.portal.
This property should be set to
+                        the new portal application name. See the section on Creating a new
Portal Application.
+                    </td>
+                </tr>
+                <tr>
+                    <td>org.apache.jetspeed.project.home</td>
+                    <td>/home/apache/jetspeed-2/</td>
+                    <td>The root of your Jetspeed-2 source installation (see example
on left).</td>
+                </tr>
+                <tr>
+                    <td>org.apache.jetspeed.server.home</td>
+                    <td>${CATALINA_HOME}/</td>
+                    <td>The root of your Tomcat server installation.</td>
+                </tr>
+                <tr>
+                    <td>org.apache.jetspeed.catalina.version.major</td>
+                    <td>5</td>
+                    <td>Are you using Tomcat 5.0.x (use: 5) or 5.5.x? (use: 5.5)</td>
+                </tr>
+                <tr>
+                    <td>org.apache.jetspeed.server.shared</td>
+                    <td>${org.apache.jetspeed.server.home}/shared/lib/</td>
+                    <td>The location of the shared jars in your Tomcat installation.</td>
+                </tr>
+                <tr>
+                    <td>org.apache.jetspeed.deploy.war.dir</td>
+                    <td>${org.apache.jetspeed.server.home}/webapps/</td>
+                    <td>The location to deploy web application in Tomcat.</td>
+                </tr>
+                <tr>
+                    <td>org.apache.jetspeed.services.autodeployment.user</td>
+                    <td>your-tomcat-manager-user</td>
+                    <td>a Tomcat user with the manager role. See the Tomcat Configuration
section below.</td>
+                </tr>
+                <tr>
+                    <td>org.apache.jetspeed.services.autodeployment.password</td>
+                    <td>your-tomcat-manager-user-password</td>
+                    <td>The password of the Tomcat manager user.</td>
+                </tr>
+            </table>
+            <p>
+                To develop or deploy Jetspeed with another database (not the default HSQL),
see the property
+                configuration in the
+                <a href='database.html'>Database Configuration documentation</a>
+                .
+            </p>
+        </section>
+        <section name="3. Tomcat Configuration">
+            <p>
+                Jetspeed 2 now can use the Tomcat manager application for managing portlet
applications through its new
+                Portlet Application Lifecycle Manager Portlet. To be able to do so it needs
a configured Tomcat user
+                with the predefined 'manager' role in the ${CATALINA_HOME}/conf/tomcat-users.xml.
+            </p>
+            <p>
+                A minimal example tomcat-users.xml could look like:
+                <source>
+                    <![CDATA[
+<?xml version='1.0' encoding='utf-8'?>
+<tomcat-users>
+	<role rolename="manager"/>
+    <user username="j2deployer" password="j2deployer" roles="manager"/>
+</tomcat-users>]]>
+                </source>
+                Make sure to use a more appropriate username and password.
+                <br />
+                With the above example the required autodeployment properties should be set
as:
+                <source>
+                    <![CDATA[
+org.apache.jetspeed.services.autodeployment.user=j2deployer
+org.apache.jetspeed.services.autodeployment.password=j2deployer
+                ]]>
+                </source>
+            </p>
+            <subsection name="Tomcat 5.5.9 on Windows">
+                <p>
+                    To have redeployment and undeployment working properly when using Tomcat
5.5.9 on Windows you have
+                    to set the global Context attribute "antiJARLocking" to true.
+                </p>
+                <p>
+                    Thus, in $CATALINA_HOME\conf\context.xml use:
+                    <source>
+                        <![CDATA[
     <Context antiJARLocking="true">
     ...
     </Context>]]>
-  </source>
-</p>
-</subsection>
-</section>
-<section name='4. Building Jetspeed 2'>
-<p>
-Build the portal and all components for Jetspeed-2:
-</p>
-<source test=""><![CDATA[
+                    </source>
+                </p>
+            </subsection>
+        </section>
+        <section name='4. Building Jetspeed 2'>
+            <p>
+                Build the portal and all components for Jetspeed-2. If build Jetspeed 2 for
the first time, the Jetspeed
+                2 maven plugin is most likely not set up. Run:
+            </p>
+            <source test="">
+                <![CDATA[
+cd ${jetspeed-2-home}
+maven initMavenPlugin allClean allBuild
+]]>
+            </source>
+            <p>If the Jetspeed 2 maven plugin is installed, then to build the portal
and all its components run:</p>
+            <source test="">
+                <![CDATA[
 cd ${jetspeed-2-home}
 maven allClean allBuild
-]]></source>
-</section>
-<section name="5. Deploying Jetspeed into Tomcat">
-<p>
-We only cover deploying to Tomcat 5 or Tomcat 5.5.
-Step #1 below is optional if you are NOT using the default Hypersonic database.
-</p>
-<ul>
-<li>1. If you are using the Hypersonic SQL database, start the production Hypersonic
database by typing 
-       <br/><br/><b>maven start.production.server</b><br/><br/>
-</li>
-<li>2. (in seperate window/terminal session) <br></br><br></br><b>cd
${jetspeed-2-home}</b><br></br><br></br>
-       <b>maven quickStart</b><br></br><br></br> This
will recreate the DB to deploy into.  
-       WARNING This will drop all the tables and data in the production database.<br></br><br></br>
-</li>
-<li>3. Start up Tomcat. With a browser, go to: <br/><br/><b>http://localhost:8080/jetspeed</b><br/>
-</li>
-</ul>
-</section>
+]]>
+            </source>
+        </section>
+        <section name="5. Deploying Jetspeed into Tomcat">
+            <p>
+                We only cover deploying to Tomcat 5 or Tomcat 5.5. Step #1 below is optional
if you are NOT using the
+                default Hypersonic database.
+            </p>
+            <ul>
+                <li>
+                    1. If you are using the Hypersonic SQL database, start the production
Hypersonic database by typing
+                    <br />
+                    <br />
+                    <b>maven start.production.server</b>
+                    <br />
+                    <br />
+                </li>
+                <li>
+                    2. (in seperate window/terminal session)
+                    <br></br>
+                    <br></br>
+                    <b>cd ${jetspeed-2-home}</b>
+                    <br></br>
+                    <br></br>
+                    <b>maven j2:quickStart</b>
+                    <br></br>
+                    <br></br>
+                    This will recreate the DB to deploy into. WARNING This will drop all
the tables and data in the
+                    production database.
+                    <br></br>
+                    <br></br>
+                </li>
+                <li>
+                    3. Start up Tomcat. With a browser, go to:
+                    <br />
+                    <br />
+                    <b>http://localhost:8080/jetspeed</b>
+                    <br />
+                </li>
+            </ul>
+        </section>
+        <section name="6. Creating a new Portal Application">
+            <p>
+                In order to get started with a new portal application that will include a
developer's specific portal
+                customization, Jetspeed 2 provides as part of its <a href="j2-maven-plugin.html">Maven
Plugin</a>
+                a goal that can get you started with your project. To do so:
+            </p>
+            <p>
+                1. Make sure that the following properties are set in your your ${USER_HOME}/
+                <code>build.properties</code> file:
+            </p>
+            <table>
+                <tr>
+                    <th>property</th>
+                    <th>example</th>
+                    <th>what is it?</th>
+                </tr>
+                <tr>
+                    <td>org.apache.jetspeed.portal.name</td>
+                    <td>testportal</td>
+                    <td>The name of your new portal application.  This will also be
used as the artifactId for your
+                    project in the maven repository.</td>
+                </tr>
+                <tr>
+                    <td>org.apache.jetspeed.genapp.home</td>
+                    <td>C:/tools/workspace/testportal</td>
+                    <td>The location where your new portal application should be created.</td>
+                </tr>
+                <tr>
+                    <td>org.apache.jetspeed.genapp.groupId</td>
+                    <td>testportal</td>
+                    <td>The maven pom group id indicates the group location for your
project in the maven repository.</td>
+                </tr>
+                <tr>
+                    <td>org.apache.jetspeed.genapp.name</td>
+                    <td>My Test Portal</td>
+                    <td>A friendly name for your new portal.</td>
+                </tr>
+                <tr>
+                    <td>org.apache.jetspeed.genapp.currentVersion</td>
+                    <td>1.0</td>
+                    <td>The current version for your new portal application.</td>
+                </tr>
+            </table>
+            <p>
+                2. Once the above properties are set, make sure that the Jetspeed 2 Maven
Plugin is installed on
+                your local machine.  You can install the Jetspeed 2 Maven Plugin as follow:
+                <source>
+                <![CDATA[
+maven -DartifactId=maven-jetspeed2-plugin -DgroupId=jetspeed2 
+      -Dversion=2.0-M4-SNAPSHOT plugin:download]]>
+                </source>
+                <ul>
+                	<li>artifactId: The name of the Jetspeed2 plugin artifact deployed
to the maven repository.</li>
+                	<li>groupId: The name of the group where the Jetspeed2 plugin is deployed
in the maven repository.</li>
+                	<li>version: The version that you want to use.  For this functionality,
the version should be
+                	2.0-M4-SNAPSHOT or above.</li>
+                </ul>         
+            </p>
+            <p>
+            	3. Run the Jetspeed2 plugin target for generating a new portal application:
+            	<source>
+                <![CDATA[
+maven j2:genapp.portal]]>
+                </source>
+            </p>
+            <p>
+            	3. Go to the directory where you just created your new portal application and
execute:
+            	<source>
+                <![CDATA[
+maven j2:portal.install
+maven j2:quickStart]]>
+                </source>
+                That's it, you are ready to get started with your new portal application.
+            </p>
+        </section>
 
-</body>
+    </body>
 </document>
 



---------------------------------------------------------------------
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