You are viewing a plain text version of this content. The canonical link for it is here.
Posted to pluto-scm@portals.apache.org by dd...@apache.org on 2005/11/02 00:41:37 UTC

svn commit: r330152 - in /portals/pluto/trunk/pluto-site/src/site/apt: index.apt mission.apt subprojects.apt

Author: ddewolf
Date: Tue Nov  1 15:41:33 2005
New Revision: 330152

URL: http://svn.apache.org/viewcvs?rev=330152&view=rev
Log:
merging 1.0.1 and 1.1 docs into trunk site

Added:
    portals/pluto/trunk/pluto-site/src/site/apt/mission.apt
    portals/pluto/trunk/pluto-site/src/site/apt/subprojects.apt
Modified:
    portals/pluto/trunk/pluto-site/src/site/apt/index.apt

Modified: portals/pluto/trunk/pluto-site/src/site/apt/index.apt
URL: http://svn.apache.org/viewcvs/portals/pluto/trunk/pluto-site/src/site/apt/index.apt?rev=330152&r1=330151&r2=330152&view=diff
==============================================================================
--- portals/pluto/trunk/pluto-site/src/site/apt/index.apt (original)
+++ portals/pluto/trunk/pluto-site/src/site/apt/index.apt Tue Nov  1 15:41:33 2005
@@ -6,7 +6,59 @@
  14 Sept 2005
  ------
 
-Pluto 1.1
+Welcome to Pluto
+
+  Pluto is the Reference Implementation of the Java Portlet 
+  Specfication. The current version of this specification is 
+  JSR 168.
+
+  Portlets are designed to run in the context of a portal. 
+  They are written to the Portlet API which are similar to 
+  the Servlet API.
+
+  In contrast to servlets, portlets may not do things like 
+  sending redirects or errors to browsers directly, forwarding 
+  requests or writing arbitrary markup to the output stream to 
+  assure that they don?t distract the portal web application 
+  which uses them. Another difference compared to servlets is 
+  that portlets rely on portal specific infrastructure functions 
+  such as access to user profile information, standard interface 
+  for storing/retrieving persistent settings, getting client 
+  information, etc. Generally, portlets are administrated more 
+  dynamically than servlets typically are.
+
+  A portlet container provides a runtime environment for portlets 
+  implemented according to the Portlet API. In this environment 
+  portlets can be instantiated, used and finally destroyed. The 
+  portlet container is not a stand-alone container like the servlet 
+  container; instead it is implemented as a thin layer on top of 
+  the servlet container and reuses the functionality provided by the 
+  servlet container.
+
+  Pluto serves as portlet container that implements the Portlet API 
+  and offers developers a working example platform from which they 
+  can test their portlets. However, it's cumbersome to execute and 
+  test the portlet container without a driver, in this case, the 
+  portal. Pluto's simple portal component is built only on the 
+  portlet container's and the JSR 168's requirements. (In contrast, 
+  the more sophisticated, Jetspeed project concentrates on the
+  portal itself rather than the portlet container, and considers 
+  requirements from other groups.) 
+
+Project Status
+
+  Apache Pluto is a subproject of the Apache Portals Project.
+  The current stable release of Apache Pluto is version 1.0.1.
+  The current version actively being developed is version 1.1.
+
+* Pluto 1.0.1
+
+  Pluto 1.0.1 is the current stable release of Pluto.
+  This version of pluto is utilized as the portlet container
+  for Jetspeed and other portals. In addition, Pluto 1.0.1
+  is embeded within Apache Geronimo.
+
+* Pluto 1.1
 
   Pluto 1.1 introduces a new container architecture.  If you
   are embedding Pluto in your portal, realize that 1.1 is not
@@ -20,5 +72,4 @@
   mailing lists!
 
   Pluto 1.1 is currently only available through subversion 
-  repository.  Once a GA release of Pluto 1.0.1 is finalized
-  we will consider an alpha level distribution.
+  repository.  An alpha release is currently being considered.

