You are viewing a plain text version of this content. The canonical link for it is here.
Posted to site-svn@forrest.apache.org by cr...@apache.org on 2011/01/10 09:55:04 UTC
svn commit: r1057128 - in /forrest/site:
docs_0_90/howto/howto-buildPlugin.html dtdx/document-v13.pdf
dtdx/document-v20.pdf forrest-issues.html zone.html
Author: crossley
Date: Mon Jan 10 08:55:03 2011
New Revision: 1057128
URL: http://svn.apache.org/viewvc?rev=1057128&view=rev
Log:
Publish from forrestbot
Modified:
forrest/site/docs_0_90/howto/howto-buildPlugin.html
forrest/site/dtdx/document-v13.pdf
forrest/site/dtdx/document-v20.pdf
forrest/site/forrest-issues.html
forrest/site/zone.html
Modified: forrest/site/docs_0_90/howto/howto-buildPlugin.html
URL: http://svn.apache.org/viewvc/forrest/site/docs_0_90/howto/howto-buildPlugin.html?rev=1057128&r1=1057127&r2=1057128&view=diff
==============================================================================
--- forrest/site/docs_0_90/howto/howto-buildPlugin.html (original)
+++ forrest/site/docs_0_90/howto/howto-buildPlugin.html Mon Jan 10 08:55:03 2011
@@ -814,18 +814,21 @@ document.write("Last Published: " + docu
<p>
When a plugin gains new functionality, then it will be dependent on a
more recent version of Forrest. Deploy the plugin one final time
- before implementing the new work. For example, if current release is
+ before implementing the new work. For example, if current Forrest release is
0.7 then ...
</p>
<ul>
<li>Review the docs and ensure any version numbers in text are "0.7"</li>
-<li>Edit the plugin's descriptors to ensure that the "forrestVersion" is 0.7 and that the "version" is appropriate. </li>
+<li>Edit the plugin's descriptors and build.xml file to ensure that the "forrestVersion" is 0.7 and that the "version" is appropriate. </li>
<li>Ensure that the "website" parameter includes "pluginDocs/plugins_0_70"</li>
-<li>Edit status.xml to set the release date. Ensure that the changes notes are complete.</li>
+<li>Edit status.xml to ensure that the changes notes are complete.</li>
+
+<li>Do <span class="codefrag">'ant deploy'</span> and <span class="codefrag">'ant release'</span> again
+ to get any final minor changes deployed.</li>
</ul>
<p>
@@ -837,16 +840,18 @@ document.write("Last Published: " + docu
<li>Review the docs and ensure any version numbers in text are
"0.8"</li>
-<li>Edit the plugin's descriptors to ensure that the "forrestVersion" is
+<li>Edit the plugin's descriptors and build.xml file to ensure that the "forrestVersion" is
0.8 and that the "version" is incremented. </li>
<li>Ensure that the "website" parameter includes "pluginDocs/plugins_0_80"</li>
-<li>Edit status.xml to add a new section and set the release date.
- Start adding changes notes.</li>
+<li>Edit status.xml to add a new section and set the release date to "not-yet-released".
+ Start adding changes notes and the new functionality.</li>
+
+<li>When ready do the plugin release process, and do <span class="codefrag">'ant deploy'</span> and <span class="codefrag">'ant release'</span> etc.</li>
</ul>
-<a name="N10205"></a><a name="register"></a>
+<a name="N10217"></a><a name="register"></a>
<h4>Register the Plugin with Apache Forrest</h4>
<div class="fixme">
<div class="label">Fixme (open)</div>
@@ -855,9 +860,9 @@ document.write("Last Published: " + docu
In the meantime just ask on the dev mail list.
</div>
</div>
-<a name="N10211"></a><a name="release"></a>
+<a name="N10223"></a><a name="release"></a>
<h3 class="underlined_5">Deploying and Releasing a Plugin</h3>
-<a name="N10217"></a><a name="explain-deploy"></a>
+<a name="N10229"></a><a name="explain-deploy"></a>
<h4>Explanation</h4>
<div class="fixme">
<div class="label">Fixme (open)</div>
@@ -877,7 +882,7 @@ document.write("Last Published: " + docu
<li>a text document at $FORREST_HOME/plugins/RELEASE_PROCESS.txt</li>
</ul>
-<a name="N1022F"></a><a name="deploy"></a>
+<a name="N10241"></a><a name="deploy"></a>
<h4>Deploying the Plugin</h4>
<p>
To deploy the plugin so that others can use it, it must be made
@@ -915,7 +920,7 @@ document.write("Last Published: " + docu
cycle, but we feel the peace of mind is worth it.
</div>
</div>
-<a name="N10262"></a><a name="experimental"></a>
+<a name="N10274"></a><a name="experimental"></a>
<h3 class="underlined_5">Experimental Functionality</h3>
<div class="warning">
<div class="label">Warning</div>
@@ -934,7 +939,7 @@ document.write("Last Published: " + docu
<span class="codefrag">org.apache.forrest.internal.NoteTaking</span> plugin.
</div>
</div>
-<a name="N10271"></a><a name="Locationmap"></a>
+<a name="N10283"></a><a name="Locationmap"></a>
<h4>Locationmap</h4>
<p>
Plugins can use the Forrest locationmap to expose resources to your
@@ -946,7 +951,7 @@ document.write("Last Published: " + docu
<a href="http://issues.apache.org/jira/browse/FOR-200">issue</a> for
the status of locationmap development.
</p>
-<a name="N10285"></a><a name="Dispatcher"></a>
+<a name="N10297"></a><a name="Dispatcher"></a>
<h4>Dispatcher</h4>
<p>
Dispatcher (previous codename Forrest Views) is the collective name
@@ -993,7 +998,7 @@ document.write("Last Published: " + docu
locationmap which is generated when you seed a new plugin, but for now
it must be done manually.
</p>
-<a name="N102A5"></a><a name="Plugin+Properties"></a>
+<a name="N102B7"></a><a name="Plugin+Properties"></a>
<h4>Plugin Properties</h4>
<p>
Plugins can define properties that each project can over-ride. For
@@ -1004,13 +1009,13 @@ document.write("Last Published: " + docu
<a href="http://issues.apache.org/jira/browse/FOR-588">issue</a> for
the status of this new configuration system.
</p>
-<a name="N102B7"></a><a name="examples"></a>
+<a name="N102C9"></a><a name="examples"></a>
<h3 class="underlined_5">Examples</h3>
<p>
This section will provide some example plugins to help illustrate the
steps discussed above.
</p>
-<a name="N102C0"></a><a name="input"></a>
+<a name="N102D2"></a><a name="input"></a>
<h4>Input Plugin</h4>
<div class="fixme">
<div class="label">Fixme (open)</div>
@@ -1018,7 +1023,7 @@ document.write("Last Published: " + docu
Discuss a simple example of an "input" plugin here.
</div>
</div>
-<a name="N102CB"></a><a name="output"></a>
+<a name="N102DD"></a><a name="output"></a>
<h4>Output Plugin</h4>
<div class="fixme">
<div class="label">Fixme (open)</div>
@@ -1026,7 +1031,7 @@ document.write("Last Published: " + docu
Discuss a simple example of an "output" plugin here.
</div>
</div>
-<a name="N102D6"></a><a name="internal"></a>
+<a name="N102E8"></a><a name="internal"></a>
<h4>Internal Plugin</h4>
<div class="fixme">
<div class="label">Fixme (open)</div>
@@ -1034,7 +1039,7 @@ document.write("Last Published: " + docu
Discuss a simple example of an "internal" plugin here.
</div>
</div>
-<a name="N102E2"></a><a name="extension"></a>
+<a name="N102F4"></a><a name="extension"></a>
<h3 class="underlined_5">Further Reading</h3>
<ul>
@@ -1045,7 +1050,7 @@ document.write("Last Published: " + docu
<a href="../../pluginDocs/plugins_0_90/">Plugins Documentation</a> for users</li>
</ul>
-<a name="N102F8"></a><a name="summarise"></a>
+<a name="N1030A"></a><a name="summarise"></a>
<h3 class="underlined_5">Summarise the Entire Process</h3>
<div class="fixme">
<div class="label">Fixme (open)</div>
Modified: forrest/site/dtdx/document-v13.pdf
URL: http://svn.apache.org/viewvc/forrest/site/dtdx/document-v13.pdf?rev=1057128&r1=1057127&r2=1057128&view=diff
==============================================================================
Binary files - no diff available.
Modified: forrest/site/dtdx/document-v20.pdf
URL: http://svn.apache.org/viewvc/forrest/site/dtdx/document-v20.pdf?rev=1057128&r1=1057127&r2=1057128&view=diff
==============================================================================
Binary files - no diff available.
Modified: forrest/site/forrest-issues.html
URL: http://svn.apache.org/viewvc/forrest/site/forrest-issues.html?rev=1057128&r1=1057127&r2=1057128&view=diff
==============================================================================
--- forrest/site/forrest-issues.html (original)
+++ forrest/site/forrest-issues.html Mon Jan 10 08:55:03 2011
@@ -222,9 +222,6 @@ document.write("Last Published: " + docu
<a href="#%5BFOR-644%5D+code-style+cleanup+for+xml+files">[FOR-644] code-style cleanup for xml files</a>
</li>
<li>
-<a href="#%5BFOR-1187%5D+upgraded+PDF+plugin+was+not+deployed+properly">[FOR-1187] upgraded PDF plugin was not deployed properly</a>
-</li>
-<li>
<a href="#%5BFOR-922%5D+update+all+docs+that+explain+sitemap+fragments">[FOR-922] update all docs that explain sitemap fragments</a>
</li>
</ul>
@@ -315,15 +312,7 @@ Perhaps there some way that we can word-
<p>We have much inconsistent whitespace in all of our files. This is known to cause trouble in a collaborative environment. See discussion at: <a href="http://marc.theaimsgroup.com/?t=112450901100001">http://marc.theaimsgroup.com/?t=112450901100001</a> and <a href="http://marc.theaimsgroup.com/?t=112495618800002">http://marc.theaimsgroup.com/?t=112495618800002</a> and various linked discussions.<br/>
</p>
</div>
-<a name="N10065"></a><a name="%5BFOR-1187%5D+upgraded+PDF+plugin+was+not+deployed+properly"></a>
-<h2 class="underlined_10">[FOR-1187] upgraded PDF plugin was not deployed properly</h2>
-<div class="section">
-<p>
-<a href="https://issues.apache.org:443/jira/browse/FOR-1187">https://issues.apache.org:443/jira/browse/FOR-1187</a>
-</p>
-<p>Around January 2008 the PDF plugin was upgraded, gaining functionality that was only relevant to forrest-0.9-dev. It was re-deployed without changing the version numbers in the plugin descriptor.</p>
-</div>
-<a name="N10071"></a><a name="%5BFOR-922%5D+update+all+docs+that+explain+sitemap+fragments"></a>
+<a name="N10065"></a><a name="%5BFOR-922%5D+update+all+docs+that+explain+sitemap+fragments"></a>
<h2 class="underlined_10">[FOR-922] update all docs that explain sitemap fragments</h2>
<div class="section">
<p>
Modified: forrest/site/zone.html
URL: http://svn.apache.org/viewvc/forrest/site/zone.html?rev=1057128&r1=1057127&r2=1057128&view=diff
==============================================================================
--- forrest/site/zone.html (original)
+++ forrest/site/zone.html Mon Jan 10 08:55:03 2011
@@ -276,9 +276,19 @@ document.write("Last Published: " + docu
provides our testing and demonstration area. It is managed by Apache
Forrest committers. The material is intended for developer use only.
</p>
+<div class="fixme">
+<div class="label">Fixme ()</div>
+<div class="content">
+ These notes are for our previous zone on the Solaris OS.
+ Much of this documentation will just need some tweaking.
+ The new zone (jail)
+ <a href="http://www.apache.org/dev/freebsd-jails.html">documentation</a>
+ needs to be referenced.
+ </div>
+</div>
</div>
-<a name="N1001C"></a><a name="configuration"></a>
+<a name="N10024"></a><a name="configuration"></a>
<h2 class="underlined_10">Configuration</h2>
<div class="section">
<p>
@@ -330,7 +340,7 @@ Hold them here until building properly.
</p>
</div>
-<a name="N10051"></a><a name="software"></a>
+<a name="N10059"></a><a name="software"></a>
<h2 class="underlined_10">Software</h2>
<div class="section">
<p>
@@ -348,7 +358,7 @@ Hold them here until building properly.
so should always come back up automatically after a failure or machine reboot.
</p>
-<a name="N1006B"></a><a name="s-forrest"></a>
+<a name="N10073"></a><a name="s-forrest"></a>
<h3 class="underlined_5">Forrest</h3>
<p>
@@ -389,7 +399,7 @@ cd main
</pre>
</div>
-<a name="N10098"></a><a name="fb"></a>
+<a name="N100A0"></a><a name="fb"></a>
<h2 class="underlined_10">The forrestbots</h2>
<div class="section">
<p>
@@ -424,7 +434,7 @@ Configuration files and the generated re
</p>
</div>
-<a name="N100B9"></a><a name="admin"></a>
+<a name="N100C1"></a><a name="admin"></a>
<h2 class="underlined_10">Administration</h2>
<div class="section">
<p>
@@ -473,7 +483,7 @@ Configuration files and the generated re
Keep an occasional eye on $CONFIG/update-forrest-trunk.log This is
the output of the cronjob to do svn update to trunk and re-build.
</p>
-<a name="N100FA"></a><a name="admin-user"></a>
+<a name="N10102"></a><a name="admin-user"></a>
<h3 class="underlined_5">User administration</h3>
<p>
After receiving your account, please be sure to configure it properly.
@@ -490,7 +500,7 @@ Configuration files and the generated re
</p>
</div>
-<a name="N10113"></a><a name="other"></a>
+<a name="N1011B"></a><a name="other"></a>
<h2 class="underlined_10">Other notes</h2>
<div class="section">
<ul>