Apache Harmony - Building and Deploying the Apache Harmony Website

From harmony-commits-return-662-apmail-incubator-harmony-commits-archive=incubator.apache.org@incubator.apache.org Mon Jan 16 15:29:56 2006 Return-Path: Delivered-To: apmail-incubator-harmony-commits-archive@www.apache.org Received: (qmail 77615 invoked from network); 16 Jan 2006 15:29:55 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (209.237.227.199) by minotaur.apache.org with SMTP; 16 Jan 2006 15:29:55 -0000 Received: (qmail 62981 invoked by uid 500); 16 Jan 2006 15:29:55 -0000 Delivered-To: apmail-incubator-harmony-commits-archive@incubator.apache.org Received: (qmail 62903 invoked by uid 500); 16 Jan 2006 15:29:54 -0000 Mailing-List: contact harmony-commits-help@incubator.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: harmony-dev@incubator.apache.org Delivered-To: mailing list harmony-commits@incubator.apache.org Received: (qmail 62886 invoked by uid 99); 16 Jan 2006 15:29:54 -0000 Received: from asf.osuosl.org (HELO asf.osuosl.org) (140.211.166.49) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 16 Jan 2006 07:29:54 -0800 X-ASF-Spam-Status: No, hits=-9.4 required=10.0 tests=ALL_TRUSTED,NO_REAL_NAME X-Spam-Check-By: apache.org Received: from [209.237.227.194] (HELO minotaur.apache.org) (209.237.227.194) by apache.org (qpsmtpd/0.29) with SMTP; Mon, 16 Jan 2006 07:29:52 -0800 Received: (qmail 77479 invoked by uid 65534); 16 Jan 2006 15:29:32 -0000 Message-ID: <20060116152932.77478.qmail@minotaur.apache.org> Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r369496 - in /incubator/harmony/standard/site: docs/ docs/documentation/ xdocs/ xdocs/documentation/ Date: Mon, 16 Jan 2006 15:29:24 -0000 To: harmony-commits@incubator.apache.org From: geirm@apache.org X-Mailer: svnmailer-1.0.5 X-Virus-Checked: Checked by ClamAV on apache.org X-Spam-Rating: minotaur.apache.org 1.6.2 0/1000/N 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 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + Apache Harmony - Building and Deploying the Apache Harmony Website + + + + + + + + + +

+ + +

+

+

+

+

+ +

+

+ + + + + + + + + + + + +

+

+

+ + + + + + + + +

General

+

+

Community

+

+

Development

+

+

+ + + + +

+ + Building and Deploying the Apache Harmony Website + +

+

+ + + + +
+ + Building + +
+
+
+ The following tools are required to build the Harmony website + +
+
+ Subversion +
+
+ Apache Ant +
+
+ Java 1.4.2 JDK +
+
+
+
+
+
+ Download the website source from Harmony subversion repository +
$ svn checkout https://svn.apache.org/repos/asf/incubator/harmony/standard/site
+
+ +
+ Change into the site directory and run the default ant script target +
$ cd site
+
$ ant
+
+
+
+
+ At this point, you have a complete generated website and documentation in the site/docs + subdirectory. Open the index.html page and start browsing. +
+
+
+ + + + +
+ + Making Changes + +
+
+
+ Making changes is straightforward. All edits are made to the contents of the xdocs/ + subdirectory, and then rendered via the procedure above into the docs/ directory. +
+
+ 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 Get Involved page for instructions + on how to contribute your changes. +
+
+

+ + + + +
+ + Deploying to Harmony Website + +
+
+
+ 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 : +
+
+
+
+ SSH to minotaur.apache.org +
$ ssh geirm@minotaur.apache.org 
+ Your login name will of course be your own. +
+
+ Go to the project website directory. +
$ cd /www/incubator.apache.org/harmony/
+
+
+ Update the local copy. There are two ways. A simple +
$ svn update
+ will update the local copy. If you need to delete the HTML and + re-checout use +
$ `cat UPDATE`
+ as the UPDATE file has the command used to do a fresh svn checkout. +
+ +
+
+
+
+

+

+

+

+

+

+

+ Copyright © 2003-2005, The Apache Software Foundation +

+

+ + + + + + + + + + + + + + + + + + + + + + + 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 @@

+ Building and Deploying the Apache Harmony Website +
+
Building the Classlibrary Code

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 @@
+ + + + +
+ + How to Create and Submit A Patch or Enhancement + +
+
+
+ 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 + JIRA. +
+
+ Here are some basic guidelines and suggestions : +
+
+ Once you have completed your changes, please be sure + to test your changes very well. +
+
+ 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. +
+
+ 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. +
+
+ 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. +
+
+ When offering something new, please include the entire file + that you are contributing. +
+
+ When you are offering a change to something that already exists + in the project SVN repository, please submit a patch as outlined below. +
+
+
+
+ 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. +
+
+ Please use the subversion 'diff' utility to create a patch as follows : + +
+    svn diff file.java > file.patch
+  
+ + 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. +
+
+
+
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 @@ + + + + + + + + Building and Deploying the Apache Harmony Website + Harmony Documentation Team + + + + +
+ + +
+ The following tools are required to build the Harmony website + +
+
+ Subversion +
+
+ Apache Ant +
+
+ Java 1.4.2 JDK +
+
+
+ +
+
+
+ Download the website source from Harmony subversion repository +
$ svn checkout https://svn.apache.org/repos/asf/incubator/harmony/standard/site
+
+ +
+ Change into the site directory and run the default ant script target +
$ cd site
+
$ ant
+
+
+
+ +
+ At this point, you have a complete generated website and documentation in the site/docs + subdirectory. Open the index.html page and start browsing. +
+ + + + + +
+ Making changes is straightforward. All edits are made to the contents of the xdocs/ + subdirectory, and then rendered via the procedure above into the docs/ directory. +
+ +
+ 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 Get Involved page for instructions + on how to contribute your changes. +
+ + + + + +
+ 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 : +
+ +
+
+
+ SSH to minotaur.apache.org +
$ ssh geirm@minotaur.apache.org
+ Your login name will of course be your own. +
+
+ Go to the project website directory. +
$ cd /www/incubator.apache.org/harmony/
+
+
+ Update the local copy. There are two ways. A simple +
$ svn update
+ will update the local copy. If you need to delete the HTML and + re-checout use +
$ `cat UPDATE`
+ as the UPDATE file has the command used to do a fresh svn checkout. +
+ +
+
+ + +
+ + \ 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 @@

+ Building and Deploying the Apache Harmony Website +
+
Building the Classlibrary Code

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 @@ + +
+ +
+ 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 + JIRA. +
+ +
+ Here are some basic guidelines and suggestions : +
+
+ Once you have completed your changes, please be sure + to test your changes very well. +
+
+ 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. +
+
+ 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. +
+
+ 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. +
+
+ When offering something new, please include the entire file + that you are contributing. +
+
+ When you are offering a change to something that already exists + in the project SVN repository, please submit a patch as outlined below. +
+
+
+ +
+ 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. +
+ +
+ Please use the subversion 'diff' utility to create a patch as follows : + +
+    svn diff file.java > file.patch
+  
+ + 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. +
+ + + + +