[prev in list] [next in list] [prev in thread] [next in thread] 

List:       log4j-user
Subject:    Re: log4j documentation help?
From:       Mark Womack <mwomack () apache ! org>
Date:       2005-12-21 17:24:30
Message-ID: 284ea76b0512210924g5ad82f30j72524bba92fd3848 () mail ! google ! com
[Download RAW message or body]

Something like this is a good start, and I think we have pieces of it.
 But something a little more in-depth about the overall structure,
flow, and points of configuration would be useful too.

On 12/20/05, Ron Grabowski <rongrabowski@yahoo.com> wrote:
> Are you looking for something like this:
>
>  http://logging.apache.org/log4net/release/manual/configuration.html
>
>  http://logging.apache.org/log4net/release/config-examples.html
>
> Examples showing how to use each of the built-in appenders is helpful.
>
> ----- Original Message ----
> From: Mark Womack <mwomack@apache.org>
> To: Log4J Users List <log4j-user@logging.apache.org>
> Sent: Tuesday, December 20, 2005 6:15:47 PM
> Subject: Re: log4j documentation help?
>
> Wiki is good for learnings, and we can certainly do that, but we are
> looking to provide something more concrete/permanent than just wiki
> pages.
>
> We have started looking at tools like Maven2 which can provide a lot
> information about the project, but as I said, we want to start
> creating "users manual" type information.  Starting with the overall
> usage and the top 10 asked questions would probably be a good start I
> imagine.
>
> -Mark
>
> On 12/20/05, James Stauffer <stauffer.james@gmail.com> wrote:
> > How about putting it in a wiki?  Most of my helpful additions for
> > documentation would just come as learn/use the code so that would be
> > the easiest way to add helpful tidbits.
> >
> > On 12/20/05, Mark Womack <mwomack@apache.org> wrote:
> > > One of the tasks for the log4j 1.3 release (or even before that) is to
> > > create a better documentation set for log4j.  This would be both the
> > > documentation that ships at part of the release and what is available
> > > from the web.  I am speaking for myself, but I think most of the
> > > committers agree, that the current documentation on the web needs to
> > > be greatly updated and provide more information.
> > >
> > > I know that some of you out there have posted similar sentiments in
> > > the past.  As I said, we are looking to updated it for at least the
> > > 1.3 release.  So, we are looking for volunteers that want to do
> > > something about it.  Maybe you want to write some clearer
> > > documentation, provide better examples, or know an out-of-work tech
> > > writer that would like to use it as a reference :-).
> > >
> > > The code API's will be handled by the generated javadoc's.  What we
> > > are talking about here is more of a user's manual.
> > >
> > > We (the committers) are going to do a better job of it, but it just
> > > seems like documentation for the user community might be better served
> > > by getting that community directly involved.  We want you involved.
> > >
> > > Any takers?  Comments, suggestions?
> > >
> > > -Mark
> > >
> > > ---------------------------------------------------------------------
> > > To unsubscribe, e-mail: log4j-user-unsubscribe@logging.apache.org
> > > For additional commands, e-mail: log4j-user-help@logging.apache.org
> > >
> > >
> >
> >
> > --
> > James Stauffer
> > Are you good? Take the test at http://www.livingwaters.com/good/
> >
> > ---------------------------------------------------------------------
> > To unsubscribe, e-mail: log4j-user-unsubscribe@logging.apache.org
> > For additional commands, e-mail: log4j-user-help@logging.apache.org
> >
> >
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: log4j-user-unsubscribe@logging.apache.org
> For additional commands, e-mail: log4j-user-help@logging.apache.org
>
>
>
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: log4j-user-unsubscribe@logging.apache.org
> For additional commands, e-mail: log4j-user-help@logging.apache.org
>
>

---------------------------------------------------------------------
To unsubscribe, e-mail: log4j-user-unsubscribe@logging.apache.org
For additional commands, e-mail: log4j-user-help@logging.apache.org


[prev in list] [next in list] [prev in thread] [next in thread]