harmony-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ge...@apache.org
Subject svn commit: r369496 - in /incubator/harmony/standard/site: docs/ docs/documentation/ xdocs/ xdocs/documentation/
Date Mon, 16 Jan 2006 15:29:24 GMT
Author: geirm
Date: Mon Jan 16 07:29:16 2006
New Revision: 369496

URL: http://svn.apache.org/viewcvs?rev=369496&view=rev
Log:
1) Added instructions to building the website, and
   put a link on the docs page
2) Added some more info on making contribs to the
   get-involved page


Added:
    incubator/harmony/standard/site/docs/documentation/build_website.html
    incubator/harmony/standard/site/xdocs/documentation/build_website.xml
Modified:
    incubator/harmony/standard/site/docs/documentation/documentation.html
    incubator/harmony/standard/site/docs/get-involved.html
    incubator/harmony/standard/site/xdocs/documentation/documentation.xml
    incubator/harmony/standard/site/xdocs/get-involved.xml

Added: incubator/harmony/standard/site/docs/documentation/build_website.html
URL: http://svn.apache.org/viewcvs/incubator/harmony/standard/site/docs/documentation/build_website.html?rev=369496&view=auto
==============================================================================
--- incubator/harmony/standard/site/docs/documentation/build_website.html (added)
+++ incubator/harmony/standard/site/docs/documentation/build_website.html Mon Jan 16 07:29:16
2006
@@ -0,0 +1,278 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+
+<!--
+Copyright 1999-2004 The Apache Software Foundation
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+
+
+<!-- Content Stylesheet for Site -->
+
+        
+<!-- start the processing -->
+    <!-- ====================================================================== -->
+    <!-- GENERATED FILE, DO NOT EDIT, EDIT THE XML FILE IN xdocs INSTEAD! -->
+    <!-- Main Page Section -->
+    <!-- ====================================================================== -->
+    <html>
+        <head>
+            <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/>
+
+                                                    <meta name="author" value="Harmony
Documentation Team">
+            <meta name="email" value="harmony-dev@incubator.apache.org">
+            
+           
+            
+            
+            
+            
+            
+            <title>Apache Harmony - Building and Deploying the Apache Harmony Website</title>
+        </head>
+
+        <body bgcolor="#ffffff" text="#000000" link="#525D76">        
+            <table border="0" width="100%" cellspacing="0">
+                <!-- TOP IMAGE -->
+                <tr>
+                    <td align='LEFT'>
+                    <table><tr><td>
+                    <td align="left">
+<a href="http://incubator.apache.org/harmony/"><img  src="../images/harmony-logo.png"
alt="Apache Harmony" border="0"/></a>
+</td>
+</td>
+                    </td></tr></table>
+                    </td>
+                    <td align='RIGHT'>
+                    <a href="http://incubator.apache.org/harmony/">
+                    <img src="images/apache-incubator-logo.png" alt="Apache Harmony" border="0"/></a>
                   
