Modified: forrest/trunk/site-author/content/xdocs/trash/docs_0_50/upgrading_05.xml URL: http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/trash/docs_0_50/upgrading_05.xml?view=diff&rev=527010&r1=527009&r2=527010 ============================================================================== --- forrest/trunk/site-author/content/xdocs/trash/docs_0_50/upgrading_05.xml (original) +++ forrest/trunk/site-author/content/xdocs/trash/docs_0_50/upgrading_05.xml Mon Apr 9 20:48:52 2007 @@ -16,29 +16,30 @@ limitations under the License. --> <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.2//EN" "http://forrest.apache.org/dtd/document-v12.dtd";> -<document> - <header> - <title>Upgrading to Forrest 0.5</title> +<document> + <header> + <title>Upgrading to Forrest 0.5</title> <version>$Revision: 1.8 $</version> - </header> - <body> + </header> + <body> <section> <title>Introduction</title> <p> - This page describes changes to Forrest that affect people who are - upgrading from 0.4 and earlier to the 0.5 version. - Please post your upgrade experiences to the - <link href="site:mail-lists/forrest-dev">forrest-dev mailing list</link>. - As more experience is gained, this document will be updated. + This page describes changes to Forrest that affect people who are + upgrading from 0.4 and earlier to the 0.5 version. Please post your + upgrade experiences to the + <link href="site:mail-lists/forrest-dev">forrest-dev mailing + list</link>. As more experience is gained, this document will be + updated. </p> </section> - <section> <title>New Features</title> - <p>This new version includes many changes, as it as been under - development for seven months (in part, awaiting the Cocoon 2.1 release). - The following list shows some of the key new features for Forrest 0.5 - (for the full list of changes, see the + <p> + This new version includes many changes, as it as been under development + for seven months (in part, awaiting the Cocoon 2.1 release). The + following list shows some of the key new features for Forrest 0.5 (for + the full list of changes, see the <link href="site:v0.50//changes">change log</link>). </p> <ul> @@ -49,37 +50,27 @@ for standard rendering. For rendering as full DocBook, see <link href="site:v0.50//faq/docbook">this FAQ entry</link>. </li> - <li>Configuration of URLs to ignore with cli.xconf configuration.</li> - <li>Skin enhancements.</li> - <li>The document-v12 DTDs are added. You can still use the old document-v11 DTDs if you would rather. However it is easy to upgrade - just change the document type declarations in you project's xdocs and run '<code>forrest validate-xdocs</code>'.</li> - <li>Automated handling of documents in Wiki syntax. See the fresh-site example which are generated when you '<code>forrest seed</code>' a new project.</li> - <li>The '<code>forrest backcopy</code>' target copies all types of content that you may have edited under the webapp while doing a '<code>forrest run</code>'.</li> - <li>Flag for email obfuscation.</li> - <li>Support for raw un-processed content. See <link href="site:v0.50//faq/link_raw">this FAQ entry</link>. </li> - <li>Element <code><abstract></code> is now rendered in the HTML output.</li> - <li>Images scale properly in PDF output. See also <link href="site:v0.50//faq/pdf_images">this FAQ entry</link>. </li> - <li>Configurable table-of-content depth with new 'toc' element in the <code>skinconf.xml</code> configuration.</li> </ul> @@ -87,14 +78,19 @@ <section> <title>Upgrading the sitemap</title> <p> - In brief, Forrest 0.5 is <em>mostly</em> backwards-compatible for sites that do not define a custom sitemap. - Between 0.4 and 0.5, the Forrest sitemap was completely rewritten. Instead of a single sitemap.xmap doing - everything, a 'driver' sitemap.xmap now delegates to a number of mounted subsitemaps handling different functional - areas. The new sitemap is fully described in the <link href="site:v0.50//sitemap-ref">Sitemap Reference</link>. - </p> - <p>Users that have overridden and augmented the Forrest 0.4 sitemap.xmap - (run '<code>forrest overrides</code>' to see if your project has) - will need to:</p> + In brief, Forrest 0.5 is <em>mostly</em> backwards-compatible for sites + that do not define a custom sitemap. Between 0.4 and 0.5, the Forrest + sitemap was completely rewritten. Instead of a single sitemap.xmap doing + everything, a 'driver' sitemap.xmap now delegates to a number of mounted + subsitemaps handling different functional areas. The new sitemap is + fully described in the <link href="site:v0.50//sitemap-ref">Sitemap + Reference</link>. + </p> + <p> + Users that have overridden and augmented the Forrest 0.4 sitemap.xmap + (run '<code>forrest overrides</code>' to see if your project has) will + need to: + </p> <ol> <li>Move their overridden sitemap (<code>src/documentation/sitemap.xmap</code>) out the way</li> <li>Copy the new sitemap, $FORREST_HOME/context/sitemap.xmap, to <code>src/documentation</code></li> @@ -104,110 +100,142 @@ Forrest 0.4 sitemap</link>.</li> </ol> </section> - <section> <title>Version-specific sitemaps</title> - <p>Forrest 0.5 now supports <em>version-specific sitemaps</em>. Ie., if your project's overridden sitemap is - called <code>sitemap-0.5.xmap</code>, then this sitemap will be used in preference to - <code>sitemap.xmap</code>, or any other sitemap-*.xmap variants.</p> - <p>So if, for example, one has:</p> + <p> + Forrest 0.5 now supports <em>version-specific sitemaps</em>. Ie., if + your project's overridden sitemap is called + <code>sitemap-0.5.xmap</code>, then this sitemap will be used in + preference to <code>sitemap.xmap</code>, or any other sitemap-*.xmap + variants. + </p> + <p> + So if, for example, one has: + </p> <source> src/documentation/sitemap.xmap src/documentation/sitemap-0.5.xmap </source> - <p>Then Forrest 0.4 will use sitemap.xmap, and Forrest 0.5 will use sitemap-0.5.xmap. This means users don't - need to all upgrade to 0.5 at once.</p> - <p>As Forrest 0.5 has been split into multiple sitemaps, this version-specific behaviour is triggered for any - *-0.5.xmap file. For example, if one has:</p> + <p> + Then Forrest 0.4 will use sitemap.xmap, and Forrest 0.5 will use + sitemap-0.5.xmap. This means users don't need to all upgrade to 0.5 at + once. + </p> + <p> + As Forrest 0.5 has been split into multiple sitemaps, this + version-specific behaviour is triggered for any *-0.5.xmap file. For + example, if one has: + </p> <source> src/documentation/sitemap.xmap src/documentation/forrest-0.5.xmap </source> - <p>Then Forrest 0.4 will use sitemap.xmap, and Forrest 0.5 will use Forrest's own sitemap.xmap, plus the - user-defined forrest-0.5.xmap file.</p> - <p>The same system prevents future compatibility problems, so Forrest 0.5 should continue to work when future - (incompatible) sitemaps are present:</p> + <p> + Then Forrest 0.4 will use sitemap.xmap, and Forrest 0.5 will use + Forrest's own sitemap.xmap, plus the user-defined forrest-0.5.xmap file. + </p> + <p> + The same system prevents future compatibility problems, so Forrest 0.5 + should continue to work when future (incompatible) sitemaps are present: + </p> <source> src/documentation/sitemap.xmap src/documentation/sitemap-0.5.xmap src/documentation/sitemap-0.6.xmap src/documentation/sitemap-0.7.xmap </source> - <note>If your <code>forrest.properties</code> defines the - <code>forrest.validate.sitemap.{includes,excludes}</code> properties, these will have to be updated to prevent - validation of sitemaps from unused versions. If undefined, Forrest will only validate sitemaps from the - current version.</note> + <note> + If your <code>forrest.properties</code> defines the + <code>forrest.validate.sitemap.{includes,excludes}</code> properties, + these will have to be updated to prevent validation of sitemaps from + unused versions. If undefined, Forrest will only validate sitemaps from + the current version. + </note> </section> <section> <title>Excluding URLs: filterlinks.xsl removed and cli.xconf added</title> - <p>In Forrest 0.4 certain URLs could be excluded from command-line - processing by overriding and editing - <code>filterlinks.xsl</code> and so excluding the link nodes. - </p> - <p>Forrest 0.5 uses the re-written command-line from Cocoon 2.1.1 which, - apart from being much faster, - <strong>does not use filterlinks.xsl</strong>. Instead, patterns for - command-line inclusion and exclusion can be specified in cli.xconf, - as described in - <link href="site:v0.50//faq/cli-xconf">this FAQ entry</link>. There is - already a default cli.xconf but you can over-ride that with your own if - needed by copying <code>resources/conf/cli.xconf</code> from the Forrest - distribution into your project's top-level directory. + <p> + In Forrest 0.4 certain URLs could be excluded from command-line + processing by overriding and editing <code>filterlinks.xsl</code> and so + excluding the link nodes. + </p> + <p> + Forrest 0.5 uses the re-written command-line from Cocoon 2.1.1 which, + apart from being much faster, <strong>does not use + filterlinks.xsl</strong>. Instead, patterns for command-line inclusion + and exclusion can be specified in cli.xconf, as described in + <link href="site:v0.50//faq/cli-xconf">this FAQ entry</link>. There is + already a default cli.xconf but you can over-ride that with your own if + needed by copying <code>resources/conf/cli.xconf</code> from the Forrest + distribution into your project's top-level directory. </p> </section> - <section> <title>Skin invocation changes</title> - <p>Users with custom skins <em>may</em> need to update them, depending on what use they make of passed-in XSLT - parameters. If your custom skin does not appear to work with 0.5, look in Forrest's <code>sitemap.xmap</code> - for occurrences of <code>{forrest:forrest.skin}</code>, and check that the callee (your XSLT) is expecting what the - caller (the sitemap) is passing it. Forrest skins can be used as a reference.</p> + <p> + Users with custom skins <em>may</em> need to update them, depending on + what use they make of passed-in XSLT parameters. If your custom skin + does not appear to work with 0.5, look in Forrest's + <code>sitemap.xmap</code> for occurrences of + <code>{forrest:forrest.skin}</code>, and check that the callee (your + XSLT) is expecting what the caller (the sitemap) is passing it. Forrest + skins can be used as a reference. + </p> </section> - <section> <title>Upgrading skinconf.xml</title> - <p>Look at the - <link href="http://cvs.apache.org/viewcvs/xml-forrest/src/resources/fresh-site/src/documentation/skinconf.xml.diff?r1=1.7%3AFORREST_04&r2=1.15%3AFORREST_05&diff_format=h";>differences - for the sample skinconf.xml</link> as a guide. - You will need to update the internal DTD and add several new elements. + <p> + Look at the + <link href="http://cvs.apache.org/viewcvs/xml-forrest/src/resources/fresh-site/src/documentation/skinconf.xml.diff?r1=1.7%3AFORREST_04&r2=1.15%3AFORREST_05&diff_format=h";>differences + for the sample skinconf.xml</link> as a guide. You will need to update + the internal DTD and add several new elements. </p> </section> - <section> <title>Upgrading forrest.properties</title> - <p>Look at the - <link href="http://cvs.apache.org/viewcvs/xml-forrest/src/resources/fresh-site/forrest.properties.diff?r1=1.20%3AFORREST_04&r2=1.32%3AFORREST_05&diff_format=h";>differences + <p> + Look at the + <link href="http://cvs.apache.org/viewcvs/xml-forrest/src/resources/fresh-site/forrest.properties.diff?r1=1.20%3AFORREST_04&r2=1.32%3AFORREST_05&diff_format=h";>differences for the sample forrest.properties</link> as a guide. Note that project.sitemap has changed to project.sitemap-dir and note that - cli.xconf now controls some settings that were previously controlled - by forrest.properties, such as project.start-uri + cli.xconf now controls some settings that were previously controlled by + forrest.properties, such as project.start-uri </p> </section> - <section> <title>Run a clean target after upgrade</title> - <p>To avoid any issue with old classes being loaded, run a - '<code>forrest clean</code>' just after you upgraded to this version.</p> + <p> + To avoid any issue with old classes being loaded, run a '<code>forrest + clean</code>' just after you upgraded to this version. + </p> </section> - <section> <title>SVGs should omit DOCTYPE declarations</title> -<fixme author="forrest-dev">Is this note still relevant?</fixme> - <p>In Forrest 0.5, sites that render SVGs may encounter ClassCastExceptions:</p> + <fixme author="forrest-dev"> + Is this note still relevant? + </fixme> + <p> + In Forrest 0.5, sites that render SVGs may encounter + ClassCastExceptions: + </p> <source> javax.xml.transform.TransformerException: java.lang.ClassCastException at org.apache.xalan.transformer.TransformerImpl.transformNode(TransformerImpl.java:1326) at org.apache.xalan.transformer.TransformerImpl.run(TransformerImpl.java:3329) ...</source> - <p>There appears to be a bug in Cocoon 2.1.1's SVG component where the DTD associated with SVGs cannot be - resolved. The workaround is to edit your <code>src/documentation/resources/images/*.svg</code> files, and - comment out the <strong><!DOCTYPE ... ></strong> declaration.</p> + <p> + There appears to be a bug in Cocoon 2.1.1's SVG component where the DTD + associated with SVGs cannot be resolved. The workaround is to edit your + <code>src/documentation/resources/images/*.svg</code> files, and comment + out the <strong><!DOCTYPE ... ></strong> declaration. + </p> </section> - <section> <title>To be continued...</title> - <p>..as more issues are discovered/remembered :) Please send feedback to the - <link href="site:mail-lists/forrest-dev">mailing list</link>.</p> + <p> + ..as more issues are discovered/remembered :) Please send feedback to + the <link href="site:mail-lists/forrest-dev">mailing list</link>. + </p> </section> </body> </document>
Modified: forrest/trunk/site-author/content/xdocs/uri-namespace.xml URL: http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/uri-namespace.xml?view=diff&rev=527010&r1=527009&r2=527010 ============================================================================== --- forrest/trunk/site-author/content/xdocs/uri-namespace.xml (original) +++ forrest/trunk/site-author/content/xdocs/uri-namespace.xml Mon Apr 9 20:48:52 2007 @@ -16,147 +16,173 @@ limitations under the License. --> <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.2//EN" "http://forrest.apache.org/dtd/document-v12.dtd";> -<document> - <header> - <title>URI namespace description</title> +<document> + <header> + <title>URI namespace description</title> <subtitle>Background reading for the Forrest sitemap</subtitle> - <abstract>This document describes the URI request namespace as being - declared and supported by Forrest. Its concrete implementation can be found in - Forrest's Cocoon sitemap.</abstract> - </header> - <body> - <p>Since Forrest uses Cocoon as its documentation generation mechanism, it + <abstract> + This document describes the URI request namespace as being declared and + supported by Forrest. Its concrete implementation can be found in + Forrest's Cocoon sitemap. + </abstract> + </header> + <body> + <p> + Since Forrest uses Cocoon as its documentation generation mechanism, it ships with a Cocoon <link href="http://cocoon.apache.org/userdocs/concepts/sitemap.html";>sitemap</link> - stating the so-called URI namespace being declared by Forrest. So this document - serves as a background reader for people trying to understand the sitemap and - the internal workings of the Cocoon link crawling. It should answer questions - like "what kind of resources can I add to my project documentation" and "how - should I specify my links inside my documents so that they are correctly - processed by Forrest". This doesn't mean your HTML hypertext writing skills of - the past will not help you anymore while creating documents to be processed by - Forrest, but since Cocoon is a less forgiving (read: "best practices - enforcing") hypertext processing environment than the Web, there is a need for - an authorative source on URIs in the Forrest space. This document is meant to - be that source.</p> - <section> - <title>URI hierarchy</title> - <section> - <title>External</title> - <p><strong>Network protocol</strong> Currently, the only network protocol - that can be used to access Forrest resources is <em>HTTP</em>. Of course, you - can embed hypertext references to other protocols (<code>news:</code>, - <code>mailto:</code>, ...), but these links are not processed by the - crawler.</p> - <p><strong>Host</strong> Forrest publishes its generated documentation on - some server, so part of the URI namespace is the <em>host address</em>, i.e. - <code>xml.apache.org</code>,<code>intranetsrv2</code> or - <code>localhost</code>.</p> - <p><strong>Mountpoint</strong> Similar to so-called Java Web - Applications, a Forrest website URI is often prepended with a - <em>mountpoint</em>, indicating the root of the website shouldn't be found on - <code>http://somehost/</code>, but on <code>http://somehost/mountpoint/</code> - instead. Declaring a mountpoint is <em>optional</em> however.</p> - <p>Both <code>host</code> and <code>mountpoint</code> are passed into the - Forrest processing pipeline as Cocoon sitemap parameters and subsequently as - XSLT parameters too, which means they are accessible to skin designers. They - should be declared like:</p> - <ul> - <li><strong>host:</strong> <code>xml.apache.org</code> <em>(host - address)</em></li> - <li><strong>mountpoint:</strong> <code>forrest</code> <em>(projectname, - hence no trailing slash!)</em></li> - </ul> - <p>Forrest will add slashes in-between if needed.</p> - <note>It is currently undefined how these parameters will be configured - when running Forrest. This can be done using Ant-filtered copying of the - sitemap, or using some to-be-created Cocoon CLIInputModule.</note> - </section> - <section> - <title>Internal</title> - <p>Adding documents to your local documentation fileset means they will - become available across Forrest too. There exists however a naming convention - for a number of 'special' documents, which has to be taken into account. - Furthermore, Forrest adds a number of autogenerated resources.</p> + stating the so-called URI namespace being declared by Forrest. So this + document serves as a background reader for people trying to understand the + sitemap and the internal workings of the Cocoon link crawling. It should + answer questions like "what kind of resources can I add to my project + documentation" and "how should I specify my links inside my documents so + that they are correctly processed by Forrest". This doesn't mean your HTML + hypertext writing skills of the past will not help you anymore while + creating documents to be processed by Forrest, but since Cocoon is a less + forgiving (read: "best practices enforcing") hypertext processing + environment than the Web, there is a need for an authorative source on + URIs in the Forrest space. This document is meant to be that source. + </p> + <section> + <title>URI hierarchy</title> <section> - <title><code> (empty URI)</code></title> - <p>This URI is automatically redirected (server-side) to - <code>index.xml</code>. It serves as the root of your documentation site.</p> + <title>External</title> + <p> + <strong>Network protocol</strong> Currently, the only network protocol + that can be used to access Forrest resources is <em>HTTP</em>. Of + course, you can embed hypertext references to other protocols + (<code>news:</code>, <code>mailto:</code>, ...), but these links are + not processed by the crawler. + </p> + <p> + <strong>Host</strong> Forrest publishes its generated documentation on + some server, so part of the URI namespace is the <em>host + address</em>, i.e. + <code>xml.apache.org</code>,<code>intranetsrv2</code> or + <code>localhost</code>. + </p> + <p> + <strong>Mountpoint</strong> Similar to so-called Java Web + Applications, a Forrest website URI is often prepended with a + <em>mountpoint</em>, indicating the root of the website shouldn't be + found on <code>http://somehost/</code>, but on + <code>http://somehost/mountpoint/</code> instead. Declaring a + mountpoint is <em>optional</em> however. + </p> + <p> + Both <code>host</code> and <code>mountpoint</code> are passed into the + Forrest processing pipeline as Cocoon sitemap parameters and + subsequently as XSLT parameters too, which means they are accessible + to skin designers. They should be declared like: + </p> + <ul> + <li><strong>host:</strong><code>xml.apache.org</code><em>(host + address)</em></li> + <li><strong>mountpoint:</strong><code>forrest</code><em>(projectname, + hence no trailing slash!)</em></li> + </ul> + <p> + Forrest will add slashes in-between if needed. + </p> + <note> + It is currently undefined how these parameters will be configured when + running Forrest. This can be done using Ant-filtered copying of the + sitemap, or using some to-be-created Cocoon CLIInputModule. + </note> </section> <section> - <title><code>http://host/mountpoint/*.html</code></title> + <title>Internal</title> + <p> + Adding documents to your local documentation fileset means they will + become available across Forrest too. There exists however a naming + convention for a number of 'special' documents, which has to be taken + into account. Furthermore, Forrest adds a number of autogenerated + resources. + </p> + <section> + <title><code> (empty URI)</code></title> + <p> + This URI is automatically redirected (server-side) to + <code>index.xml</code>. It serves as the root of your documentation + site. + </p> + </section> + <section> + <title><code>http://host/mountpoint/*.html</code></title> + </section> </section> - </section> - </section> - <section> - <title>Media types</title> - <p>Forrest is able to explicitely process the following media types:</p> - <table> - <tr> - <th>Extension</th> - <th>Description</th> - </tr> - <tr> - <td>.html</td> - <td>Plain web pages (default rendition format)</td> - </tr> - <tr> - <td>.pdf</td> - <td>Acrobat files</td> - </tr> - <tr> - <td>.png</td> - <td>Portable Network Graphic files (preferred image format)</td> - </tr> - <tr> - <td>.gif</td> - <td>Compuserve GIF graphics</td> - </tr> - <tr> - <td>.jpg</td> - <td>JPEG graphics</td> - </tr> - <tr> - <td>.svg</td> - <td>Scalable Vector Graphics</td> - </tr> - <tr> - <td>.txt</td> - <td>plain text documents</td> - </tr> - <tr> - <td>.zip</td> - <td>compressed file archive</td> - </tr> - <tr> - <td>.tar</td> - <td>'tape' archives</td> - </tr> - <tr> - <td>.tar.gz</td> - <td>compressed tar file archives</td> - </tr> - <tr> - <td>.tar.bz2</td> - <td>compressed tar file archives</td> - </tr> - <tr> - <td>.jar</td> - <td>Java application archives</td> - </tr> - <tr> - <td>.war</td> - <td>Java web application archives</td> - </tr> - <tr> - <td>.ear</td> - <td>Java enterprise application archives</td> - </tr> - <tr> - <td>...</td> - <td>...</td> - </tr> - </table> - </section> + </section> + <section> + <title>Media types</title> + <p> + Forrest is able to explicitely process the following media types: + </p> + <table> + <tr> + <th>Extension</th> + <th>Description</th> + </tr> + <tr> + <td>.html</td> + <td>Plain web pages (default rendition format)</td> + </tr> + <tr> + <td>.pdf</td> + <td>Acrobat files</td> + </tr> + <tr> + <td>.png</td> + <td>Portable Network Graphic files (preferred image format)</td> + </tr> + <tr> + <td>.gif</td> + <td>Compuserve GIF graphics</td> + </tr> + <tr> + <td>.jpg</td> + <td>JPEG graphics</td> + </tr> + <tr> + <td>.svg</td> + <td>Scalable Vector Graphics</td> + </tr> + <tr> + <td>.txt</td> + <td>plain text documents</td> + </tr> + <tr> + <td>.zip</td> + <td>compressed file archive</td> + </tr> + <tr> + <td>.tar</td> + <td>'tape' archives</td> + </tr> + <tr> + <td>.tar.gz</td> + <td>compressed tar file archives</td> + </tr> + <tr> + <td>.tar.bz2</td> + <td>compressed tar file archives</td> + </tr> + <tr> + <td>.jar</td> + <td>Java application archives</td> + </tr> + <tr> + <td>.war</td> + <td>Java web application archives</td> + </tr> + <tr> + <td>.ear</td> + <td>Java enterprise application archives</td> + </tr> + <tr> + <td>...</td> + <td>...</td> + </tr> + </table> + </section> </body> </document> Modified: forrest/trunk/site-author/content/xdocs/versions.xml URL: http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/versions.xml?view=diff&rev=527010&r1=527009&r2=527010 ============================================================================== --- forrest/trunk/site-author/content/xdocs/versions.xml (original) +++ forrest/trunk/site-author/content/xdocs/versions.xml Mon Apr 9 20:48:52 2007 @@ -17,11 +17,15 @@ --> <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.2//EN" "http://forrest.apache.org/dtd/document-v12.dtd";> <document> - <header> - <title>Apache Forrest Documentation Versions</title> - </header> + <header> + <title>Apache Forrest Documentation Versions</title> + </header> <body> - <p>This sections contains version-specific documentation for Apache Forrest</p> - <p>See the <link href="../">Forrest Project</link> for main documents.</p> + <p> + This sections contains version-specific documentation for Apache Forrest + </p> + <p> + See the <link href="../">Forrest Project</link> for main documents. + </p> </body> </document> Modified: forrest/trunk/site-author/content/xdocs/who.xml URL: http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/who.xml?view=diff&rev=527010&r1=527009&r2=527010 ============================================================================== --- forrest/trunk/site-author/content/xdocs/who.xml (original) +++ forrest/trunk/site-author/content/xdocs/who.xml Mon Apr 9 20:48:52 2007 @@ -23,16 +23,18 @@ <body> <section id="community"> <title>The Forrest Community</title> - <p> The Forrest Project operates as a meritocracy: the more you do, the - more responsibility you will obtain. This page lists all of the people who have - gone the extra mile and are Committers. If you would like to get involved, the - first step is to join the mailing lists. </p> - <p> - Of course the committers are not the only people involved in the community. - Thanks to the many people for their contributions - of patches, assistance, ideas, and email discussion. - Some are mentioned at the <a href="site:changes">changes</a> page. - See how we <a href="guidelines.html#contribution">acknowledge</a> contributions. + <p> + The Forrest Project operates as a meritocracy: the more you do, the more + responsibility you will obtain. This page lists all of the people who + have gone the extra mile and are Committers. If you would like to get + involved, the first step is to join the mailing lists. + </p> + <p> + Of course the committers are not the only people involved in the + community. Thanks to the many people for their contributions of patches, + assistance, ideas, and email discussion. Some are mentioned at the + <a href="site:changes">changes</a> page. See how we + <a href="guidelines.html#contribution">acknowledge</a> contributions. </p> <p> Please do not send emails directly to individual developers asking for @@ -42,7 +44,10 @@ </section> <section id="committers"> <title>List of committers</title> - <p>List of all people who have ever been committers at Apache Forrest, sorted alphabetically.</p> + <p> + List of all people who have ever been committers at Apache Forrest, + sorted alphabetically. + </p> <ul> <li><em>[NKB] - Nicola Ken Barozzi (nicolaken.at.apache.org)</em></li> <li><strong>[DB] - Dave Brondsema (brondsem.at.apache.org)</strong></li> @@ -65,30 +70,38 @@ <li><strong>[FSO] - Ferdinand Soethe (ferdinand.at.apache.org)</strong></li> <li><strong>[RFT] - Rick F. Tessner (rick.at.apache.org)</strong></li> <li>[JT] - Jeff Turner (jefft.at.apache.org)</li> - <li><strong>[TW] - Tim Williams (twilliams.at.apache.org)</strong></li> + <li><strong>[TW] - Tim Williams (twilliams.at.apache.org)</strong></li> </ul> </section> <section id="notes"> <title>Notes</title> - <p>Strong type denotes "Project Management Committee (<a href="guidelines.html#pmc">PMC</a>) member". - Emphasis type denotes "emeritus PMC member". - See the <a href="guidelines.html#roles">ASF role definitions</a> for detailed role information. - The actual list of PMC members is in the SVN "committers" repository - at /board/committee-info.txt - </p> - <p>Some people were committers prior to Forrest becoming a top-level project and - so gaining a PMC. They were not around since then, so have never been on the PMC. - All new committers are <a href="guidelines.html#pmc-committers">encouraged</a> to be PMC members. + <p> + Strong type denotes "Project Management Committee + (<a href="guidelines.html#pmc">PMC</a>) member". Emphasis type denotes + "emeritus PMC member". See the <a href="guidelines.html#roles">ASF role + definitions</a> for detailed role information. The actual list of PMC + members is in the SVN "committers" repository at + /board/committee-info.txt + </p> + <p> + Some people were committers prior to Forrest becoming a top-level + project and so gaining a PMC. They were not around since then, so have + never been on the PMC. All new committers are + <a href="guidelines.html#pmc-committers">encouraged</a> to be PMC + members. </p> <p> Committers can be as active as they choose and there is no performance - pressure from the project. For those who are interested in the work - that each paticular committer has done, see the + pressure from the project. For those who are interested in the work that + each paticular committer has done, see the <a href="guidelines.html#contribution">acknowledgements</a> section. </p> - <p> All <a href="http://cocoon.apache.org/community/members.html";>Apache Cocoon committers</a> - and <a href="http://lenya.apache.org/community/acknowledgements.html";>Apache Lenya committers</a> - also have rights to commit to Forrest.</p> + <p> + All <a href="http://cocoon.apache.org/community/members.html";>Apache + Cocoon committers</a> and + <a href="http://lenya.apache.org/community/acknowledgements.html";>Apache + Lenya committers</a> also have rights to commit to Forrest. + </p> </section> </body> </document> Modified: forrest/trunk/site-author/content/xdocs/zone.xml URL: http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/zone.xml?view=diff&rev=527010&r1=527009&r2=527010 ============================================================================== --- forrest/trunk/site-author/content/xdocs/zone.xml (original) +++ forrest/trunk/site-author/content/xdocs/zone.xml Mon Apr 9 20:48:52 2007 @@ -24,190 +24,172 @@ <section id="overview"> <title>Overview</title> <p> - The server - <a href="ext:forrest-zone">forrest.zones.apache.org</a> - provides our testing and demonstration area. - It is managed by Apache Forrest committers. - The material is intended for developer use only. + The server <a href="ext:forrest-zone">forrest.zones.apache.org</a> + provides our testing and demonstration area. It is managed by Apache + Forrest committers. The material is intended for developer use only. </p> </section> - <section id="configuration"> <title>Configuration</title> <p> Configuration files and directory structures are stored in SVN at <code>https://svn.apache.org/repos/asf/forrest/zone</code> </p> - <p> <strong>config</strong> </p> <!-- FIXME: create better layout for notes, just dumping text inside source elements for now. --> -<source> + <source> creates /export/home/config ... $CONFIG directories /forrestbot-*/ are the forrestbot homes, see below. setenv*.sh ... these are sourced by the forrestbots and other cronjobs and user configs, to set the environment. </source> - <p> <strong>htdocs</strong> </p> -<source> + <source> creates /var/apache2/htdocs ... $DOC_ROOT directories /ft/ and /fts/ are the forrestbot config and results, see below. </source> - <p> <strong>test-sources</strong> </p> -<source> + <source> A place to hold sources for various test sites. Normally these would be in the relevant project's SVN. Hold them here until building properly. </source> - <p> All files are owned in the group "other" so any one of us can - edit/update. Make sure that your 'umask' is set properly so that - new files have group write permissions. - See the <a href="#admin-user">notes</a> about user administration. - FIXME: Add a proper group. + edit/update. Make sure that your 'umask' is set properly so that new + files have group write permissions. See the + <a href="#admin-user">notes</a> about user administration. FIXME: Add a + proper group. </p> <p> - Cron runs the various Forrestbots and management tasks, such as - updating the forrest-trunk software; cleaning up old logfiles, etc. - FIXME: These are not yet managed under SVN, see ~crossley/my-crontab.txt + Cron runs the various Forrestbots and management tasks, such as updating + the forrest-trunk software; cleaning up old logfiles, etc. FIXME: These + are not yet managed under SVN, see ~crossley/my-crontab.txt </p> </section> - <section id="software"> <title>Software</title> - <p> - Global zone software is as described in - <a href="http://www.apache.org/dev/solaris-zones.html";>zone administration</a>. - </p> - <p> - Various local software is installed in - <code>/export/opt/</code> (not managed with SVN) ... - </p> - + <p> + Global zone software is as described in + <a href="http://www.apache.org/dev/solaris-zones.html";>zone + administration</a>. + </p> + <p> + Various local software is installed in <code>/export/opt/</code> (not + managed with SVN) ... + </p> <section id="s-forrest"> <title>Forrest</title> - <p> <strong>forrest-trunk</strong> </p> -<source> + <source> svn checkout of trunk. automatically 'svn update' and 'build' via cron: $CONFIG/update-forrest-trunk.sh </source> - <p> <strong>forrest-trunk-stable</strong> </p> -<source> + <source> svn checkout of trunk, manually updated as needed. </source> - <p> <strong>forrest-release</strong> </p> -<source> + <source> svn checkout of current release branch, manually updated as needed. </source> - <p> To manually update -stable or -release do this: </p> - <source><![CDATA[ + <source> +<![CDATA[ source $CONFIG/setenv-java-14.sh cd /export/opt/forrest-trunk-stable svn up cd main ./build.sh clean; ./build.sh -]]></source> +]]> + </source> </section> </section> - <section id="fb"> <title>The forrestbots</title> <p> - There are various forrestbots operating with different versions - of forrest. - Their home is at $CONFIG + There are various forrestbots operating with different versions of + forrest. Their home is at $CONFIG </p> - <p> <strong>$CONFIG/forrestbot-trunk</strong> </p> -<source> + <source> forrestbot operating with trunk. builds various sites automatically, triggered via cron. Configuration files and the generated results are at $DOC_ROOT/ft/ FIXME: The web interface is coming soon. </source> - <p> <strong>$CONFIG/forrestbot-trunk-stable</strong> </p> -<source> + <source> forrestbot operating with trunk-stable. builds various sites, only runs when needed, triggered via cron. Configuration files and the generated results are at $DOC_ROOT/fts/ </source> - <p> - Forrestbot logs are at - $CONFIG/forrestbot-trunk*/logs/ - and old ones are cleaned up by the crontab. - There is also a log file for each site that forrestbot builds - which captures the output of cron (cronout-*.txt). - Be sure to verify this logfile after making configuration changes. + Forrestbot logs are at $CONFIG/forrestbot-trunk*/logs/ and old ones are + cleaned up by the crontab. There is also a log file for each site that + forrestbot builds which captures the output of cron (cronout-*.txt). Be + sure to verify this logfile after making configuration changes. </p> </section> - <section id="admin"> <title>Administration</title> <p> See the general notes for the - <a href="http://www.apache.org/dev/solaris-zones.html";>zone administration</a>. + <a href="http://www.apache.org/dev/solaris-zones.html";>zone + administration</a>. </p> <p> - The project chair is the root user. - Committers can ask on the dev list to get a user account added or modified. + The project chair is the root user. Committers can ask on the dev list + to get a user account added or modified. </p> <p> Follow Leo's config ideas at <a href="http://wiki.apache.org/gump/GumpZonesConfig";>GumpZonesConfig</a>. </p> <p> - Also 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. + Also 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> <p> - FIXME: - Start apache2 on boot (using new Solaris init.d replacement called smf). - At the moment we need to realise that it is down and manually - restart as per http://www.apache.org/dev/solaris-zones.html - Also it seems that /var/run/apache2 is wiped out on reboot, - so need to mkdir again. + FIXME: Start apache2 on boot (using new Solaris init.d replacement + called smf). At the moment we need to realise that it is down and + manually restart as per http://www.apache.org/dev/solaris-zones.html + Also it seems that /var/run/apache2 is wiped out on reboot, so need to + mkdir again. </p> - -<source> + <source> sudo mkdir /var/run/apache2 sudo /usr/apache2/bin/apachectl -k start </source> - <section id="admin-user"> <title>User administration</title> - <p>After receiving your account, please be sure to configure it properly.</p> - <p>See some notes at - <a href="http://www.apache.org/dev/solaris-zones.html";>zone administration</a> - and the general notes for - <a href="http://www.apache.org/dev/new-committers-guide.html#shell";>new committers</a> (especially the part about 'umask'). + <p> + After receiving your account, please be sure to configure it properly. + </p> + <p> + See some notes at + <a href="http://www.apache.org/dev/solaris-zones.html";>zone + administration</a> and the general notes for + <a href="http://www.apache.org/dev/new-committers-guide.html#shell";>new + committers</a> (especially the part about 'umask'). </p> <p> Look at the setup of some other users on our zone.
