cvs commit: incubator-directory/www/subprojects/sitedocs index.html

[ak...@apache.org]

akarasulu    2004/02/03 20:08:40

  Modified:    www/subprojects/sitedocs index.html
  Log:
  forgot to talk about stubs and the maven.xml file changes
  
  Revision  Changes    Path
  1.6       +99 -0     incubator-directory/www/subprojects/sitedocs/index.html
  
  Index: index.html
  ===================================================================
  RCS file: /home/cvs/incubator-directory/www/subprojects/sitedocs/index.html,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -r1.5 -r1.6
  --- index.html	4 Feb 2004 03:45:23 -0000	1.5
  +++ index.html	4 Feb 2004 04:08:40 -0000	1.6
  @@ -788,6 +788,55 @@
           </h3>
         
         
  +    <p>
  +      
  +        At the present time there are stubs that have been placed
  +        into the respective directories for the subprojects.  So under 
  +    <b>
  +      
  +        sitedocs/xdocs/subprojects
  +    </b>
  +    where subproject directories are 
  +        contained a stub 
  +    <b>
  +      
  +    <em>
  +      index.xml
  +    </em>
  +   
  +    </b>
  +    and 
  +    <b>
  +      
  +    <em>
  +      navigation.xml
  +        
  +    </em>
  +   
  +    </b>
  +    will be found.
  +      
  +    </p>
  +   
  +    <p>
  +      
  +        We have done this to prevent users from encountering broken links on the
  +        site.  Once you have built your subproject's site and are sure it works
  +        remove the respective stubs for your subproject.  If you do not do so
  +        your content may be over written by the stubs if someone deploys the
  +        top level site without generating your subproject's content.  So please
  +        rm these stubs from the repository once your subproject is up. 
  +      
  +    </p>
  +   
  +    <p>
  +      
  +        Below we point out all the files and changes that need to be made in
  +        order to make your subproject integrate into the top level site to
  +        maintain a consistant look and feel.
  +      
  +    </p>
  +   
       <div class="h4">
         
         
  @@ -985,6 +1034,56 @@
           </pre>
       </div>
     
  +    </div>
  +  
  +    <div class="h4">
  +      
  +      
  +        <h4>
  +          <a name="maven.xml">maven.xml</a>
  +        </h4>
  +      
  +      
  +    <p>
  +      
  +          Some scripting is required within the maven jelly scripting file for
  +          your project.  As you may already know this maven.xml file sits at
  +          your projects top level directory along side your project.xml file.
  +          Here's what you have to add to it:
  +        
  +    </p>
  +   
  +    <div id="source">
  +      <pre>
  +  &lt;postGoal name="site"&gt;
  +    &lt;attainGoal name="subproject:collectdocs"/&gt;
  +  &lt;/postGoal&gt;
  +
  +  &lt;goal name="subproject:collectdocs"&gt;
  +    &lt;ant:copy toDir="../../../sitedocs/trunk/sitedocs/target/docs/subprojects/[subproject-name]"&gt;
  +      &lt;ant:fileSet dir="${basedir}/target/docs"&gt;
  +        &lt;ant:include name="**"/&gt;
  +      &lt;/ant:fileSet&gt;
  +    &lt;/ant:copy&gt;
  +  &lt;/goal&gt;
  +        </pre>
  +    </div>
  +  
  +    <p>
  +      
  +          This Jelly code sets up a new goal to execute after the subproject's
  +          site has been built.  It is called 
  +    <em>
  +      subproject:collectdocs
  +    </em>
  +   .
  +          Make sure you edit the toDir attribute value on the &lt;ant:copy&gt;
  +          tag to use your subprojects destination directory.  It will copy the
  +          generated output of your subproject site build under the sitedocs
  +          directory in the respective position.
  +        
  +    </p>
  +   
       </div>
     
       <div class="h4">