+                    </td>
+                </tr>
+            </table>
+            <table border="0" width="100%" cellspacing="4">
+                <tr><td colspan="2">
+                    <hr noshade="" size="1"/>
+                </td></tr>
+
+                <tr>
+                    <!-- LEFT SIDE NAVIGATION -->
+                    <td width="20%" valign="top" nowrap="true">
+
+                    <!-- special ACon Logo - leave here for next time 
+                    <a href="http://apachecon.com/2005/US/">
+                        <img src="http://apache.org/images/ac2005us_blue_125x125.jpg"
height="125"
+                             width="125" border="0" alt="ApacheCon US 2005" />
+                    </a>
+                    -->
+
+                   <!-- regular menu -->
+
+                    
+    <!-- ============================================================ -->
+
+                <p><strong>General</strong></p>
+        <ul>
+                    <li>    <a href="../index.html">Home</a>
+</li>
+                    <li>    <a href="../license.html">License</a>
+</li>
+                    <li>    <a href="../contribution_policy.html">Contribution
Policy</a>
+</li>
+                    <li>    <a href="../guidelines.html">Project Guidelines</a>
+</li>
+                    <li>    <a href="http://www.apache.org/">ASF</a>
+</li>
+                    <li>    <a href="../downloads.html">Downloads</a>
+</li>
+                </ul>
+            <p><strong>Community</strong></p>
+        <ul>
+                    <li>    <a href="../get-involved.html">Get Involved</a>
+</li>
+                    <li>    <a href="../contributors.html">Committers</a>
+</li>
+                    <li>    <a href="../mailing.html">Mailing Lists</a>
+</li>
+                    <li>    <a href="../documentation/documentation.html">Documentation</a>
+</li>
+                    <li>    <a href="../faq.html">FAQ</a>
+</li>
+                    <li>    <a href="http://wiki.apache.org/harmony">Wiki</a>
+</li>
+                </ul>
+            <p><strong>Development</strong></p>
+        <ul>
+                    <li>    <a href="../roadmap.html">Road Map / TODO</a>
+</li>
+                    <li>    <a href="../svn.html">Source Code</a>
+</li>
+                    <li>    <a href="http://issues.apache.org/jira/browse/HARMONY">JIRA</a>
+</li>
+                    <li>    <a href="../related.html">Other Projects</a>
+</li>
+                </ul>
+                        </td>
+                    <td width="80%" align="left" valign="top">
+                                                                    <table border="0"
cellspacing="0" cellpadding="2" width="100%">
+      <tr><td bgcolor="#525D76">
+        <font color="#ffffff" face="arial,helvetica,sanserif">
+          <a name="Building and Deploying the Apache Harmony Website"><strong>Building
and Deploying the Apache Harmony Website</strong></a>
+        </font>
+      </td></tr>
+      <tr><td>
+        <blockquote>
+                                        <table border="0" cellspacing="0" cellpadding="2"
width="100%">
+      <tr><td bgcolor="#828DA6">
+        <font color="#ffffff" face="arial,helvetica,sanserif">
+          <a name="Building"><strong>Building</strong></a>
+        </font>
+      </td></tr>
+      <tr><td>
+        <blockquote>
+                                    <p>
+		The following tools are required to build the Harmony website
+		
+		<ul>
+		    <li>
+		      <a href="http://subversion.tigris.org/">Subversion</a>
+		    </li>
+		    <li>
+		      <a href="http://ant.apache.org/">Apache Ant</a>
+		    </li>
+			<li>
+			   Java 1.4.2 JDK
+			</li>
+		</ul>
+	</p>
+                                                <p>
+		<ol>
+			<li>
+			   Download the website source from Harmony subversion repository
+			   <pre>$ svn checkout https://svn.apache.org/repos/asf/incubator/harmony/standard/site</pre>
+			</li>
+			
+			<li>
+			   Change into the site directory and run the default ant script target
+			  <pre>$ cd site</pre>
+			  <pre>$ ant</pre>
+			</li>
+	    </ol>
+	</p>
+                                                <p>
+	  At this point, you have a complete generated website and documentation in the <i>site/docs</i>
+	   subdirectory.  Open the <i>index.html</i> page and start browsing.
+	</p>
+                            </blockquote>
+      </td></tr>
+      <tr><td><br/></td></tr>
+    </table>
+                                                    <table border="0" cellspacing="0"
cellpadding="2" width="100%">
+      <tr><td bgcolor="#828DA6">
+        <font color="#ffffff" face="arial,helvetica,sanserif">
+          <a name="Making Changes"><strong>Making Changes</strong></a>
+        </font>
+      </td></tr>
+      <tr><td>
+        <blockquote>
+                                    <p>
+    Making changes is straightforward.  All edits are made to the contents of the <i>xdocs/</i>

+    subdirectory, and then rendered via the procedure above into the <i>docs/</i>
directory.
+  </p>
+                                                <p>
+    If you are a Harmony committer, you can simply checkin your changes.  If you are not

