forrest-svn mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From rgard...@apache.org
Subject svn commit: rev 71506 - forrest/trunk/docs-author/content/xdocs/howto
Date Mon, 15 Nov 2004 18:55:52 GMT
Author: rgardler
Date: Mon Nov 15 10:55:51 2004
New Revision: 71506

Modified:
   forrest/trunk/docs-author/content/xdocs/howto/howto-buildPlugin.xml
Log:
add section on testing a plugin in development

Modified: forrest/trunk/docs-author/content/xdocs/howto/howto-buildPlugin.xml
==============================================================================
--- forrest/trunk/docs-author/content/xdocs/howto/howto-buildPlugin.xml	(original)
+++ forrest/trunk/docs-author/content/xdocs/howto/howto-buildPlugin.xml	Mon Nov 15 10:55:51
2004
@@ -104,16 +104,51 @@
     </section>
     
     <section>
-      <title>Register the Plugin with Apache Forrest</title>
-      <fixme author="rdg">Describe the plugins.xml file</fixme>
-      <fixme author="rdg">Describe making a request of Forrest devs for 
-      inclusion</fixme>
+      <title>Testing a Plugin</title>
+      <p>Since your documentation for the plugin illustrates all of its 
+      functionality you can use that site for testing the plugin. However, you
+      must first deploy in your local install of Forrest. The 
+      <code>plugins</code> directory of the Forrest project contains an
+      Apache Ant build file with some useful targets for deploying to a local
+      instance of Forrest.</p>
+      
+      <p class="instruction">Run the command <code>ant local-deploy</code>
in
+      the plugins directory.</p>
+      
+      <p>You will be asked the name of the plugin you wish to deploy, enter
+      the name of your plugin and hit return. All the necessary files will be 
+      copied to your local Forrest installation. You can now generate your
+      documentation.</p>
+      
+      <p class="instruction">Run the command <code>forrest site</code>
in your
+      plugin directory to generate your documentation.</p>
+      
+      <p>Of course, the build should complete without errors.</p>
+      
+      <note>You can also use <code>forrest run</code> to interactively
examine
+      your documentation (point your prowser at 
+      <a href="localhost:8888">localhost:8888</a>).</note>
+      
+      <fixme author="rdg">Encourage users to build propoer tests for their 
+      plugins using, for example, 
+      <a href="http://webtest.canoo.com/">WebTest</a>.</fixme>
     </section>
     
     <section>
-      <title>Publish the Plugin</title>
-      <fixme author="rdg">Describe the generation of the plugin zip and
-      the publication of that zip (ant dist)</fixme>
+      <title>Releasing a Plugin</title>
+    
+      <section>
+        <title>Register the Plugin with Apache Forrest</title>
+        <fixme author="rdg">Describe the plugins.xml file</fixme>
+        <fixme author="rdg">Describe making a request of Forrest devs for 
+        inclusion</fixme>
+      </section>
+      
+      <section>
+        <title>Publish the Plugin</title>
+        <fixme author="rdg">Describe the generation of the plugin zip and
+        the publication of that zip (ant dist)</fixme>
+      </section>
     </section>
     
     <section>

Mime
View raw message