forrest-svn mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject svn commit: r407429 - /forrest/trunk/site-author/content/xdocs/roles.xml
Date Thu, 18 May 2006 01:56:09 GMT
Author: crossley
Date: Wed May 17 18:56:09 2006
New Revision: 407429

Explain how to publish docs for a plugin.


Modified: forrest/trunk/site-author/content/xdocs/roles.xml
--- forrest/trunk/site-author/content/xdocs/roles.xml (original)
+++ forrest/trunk/site-author/content/xdocs/roles.xml Wed May 17 18:56:09 2006
@@ -120,23 +120,32 @@
         <p>This role is not actually about doing the documentation. That should
           be up to everyone.</p>
-        <p>It is very easy using a local forrestbot:</p>
+        <p>Generating and publishing the main docs is very easy using a local forrestbot:</p>
         <source>cd site-author
-  forrest -f publish.xml build
-  forrest -f publish.xml deploy</source>
+forrest -f publish.xml build
+forrest -f publish.xml deploy</source>
         <p>This builds the documentation locally then deploys it by committing
           it to the <a href="">forrest/site
           Then a cronjob on the server will automatically publish it. However, if
           instant turnaround is required, then do this:
-  cd /www/
-  svn update</source>
+cd /www/
+svn update</source>
         <p>See some general notes about managing
           <a href="">project websites</a>.
         <p>Note that forrestbot does not remove docs from the forrest/site SVN (FOR-392).
           So need to manually 'svn delete oldDoc'.
+        </p>
+        <p>
+          Publishing documentation for a particular plugin is done by:
+        </p>
+        <source>cd plugins/myPluginName
+$FORREST_HOME/tools/ant/bin/ant deploy-docs</source>
+        <p>
+          See further information in the 
+          <a href="site:buildPlugin">buildPlugin</a> doc.
       <section id="subversion-monitor">

View raw message