+    a committer, any updates and additions to the site are very welcome.  Please
+    see our <a href="../get-involved.html">Get Involved</a> page for instructions
+    on how to contribute your changes.
+  </p>
+                            </blockquote>
+      </td></tr>
+      <tr><td><br/></td></tr>
+    </table>
+                                                    <table border="0" cellspacing="0"
cellpadding="2" width="100%">
+      <tr><td bgcolor="#828DA6">
+        <font color="#ffffff" face="arial,helvetica,sanserif">
+          <a name="Deploying to Harmony Website"><strong>Deploying to Harmony
Website</strong></a>
+        </font>
+      </td></tr>
+      <tr><td>
+        <blockquote>
+                                    <p>
+    If you are a Harmony Committer, you can commit your changes into SVN and then
+    publish to the project website.  Once the changes are in SVN, simply :
+  </p>
+                                                <p>
+    <ol>
+      <li>
+        SSH to minotaur.apache.org
+        <pre>$ ssh geirm@minotaur.apache.org </pre>
+        Your login name will of course be your own.
+      </li>
+      <li>
+        Go to the project website directory.
+        <pre>$ cd /www/incubator.apache.org/harmony/</pre>
+      </li>
+      <li>
+        Update the local copy.  There are two ways.  A simple
+        <pre>$ svn update</pre>
+        will update the local copy.  If you need to delete the HTML and 
+        re-checout use 
+        <pre>$ `cat UPDATE`</pre>
+        as the UPDATE file has the command used to do a fresh svn checkout.
+      </li>
+        
+    </ol>
+  </p>
+                            </blockquote>
+      </td></tr>
+      <tr><td><br/></td></tr>
+    </table>
+                            </blockquote>
+        </p>
+      </td></tr>
+      <tr><td><br/></td></tr>
+    </table>
+                                        </td>
+                </tr>
+
+                <!-- FOOTER -->
+                <tr><td colspan="2">
+                    <hr noshade="" size="1"/>
+                </td></tr>
+                <tr><td colspan="2">
+                    <div align="center"><font color="#525D76" size="-1"><em>
+                    Copyright &#169; 2003-2005, The Apache Software Foundation
+                    </em></font></div>
+                </td></tr>
+            </table>
+        </body>
+    </html>
+<!-- end the processing -->
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

Modified: incubator/harmony/standard/site/docs/documentation/documentation.html
URL: http://svn.apache.org/viewcvs/incubator/harmony/standard/site/docs/documentation/documentation.html?rev=369496&r1=369495&r2=369496&view=diff
==============================================================================
--- incubator/harmony/standard/site/docs/documentation/documentation.html (original)
+++ incubator/harmony/standard/site/docs/documentation/documentation.html Mon Jan 16 07:29:16
2006
@@ -145,6 +145,9 @@
         <blockquote>
                                     <ul>
   <li>
+    <a href="build_website.html">Building and Deploying the Apache Harmony Website</a>
+  </li>
+  <li>
     <a href="build_classlib.html">Building the Classlibrary Code</a>
   </li>
 </ul>

Modified: incubator/harmony/standard/site/docs/get-involved.html
URL: http://svn.apache.org/viewcvs/incubator/harmony/standard/site/docs/get-involved.html?rev=369496&r1=369495&r2=369496&view=diff
==============================================================================
--- incubator/harmony/standard/site/docs/get-involved.html (original)
+++ incubator/harmony/standard/site/docs/get-involved.html Mon Jan 16 07:29:16 2006
@@ -165,6 +165,77 @@
       </td></tr>
       <tr><td><br/></td></tr>
     </table>
