Author: crossley
Date: Wed Apr 4 20:56:26 2007
New Revision: 525693
URL: http://svn.apache.org/viewvc?view=rev&rev=525693
Log:
Explain our scattered documentation.
Modified:
forrest/trunk/site-author/content/xdocs/docs_0_80/faq.xml
forrest/trunk/site-author/content/xdocs/docs_0_80/index.xml
forrest/trunk/site-author/content/xdocs/index.xml
forrest/trunk/site-author/content/xdocs/site.xml
forrest/trunk/site-author/status.xml
Modified: forrest/trunk/site-author/content/xdocs/docs_0_80/faq.xml
URL:
http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/docs_0_80/faq.xml?view=diff&rev=525693&r1=525692&r2=525693
==============================================================================
--- forrest/trunk/site-author/content/xdocs/docs_0_80/faq.xml (original)
+++ forrest/trunk/site-author/content/xdocs/docs_0_80/faq.xml Wed Apr 4
20:56:26 2007
@@ -36,6 +36,26 @@
<p> See the <link href="site:your-project">Using Forrest</link> guide.
</p>
</answer>
</faq>
+ <faq id="docs">
+ <question>Where is all of the documentation?</question>
+ <answer>
+ <p>
+ You have a local copy of the main documentation with your version of
Forrest.
+ Do 'cd site-author; forrest run' and visit http://localhost:8888/ in
your browser.
+ The most recent documentation is in SVN trunk which creates the
forrest.apache.org website.
+ </p>
+ <p>
+ Each <link href="site:plugins/index">plugin</link> has its own
documentation
+ and working example its techniques.
+ </p>
+ <p>
+ The example seed site has other documentation and working example of
various techniques.
+ Do 'cd my-new-directory; forrest seed-sample; forrest run'.
+ Every hour the forrestbot generates a static version of this
documentation on our
+ <link href="site:zone">testing zone</link>.
+ </p>
+ </answer>
+ </faq>
<faq id="requirements">
<question> What are the system requirements for Forrest? </question>
<answer>
Modified: forrest/trunk/site-author/content/xdocs/docs_0_80/index.xml
URL:
http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/docs_0_80/index.xml?view=diff&rev=525693&r1=525692&r2=525693
==============================================================================
--- forrest/trunk/site-author/content/xdocs/docs_0_80/index.xml (original)
+++ forrest/trunk/site-author/content/xdocs/docs_0_80/index.xml Wed Apr 4
20:56:26 2007
@@ -27,11 +27,13 @@
</p>
<p>In the <a href="howto/index.html">How-To</a> section you will find
various
practical guides on how to achieve common objectives in Forrest.</p>
- <p>We also have a <a href="faq.html">FAQ</a> that you should consult
before posting questions to
+ <p>We also have a <a href="faq.html">FAQ</a> list that you should
consult before posting questions to
our user list.</p>
<p>
The documentation <a href="site:linkmap">Table of Contents</a>
provides a
- useful overview of all documentation.
+ useful overview of the main documentation. <a
href="site:faq/docs">This FAQ</a>
+ explains that there is other documentation at the example forrest seed
+ site and that each plugin has its own documentation.
</p>
<p>
There are docs for
Modified: forrest/trunk/site-author/content/xdocs/index.xml
URL:
http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/index.xml?view=diff&rev=525693&r1=525692&r2=525693
==============================================================================
--- forrest/trunk/site-author/content/xdocs/index.xml (original)
+++ forrest/trunk/site-author/content/xdocs/index.xml Wed Apr 4 20:56:26 2007
@@ -201,11 +201,9 @@
Documentation on the Apache Forrest website exists for various versions
including the latest release, the current development, and past
releases.
All versions of Forrest include their own copy of the documentation.
- To view it, do 'cd site-author; forrest run' and visit
- http://localhost:8888/ in your browser.
- The <link href="site:forrest">Apache Forrest website</link> is updated
- manually as needed, while we develop the
- <link href="site:asf-forrestbot">forrestbot</link> deployment facility.
+ There is also documentation for each plugin and the forrest seed site
+ contains further examples and documentation (see
+ <link href="site:faq/docs">FAQ</link>).
</p>
</section>
<section id="news">
Modified: forrest/trunk/site-author/content/xdocs/site.xml
URL:
http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/site.xml?view=diff&rev=525693&r1=525692&r2=525693
==============================================================================
--- forrest/trunk/site-author/content/xdocs/site.xml (original)
+++ forrest/trunk/site-author/content/xdocs/site.xml Wed Apr 4 20:56:26 2007
@@ -331,6 +331,7 @@
<faq label="FAQs" href="faq.html">
<build_msg_a href="#build_msg_a"/>
<docbook href="#docbook"/>
+ <docs href="#docs"/>
<checksums href="#checksums"/>
<edit-content href="#edit-content"/>
<ignoring_javadocs href="#ignoring_javadocs"/>
Modified: forrest/trunk/site-author/status.xml
URL:
http://svn.apache.org/viewvc/forrest/trunk/site-author/status.xml?view=diff&rev=525693&r1=525692&r2=525693
==============================================================================
--- forrest/trunk/site-author/status.xml (original)
+++ forrest/trunk/site-author/status.xml Wed Apr 4 20:56:26 2007
@@ -143,6 +143,11 @@
</action>
<!--2007-04-->
<action dev="DC" type="add" context="docs">
+ Added <link href="site:faq/docs">notes</link> to explain the main
documentation,
+ as well as documentation and examples in each plugins and documentation
+ and examples in the 'forrest seed-sample' site.
+ </action>
+ <action dev="DC" type="add" context="docs">
Added notes about <link
href="site:validation/debug-catalog">debugging</link>
the XML Catalog Entity Resolver for local DTDs.
</action>
