You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jetspeed-dev@portals.apache.org by we...@apache.org on 2005/09/14 18:31:07 UTC
svn commit: r280881 - /portals/jetspeed-2/trunk/xdocs/getting-started.xml
Author: weaver
Date: Wed Sep 14 09:31:03 2005
New Revision: 280881
URL: http://svn.apache.org/viewcvs?rev=280881&view=rev
Log:
I have added some "basics" to the getting started page as suggested by some internal users here.
I have found what might be obvious to some users, is not to others. I have tried to briefly go over
convetions used within the document along with helpful links to Subversion clients.
Modified:
portals/jetspeed-2/trunk/xdocs/getting-started.xml
Modified: portals/jetspeed-2/trunk/xdocs/getting-started.xml
URL: http://svn.apache.org/viewcvs/portals/jetspeed-2/trunk/xdocs/getting-started.xml?rev=280881&r1=280880&r2=280881&view=diff
==============================================================================
--- portals/jetspeed-2/trunk/xdocs/getting-started.xml (original)
+++ portals/jetspeed-2/trunk/xdocs/getting-started.xml Wed Sep 14 09:31:03 2005
@@ -53,6 +53,68 @@
</li>
</ul>
</section>
+ <section name="Naming Conventions and Basic Assumptions">
+ <subsection name="Basic Assumptions">
+ <ul>
+ <li>
+ Unless otherwise specified, you should be running all maven build commands
+ from within the Jetspeed directory (if you are just building Jetspeed) or
+ from within your custom portal directory.
+ </li>
+ <li>
+ You must use "/" as a file seperator on both *nix and windows, e.g. c:/windows, and /home.
+ </li>
+ </ul>
+ </subsection>
+ <subsection name="Naming Conventions">
+ <p>
+ Below is a listing of common conventions used within this document.
+ </p>
+ <p>
+ Variables are represented as such, ${<i>some_variable</i>}. This may signify a setting in jetspeed or
+ may represent a setting within your environment.
+ <br/>
+ Properties files are also capable of using ${some_variable} within them. So, for example,
+ ${org.apache.jetspeed.server.home} references either a property defined further up in the
+ properties file, that has been defined somehwere within the build process or defined
+ in another build file within jetspeed.
+ </p>
+ <ul>
+ <li>
+ <b>${USER_HOME}</b>: This is the user's home directory. For Windows systems, this generally
+ c:\Documents and Settings\${userName} where ${userName} is the name you log into windows as.
+ <br/>
+ ${USER.HOME} is synonymous with ${USER_HOME} within this document.
+ </li>
+ <li>
+ <b>${CATALINA_HOME}</b>: This should point to the location of your tomcat installation, e.g. <i>c:/tomcat</i>.
+ </li>
+ </ul>
+ </subsection>
+ <subsection name="Subversion (SVN)">
+ <p>
+ <a href="http://subversion.tigris.org">Subversion (SVN)</a> is becoming the standard source and version control mechanism for Apache projects. SVN is
+ very similar CVS. For those user's on Windows system who prefer non-command line access we suggest using
+ <a href="http://tortoisesvn.tigris.org">TortoiseSVN</a> which plugs into your Windows Explorer view. For those
+ using the Eclipse IDE, there is a <a href="http://subclipse.tigris.org">plugin</a> available for SVN access.
+ </p>
+ </subsection>
+ <subsection name="Maven">
+ <p>
+ We will not go into the specifics of Maven as that is beyond the scope of this document. However, here are a few bits of standard
+ maven jargon we feel is important for you to know.
+ </p>
+ <p>
+ You will see mention of a <i>maven repository</i> in this document. When you install Maven the .maven/ directory is created in your
+ ${USER_HOME) directory.
+ <br/>
+ Under .maven/ you will see a <i>repository</i> directory. This is were Maven stores all the jars it downloads when you run your builds. This is
+ also were Maven puts your jars.wars you build under the format of ${groupId}/${projectId}/jars/${projectId}-{$version}.jar for jar files and
+ ${groupId}/${projectId}/wars/${projectId}.war for war files. The ${groupId}, ${projectId} and ${version} variables are discussed later on in this
+ document. Jars/wars will also be created in your project in the <i>/target</i> directory.
+ </p>
+ </subsection>
+ </section>
<section name='1. Get Maven Ready'>
<p>
If you have not already done so, download and install Maven.
@@ -93,7 +155,8 @@
</td>
<td>
The folder where the maven-plugin will (re)create or update your custom portal maven project configuration
- (with goal <code>j2:portal.conf.project</code>).
+ (with goal <code>j2:portal.conf.project</code>). This will be where you will be performing all of your future
+ custom portal development.
<br />
Example: <code>/home/myportal/</code>
</td>
---------------------------------------------------------------------
To unsubscribe, e-mail: jetspeed-dev-unsubscribe@portals.apache.org
For additional commands, e-mail: jetspeed-dev-help@portals.apache.org