forrest-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject cvs commit: xml-forrest index.html properties.xml
Date Wed, 12 Feb 2003 12:40:13 GMT
jefft       2003/02/12 04:40:13

  Modified:    .        index.html properties.xml
  Replace obsolete FAQ-type index.html content with how-to-get-started info, and
  fix properties.xml rendering
  Revision  Changes    Path
  1.6       +47 -89    xml-forrest/index.html
  Index: index.html
  RCS file: /home/cvs/xml-forrest/index.html,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -r1.5 -r1.6
  --- index.html	5 Nov 2002 01:51:06 -0000	1.5
  +++ index.html	12 Feb 2003 12:40:12 -0000	1.6
  @@ -97,9 +97,10 @@
               <td valign="top">
                 <li> <a
  - href="build/docs/index.html"
  + href="build/site/index.html"
    class="title">Documentation</a>          <br br="br">
  - (run "build docs" first)</li>
  + (run "build site" first)</li>
  + <!--
                 <li> <a
    class="title">Javadocs</a>         <br br="br">
  @@ -107,13 +108,13 @@
                 <li> <a
    class="title">Unit test results</a>        <br br="br">
  - (run "build test" first)</li>
  + (run "build test" first)</li> 
                 <li> <a
    class="title">Code metrics</a>         <br br="br">
  - (run "build metrics" first)</li>
  + (run "build metrics" first)</li> -->
                 <li> <a
  - href="build.number"
  + href="etc/build.number"
    class="title">Local build number</a>         <br br="br">
    (how many builds have been done locally)</li>
  @@ -123,9 +124,8 @@
                 <li> <a href=""
    class="title">Project Site</a>               <br br="br">
  -              <li> <a href=""
  - class="title">Krysalis Centipede build system site</a>               <br
  - br="br">
  + <li> <a href=""
  +	 class="title">Auto-generated project sites</a>               <br br="br">
  @@ -146,88 +146,46 @@
   content into a website via command-line, robot, or a dynamic web
  -<h3>&nbsp; Why?</h3>
  -&nbsp; If you ever participated in ASF open development you know why: there
  -is always<br>
  -&nbsp; the feeling that you are left on your own, that each project, effort,
  -&nbsp; community mail list and invidual has to struggle to keep up with the
  -others <br>
  -&nbsp; and to keep coherence.<br>
  -&nbsp; <br>
  -&nbsp; This effort was started by those who believe that a better and more
  -&nbsp; technical infrastructure is a first step in the right direction.<br>
  -&nbsp; <br>
  -&nbsp; <br>
  -<h3>&nbsp; Ok, better infrastructure, what what do you mean exactly?</h3>
  -&nbsp; Ever seen 'sourceforge'? ok, than you know what a technological <br>
  -&nbsp; insfrastructure for open development is. Ever seen Mozilla's 'tinkerbox'
  -and <br>
  -&nbsp; 'bonsai'? ok, then you know what we mean for 'helping tools'.<br>
  -&nbsp; <br>
  -&nbsp; Take all the wishes/dreams that you ever had when you were participating
  -&nbsp; an OSS community... well, we want Forrest to make them possible.<br>
  -&nbsp; <br>
  -<h3>&nbsp; Why the name 'Forrest'?</h3>
  -&nbsp; Oh, long story, but mainly out of the movie 'Forrest Gump', mostly<br>
  -&nbsp; to indicate that even dumb and simple things can go a long way when
  -done <br>
  -&nbsp; by heart.&nbsp; <br>
  -<h3>&nbsp; What will Forrest do?</h3>
  -&nbsp; The first development phase will bring:<br>
  -&nbsp; <br>
  -&nbsp;&nbsp; - a publishing system for documentation<br>
  -&nbsp;&nbsp; - analysis of logs and publishing of results<br>
  -&nbsp;&nbsp; <br>
  -&nbsp; Later phases will be decided after we reach this minimum functionality.<br>
  -<h3>&nbsp; Will I be able to use Forrest on my own sites?</h3>
  -&nbsp; We do Forrest for our own stuff, but there is no reason why we should<br>
  -&nbsp; restrict its use on external and unreleated sites.<br>
  -&nbsp; <br>
  -&nbsp; <br>
  -<h3>&nbsp; What will the license be?</h3>
  -&nbsp; The entire thing will be licensed with the Apache License. See the
  -&nbsp; directory for more information.<br>
  -&nbsp; <br>
  -<h3>&nbsp; Getting started</h3>
  -&nbsp; After you have downloaded the xml-forrest source, you can build the
  -&nbsp; Forrest documentation ...<br>
  -&nbsp; <br>
  -&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; UNIX:&nbsp;&nbsp;&nbsp;&nbsp;
  -./ docs <br>
  -&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Windows:&nbsp;
