Author: crossley
Date: Wed Jul 19 01:21:05 2006
New Revision: 423401
URL: http://svn.apache.org/viewvc?rev=423401&view=rev
Log:
Automatic publish from forrestbot
Modified:
forrest/site/changes.rss
forrest/site/changes.xml
forrest/site/docs_0_60/changes.html
forrest/site/docs_0_60/changes.pdf
forrest/site/docs_0_60/changes.rss
forrest/site/docs_0_70/changes.html
forrest/site/docs_0_70/changes.pdf
forrest/site/docs_0_70/changes.rss
forrest/site/docs_0_70/changes.xml
forrest/site/docs_0_80/changes.html
forrest/site/docs_0_80/changes.pdf
forrest/site/docs_0_80/changes.rss
forrest/site/docs_0_80/changes.xml
forrest/site/procedures/How_to_publish_docs.html
forrest/site/procedures/How_to_publish_docs.pdf
forrest/site/roles.html
forrest/site/roles.pdf
Modified: forrest/site/changes.rss
URL:
http://svn.apache.org/viewvc/forrest/site/changes.rss?rev=423401&r1=423400&r2=423401&view=diff
==============================================================================
--- forrest/site/changes.rss (original)
+++ forrest/site/changes.rss Wed Jul 19 01:21:05 2006
@@ -181,7 +181,7 @@
Updated xerces to 2.8.0, xml-apis to 1.3.03, log4j to 1.2.13 and
ehcache to 1.2.
</description></item>
- <item><title>code add</title><link>changes.html</link><description>code
add
+ <item><title>docs add</title><link>changes.html</link><description>docs
add
by
DC
:
@@ -5643,7 +5643,7 @@
:
Updated xerces to 2.8.0, xml-apis to 1.3.03, log4j to 1.2.13 and
ehcache to 1.2.
- </description></item><item><title>code
add</title><link>changes.html</link><description>code add
+ </description></item><item><title>docs
add</title><link>changes.html</link><description>docs add
by
DC
:
Modified: forrest/site/changes.xml
URL:
http://svn.apache.org/viewvc/forrest/site/changes.xml?rev=423401&r1=423400&r2=423401&view=diff
==============================================================================
--- forrest/site/changes.xml (original)
+++ forrest/site/changes.xml Wed Jul 19 01:21:05 2006
@@ -11,9 +11,6 @@
<section><title>Changes to Build</title><ul><li><icon alt="add"
src="images/add.jpg"/>
Add new build target "clean-build".
Committed by CD.</li></ul></section><section><title>Changes to the Code
Base</title><ul><li><icon alt="add" src="images/add.jpg"/>
- Add document about project
- <link href="site:roles">roles</link>.
- Committed by DC.</li><li><icon alt="add" src="images/add.jpg"/>
Added initial whiteboard input plugin "odt".
Use OpenDocument ODT as input.
Committed by TS.</li><li><icon alt="add" src="images/add.jpg"/>
@@ -364,6 +361,9 @@
Committed by FSO.</li><li><icon alt="add" src="images/add.jpg"/>
Re-arrange documentation menus, added best practice and procedures
sections.
Committed by FSO.</li><li><icon alt="add" src="images/add.jpg"/>
+ Add document about project
+ <link href="site:roles">roles</link>.
+ Committed by DC.</li><li><icon alt="add" src="images/add.jpg"/>
Add initial <link href="site:glossary">glossary</link> to explain
some Forrest terminology.
Committed by DC. Thanks to Gavin.</li><li><icon alt="add"
src="images/add.jpg"/>
Modified: forrest/site/docs_0_60/changes.html
URL:
http://svn.apache.org/viewvc/forrest/site/docs_0_60/changes.html?rev=423401&r1=423400&r2=423401&view=diff
==============================================================================
--- forrest/site/docs_0_60/changes.html (original)
+++ forrest/site/docs_0_60/changes.html Wed Jul 19 01:21:05 2006
@@ -479,11 +479,6 @@
<ul>
<li>
<img class="icon" alt="add" src="../images/add.jpg">
- Add document about project
- <a href="../roles.html">roles</a>.
- Committed by DC.</li>
-<li>
-<img class="icon" alt="add" src="../images/add.jpg">
Added initial whiteboard input plugin "odt".
Use OpenDocument ODT as input.
Committed by TS.</li>
@@ -1017,7 +1012,7 @@
forrest.properties. <a
href="http://svn.apache.org/viewcvs.cgi?rev=215902&view=rev";>Diff</a>
Committed by TS.</li>
</ul>
-<a name="N10339"></a><a name="Changes+to+Documentation"></a>
+<a name="N10330"></a><a name="Changes+to+Documentation"></a>
<h3 class="underlined_5">Changes to Documentation</h3>
<ul>
<li>
@@ -1040,6 +1035,11 @@
<img class="icon" alt="add" src="../images/add.jpg">
Re-arrange documentation menus, added best practice and procedures
sections.
Committed by FSO.</li>
+<li>
+<img class="icon" alt="add" src="../images/add.jpg">
+ Add document about project
+ <a href="../roles.html">roles</a>.
+ Committed by DC.</li>
<li>
<img class="icon" alt="add" src="../images/add.jpg">
Add initial <a href="../docs_0_80/glossary.html">glossary</a> to
explain
Modified: forrest/site/docs_0_60/changes.pdf
URL:
http://svn.apache.org/viewvc/forrest/site/docs_0_60/changes.pdf?rev=423401&r1=423400&r2=423401&view=diff
==============================================================================
Binary files - no diff available.
Modified: forrest/site/docs_0_60/changes.rss
URL:
http://svn.apache.org/viewvc/forrest/site/docs_0_60/changes.rss?rev=423401&r1=423400&r2=423401&view=diff
==============================================================================
--- forrest/site/docs_0_60/changes.rss (original)
+++ forrest/site/docs_0_60/changes.rss Wed Jul 19 01:21:05 2006
@@ -181,7 +181,7 @@
Updated xerces to 2.8.0, xml-apis to 1.3.03, log4j to 1.2.13 and
ehcache to 1.2.
</description></item>
- <item><title>code add</title><link>changes.html</link><description>code
add
+ <item><title>docs add</title><link>changes.html</link><description>docs
add
by
DC
:
@@ -5643,7 +5643,7 @@
:
Updated xerces to 2.8.0, xml-apis to 1.3.03, log4j to 1.2.13 and
ehcache to 1.2.
- </description></item><item><title>code
add</title><link>changes.html</link><description>code add
+ </description></item><item><title>docs
add</title><link>changes.html</link><description>docs add
by
DC
:
Modified: forrest/site/docs_0_70/changes.html
URL:
http://svn.apache.org/viewvc/forrest/site/docs_0_70/changes.html?rev=423401&r1=423400&r2=423401&view=diff
==============================================================================
--- forrest/site/docs_0_70/changes.html (original)
+++ forrest/site/docs_0_70/changes.html Wed Jul 19 01:21:05 2006
@@ -518,11 +518,6 @@
<ul>
<li>
<img class="icon" alt="add" src="../images/add.jpg">
- Add document about project
- <a href="../roles.html">roles</a>.
- Committed by DC.</li>
-<li>
-<img class="icon" alt="add" src="../images/add.jpg">
Added initial whiteboard input plugin "odt".
Use OpenDocument ODT as input.
Committed by TS.</li>
@@ -1056,7 +1051,7 @@
forrest.properties. <a
href="http://svn.apache.org/viewcvs.cgi?rev=215902&view=rev";>Diff</a>
Committed by TS.</li>
</ul>
-<a name="N10339"></a><a name="Changes+to+Documentation"></a>
+<a name="N10330"></a><a name="Changes+to+Documentation"></a>
<h3 class="underlined_5">Changes to Documentation</h3>
<ul>
<li>
@@ -1079,6 +1074,11 @@
<img class="icon" alt="add" src="../images/add.jpg">
Re-arrange documentation menus, added best practice and procedures
sections.
Committed by FSO.</li>
+<li>
+<img class="icon" alt="add" src="../images/add.jpg">
+ Add document about project
+ <a href="../roles.html">roles</a>.
+ Committed by DC.</li>
<li>
<img class="icon" alt="add" src="../images/add.jpg">
Add initial <a href="../docs_0_80/glossary.html">glossary</a> to
explain
Modified: forrest/site/docs_0_70/changes.pdf
URL:
http://svn.apache.org/viewvc/forrest/site/docs_0_70/changes.pdf?rev=423401&r1=423400&r2=423401&view=diff
==============================================================================
Binary files - no diff available.
Modified: forrest/site/docs_0_70/changes.rss
URL:
http://svn.apache.org/viewvc/forrest/site/docs_0_70/changes.rss?rev=423401&r1=423400&r2=423401&view=diff
==============================================================================
--- forrest/site/docs_0_70/changes.rss (original)
+++ forrest/site/docs_0_70/changes.rss Wed Jul 19 01:21:05 2006
@@ -181,7 +181,7 @@
Updated xerces to 2.8.0, xml-apis to 1.3.03, log4j to 1.2.13 and
ehcache to 1.2.
</description></item>
- <item><title>code add</title><link>changes.html</link><description>code
add
+ <item><title>docs add</title><link>changes.html</link><description>docs
add
by
DC
:
@@ -5643,7 +5643,7 @@
:
Updated xerces to 2.8.0, xml-apis to 1.3.03, log4j to 1.2.13 and
ehcache to 1.2.
- </description></item><item><title>code
add</title><link>changes.html</link><description>code add
+ </description></item><item><title>docs
add</title><link>changes.html</link><description>docs add
by
DC
:
Modified: forrest/site/docs_0_70/changes.xml
URL:
http://svn.apache.org/viewvc/forrest/site/docs_0_70/changes.xml?rev=423401&r1=423400&r2=423401&view=diff
==============================================================================
--- forrest/site/docs_0_70/changes.xml (original)
+++ forrest/site/docs_0_70/changes.xml Wed Jul 19 01:21:05 2006
@@ -11,9 +11,6 @@
<section><title>Changes to Build</title><ul><li><icon alt="add"
src="../images/add.jpg"/>
Add new build target "clean-build".
Committed by CD.</li></ul></section><section><title>Changes to the Code
Base</title><ul><li><icon alt="add" src="../images/add.jpg"/>
- Add document about project
- <link href="site:roles">roles</link>.
- Committed by DC.</li><li><icon alt="add" src="../images/add.jpg"/>
Added initial whiteboard input plugin "odt".
Use OpenDocument ODT as input.
Committed by TS.</li><li><icon alt="add" src="../images/add.jpg"/>
@@ -364,6 +361,9 @@
Committed by FSO.</li><li><icon alt="add" src="../images/add.jpg"/>
Re-arrange documentation menus, added best practice and procedures
sections.
Committed by FSO.</li><li><icon alt="add" src="../images/add.jpg"/>
+ Add document about project
+ <link href="site:roles">roles</link>.
+ Committed by DC.</li><li><icon alt="add" src="../images/add.jpg"/>
Add initial <link href="site:glossary">glossary</link> to explain
some Forrest terminology.
Committed by DC. Thanks to Gavin.</li><li><icon alt="add"
src="../images/add.jpg"/>
Modified: forrest/site/docs_0_80/changes.html
URL:
http://svn.apache.org/viewvc/forrest/site/docs_0_80/changes.html?rev=423401&r1=423400&r2=423401&view=diff
==============================================================================
--- forrest/site/docs_0_80/changes.html (original)
+++ forrest/site/docs_0_80/changes.html Wed Jul 19 01:21:05 2006
@@ -539,11 +539,6 @@
<ul>
<li>
<img class="icon" alt="add" src="../images/add.jpg">
- Add document about project
- <a href="../roles.html">roles</a>.
- Committed by DC.</li>
-<li>
-<img class="icon" alt="add" src="../images/add.jpg">
Added initial whiteboard input plugin "odt".
Use OpenDocument ODT as input.
Committed by TS.</li>
@@ -1077,7 +1072,7 @@
forrest.properties. <a
href="http://svn.apache.org/viewcvs.cgi?rev=215902&view=rev";>Diff</a>
Committed by TS.</li>
</ul>
-<a name="N10339"></a><a name="Changes+to+Documentation"></a>
+<a name="N10330"></a><a name="Changes+to+Documentation"></a>
<h3 class="underlined_5">Changes to Documentation</h3>
<ul>
<li>
@@ -1100,6 +1095,11 @@
<img class="icon" alt="add" src="../images/add.jpg">
Re-arrange documentation menus, added best practice and procedures
sections.
Committed by FSO.</li>
+<li>
+<img class="icon" alt="add" src="../images/add.jpg">
+ Add document about project
+ <a href="../roles.html">roles</a>.
+ Committed by DC.</li>
<li>
<img class="icon" alt="add" src="../images/add.jpg">
Add initial <a href="../docs_0_80/glossary.html">glossary</a> to
explain
Modified: forrest/site/docs_0_80/changes.pdf
URL:
http://svn.apache.org/viewvc/forrest/site/docs_0_80/changes.pdf?rev=423401&r1=423400&r2=423401&view=diff
==============================================================================
Binary files - no diff available.
Modified: forrest/site/docs_0_80/changes.rss
URL:
http://svn.apache.org/viewvc/forrest/site/docs_0_80/changes.rss?rev=423401&r1=423400&r2=423401&view=diff
==============================================================================
--- forrest/site/docs_0_80/changes.rss (original)
+++ forrest/site/docs_0_80/changes.rss Wed Jul 19 01:21:05 2006
@@ -181,7 +181,7 @@
Updated xerces to 2.8.0, xml-apis to 1.3.03, log4j to 1.2.13 and
ehcache to 1.2.
</description></item>
- <item><title>code add</title><link>changes.html</link><description>code
add
+ <item><title>docs add</title><link>changes.html</link><description>docs
add
by
DC
:
@@ -5643,7 +5643,7 @@
:
Updated xerces to 2.8.0, xml-apis to 1.3.03, log4j to 1.2.13 and
ehcache to 1.2.
- </description></item><item><title>code
add</title><link>changes.html</link><description>code add
+ </description></item><item><title>docs
add</title><link>changes.html</link><description>docs add
by
DC
:
Modified: forrest/site/docs_0_80/changes.xml
URL:
http://svn.apache.org/viewvc/forrest/site/docs_0_80/changes.xml?rev=423401&r1=423400&r2=423401&view=diff
==============================================================================
--- forrest/site/docs_0_80/changes.xml (original)
+++ forrest/site/docs_0_80/changes.xml Wed Jul 19 01:21:05 2006
@@ -11,9 +11,6 @@
<section><title>Changes to Build</title><ul><li><icon alt="add"
src="../images/add.jpg"/>
Add new build target "clean-build".
Committed by CD.</li></ul></section><section><title>Changes to the Code
Base</title><ul><li><icon alt="add" src="../images/add.jpg"/>
- Add document about project
- <link href="site:roles">roles</link>.
- Committed by DC.</li><li><icon alt="add" src="../images/add.jpg"/>
Added initial whiteboard input plugin "odt".
Use OpenDocument ODT as input.
Committed by TS.</li><li><icon alt="add" src="../images/add.jpg"/>
@@ -364,6 +361,9 @@
Committed by FSO.</li><li><icon alt="add" src="../images/add.jpg"/>
Re-arrange documentation menus, added best practice and procedures
sections.
Committed by FSO.</li><li><icon alt="add" src="../images/add.jpg"/>
+ Add document about project
+ <link href="site:roles">roles</link>.
+ Committed by DC.</li><li><icon alt="add" src="../images/add.jpg"/>
Add initial <link href="site:glossary">glossary</link> to explain
some Forrest terminology.
Committed by DC. Thanks to Gavin.</li><li><icon alt="add"
src="../images/add.jpg"/>
Modified: forrest/site/procedures/How_to_publish_docs.html
URL:
http://svn.apache.org/viewvc/forrest/site/procedures/How_to_publish_docs.html?rev=423401&r1=423400&r2=423401&view=diff
==============================================================================
--- forrest/site/procedures/How_to_publish_docs.html (original)
+++ forrest/site/procedures/How_to_publish_docs.html Wed Jul 19 01:21:05 2006
@@ -236,7 +236,10 @@
<div id="minitoc-area">
<ul class="minitoc">
<li>
-<a href="#About">About this Document</a>
+<a href="#About">Introduction</a>
+</li>
+<li>
+<a href="#forrestbot-local">Updating the site with a local forrestbot</a>
</li>
<li>
<a href="#OrgDoc">original docs</a>
@@ -245,28 +248,59 @@
</div>
-<a name="N10010"></a><a name="About"></a>
-<h2 class="underlined_10">About this Document</h2>
-<div class="section">
<div class="fixme">
<div class="label">Fixme (open)</div>
<div class="content">This is work in progress!</div>
</div>
-<p>All Documentation on Forrest and the Forrest-Project is managed as a
Forrest project located in the
- site-author-directory of Forrest head. The Forrest-Website is
updated by generating static pages from
- the site-author-project and committing them to the
forrest/site SVN, which is then
- 'svn checkout' on the forrest.apache.org webserver to create
the website.</p>
-<p>In this document you'll learn how make this happen.</p>
+
+<a name="N10014"></a><a name="About"></a>
+<h2 class="underlined_10">Introduction</h2>
+<div class="section">
+<p>All documentation about Apache Forrest is managed as a Forrest-built
project located in the
+ site-author directory of forrest/trunk SVN. The Apapce Forrest
website is updated by generating static pages from
+ the site-author-project and committing them to the forrest/site
SVN, which is then
+ 'svn checkout' on the forrest.apache.org webserver to create the
website.</p>
+<p>
+ See other notes for the Documentation Coordinator <a
href="../roles.html">role</a>.
+ </p>
+</div>
+
+<a name="N10025"></a><a name="forrestbot-local"></a>
+<h2 class="underlined_10">Updating the site with a local forrestbot</h2>
+<div class="section">
+<p>Generating and publishing the main docs is very easy using a local
forrestbot:
+ </p>
+<pre class="code">cd site-author
+forrest -f publish.xml build
+forrest -f publish.xml deploy</pre>
+<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>
+<pre class="code">ssh people.apache.org
+cd /www/forrest.apache.org
+svn update</pre>
+<p>
+ Publishing documentation for a particular plugin is done by:
+ </p>
+<pre class="code">cd plugins/myPluginName
+$FORREST_HOME/tools/ant/bin/ant deploy-docs</pre>
+<p>
+ See further information in the
+ <a
href="../docs_0_80/howto/howto-buildPlugin.html">buildPlugin</a> doc.
+ </p>
+<p>See some general notes about managing
+ <a href="http://www.apache.org/dev/project-site.html";>project
websites</a>.
+ </p>
</div>
-<a name="N10021"></a><a name="OrgDoc"></a>
+<a name="N10053"></a><a name="OrgDoc"></a>
<h2 class="underlined_10">original docs</h2>
<div class="section">
-<p>Move some content over from <a
href="../roles.html#documentation-coordinator">../roles.html#documentation-coordinator</a>.
- </p>
<p>There have been a few explantions of our docs processing on the forrest-dev
mail list.
- Need to glean the info from them. Here is the content of one:</p>
+ Need to glean the info from them. Here is the content of
some:</p>
<pre class="code">
To publish from trunk/site-author/
@@ -317,9 +351,25 @@
Just leave it out and forrestbot will use a default message.
</pre>
+<p>Some more notes that need to be integrated above ...
+ </p>
+<p>Note that forrestbot does not remove docs from the forrest/site SVN
(FOR-392).
+ So need to manually delete: 'cd /svn/forrest/site; svn delete
oldDoc'.
+ Then remove it from the forrestbot work directories:
+ 'cd $FORREST_HOME; rm build/forrest-docs/oldDoc; rm
work/svn-deploy/forrest-docs/oldDoc'.
+ </p>
+<p>
+The generated docs are in build/forrest-docs
+which is the name given to it in the forrestbot descriptor
(site-author/publish.xml).
+Here is a trick for reviewing changes that forrestbot is ready to deploy ...
+ </p>
+<pre class="code">
+forrest -f publish.xml build
+svn update work/svn-deploy/forrest-docs
+diff -rq build/forrest-docs work/svn-deploy/forrest-docs | grep -v
"\.svn"</pre>
</div>
-
-
+
+
</div>
<!--+
Modified: forrest/site/procedures/How_to_publish_docs.pdf
URL:
http://svn.apache.org/viewvc/forrest/site/procedures/How_to_publish_docs.pdf?rev=423401&r1=423400&r2=423401&view=diff
==============================================================================
Binary files - no diff available.
Modified: forrest/site/roles.html
URL:
http://svn.apache.org/viewvc/forrest/site/roles.html?rev=423401&r1=423400&r2=423401&view=diff
==============================================================================
--- forrest/site/roles.html (original)
+++ forrest/site/roles.html Wed Jul 19 01:21:05 2006
@@ -368,36 +368,11 @@
</p>
<p>This role is not actually about doing the documentation. That should
be up to everyone.</p>
-<p>Generating and publishing the main docs is very easy using a local
forrestbot:</p>
-<pre class="code">cd site-author
-forrest -f publish.xml build
-forrest -f publish.xml deploy</pre>
-<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>
-<pre class="code">ssh people.apache.org
-cd /www/forrest.apache.org
-svn update</pre>
-<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 delete: 'cd /svn/forrest/site; svn delete
oldDoc'.
- Then remove it from the forrestbot work directories:
- 'cd $FORREST_HOME; rm build/forrest-docs/oldDoc; rm
work/svn-deploy/forrest-docs/oldDoc'.
- </p>
-<p>
- Publishing documentation for a particular plugin is done by:
- </p>
-<pre class="code">cd plugins/myPluginName
-$FORREST_HOME/tools/ant/bin/ant deploy-docs</pre>
-<p>
- See further information in the
- <a href="docs_0_80/howto/howto-buildPlugin.html">buildPlugin</a> doc.
+<p>Generating and publishing the main docs is very easy using a local
forrestbot:
+ See
+ <a href="procedures/How_to_publish_docs.html">How to publish Forrest
documentation</a>.
</p>
-<a name="N100D0"></a><a name="subversion-monitor"></a>
+<a name="N100AD"></a><a name="subversion-monitor"></a>
<h3 class="underlined_5">Subversion Monitor</h3>
<p>Ensure that svn:eol-style settings are "native" for all text files.</p>
<p>Ensure no line-endings issues.</p>
@@ -407,7 +382,7 @@
"<a
href="https://svn.apache.org/repos/private/committers";>committers</a>"
SVN in the "tools" directory.
</p>
-<a name="N100EA"></a><a name="legal-monitor"></a>
+<a name="N100C7"></a><a name="legal-monitor"></a>
<h3 class="underlined_5">Legal Monitor</h3>
<p>Regularly run a script which verifies and inserts missing license
headers to source files.
@@ -423,7 +398,7 @@
"<a
href="https://svn.apache.org/repos/private/committers";>committers</a>"
SVN in the "tools" and "relicense/src/perl" directories.
</p>
-<a name="N10101"></a><a name="developer"></a>
+<a name="N100DE"></a><a name="developer"></a>
<h3 class="underlined_5">Developer</h3>
<p>The above roles are only for PMC Members. How can the Developers be
involved? That is easy: do the Developer Role.
Modified: forrest/site/roles.pdf
URL:
http://svn.apache.org/viewvc/forrest/site/roles.pdf?rev=423401&r1=423400&r2=423401&view=diff
==============================================================================
Binary files - no diff available.
