You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@ws.apache.org by te...@apache.org on 2003/09/17 12:26:48 UTC

cvs commit: ws-site/src/documentation/content/xdocs howtobuild.xml

tetsuya     2003/09/17 03:26:48

  Added:       src/documentation/content/xdocs howtobuild.xml
  Log:
  HowToBuild: User Manual of Building WebServices Project Website
  
  Revision  Changes    Path
  1.1                  ws-site/src/documentation/content/xdocs/howtobuild.xml
  
  Index: howtobuild.xml
  ===================================================================
  <?xml version="1.0" encoding="UTF-8"?>
  <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN" "../dtd/document-v11.dtd">
  
  <document>
      <header>
          <title>How To Build Web Services Project's Website</title>
          <authors>
              <person email="tetsuya@apache.org" name="Tetsuya Kitahata" id="TK"/>
          </authors>
      </header>
      <body>
          <section>
              <title>Installing Forrest</title>
              <p>
                  The Web Services website build system requires two components to perform a build.
                  <link href="ext:ant">Ant</link> and
                  <link href="ext:forrest">forrest</link>.
              </p>
              <p>
                  Specifically the build has been tested to work with Ant version
                  1.6 alpha and Forrest 0.5.  To install these products download
                  the distributions and follow the instructions in their
                  documentation.  Make sure you don't forget to set the
                  environment variables FORREST_HOME and ANT_HOME.  The
                  ANT_HOME/bin directory should be in the path.
              </p>
          </section>
          <section>
              <title>Checking out ws-site module</title>
              <p>
                  Check out
              </p>
              <p>
                  ws-site
              </p>
              <p>
                  module via your favorite CVS tools. Please follow the guildeline written <link href="site:cvs">here</link>.
              </p>
          </section>
          <section>
              <title>Running the Build</title>
              <p>
                  The main targets of interest to our users are:
              </p>
              <table>
                  <tr>
                      <th>Target</th>
                      <th>Description</th>
                  </tr>
                  <tr>
                      <td>clean</td>
                      <td>Erase all build work products (ie, everything in the
                          build directory</td>
                  </tr>
                  <tr>
                      <td>site</td>
                      <td>Build site</td>
                  </tr>
                  <tr>
                      <td>run-forrest (default)</td>
                      <td>Do clean up and build Site</td>
                  </tr>
              </table>
          </section>
          <section>
              <title>F.A.Q.</title>
              <p><em>Q1.</em><br/>
                  I encountered<br/>
                  The &lt;xmlcatalog&gt; data type doesn't support the nested &quot;catalogpath&quot; element.<br/>
                  error, during the build.
              </p>
              <p>
              <em>A1.</em><br/>
              Please make sure that your Ant version is later than 1.6 alpha. You can check the Ant version, by running &quot;ant -version&quot;.
              </p>
              <p>
              <strong>( more to be come )</strong>
              </p>
          </section>
      </body>
  </document>