axis-java-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From to...@apache.org
Subject cvs commit: ws-axis/site/src/documentation/content/xdocs howtobuild.xml site.xml
Date Tue, 26 Oct 2004 07:26:35 GMT
toshi       2004/10/26 00:26:35

  Modified:    site/src/documentation/content/xdocs site.xml
  Added:       site/src/documentation/content/xdocs howtobuild.xml
  Log:
  Add a new content for how to build Axis site.
  
  Revision  Changes    Path
  1.12      +1 -0      ws-axis/site/src/documentation/content/xdocs/site.xml
  
  Index: site.xml
  ===================================================================
  RCS file: /home/cvs/ws-axis/site/src/documentation/content/xdocs/site.xml,v
  retrieving revision 1.11
  retrieving revision 1.12
  diff -u -r1.11 -r1.12
  --- site.xml	13 Jul 2004 09:52:17 -0000	1.11
  +++ site.xml	26 Oct 2004 07:26:35 -0000	1.12
  @@ -26,6 +26,7 @@
     <mailinglist label="Mailing Lists" href="mail.html"/>
     <library label="Reference Library" href="ref.html" target="body"/>
     <bugs label="Bugs" href="bugs.html"/>
  +  <buildsite label="HowToBuildSite" href="howtobuild.html"/>
    </getinvolved>
    <axisjava label="Axis (Java)">
     <documentation label="Documentation" href="java/index.html"/>
  
  
  
  1.1                  ws-axis/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 Axis Project's Website</title>
          <authors>
              <person email="toshi@apache.org" name="Toshiyuki Kimura" />
          </authors>
      </header>
      <body>
          <section>
              <title>Installing Forrest</title>
              <p>
                  The Axis website build system requires two components to perform a build.<br/>
                  <link href="http://ant.apache.org/">Ant</link> and
                  <link href="http://forrest.apache.org/">Forrest</link>.
              </p>
              <p>
                  Specifically the build has been tested to work with Ant version
                  1.6.1 and Forrest 0.5.1. 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-axis and ws-site module</title>
              <p>
                  Check out <b>'ws-axis/site/src'</b> and <b>'ws-site/target/axis'</b>
                  module via your favorite CVS tools.<br/>
                  Please follow the guildeline written <link href="site:cvs">here</link>.
              </p>
          </section>
          <section>
              <title>Running the Build</title>
              <p>
                  Here's a list of targets for the ant task. But, what you need to do is just
"ant".
              </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>run-forrest</td>
                      <td>Run Forrest with Jetty server 
                          to review the target</td>
                  </tr>
                  <tr>
                      <td>run-browser</td>
                      <td>Invoke a web browser (ie, Internet Explorer)</td>
                  </tr>
                  <tr>
                      <td>backcopy</td>
                      <td>Reflect the updates on the build directory to
                          the master source on 'ws-axis/site/src'</td>
                  </tr>
                  <tr>
                      <td>forrest</td>
                      <td>Create the updated static contents</td>
                  </tr>
  
                  <tr>
                      <td>replace</td>
                      <td>Copy the contents to ws-site/targets/axis directory</td>
                  </tr>
                  <tr>
                      <td>build-site (default)</td>
                      <td>Do clean up and all tasks to the build site</td>
                  </tr>
              </table>
          </section>
          <section>
              <title>For Committers (Highly recommended)</title>
              <p>
                  The procedure to make changes to http://ws.apache.org/axis/ is:
              </p>
              <ul>
              <li>*cd* into the local <b>'ws-axis/site'</b> CVS dir</li>
              <li>execute <b>"ant"</b></li>
              <li>make changes to  <b>'build/webapp/content/xdocs'</b></li>
              <li><b>reload and review the contents</b> with the autostarted
browser</li>
              <li><b>close the browser and the forrest window</b> when you
are ready to
                  finish editing the site</li>
              <li>cvs commit (ie, <b>'ws-axis/site/src'</b> and 
                  <b>'ws-site/target/axis'</b>)</li>
              </ul>
          </section>
          <section>
              <title>Manual update (If you want to realize the value of ant tasks above
...)</title>
              <p>
              If you just want to update the site step-by-step, the followings
              are the instructions.
              </p>
  <PRE>
  1. Installing Forrest
      [Note] At this time, the version 0.5.1 of Forrest is tested version.
  
  2. Checking out 'ws-axis/site' module
      [ex]
      'ws-axis/site/src/documentation/content/xdocs/java/user-guide.ihtml'
  
  3. Make changes to the target
  
  4. Confirming the change with "forrest run"
     4-1) cd into the local "ws-axis/site" CVS dir
     4-2) execute "forrest run"
     4-3) have an access to http://localhost:8888/ to see the site
  
  5. Generating a static content with "forrest"
     5-1) execute "forrest" in the "ws-axis/site" dir
     5-2) check the generated contents in "ws-axis/site/build/site/"
  
  6. Make commitments
     6-1) commit the original source (xml/ihtml/gif/jpg) to "ws-axis"
     6-2) copy the generated contents into "ws-site/targets/axis"
     6-3) commit the generated contents to "ws-site"
  
  7. (Optional) If you are in a hurry to reflect the change to the site,
     cd to /www/ws.apache.org, and execute "cvs update -P" on minotaur.
  
     [Note] *** VERY IMPORTANT ***
        YOU HAVE TO CHECK YOUR UMASK IS "002" BEFORE DOING THE COMMAND,
      OR THE SITE WILL BECOME A NON-UPDATABLE SITE FROM THEN ON.
  
     The site will be updated automatically twice a day 12 midnight and
     12 noon PST by a cron job of dims.
  </PRE>
          </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><em>Q2.</em><br/>
  		I see an error like this regarding mirrors.pdf<br/>
  		[java] X [0]	mirrors.pdf BROKEN ....
  	    </p>
              <p><em>A2.</em><br/>
  		This is a known issue, but does not affect the site itself.
              </p>
              <p>
              <strong>( more to be come )</strong>
              </p>
          </section>
      </body>
  </document>
  
  

Mime
View raw message