Author: niallp Date: Tue Nov 28 20:07:12 2006 New Revision: 480391 URL: http://svn.apache.org/viewvc?view=rev&rev=480391 Log: Improve the site and build
Added: jakarta/commons/proper/discovery/trunk/xdocs/building.xml (with props) jakarta/commons/proper/discovery/trunk/xdocs/cvs-usage.xml (with props) jakarta/commons/proper/discovery/trunk/xdocs/issue-tracking.xml (with props) Modified: jakarta/commons/proper/discovery/trunk/maven.xml jakarta/commons/proper/discovery/trunk/project.properties jakarta/commons/proper/discovery/trunk/project.xml jakarta/commons/proper/discovery/trunk/xdocs/navigation.xml jakarta/commons/proper/discovery/trunk/xdocs/style/project.css Modified: jakarta/commons/proper/discovery/trunk/maven.xml URL: http://svn.apache.org/viewvc/jakarta/commons/proper/discovery/trunk/maven.xml?view=diff&rev=480391&r1=480390&r2=480391 ============================================================================== --- jakarta/commons/proper/discovery/trunk/maven.xml (original) +++ jakarta/commons/proper/discovery/trunk/maven.xml Tue Nov 28 20:07:12 2006 @@ -19,23 +19,6 @@ <project default="jar:jar" xmlns:j="jelly:core" xmlns:ant="jelly:ant" xmlns:maven="jelly:maven"> - <!-- ================================================================== --> - <!-- START : C O M M O N S - B U I L D --> - <!-- ================================================================== --> - <!-- Required: Look and Feel for documentation within distributions --> - <!-- ================================================================== --> - <postGoal name="xdoc:copy-resources"> - <copy todir="${basedir}/target/docs/style/" failonerror="false"> - <fileset dir="${basedir}/../commons-build/xdocs/style"> - <include name='**/*'/> - <exclude name='**/CVS/**'/> - </fileset> - </copy> - </postGoal> - <!-- ================================================================== --> - <!-- END: C O M M O N S - B U I L D --> - <!-- ================================================================== --> - <preGoal name="test:test"> <ant:property name="test.dest" @@ -56,6 +39,82 @@ <ant:echo message="classpath: ${classpath}"/> </preGoal> + <!-- ================================================================== --> + <!-- Copy into the binary distribution --> + <!-- ================================================================== --> + <postGoal name="dist:prepare-bin-filesystem"> + + <!-- Copy the NOTICE --> + <copy todir="${maven.dist.bin.assembly.dir}"> + <fileset file='${basedir}/NOTICE.txt'/> + <fileset file="${basedir}/RELEASE-NOTES.txt"/> + </copy> + + </postGoal> + + <!-- ================================================================== --> + <!-- Copy into the source distribution --> + <!-- ================================================================== --> + <postGoal name="dist:prepare-src-filesystem"> + + <!-- Copy the NOTICE --> + <copy todir="${maven.dist.src.assembly.dir}"> + <fileset file='${basedir}/NOTICE.txt'/> + <fileset file="${basedir}/RELEASE-NOTES.txt"/> + <fileset file="${basedir}/checkstyle.xml"/> + </copy> + + <!-- Copy xdoc files --> + <copy todir="${maven.dist.src.assembly.dir}/xdocs"> + <fileset dir="./xdocs"/> + </copy> + + <!-- Copy lib files --> + <copy todir="${maven.dist.src.assembly.dir}/lib"> + <fileset dir="./lib"/> + </copy> + + </postGoal> + + <!-- ================================================================== --> + <!-- Create MD5 Check Sums --> + <!-- ================================================================== --> + <postGoal name="dist"> + + <!-- Create a versioned pom --> + <copy file="${basedir}/project.xml" tofile="${maven.dist.dir}/${maven.final.name}.pom"/> + + <!-- create checksum for pom --> + <ant:checksum file="${maven.dist.dir}/${maven.final.name}.pom" property="pom.md5"/> + <ant:echo message="${pom.md5} *${maven.final.name}.pom" + file="${maven.dist.dir}/${maven.final.name}.pom.md5" /> + + <!-- create checksum for jar --> + <ant:checksum file="${maven.build.dir}/${maven.final.name}.jar" property="jar.md5"/> + <ant:echo message="${jar.md5} *${maven.final.name}.jar" + file="${maven.build.dir}/${maven.final.name}.jar.md5" /> + + <!-- create checksum for binary zip --> + <ant:checksum file="${maven.dist.dir}/${maven.final.name}.zip" property="zip.md5"/> + <ant:echo message="${zip.md5} *${maven.final.name}.zip" + file="${maven.dist.dir}/${maven.final.name}.zip.md5" /> + + <!-- create checksum for binary tar.gz --> + <ant:checksum file="${maven.dist.dir}/${maven.final.name}.tar.gz" property="tar.gz.md5"/> + <ant:echo message="${tar.gz.md5} *${maven.final.name}.tar.gz" + file="${maven.dist.dir}/${maven.final.name}.tar.gz.md5" /> + + <!-- create checksum for source zip --> + <ant:checksum file="${maven.dist.dir}/${maven.final.name}-src.zip" property="src.zip.md5"/> + <ant:echo message="${src.zip.md5} *${maven.final.name}-src.zip" + file="${maven.dist.dir}/${maven.final.name}-src.zip.md5" /> + + <!-- create checksum for source tar.gz --> + <ant:checksum file="${maven.dist.dir}/${maven.final.name}-src.tar.gz" property="src.tar.gz.md5"/> + <ant:echo message="${src.tar.gz.md5} *${maven.final.name}-src.tar.gz" + file="${maven.dist.dir}/${maven.final.name}-src.tar.gz.md5" /> + + </postGoal> </project> Modified: jakarta/commons/proper/discovery/trunk/project.properties URL: http://svn.apache.org/viewvc/jakarta/commons/proper/discovery/trunk/project.properties?view=diff&rev=480391&r1=480390&r2=480391 ============================================================================== --- jakarta/commons/proper/discovery/trunk/project.properties (original) +++ jakarta/commons/proper/discovery/trunk/project.properties Tue Nov 28 20:07:12 2006 @@ -25,8 +25,10 @@ maven.jar.manifest.attribute.X-Compile-Source-JDK=${maven.compile.source} maven.jar.manifest.attribute.X-Compile-Target-JDK=${maven.compile.target} +# Make the source distro unzip to a different directory +maven.dist.src.assembly.dir=${maven.dist.assembly.dir}/src/${maven.final.name}-src + # commons site L&F -maven.xdoc.jsl=../commons-build/commons-site.jsl maven.xdoc.date=left maven.xdoc.version=${pom.currentVersion} maven.xdoc.developmentProcessUrl=http://jakarta.apache.org/commons/charter.html Modified: jakarta/commons/proper/discovery/trunk/project.xml URL: http://svn.apache.org/viewvc/jakarta/commons/proper/discovery/trunk/project.xml?view=diff&rev=480391&r1=480390&r2=480391 ============================================================================== --- jakarta/commons/proper/discovery/trunk/project.xml (original) +++ jakarta/commons/proper/discovery/trunk/project.xml Tue Nov 28 20:07:12 2006 @@ -61,13 +61,13 @@ <name>Commons Dev List</name> <subscribe>[EMAIL PROTECTED]</subscribe> <unsubscribe>[EMAIL PROTECTED]</unsubscribe> - <archive>http://mail-archives.apache.org/eyebrowse/[EMAIL PROTECTED]</archive> + <archive>http://mail-archives.apache.org/mod_mbox/jakarta-commons-dev/</archive> </mailingList> <mailingList> <name>Commons User List</name> <subscribe>[EMAIL PROTECTED]</subscribe> <unsubscribe>[EMAIL PROTECTED]</unsubscribe> - <archive>http://mail-archives.apache.org/eyebrowse/[EMAIL PROTECTED]</archive> + <archive>http://mail-archives.apache.org/mod_mbox/jakarta-commons-user/</archive> </mailingList> </mailingLists> @@ -132,6 +132,10 @@ <version>3.7</version> <properties> <scope>test</scope> + <comment> + <strong>Test Only</strong> - required + only for running the unit tests. + </comment> </properties> </dependency> @@ -144,7 +148,7 @@ <properties> <comment> <strong>Site Only</strong> - v1.9.2 (minimum) - required for building the BeanUtils Site documentation. + required for building the Site documentation. </comment> </properties> </dependency> @@ -177,6 +181,15 @@ </resource> </resources> </unitTest> + <resources> + <resource> + <directory>${basedir}</directory> + <targetPath>META-INF</targetPath> + <includes> + <include>NOTICE.txt</include> + </includes> + </resource> + </resources> </build> Added: jakarta/commons/proper/discovery/trunk/xdocs/building.xml URL: http://svn.apache.org/viewvc/jakarta/commons/proper/discovery/trunk/xdocs/building.xml?view=auto&rev=480391 ============================================================================== --- jakarta/commons/proper/discovery/trunk/xdocs/building.xml (added) +++ jakarta/commons/proper/discovery/trunk/xdocs/building.xml Tue Nov 28 20:07:12 2006 @@ -0,0 +1,73 @@ +<?xml version="1.0"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You 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</title> + <author email="commons-dev@jakarta.apache.org">Commons Documentation Team</author> + </properties> +<body> +<!-- ================================================== --> +<section name="Overview"> +<p> + Commons Discovery uses <a href="http://maven.apache.org">Maven</a> or + <a href="http://ant.apache.org">Ant</a> as a build system. +</p> +</section> +<!-- ================================================== --> +<section name="Maven Goals"> + <p> + To build a jar file, change into Discovery's root directory and run + <strong><code>maven jar</code></strong>. + The result will be in the "target" subdirectory. + </p> + <p> + To build the Javadocs, run <strong><code>maven javadoc</code></strong>. + The result will be in "target/docs/apidocs". + </p> + <p> + To build the full website, run <strong><code>maven site</code></strong>. + + The result will be in "target/docs". + </p> + <p> + Further details can be found in the + <a href="http://jakarta.apache.org/commons/building.html">commons build instructions</a>. + </p> +</section> +<!-- ================================================== --> +<section name="Ant Goals"> + <p> + To build a jar file and the javadocs, change into Discovery's root directory + and run <strong><code>ant dist</code></strong>. + The result will be in the "dist" subdirectory. + </p> +</section> + +<!-- ================================================== --> +<section name="Nightly Builds"> + <p> + <a href="http://people.apache.org/builds/jakarta-commons/nightly/commons-discovery/">Nightly Builds</a> + are built once a day from the current SVN HEAD. These are provided purely for test purposes and are <b>NOT + official releases</b> of the Apache Software Foundation - Released versions of Commons Discovery are + available <a href="http://jakarta.apache.org/site/downloads/downloads_commons-discovery.cgi">here</a>. + </p> +</section> + +<!-- ================================================== --> +</body> +</document> Propchange: jakarta/commons/proper/discovery/trunk/xdocs/building.xml ------------------------------------------------------------------------------ svn:eol-style = native Propchange: jakarta/commons/proper/discovery/trunk/xdocs/building.xml ------------------------------------------------------------------------------ svn:keywords = Date Author Id Revision HeadURL Added: jakarta/commons/proper/discovery/trunk/xdocs/cvs-usage.xml URL: http://svn.apache.org/viewvc/jakarta/commons/proper/discovery/trunk/xdocs/cvs-usage.xml?view=auto&rev=480391 ============================================================================== --- jakarta/commons/proper/discovery/trunk/xdocs/cvs-usage.xml (added) +++ jakarta/commons/proper/discovery/trunk/xdocs/cvs-usage.xml Tue Nov 28 20:07:12 2006 @@ -0,0 +1,50 @@ +<?xml version="1.0" encoding="ISO-8859-1" ?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You 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>Source repository</title> + <author email="commons-dev@jakarta.apache.org">Commons Documentation Team</author> + </properties> + <body> +<!-- ================================================== --> +<section name="Source repository"> +<p> + Jakarta Commons Discovery is hosted on the Apache + <a href="http://subversion.tigris.org/">subversion</a> repository. +</p> +<p> + The project URL is:<br /> + <code>http://svn.apache.org/repos/asf/jakarta/commons/proper/discovery/trunk</code> +</p> +<p> + The best way to view the repository is via the + <a href="http://svn.apache.org/viewvc/jakarta/commons/proper/discovery/trunk/">subversion viewer</a>. +</p> +<p> + The alternative is to use the + <a href="http://svn.apache.org/repos/asf/jakarta/commons/proper/discovery/trunk/">native subversion</a> display. +</p> +<p> + For more information on subversion and creating patches see the + <a href="http://www.apache.org/dev/contributors.html">Apache Contributors Guide</a>. +</p> +</section> +<!-- ================================================== --> +</body> +</document> \ No newline at end of file Propchange: jakarta/commons/proper/discovery/trunk/xdocs/cvs-usage.xml ------------------------------------------------------------------------------ svn:eol-style = native Propchange: jakarta/commons/proper/discovery/trunk/xdocs/cvs-usage.xml ------------------------------------------------------------------------------ svn:keywords = Date Author Id Revision HeadURL Added: jakarta/commons/proper/discovery/trunk/xdocs/issue-tracking.xml URL: http://svn.apache.org/viewvc/jakarta/commons/proper/discovery/trunk/xdocs/issue-tracking.xml?view=auto&rev=480391 ============================================================================== --- jakarta/commons/proper/discovery/trunk/xdocs/issue-tracking.xml (added) +++ jakarta/commons/proper/discovery/trunk/xdocs/issue-tracking.xml Tue Nov 28 20:07:12 2006 @@ -0,0 +1,72 @@ +<?xml version="1.0"?> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You 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>Issue tracking</title> + <author email="commons-dev@jakarta.apache.org">Commons Documentation Team</author> + </properties> +<body> +<!-- ================================================== --> +<section name="Issue tracking"> +<p> + Commons Discovery uses <a href="http://issues.apache.org/jira/">ASF JIRA</a> for for tracking issues. + See the <a href="http://issues.apache.org/jira/browse/DISCOVERY">Discovery JIRA project page</a>. +</p> +<p> + To use JIRA you may need to <a href="http://issues.apache.org/jira/secure/Signup!default.jspa">create an account</a> + (if you have previously created/updated Commons issues using Bugzilla an account will have been automatically + created and you can use the <a href="http://issues.apache.org/jira/secure/ForgotPassword!default.jspa">Forgot Password</a> + page to get a new password). +</p> +<p> + If you would like to report a bug, or raise an enhancement request with + Commons Discovery please do the following: + <ol> + <li><a href="http://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310472&sorter/field=issuekey&sorter/order=DESC&status=1&status=4">Search existing open bugs</a>. + If you find your issue listed then please add a comment with your details.</li> + <li><a href="http://mail-archives.apache.org/mod_mbox/jakarta-commons-dev/">Search the mailing list archive</a>. + You may find your issue or idea has already been discussed.</li> + <li>Decide if your issue is a bug or an enhancement.</li> + <li>Submit either a <a href="http://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12310472&issuetype=1&priority=4&assignee=-1">bug report</a> + or <a href="http://issues.apache.org/jira/secure/CreateIssueDetails!init.jspa?pid=12310472&issuetype=4&priority=4&assignee=-1">enhancement request</a>.</li> + </ol> +</p> +<p> + Please also remember these points: + <ul> + <li>the more information you provide, the better we can help you</li> + <li>test cases are vital, particularly for any proposed enhancements</li> + <li>the developers of Commons Discovery are all unpaid volunteers</li> + </ul> +</p> +<p> + For more information on subversion and creating patches see the + <a href="http://www.apache.org/dev/contributors.html">Apache Contributors Guide</a>. +</p> +<p> + You may also find these links useful: + <ul> + <li><a href="http://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310472&sorter/field=issuekey&sorter/order=DESC&status=1&status=4">All Open Discovery bugs</a></li> + <li><a href="http://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310472&sorter/field=issuekey&sorter/order=DESC&status=5&status=6">All Resolved Discovery bugs</a></li> + <li><a href="http://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&pid=12310472&sorter/field=issuekey&sorter/order=DESC">All Discovery bugs</a></li> + </ul> +</p> +</section> +<!-- ================================================== --> +</body> +</document> Propchange: jakarta/commons/proper/discovery/trunk/xdocs/issue-tracking.xml ------------------------------------------------------------------------------ svn:eol-style = native Propchange: jakarta/commons/proper/discovery/trunk/xdocs/issue-tracking.xml ------------------------------------------------------------------------------ svn:keywords = Date Author Id Revision HeadURL Modified: jakarta/commons/proper/discovery/trunk/xdocs/navigation.xml URL: http://svn.apache.org/viewvc/jakarta/commons/proper/discovery/trunk/xdocs/navigation.xml?view=diff&rev=480391&r1=480390&r2=480391 ============================================================================== --- jakarta/commons/proper/discovery/trunk/xdocs/navigation.xml (original) +++ jakarta/commons/proper/discovery/trunk/xdocs/navigation.xml Tue Nov 28 20:07:12 2006 @@ -15,7 +15,7 @@ See the License for the specific language governing permissions and limitations under the License. --> -<!DOCTYPE org.apache.commons.menus SYSTEM '../../commons-build/menus/menus.dtd'> +<!DOCTYPE org.apache.commons.menus SYSTEM 'http://jakarta.apache.org/commons/build/maven-build.dtd'> <project name="Discovery"> <title>Discovery</title> @@ -25,25 +25,31 @@ <body> <links> - <item name="Jakarta Commons" - href="http://jakarta.apache.org/commons/"/> + <item name="Apache" href="http://www.apache.org"/> + <item name="Jakarta" href="http://jakarta.apache.org"/> + <item name="Commons" href="http://jakarta.apache.org/commons/"/> </links> - <menu name="Commons Discovery"> + <menu name="Discovery"> <item name="Overview" href="/index.html"/> + <item name="Download" href="http://jakarta.apache.org/site/downloads/downloads_commons-discovery.cgi"/> <!--item name="Users guide" href="/userguide.html"/--> <item name="Best practices" href="/best-practices.html"/> <item name="Guidelines" href="/adc-guidelines.html"/> <!--item name="History" href="/history.html"/--> <item name="Javadoc (0.4 release)" href="apidocs/index.html"/> - <item name="Mailing lists" href="/mail-lists.html"/> - <item name="Team" href="/team-list.html"/> <!--item name="Tasks" href="/tasks.html"/--> - <item name="SVN source repository" href="http://svn.apache.org/repos/asf/jakarta/commons/proper/discovery"/> + </menu> + + <menu name="Development"> + <item name="Mailing Lists" href="/mail-lists.html"/> + <item name="Issue Tracking" href="/issue-tracking.html"/> + <item name="Source Repository" href="/cvs-usage.html"/> + <item name="Building" href="/building.html"/> <!-- item name="Javadoc (SVN latest)" href="apidocs/index.html"/--> </menu> - &common-menus; + &commons; </body> </project> Modified: jakarta/commons/proper/discovery/trunk/xdocs/style/project.css URL: http://svn.apache.org/viewvc/jakarta/commons/proper/discovery/trunk/xdocs/style/project.css?view=diff&rev=480391&r1=480390&r2=480391 ============================================================================== --- jakarta/commons/proper/discovery/trunk/xdocs/style/project.css (original) +++ jakarta/commons/proper/discovery/trunk/xdocs/style/project.css Tue Nov 28 20:07:12 2006 @@ -1,5 +1 @@ -#banner, #banner td { - background: #fff; - color: #000; -} - [EMAIL PROTECTED] url("http://jakarta.apache.org/style/jakarta-maven.css"); --------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]