build docs<br>
  -&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <br>
  -&nbsp; The HTML documents are then generated in ./build/xml-forrest/docs/<br>
  -&nbsp; <br>
  -<h3>&nbsp; Can I help?</h3>
  -&nbsp; Of course! We need you! Even your wish-list is a good way of contributing...<br>
  -&nbsp; so please, send email to <br>
  -&nbsp; <br>
  -&nbsp;&nbsp;&nbsp; <br>
  -&nbsp; and join us!<br>
  -<br style="font-weight: bold;">
  -<span style="font-weight: bold;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
  -The Apache XML Project</span><br style="font-weight: bold;">
  -<span style="font-weight: bold;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
  +<h3>&nbsp; What do I do now?</h3>
  +You are using a 'source' distribution of Forrest.  You need to first build
  +Forrest, by typing <pre>build.bat</pre> (Windows) or <pre>./</pre>
  +This will create a "shbat" distribution in <pre>build/dist/shbat</pre>, or
  +whever the <pre>dist-shbat.dir</pre> property is set to.  You should now add
  +the <pre>build/dist/shbat/bin</pre> directory to your PATH variable. 
  +If you have done this correctly, you are now ready to test out Forrest!  Here
  +are three things to try:
  +	<li><b>Render the Forrest website</b> -- simply type <pre>forrest</pre>
  +	this (Forrest's source distribution) directory.  It should chug along for a
  +	good while (Forrest's site is quite large), and render the HTML and PDFs to
  +	<pre>build/site</pre>.</li>
  +	<li><b>Run a webapp of the Forrest site</b> -- type <pre>forrest
  +	in this directory.  You can then point your browser to <a
  +		href="http://localhost:8888/">http://localhost:8888/</a>, and view the
  +	Forrest website generated dynamically.  Experiment with editing docs in
  +	<pre>build/webapp/content/xdocs</pre>, and watch them be (nearly) instantly
  +	rendered.</li>
  -<address>       </address>
  +	<li><b>Generate your own site</b> -- create a new (clean) directory,
  +	type <pre>forrest seed</pre>.  This will generate a skeleton directory
  +	structure and template XML.  If you like, edit the XML in
  +	<pre>src/documentation/content/xdocs</pre>.  Now type <pre>forrest</pre>
  +	render your new site, or <pre>forrest run</pre> to generate a <a
  +		href="http://localhost:8888/">webapp</a>.
  +	</li>
  +For further information, please read our <a
  +	href="">Getting Started</a>
  +guide.  If you have any questions or suggestions, please subscribe to the <a
  +	href="">forrest-dev
  +	mailing list</a>.
  +Thanks for using Apache Forrest!
   <hr hr="hr">        Copyright &copy;2002 Apache Software Foundation. All rights
   reserved.         <br>
  1.3       +1 -1      xml-forrest/properties.xml
  Index: properties.xml
  RCS file: /home/cvs/xml-forrest/properties.xml,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- properties.xml	30 Oct 2002 08:52:11 -0000	1.2
  +++ properties.xml	12 Feb 2003 12:40:12 -0000	1.3
  @@ -1,5 +1,5 @@
   <?xml version="1.0"?>
  -<?xml-stylesheet type="text/xsl" href="tools/ant/stylesheets/properties.xsl"?>
  +<?xml-stylesheet type="text/xsl" href="tools/stylesheets/properties.xsl"?>
   <!-- Build properties - these override any property specified in the build -->

View raw message