Added: portals/pluto/trunk/pluto-site/src/site/apt/mission.apt
URL: http://svn.apache.org/viewcvs/portals/pluto/trunk/pluto-site/src/site/apt/mission.apt?rev=330152&view=auto
==============================================================================
--- portals/pluto/trunk/pluto-site/src/site/apt/mission.apt (added)
+++ portals/pluto/trunk/pluto-site/src/site/apt/mission.apt Tue Nov  1 15:41:33 2005
@@ -0,0 +1,54 @@
+ ------
+ The Pluto Project Mission
+ ------
+ David H. DeWolf
+ ------
+ 01 Nov 2005
+ ------
+
+The Pluto Project Mission
+
+  The Pluto Portlet Container is the Reference Implementation of the 
+  Java Portlet Specification. As such, Pluto offers the development 
+  community a reference for interpretation of the specification, 
+  portlet developers a container with which compliant portlets can be 
+  tested, and portal developers a compliant container with which they 
+  can integrate.
+
+  The following document attempts to clarify the development priorities 
+  of the Apache Pluto project.
+
+  The primary concern of the pluto community is to ensure that the Pluto 
+  Container maintains compatibility with the most current Java Portlet 
+  Specification. Enhancements and bug fixes should be completed in a 
+  manner in which compatibility is maintained.
+
+  It is the responsibility of the pluto development team to ensure that 
+  no ambiguity is introduced into the reference implementation. No 
+  enhancements should be implemented which introduce questions about 
+  the specification.
+
+  It is desirable for Pluto to become a robust and easy to use portlet 
+  container. This will facilitate its wider acceptance and usage in 
+  the community. In order to accomplish these goals, it is assumed 
+  that enhancements which are above and beyond the specification will 
+  be introduced. These enhancements may be integrated with Pluto as long 
+  as they do not compromise the integrity of the reference implementation 
+  as described above.
+
+  Furthermore, functionality which is clearly beyond the scope of the 
+  specification should be documented as such and placed into a package 
+  which helps to distinguish it as such. The Pluto container should always 
+  remain fully specification compliant and in working state when these 
+  enhancements are removed. In most cases, this removal should be supported 
+  through configuration parameters.
+
+  Finally, while the pluto project contains several subprojects, it is important 
+  to realize that the container itself is the most important aspect of the 
+  project. It, in an of itself, is the Java Portlet reference implementation. 
+  The portal driver (Pluto Test Portal), testsuite, and deployer exist to simplfy 
+  the use and testing of the container. As such, any significant enhancements to 
+  these components (most especially the portal driver) should be scrutinized before 
+  implementation, as most likely, it is outside the scope of the pluto project and 
+  belong in a portal full implementation. 
+

Added: portals/pluto/trunk/pluto-site/src/site/apt/subprojects.apt
URL: http://svn.apache.org/viewcvs/portals/pluto/trunk/pluto-site/src/site/apt/subprojects.apt?rev=330152&view=auto
==============================================================================
--- portals/pluto/trunk/pluto-site/src/site/apt/subprojects.apt (added)
+++ portals/pluto/trunk/pluto-site/src/site/apt/subprojects.apt Tue Nov  1 15:41:33 2005
@@ -0,0 +1,58 @@
+ ------
+ Pluto Subprojects
+ ------
+ David H. DeWolf
+ ------
+ 1 Nov 2005
+ ------
+
+Pluto Subprojects
+
+  Pluto 1.1 utilizes Maven 2 as it's project management and build
+  automation tool.  Pluto follows maven's best practices and is
+  organized into modules or subprojects.
+
+* Pluto Container
+
+  The Pluto Container is the core compontent of the Apache Pluto
+  project.  All other modules either support the development.  The
+  Pluto Container is the reference implementation of the Portlet 
+  Specification.
+
+* Pluto Descriptor API
+
+  A domain model which represents the deployment descriptors read
+  by the portlet container.  Contains service interfaces for reading
+  and writing portlet.xml and web.xml.
+
+* Pluto Descriptor Impl
+
+  The default implementation of the Pluto Descriptor API Subproject.
+  The default implementation utilzes castor for reading and writing
+  portlet and web application descriptors.
+
+* Pluto Portal Driver
+
+  A driver library for the Pluto Portlet Container.  Provides service 
+  implementations and utilities for implementing a portal which utilizes
+  the container.
+
+* Pluto Portal
+
+  The user interface components (web application) of the Pluto Portal.
+  The pluto portal is a simple portal application which embeds the portal.
+  The portal is not meant to be a full enterprise portal, but instead 
+  is meant to be an example of how to embed the container and a lightweight
+  environment for developing and testing portlets.
+
+* Pluto Deploy
+
+  Deployment Utilities for working with the Pluto Portal.
+
+* Pluto Testsuite
+
+  A test portlet which can be used to exercise and test any 
+  portlet container.
+
+
+