Re: [Bug 2328] New: - easy change to ant doc make much more browsable

[Peter Donald <do...@apache.org>]

On Wed, 27 Jun 2001 01:52, Steve Loughran wrote:
> ----- Original Message ----- >
>
> > + Specifically, having the Ant tasks presented one
> > + per html page is not conducive to introducing the
> > + new ant user to what ant's built in capabilities are.
> > +
> > + I suggest either
> > + 1) a intro page with an 2-3 sentence description of each
> > + Ant command.
> > + 2) gluing all of the pages together in a pdf, so that
> > + that tree killers (incl. myself) can easily download and
> > + print out a physically browsable menu.
> > \ No newline at end of file
>
> The problem seems valid to me, but there may be alternate solutions.
>
> One of the problems of the current layout is that it groups stuff in two
> alphabetical lists -one for optional, one for core.
>
> What might be useful is a single page listing tasks by category:
>
> Java Compilation
>  javac, depends
>
> File Management
>  copy, delete, replace, crlf
>
> archives
>  zip, jar, tar, war, ejbjar
>
> deployment
>  -ftp, telnet, SQL
>
> SCM
>  -CVS, clearcase, perforce, VSS
>
> Testing and code quality
>  -junit, jprobe, icontract, ...
>
> ant control
>  available, taskdef, ant, antcall, property
>
> The aim would be to point people at the likely ant tasks based on user
> tasks. Making the list isnt too hard, apart from deciding where some tasks
> go.
>
> Comments?

+1 and these same categories would be good categories to base ant2 .tsk files 
on aswell ;)

BTW are you volunteering? ;)

Cheers,

Pete

*-----------------------------------------------------*
| "Faced with the choice between changing one's mind, |
| and proving that there is no need to do so - almost |
| everyone gets busy on the proof."                   |
|              - John Kenneth Galbraith               |
*-----------------------------------------------------*

Re: [Bug 2328] New: - easy change to ant doc make much more browsable

[Steve Loughran <st...@iseran.com>]

----- Original Message -----
From: "Peter Donald" <do...@apache.org>
To: <an...@jakarta.apache.org>
Sent: Tuesday, June 26, 2001 09:46
Subject: Re: [Bug 2328] New: - easy change to ant doc make much more
browsable


> On Wed, 27 Jun 2001 01:52, Steve Loughran wrote:

> > What might be useful is a single page listing tasks by category:
> >
> > Java Compilation
> >  javac, depends
> >
> > File Management
> >  copy, delete, replace, crlf
> >
> > archives
> >  zip, jar, tar, war, ejbjar
> >
> > deployment
> >  -ftp, telnet, SQL
> >
> > SCM
> >  -CVS, clearcase, perforce, VSS
> >
> > Testing and code quality
> >  -junit, jprobe, icontract, ...
> >
> > ant control
> >  available, taskdef, ant, antcall, property
> >
> > The aim would be to point people at the likely ant tasks based on user
> > tasks. Making the list isnt too hard, apart from deciding where some
tasks
> > go.
> >
> > Comments?
>
> +1 and these same categories would be good categories to base ant2 .tsk
files
> on aswell ;)
>
> BTW are you volunteering? ;)

If I wasnt knee deep in deployment hell I'd consider it (indeed, there may
be a special level in hell full of nothing but win2K/IIS boxes needing
configuration). If nobody makes a start on this in a few days I'll give it a
go.

-steve