You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by robert burrell donkin <ro...@blueyonder.co.uk> on 2006/01/21 18:38:23 UTC
[logging] improvements to generated documentation
the site generated by maven could do with some improvements before the
release. here's a brief list (but could do with a general review):
1 junit report - this should be replaced by a note explaining that maven
cannot run the JCL unit tests
2 javadocs warnings and errors - these need to be eliminated
3 task list - we don't use it so probably wants removing
4 use the improved mailing list and issues documentation created by
stephen at el. ideally, these should be fed back into the maven loop.
anyone fancy picking any of these up?
- robert
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org
Re: [logging] improvements to generated documentation
Posted by robert burrell donkin <ro...@blueyonder.co.uk>.
On Sun, 2006-01-22 at 14:45 +1300, Simon Kitching wrote:
> On Sun, 2006-01-22 at 00:15 +0100, Dennis Lundberg wrote:
> > I'd like to change the menu on the site so that it looks like the one
> > used on the digester site [1]. That mean changing the menu items "1.0.4
> > Release", "1.0.3 Release" and "1.0.2 Release" to be menus.
> >
> > There are two reasons for this:
> >
> > 1. It looks better
> >
> > 2. These menu items doesn't have a href, but they are still clickable,
> > going to the same page that the user is on. This is confusing to users.
>
> > [1] http://jakarta.apache.org/commons/digester/
> >
>
> Sounds good.
+1
- robert
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org
Re: [logging] improvements to generated documentation
Posted by Simon Kitching <sk...@apache.org>.
On Sun, 2006-01-22 at 00:15 +0100, Dennis Lundberg wrote:
> I'd like to change the menu on the site so that it looks like the one
> used on the digester site [1]. That mean changing the menu items "1.0.4
> Release", "1.0.3 Release" and "1.0.2 Release" to be menus.
>
> There are two reasons for this:
>
> 1. It looks better
>
> 2. These menu items doesn't have a href, but they are still clickable,
> going to the same page that the user is on. This is confusing to users.
> [1] http://jakarta.apache.org/commons/digester/
>
Sounds good.
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org
Re: [logging] improvements to generated documentation
Posted by Dennis Lundberg <de...@apache.org>.
robert burrell donkin wrote:
> the site generated by maven could do with some improvements before the
> release. here's a brief list (but could do with a general review):
>
> 1 junit report - this should be replaced by a note explaining that maven
> cannot run the JCL unit tests
> 2 javadocs warnings and errors - these need to be eliminated
> 3 task list - we don't use it so probably wants removing
> 4 use the improved mailing list and issues documentation created by
> stephen at el. ideally, these should be fed back into the maven loop.
>
> anyone fancy picking any of these up?
I'd like to change the menu on the site so that it looks like the one
used on the digester site [1]. That mean changing the menu items "1.0.4
Release", "1.0.3 Release" and "1.0.2 Release" to be menus.
There are two reasons for this:
1. It looks better
2. These menu items doesn't have a href, but they are still clickable,
going to the same page that the user is on. This is confusing to users.
[1] http://jakarta.apache.org/commons/digester/
--
Dennis Lundberg
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org
Re: [logging] improvements to generated documentation
Posted by Rahul Akolkar <ra...@gmail.com>.
On 1/21/06, Dennis Lundberg <de...@apache.org> wrote:
> Rahul Akolkar wrote:
<snip/>
> >
> > I see 3 warnings, so does this page:
> > http://jakarta.apache.org/commons/logging/javadoc.html
> >
> > I get a clean slate after the related patch here:
> > http://issues.apache.org/bugzilla/show_bug.cgi?id=38344
>
> Can you run this command:
> maven --info
>
> Then e-mail me the section "Installed plugins" so I can check what
> differs between your setup and mine. Perhaps the problem has been solved
> by an updated plugin.
>
<snap/>
Thanks, IMO, we're now done with 38344 and this doesn't deserve any more cycles.
-Rahul
> --
> Dennis Lundberg
>
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org
Re: [logging] improvements to generated documentation
Posted by Dennis Lundberg <de...@apache.org>.
Rahul Akolkar wrote:
> On 1/21/06, Dennis Lundberg <de...@apache.org> wrote:
> <snip/>
>>>> 2 javadocs warnings and errors - these need to be eliminated
>> These are already gone.
>>
> <snap/>
>
> I see 3 warnings, so does this page:
> http://jakarta.apache.org/commons/logging/javadoc.html
>
> I get a clean slate after the related patch here:
> http://issues.apache.org/bugzilla/show_bug.cgi?id=38344
Can you run this command:
maven --info
Then e-mail me the section "Installed plugins" so I can check what
differs between your setup and mine. Perhaps the problem has been solved
by an updated plugin.
--
Dennis Lundberg
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org
Re: [logging] improvements to generated documentation
Posted by Rahul Akolkar <ra...@gmail.com>.
On 1/21/06, Dennis Lundberg <de...@apache.org> wrote:
<snip/>
>
> >> 2 javadocs warnings and errors - these need to be eliminated
>
> These are already gone.
>
<snap/>
I see 3 warnings, so does this page:
http://jakarta.apache.org/commons/logging/javadoc.html
I get a clean slate after the related patch here:
http://issues.apache.org/bugzilla/show_bug.cgi?id=38344
>
> >> 4 use the improved mailing list and issues documentation created by
> >> stephen at el. ideally, these should be fed back into the maven loop.
>
> It's already in the Maven loop, thanks to niallp. See
> http://jira.codehaus.org/browse/MPXDOC-183
>
<snip/>
Interim solution attached to 38344 (most Commons component use this).
-Rahul
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org
Re: [logging] improvements to generated documentation
Posted by Dennis Lundberg <de...@apache.org>.
robert burrell donkin wrote:
> On Sat, 2006-01-21 at 19:41 +0100, Dennis Lundberg wrote:
>> Rahul Akolkar wrote:
>>> On 1/21/06, robert burrell donkin <ro...@blueyonder.co.uk> wrote:
>>>> the site generated by maven could do with some improvements before the
>>>> release. here's a brief list (but could do with a general review):
>>>>
>>>> 1 junit report - this should be replaced by a note explaining that maven
>>>> cannot run the JCL unit tests
>> This would mean removing the junit report and adding a new xdocs page. I
>> can do the site stuff if someone else can write a nice text to put on
>> the page.
>
> here a first draft:
>
> "The Jakarta Commons Logging test cases make extensive use of
> sophisticated classloader configurations in order to simulate the
> behaviour of various containers. It is difficult to run these tests
> under Maven (which is used to generate the website). Once JCL is
> upgraded to Maven 2 it is hoped that we will be able to display a report
> on the unit tests."
>
> hopefully people will dive in and patch once it's in the
> documentation...
Checked in as xdocs/junit-report.xml if someone wants to patch the text.
--
Dennis Lundberg
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org
Re: [logging] improvements to generated documentation
Posted by robert burrell donkin <ro...@blueyonder.co.uk>.
On Sat, 2006-01-21 at 19:41 +0100, Dennis Lundberg wrote:
> Rahul Akolkar wrote:
> > On 1/21/06, robert burrell donkin <ro...@blueyonder.co.uk> wrote:
> >> the site generated by maven could do with some improvements before the
> >> release. here's a brief list (but could do with a general review):
> >>
> >> 1 junit report - this should be replaced by a note explaining that maven
> >> cannot run the JCL unit tests
>
> This would mean removing the junit report and adding a new xdocs page. I
> can do the site stuff if someone else can write a nice text to put on
> the page.
here a first draft:
"The Jakarta Commons Logging test cases make extensive use of
sophisticated classloader configurations in order to simulate the
behaviour of various containers. It is difficult to run these tests
under Maven (which is used to generate the website). Once JCL is
upgraded to Maven 2 it is hoped that we will be able to display a report
on the unit tests."
hopefully people will dive in and patch once it's in the
documentation...
- robert
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org
Re: [logging] improvements to generated documentation
Posted by Dennis Lundberg <de...@apache.org>.
Rahul Akolkar wrote:
> On 1/21/06, robert burrell donkin <ro...@blueyonder.co.uk> wrote:
>> the site generated by maven could do with some improvements before the
>> release. here's a brief list (but could do with a general review):
>>
>> 1 junit report - this should be replaced by a note explaining that maven
>> cannot run the JCL unit tests
This would mean removing the junit report and adding a new xdocs page. I
can do the site stuff if someone else can write a nice text to put on
the page.
>> 2 javadocs warnings and errors - these need to be eliminated
These are already gone.
>> 3 task list - we don't use it so probably wants removing
I'll do this together with 5.
>> 4 use the improved mailing list and issues documentation created by
>> stephen at el. ideally, these should be fed back into the maven loop.
It's already in the Maven loop, thanks to niallp. See
http://jira.codehaus.org/browse/MPXDOC-183
> <snip/>
>
> Allow me to add:
>
> 5. Add URLs to dependencies page
I'll do this.
> 6. Figure out why the links are broken on (try clicking the line number):
> http://jakarta.apache.org/commons/logging/javadoc-warnings-report.html
I'll see if I can track this one down using the 1.0.4 release as a test
case. If something is wrong in Maven I'll contact them as well.
>> anyone fancy picking any of these up?
>>
> <snap/>
>
> I will attach fixes for 2 through 4 to bugzilla by end of day tomorrow
> -- Sunday -- and that will indirectly take care of 6, but IMO, its a
> distinct issue nevertheless.
>
> 1 and 5, anyone? Whats causing 6?
>
> -Rahul
>
>
>> - robert
>>
>
--
Dennis Lundberg
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org
Re: [logging] improvements to generated documentation
Posted by robert burrell donkin <ro...@blueyonder.co.uk>.
On Sat, 2006-01-21 at 13:19 -0500, Rahul Akolkar wrote:
<snip>
> 6. Figure out why the links are broken on (try clicking the line number):
> http://jakarta.apache.org/commons/logging/javadoc-warnings-report.html
<snip>
> Whats causing 6?
vadoc/src/org/apache/commons/logging/LogFactory.java
^^^^^
but i'm not sure what's causing the vadoc prefix to be inserted.
i'll try to get back to this once i've finished the documentation i'm
working on (if no one beats me to it)...
- robert
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org
Re: [logging] improvements to generated documentation
Posted by Rahul Akolkar <ra...@gmail.com>.
On 1/21/06, robert burrell donkin <ro...@blueyonder.co.uk> wrote:
> the site generated by maven could do with some improvements before the
> release. here's a brief list (but could do with a general review):
>
> 1 junit report - this should be replaced by a note explaining that maven
> cannot run the JCL unit tests
> 2 javadocs warnings and errors - these need to be eliminated
> 3 task list - we don't use it so probably wants removing
> 4 use the improved mailing list and issues documentation created by
> stephen at el. ideally, these should be fed back into the maven loop.
>
<snip/>
Allow me to add:
5. Add URLs to dependencies page
6. Figure out why the links are broken on (try clicking the line number):
http://jakarta.apache.org/commons/logging/javadoc-warnings-report.html
> anyone fancy picking any of these up?
>
<snap/>
I will attach fixes for 2 through 4 to bugzilla by end of day tomorrow
-- Sunday -- and that will indirectly take care of 6, but IMO, its a
distinct issue nevertheless.
1 and 5, anyone? Whats causing 6?
-Rahul
>
> - robert
>
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org