+                                                <table border="0" cellspacing="0" cellpadding="2"
width="100%">
+      <tr><td bgcolor="#525D76">
+        <font color="#ffffff" face="arial,helvetica,sanserif">
+          <a name="How to Create and Submit A Patch or Enhancement"><strong>How
to Create and Submit A Patch or Enhancement</strong></a>
+        </font>
+      </td></tr>
+      <tr><td>
+        <blockquote>
+                                    <p>
+  One of the best ways to get involved in the Harmony project is to 
+  create patches or additions and contribute them.  All contributions
+  should be made via a new entry in our project 
+  <a href="http://issues.apache.org/jira/browse/HARMONY">JIRA</a>.
+</p>
+                                                <p>
+  Here are some basic guidelines and suggestions : 
+  <ul>
+  <li>
+    Once you have completed your changes, please  be sure 
+    to test your changes very well. 
+  </li>
+  <li>
+    If you are offering a code addition or change, be sure that 
+    the codebase builds cleanly and the full test suite passes 
+    before submitting.  Patches that break the 
+    build or break the code will be rejected.
+  </li>
+  <li>
+   If you are offering a change to documentation or the website, 
+    please review the generated output and be sure that it is as you expect.
+  </li>
+  <li>
+    If you are offering a fix to a bug, please provide a testcase and 
+    instructions to help us duplicate the bug, and then test that the bug
+    is fixed.  We will add the testcase to our testsuite.
+  </li>
+  <li>
+     When offering something new, please include the entire file
+     that you are contributing.
+  </li>
+  <li>
+     When you are offering a change to something that already exists
+     in the project SVN repository, please submit a patch as outlined below.
+  </li>
+  </ul>
+</p>
+                                                <p>
+  Once you are sure you have tested/reviewed your changes, open a 
+  new JIRA entry.  Clearly describe the patch or enhancement, and 
+  provide details, such as how to re-create if a bug, why the 
+  change or enhancement is useful, etc.  Then, attach all materials 
+  to the JIRA entry via "Attach File".  Please be sure to select 
+  "Grant license to ASF for inclusion in ASF works...".  Any patch
+  without this grant will be rejected.
+</p>
+                                                <p>
+  Please use the subversion 'diff' utility to create a patch as follows : 
+  
+  <pre>
+    svn diff file.java &gt; file.patch
+  </pre>
+  
+  where 'file' is the filename that you have changed.  This will produce a 
+  nice patch file that can be added to the JIRA, which makes it easy for
+  the project committers to review and possibly accept your patch.
+</p>
+                            </blockquote>
+        </p>
+      </td></tr>
+      <tr><td><br/></td></tr>
+    </table>
                                         </td>
                 </tr>
 

Added: incubator/harmony/standard/site/xdocs/documentation/build_website.xml
URL: http://svn.apache.org/viewcvs/incubator/harmony/standard/site/xdocs/documentation/build_website.xml?rev=369496&view=auto
==============================================================================
--- incubator/harmony/standard/site/xdocs/documentation/build_website.xml (added)
+++ incubator/harmony/standard/site/xdocs/documentation/build_website.xml Mon Jan 16 07:29:16
2006
@@ -0,0 +1,119 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+
+    Copyright 2006 The Apache Software Foundation
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+-->
+
+<document>
+
+ <properties>
+  <title>Building and Deploying the Apache Harmony Website</title>
+  <author email="harmony-dev@incubator.apache.org">Harmony Documentation Team</author>
+ </properties>
+
+<body>
+
+<section name="Building and Deploying the Apache Harmony Website">
+
+<subsection name="Building">
+	<p>
+		The following tools are required to build the Harmony website
+		
+		<ul>
+		    <li>
+		      <a href="http://subversion.tigris.org/">Subversion</a>
+		    </li>
+		    <li>
+		      <a href="http://ant.apache.org/">Apache Ant</a>
+		    </li>
+			<li>
+			   Java 1.4.2 JDK
+			</li>
+		</ul>
+	</p>
+	
+	<p>
+		<ol>
+			<li>
+			   Download the website source from Harmony subversion repository
+			   <pre>$ svn checkout https://svn.apache.org/repos/asf/incubator/harmony/standard/site</pre>
+			</li>
+			
+			<li>
+			   Change into the site directory and run the default ant script target
+			  <pre>$ cd site</pre>
+			  <pre>$ ant</pre>
+			</li>
+	    </ol>
+	</p>
+	
+	<p>
+	  At this point, you have a complete generated website and documentation in the <i>site/docs</i>
+	   subdirectory.  Open the <i>index.html</i> page and start browsing.
+	</p>
+
+</subsection>
+
+<subsection name="Making Changes">
+
+  <p>
+    Making changes is straightforward.  All edits are made to the contents of the <i>xdocs/</i>

+    subdirectory, and then rendered via the procedure above into the <i>docs/</i>
directory.
+  </p>
+  
+  <p>
+    If you are a Harmony committer, you can simply checkin your changes.  If you are not

