svn commit: r407429 - /forrest/trunk/site-author/content/xdocs/roles.xml

[cr...@apache.org]

Author: crossley
Date: Wed May 17 18:56:09 2006
New Revision: 407429

URL: http://svn.apache.org/viewvc?rev=407429&view=rev
Log:
Explain how to publish docs for a plugin.

Modified:
    forrest/trunk/site-author/content/xdocs/roles.xml

Modified: forrest/trunk/site-author/content/xdocs/roles.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/roles.xml?rev=407429&r1=407428&r2=407429&view=diff
==============================================================================
--- 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>
         <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="https://svn.apache.org/repos/asf/forrest/site">forrest/site SVN</a>.
           Then a cronjob on the server will automatically publish it. However, if
           instant turnaround is required, then do this:
         </p>
         <source>ssh people.apache.org
-  cd /www/forrest.apache.org
-  svn update</source>
+cd /www/forrest.apache.org
+svn update</source>
         <p>See some general notes about managing
           <a href="http://www.apache.org/dev/project-site.html">project websites</a>.
         </p>
         <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.
         </p>
       </section>
       <section id="subversion-monitor">

Re: svn commit: r407429 - /forrest/trunk/site-author/content/xdocs/roles.xml

[Ross Gardler <rg...@apache.org>]

crossley@apache.org wrote:
> Author: crossley
> Date: Wed May 17 18:56:09 2006
> New Revision: 407429

...

> +        </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.

This is also done as part of:

ant deploy

and

and release

Ross