You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by sc...@apache.org on 2005/11/13 14:01:41 UTC
svn commit: r332977 - in /jakarta/commons/proper/io/trunk/xdocs:
cvs-usage.xml index.xml issue-tracking.xml
Author: scolebourne
Date: Sun Nov 13 05:01:38 2005
New Revision: 332977
URL: http://svn.apache.org/viewcvs?rev=332977&view=rev
Log:
Improve documentation with better links
Modified:
jakarta/commons/proper/io/trunk/xdocs/cvs-usage.xml
jakarta/commons/proper/io/trunk/xdocs/index.xml
jakarta/commons/proper/io/trunk/xdocs/issue-tracking.xml
Modified: jakarta/commons/proper/io/trunk/xdocs/cvs-usage.xml
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/io/trunk/xdocs/cvs-usage.xml?rev=332977&r1=332976&r2=332977&view=diff
==============================================================================
--- jakarta/commons/proper/io/trunk/xdocs/cvs-usage.xml (original)
+++ jakarta/commons/proper/io/trunk/xdocs/cvs-usage.xml Sun Nov 13 05:01:38 2005
@@ -31,7 +31,7 @@
<code>http://svn.apache.org/repos/asf/jakarta/commons/proper/io/trunk</code>
</p>
<p>
- The best way to access the repository is via the
+ The best way to view the repository is via the
<a href="http://svn.apache.org/viewcvs.cgi/jakarta/commons/proper/io/trunk/">subversion viewer</a>.
</p>
<p>
Modified: jakarta/commons/proper/io/trunk/xdocs/index.xml
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/io/trunk/xdocs/index.xml?rev=332977&r1=332976&r2=332977&view=diff
==============================================================================
--- jakarta/commons/proper/io/trunk/xdocs/index.xml (original)
+++ jakarta/commons/proper/io/trunk/xdocs/index.xml Sun Nov 13 05:01:38 2005
@@ -38,7 +38,8 @@
<section name="Documentation">
<p>
A getting started <a href="description.html">user guide</a> is available,
-as are some IO <a href="bestpractices.html">best practices</a>.
+as are some IO <a href="bestpractices.html">best practices</a>
+and various <a href="maven-reports.html">project reports</a>.
</p>
<p>
The JavaDoc API documents are available online:
@@ -49,7 +50,8 @@
<li>The <a href="apidocs/index.html">latest SVN</a></li>
</ul>
<p>
-The <a href="http://svn.apache.org/viewcvs.cgi/jakarta/commons/proper/io/trunk/">SVN repository</a> can be browsed.
+The <a href="cvs-usage.html">subversion repository</a> can be
+<a href="http://svn.apache.org/viewcvs.cgi/jakarta/commons/proper/io/trunk/">browsed</a>.
</p>
</section>
<!-- ================================================== -->
@@ -65,16 +67,19 @@
</p>
</section>
<!-- ================================================== -->
-<section name="Bugs">
+<section name="Support">
<p>
-Bugs may be reported via the Bugzilla Management system. The following links may prove useful:
+The <a href="mail-lists.html">commons mailing lists</a> act as the main support forum.
+The user list is suitable for most library usage queries.
+The dev list is intended for the development discussion.
+Please remember that the lists are shared between all commons components,
+so prefix your email by [io].
+</p>
+<p>
+Issues may be reported via <a href="issue-tracking.html">ASF Bugzilla</a>.
+Please remember that Bugzilla is shared between all commons components,
+so prefix your issue by [io].
</p>
-<ul>
-<li><a href="http://issues.apache.org/bugzilla/createaccount.cgi">Create a Bugzilla account</a></li>
-<li><a href="http://issues.apache.org/bugzilla/enter_bug.cgi?product=Commons&component=IO&version=1.1%20Final">Submit a bug report</a></li>
-<li><a href="http://issues.apache.org/bugzilla/buglist.cgi?bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=NEEDINFO&email1=&emailtype1=substring&emailassigned_to1=1&email2=&emailtype2=substring&emailreporter2=1&bugidtype=include&bug_id=&changedin=&votes=&chfieldfrom=&chfieldto=Now&chfieldvalue=&product=Commons&component=IO&short_desc=&short_desc_type=allwordssubstr&long_desc=&long_desc_type=allwordssubstr&bug_file_loc=&bug_file_loc_type=allwordssubstr&keywords=&keywords_type=anywords&field0-0-0=noop&type0-0-0=noop&value0-0-0=&cmdtype=doit&newqueryname=&order=Reuse+same+sort+as+last+time">All open IO bugs</a></li>
-<li><a href="http://issues.apache.org/bugzilla/buglist.cgi?bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=NEEDINFO&bug_status=RESOLVED&bug_status=VERIFIED&bug_status=CLOSED&email1=&emailtype1=substring&emailassigned_to1=1&email2=&emailtype2=substring&emailreporter2=1&bugidtype=include&bug_id=&changedin=&votes=&chfieldfrom=&chfieldto=Now&chfieldvalue=&product=Commons&component=IO&short_desc=&short_desc_type=allwordssubstr&long_desc=&long_desc_type=allwordssubstr&bug_file_loc=&bug_file_loc_type=allwordssubstr&keywords=&keywords_type=anywords&field0-0-0=noop&type0-0-0=noop&value0-0-0=&cmdtype=doit&newqueryname=&order=Reuse+same+sort+as+last+time">All IO bugs</a></li>
-</ul>
</section>
<!-- ================================================== -->
</body>
Modified: jakarta/commons/proper/io/trunk/xdocs/issue-tracking.xml
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/io/trunk/xdocs/issue-tracking.xml?rev=332977&r1=332976&r2=332977&view=diff
==============================================================================
--- jakarta/commons/proper/io/trunk/xdocs/issue-tracking.xml (original)
+++ jakarta/commons/proper/io/trunk/xdocs/issue-tracking.xml Sun Nov 13 05:01:38 2005
@@ -23,16 +23,19 @@
<!-- ================================================== -->
<section name="Issue tracking">
<p>
+ Commons IO uses <a href="http://issues.apache.org/bugzilla/">ASF Bugzilla</a> for tracking issues.
+ To use Bugzilla you may need to <a href="http://issues.apache.org/bugzilla/createaccount.cgi">create an account</a>.
+</p>
+<p>
If you would like to report a bug, or raise an enhancement request with
Commons IO please do the following:
<ol>
- <li><a href="http://issues.apache.org/bugzilla/buglist.cgi?bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=NEEDINFO&bugidtype=include&chfieldfrom=&chfieldto=Now&chfieldvalue=&product=Commons&component=IO&short_desc=&short_desc_type=allwordssubstr&long_desc=&long_desc_type=allwordssubstr&bug_file_loc=&bug_file_loc_type=allwordssubstr&keywords=&keywords_type=anywords&field0-0-0=noop&type0-0-0=noop&value0-0-0=&cmdtype=doit">Search existing open bugs</a>.
- Hopefully, you will find your issue already listed.</li>
+ <li><a href="http://issues.apache.org/bugzilla/buglist.cgi?bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=NEEDINFO&product=Commons&component=IO">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><a href="http://issues.apache.org/bugzilla/enter_bug.cgi?product=Commons&component=IO&version=1.1%20Final">Submit a bug report</a>.
- To do this, you may need to <a href="http://issues.apache.org/bugzilla/createaccount.cgi">create an account</a> on Bugzilla.
- Please prefix all new bug reports by [io] in the summary line.
+ <li><a href="http://issues.apache.org/bugzilla/enter_bug.cgi?product=Commons&component=IO&version=1.1%20Final">Submit a bug report or enhancement request</a>.
+ Please prefix all new issues with [io] in the summary line.
</li>
</ol>
</p>
@@ -42,6 +45,14 @@
<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 IO are all unpaid volunteers</li>
+ </ul>
+</p>
+<p>
+ You may also find these links useful:
+ <ul>
+ <li><a href="http://issues.apache.org/bugzilla/buglist.cgi?bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=NEEDINFO&product=Commons&component=IO">All Open IO bugs</a></li>
+ <li><a href="http://issues.apache.org/bugzilla/buglist.cgi?bug_status=RESOLVED&bug_status=VERIFIED&bug_status=CLOSED&product=Commons&component=IO">All Closed IO bugs</a></li>
+ <li><a href="http://issues.apache.org/bugzilla/buglist.cgi?bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=NEEDINFO&bug_status=RESOLVED&bug_status=VERIFIED&bug_status=CLOSED&product=Commons&component=IO">All IO bugs</a></li>
</ul>
</p>
</section>
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org