portals-pluto-scm mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From cdore...@apache.org
Subject svn commit: r289832 - /portals/pluto/trunk/portal/src/webapp/portlets/admin/DeployWarHelp.html
Date Sat, 17 Sep 2005 16:50:32 GMT
Author: cdoremus
Date: Sat Sep 17 09:50:29 2005
New Revision: 289832

URL: http://svn.apache.org/viewcvs?rev=289832&view=rev
Log:
Fleshed out this help file, specially the Troubleshooting section.

Modified:
    portals/pluto/trunk/portal/src/webapp/portlets/admin/DeployWarHelp.html

Modified: portals/pluto/trunk/portal/src/webapp/portlets/admin/DeployWarHelp.html
URL: http://svn.apache.org/viewcvs/portals/pluto/trunk/portal/src/webapp/portlets/admin/DeployWarHelp.html?rev=289832&r1=289831&r2=289832&view=diff
==============================================================================
--- portals/pluto/trunk/portal/src/webapp/portlets/admin/DeployWarHelp.html (original)
+++ portals/pluto/trunk/portal/src/webapp/portlets/admin/DeployWarHelp.html Sat Sep 17 09:50:29
2005
@@ -14,20 +14,26 @@
 See the License for the specific language governing permissions and
 limitations under the License.
 -->
-<h2>Deploy War Portlet Help</h2>
+<h2 align="center">Deploy War Portlet Help</h2>
 
+<h3>Contents</h3>
+<p class="portlet-font">
+<a href="#deploy">Deploying portlets</a><br>
+<a href="#redeploy">Redeploying portlets</a><br>
+<a href="#undeploy">Undeploying portlets</a><br>
+<a href="#troubleshooting">Troubleshooting</a><br>
+</p>
 
+<a name="deploy"><h3>Deploying portlets</h3></a>
 <p class="portlet-font">
-This portlet is used to deploy new portlet applications to Pluto packaged
+The Deploy War Portlet is used to deploy new portlet applications to Pluto packaged
 in a war file. Deployment involves unzippling the war file into
 Pluto's webapps directory and adding records to the
 registry files located in <CATALINA_HOME>/webapps/pluto/WEB-INF/data (
-portletentityregistry.xml, pageregistry.xml and portletcontexts.txt).
+portletentityregistry.xml, pageregistry.xml and portletcontexts.txt). Use the following steps
to deploy
+a custom portlet:
 </p>
 
-
-<h3>Deploying portlets</h3>
-
 <ol>
 </li>
 <li class="portlet-font">
@@ -61,7 +67,7 @@
 </li>
 </ol>
 
-<h3>Redeploying portlets</h3>
+<a name="redeploy"><h3>Redeploying portlets</h3></a>
 <p class="portlet-font">
 Redeployment of previously deployed portlets can be done, but the results can be
 somewhat flaky due to caching of portlet content by the Pluto portal.
@@ -80,7 +86,20 @@
 to clear the old content.
 </p>
 
-<h3>Troubleshooting</h3>
+<a name="undeploy"><h3>Undeploying portlets</h3></a>
+<p class="portlet-font">
+The admin portlet app does not currently support undeployment of portlets. To undeploy a
portlet,
+manually remove the record for the portlet from portletentityregistry.xml, pageregistry.xml
and 
+portletcontexts.txt in the webapps/pluto/WEB-INF/data directory and restart Pluto.
+</p>
+
+<a name="troubleshooting"><h3>Troubleshooting</h3></a>
+<p class="portlet-font">
+The date-stamped pluto.log file in the logs directory is the source of any error information
when things go 
+wrong in Pluto. That is the first thing you should check out if you have a problem. Other
log files in
+that directory might also be helpful. It's a good idea to look at the timestamp of the log
files and check them
+in reverse chronological order.
+</p>
 <p class="portlet-font">
 The main problem with deployments using the Deploy War Portlet has to do with an improperly
formatted portlet.xml file. 
 The deployment process validates portlet.xml against the official XML schema. This schema
validation
@@ -93,3 +112,14 @@
 &lt;portlet-app xmlns="http://java.sun.com/xml/ns/portlet/portlet-app_1_0.xsd" version="1.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xsi:schemaLocation="http://java.sun.com/xml/ns/portlet/portlet-app_1_0.xsd http://java.sun.com/xml/ns/portlet/portlet-app_1_0.xsd"/&gt;
 </p>
+<p class="portlet-font">
+If hot deployment of a portlet causes the new portlet to not appear in the Pluto portal,
check the pluto log file and 
+the portlet's web.xml in webapps/&lt;myportlet&gt;/WEB-INF to make sure that the
PortletServlet record has been 
+properly added to the file and it has not been corrupted. Manually <a href="#undeploy">undeploy</a>
the portlet 
+and restart Pluto when you fix the problems. 
+</p>
+<p class="portlet-font">
+If deployment of a new portlet causes an error that breaks Pluto, manually <a href="#undeploy">undeploy</a>
the portlet 
+and restart Pluto. Make sure that your web.xml and portlet.xml file is correct and retry
the deployment after you
+fix any problems.
+</p>
\ No newline at end of file



Mime
View raw message