Are you proposing that each component add their own custom "issue-tracking.xml" and "cvs-usage.xml" pages - or having standard templates for them in commons-build that can be used to generate a custom one for the component? +1 to that from me.
Also, for the "issue-tracking.xml" pages I just set up for Validator and BeanUtils - I used the "Math" component for the basis of "submit a bug report or enhancement" link - it puts some default text in the bug with useful instructions and also automatically adds the prefix of the component ( e.g. "[beanutils]" ) to the subject line. http://jakarta.apache.org/commons/beanutils/issue-tracking.html Niall ----- Original Message ----- From: "Stephen Colebourne" <[EMAIL PROTECTED]> To: "Jakarta Commons Developers List" <[email protected]> Sent: Monday, November 14, 2005 10:39 PM Subject: [all] Website enhancements [was Release Validator 1.2.0] > I spent some of the weekend fine tuning some improvements to the maven > documentation. I'd like to propose that other components consider the > same ideas. > > 1) Improving cvs-usage: > Maven default: > http://jakarta.apache.org/commons/digester/cvs-usage.html > Improved version: > http://jakarta.apache.org/commons/io/cvs-usage.html > > This provides much more info. > > 2) Improved issue-tracking: > Maven default: > http://jakarta.apache.org/commons/cli/issue-tracking.html > Improved version: > http://jakarta.apache.org/commons/io/issue-tracking.html > > Again, this provides much more info and hopefully improves reporting. > > 3) Including three sections on the home page - Documentation, Releases, > Support, example: > http://jakarta.apache.org/commons/io/ > > These provide the links to the improved pages, and also stress the [xxx] > convention for mailing lists and bugs. > > 4) Breaking the left navigation into Commons Xxx and Development menus, > example: > http://jakarta.apache.org/commons/io/ > > This separates the needs of most users from the needs of those who get > much more involved. > > 5) Javadoc directories: > The latest svn docs: > http://jakarta.apache.org/commons/io/apidocs/index.html > Version 1.0: > http://jakarta.apache.org/commons/io/api-1.0/index.html > Version 1.1: > http://jakarta.apache.org/commons/io/api-1.1/index.html > The latest release (a unix link to api-1.1): > http://jakarta.apache.org/commons/io/api-release/index.html > > This is the current best fit with maven, as maven can and will freely > overwrite the apidocs directory. Thus the idea is that when you do a > release, you copy the docs to the named directory manually. > > > > I'm not forcing anybody into anything :-), but I think these do provide > benefits to our users if we can share them across more commons > components. I would like us to try and agree on one naming convention > for the javadocs if at all possible. > > Currently these changes are implemented on [collections] and [io], and > are on their way (all or in part) in [validator] & [beanutils]. > > Stephen > > --------------------------------------------------------------------- > To unsubscribe, e-mail: [EMAIL PROTECTED] > For additional commands, e-mail: [EMAIL PROTECTED] > > > --------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