+    a committer, any updates and additions to the site are very welcome.  Please
+    see our <a href="../get-involved.html">Get Involved</a> page for instructions
+    on how to contribute your changes.
+  </p>
+  
+</subsection>
+
+<subsection name="Deploying to Harmony Website">
+
+  <p>
+    If you are a Harmony Committer, you can commit your changes into SVN and then
+    publish to the project website.  Once the changes are in SVN, simply :
+  </p>
+  
+  <p>
+    <ol>
+      <li>
+        SSH to minotaur.apache.org
+        <pre>$ ssh geirm@minotaur.apache.org </pre>
+        Your login name will of course be your own.
+      </li>
+      <li>
+        Go to the project website directory.
+        <pre>$ cd /www/incubator.apache.org/harmony/</pre>
+      </li>
+      <li>
+        Update the local copy.  There are two ways.  A simple
+        <pre>$ svn update</pre>
+        will update the local copy.  If you need to delete the HTML and 
+        re-checout use 
+        <pre>$ `cat UPDATE`</pre>
+        as the UPDATE file has the command used to do a fresh svn checkout.
+      </li>
+        
+    </ol>
+  </p>
+  
+</subsection>
+</section>
+</body>
+</document>
\ No newline at end of file

Modified: incubator/harmony/standard/site/xdocs/documentation/documentation.xml
URL: http://svn.apache.org/viewcvs/incubator/harmony/standard/site/xdocs/documentation/documentation.xml?rev=369496&r1=369495&r2=369496&view=diff
==============================================================================
--- incubator/harmony/standard/site/xdocs/documentation/documentation.xml (original)
+++ incubator/harmony/standard/site/xdocs/documentation/documentation.xml Mon Jan 16 07:29:16
2006
@@ -38,6 +38,9 @@
 
 <ul>
   <li>
+    <a href="build_website.html">Building and Deploying the Apache Harmony Website</a>
+  </li>
+  <li>
     <a href="build_classlib.html">Building the Classlibrary Code</a>
   </li>
 </ul>

Modified: incubator/harmony/standard/site/xdocs/get-involved.xml
URL: http://svn.apache.org/viewcvs/incubator/harmony/standard/site/xdocs/get-involved.xml?rev=369496&r1=369495&r2=369496&view=diff
==============================================================================
--- incubator/harmony/standard/site/xdocs/get-involved.xml (original)
+++ incubator/harmony/standard/site/xdocs/get-involved.xml Mon Jan 16 07:29:16 2006
@@ -45,5 +45,74 @@
 </ul>
 
 </section>
+
+<section name="How to Create and Submit A Patch or Enhancement">
+
+<p>
+  One of the best ways to get involved in the Harmony project is to 
+  create patches or additions and contribute them.  All contributions
+  should be made via a new entry in our project 
+  <a href="http://issues.apache.org/jira/browse/HARMONY">JIRA</a>.
+</p>
+
+<p>
+  Here are some basic guidelines and suggestions : 
+  <ul>
+  <li>
+    Once you have completed your changes, please  be sure 
+    to test your changes very well. 
+  </li>
+  <li>
+    If you are offering a code addition or change, be sure that 
+    the codebase builds cleanly and the full test suite passes 
+    before submitting.  Patches that break the 
+    build or break the code will be rejected.
+  </li>
+  <li>
+   If you are offering a change to documentation or the website, 
+    please review the generated output and be sure that it is as you expect.
+  </li>
+  <li>
+    If you are offering a fix to a bug, please provide a testcase and 
+    instructions to help us duplicate the bug, and then test that the bug
+    is fixed.  We will add the testcase to our testsuite.
+  </li>
+  <li>
+     When offering something new, please include the entire file
+     that you are contributing.
+  </li>
+  <li>
+     When you are offering a change to something that already exists
+     in the project SVN repository, please submit a patch as outlined below.
+  </li>
+  </ul>
+</p>
+
+<p>
+  Once you are sure you have tested/reviewed your changes, open a 
+  new JIRA entry.  Clearly describe the patch or enhancement, and 
+  provide details, such as how to re-create if a bug, why the 
+  change or enhancement is useful, etc.  Then, attach all materials 
+  to the JIRA entry via "Attach File".  Please be sure to select 
+  "Grant license to ASF for inclusion in ASF works...".  Any patch
+  without this grant will be rejected.
+</p>
+
+<p>
+  Please use the subversion 'diff' utility to create a patch as follows : 
+  
+  <pre>
+    svn diff file.java > file.patch
+  </pre>
+  
+  where 'file' is the filename that you have changed.  This will produce a 
+  nice patch file that can be added to the JIRA, which makes it easy for
+  the project committers to review and possibly accept your patch.
+</p>   
+
+   
+
+
+</section>
 </body>
 </document>



Mime
View raw message