peterjhart / uportal Goto Github PK

README for uPortal Documents directory

In this directory you'll find documentation for JA-SIG's uPortal
framework. 


Manifest
--------
README                  o This file
build.xml               o Ant build file 
website/                o A complete copy of the uPortal website. 
                
The website directory contains several subdirectories:

website/administrators  o documentation which describes the installation
                        and configuration of uPortal

website/developers      o documentation for uportal channel developers

website/architecture    o documentation describing uPortal architecture
                        and background

website/meetings        o meeting notes from JA-SIG uPortal conferences, 
                        developers meetings, and users groups.

website/release         o uPortal release information
                    
website/rfc             o Request for Comments documentaion

website/user            o Documentation for end users.

website/user            o Documentation for end users.

There are also several other documents in the website directory including 
FAQ page, bug reporting, licensing, etc.

Deploying 
---------

The documentation may be deployed into the uPortal deployment directory
or to a web server.  By default files are copied to the docs subdirectory
of the uPortal deploy.home directory defined in the build.properties file
in the uPortal release directory.  To change the location modify the 
doc.deploy.home property in the build.xml file.  For example, to deploy 
the documentation to a web site running under Apache change the property
to something like /usr/local/apache/html/uportal.

Note: the deploy target will append the "docs" directory to the deployment
home.

The following ant command will deploy the documentation:

  ant deploy


Copyright
---------

Copyright (C) 2000, 2001 JA-SIG

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the documentation.

Except as contained in this notice, the names of individuals credited
with contribution to this documentation shall not be used in
advertising or otherwise to promote the sale, use or other dealings in
this documentation without prior written authorization from the individuals
in question.

Any documents derived from this documentation that are publically
distributed will be identified with a different name and the version
strings in any derived documentation will be changed so that no
possibility of confusion between the derived package and this
documentation will exist.

Warranty
--------

THE DOCUMENTATION IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL JA-SIG OR ANY CONTRIBUTOR BE LIABLE FOR ANY CLAIM,
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
DOCUMENTATION OR THE USE OR OTHER DEALINGS IN THE DOCUMENTATION.

Contacting the Author(s)
---------------------

The documentation is coordinated and maintained by Bill Brooks
<[email protected]>.

The best way to get your questions about the documentation answered is
to send a message to the mailing list. See
http://www.ja-sig.org/lists/Main.html for information on how to join
the appropriate list.


$Revision$