Re: Proposed: gnome-nettool

[Rodrigo Moya <rodrigo gnome-db org>]

On Tue, 2004-07-27 at 15:58 +0100, Telsa Gwynne wrote:
> On Tue, Jul 20, 2004 at 01:00:00AM -0500 or thereabouts, Shaun McCance wrote:
> > (This is my analysis of the documentation, wearing my GDP FL hat.  This
> > is not my opinion of the program or its appropriateness for inclusion in
> > the Gnome desktop.)
> > 
> > GNOME Nettool has no documentation.  Ideally, a tool like this should
> > have a complete section on each tool, with background material on what
> > that tool actually does.  I do *not* want to see a section like this:
> > 
> > 3.2 Port Scan
> > 
> > Click the Port Scan tab to get the Port Scan tabbed section.  To port
> > scan a machine, enter the DNS or IP address of the machine in the text
> > field labelled 'Network address' and click the Scan button.  The results
> > of the port scan will be displayed in the text area below.
> > 
> > Really, documenting this well means explaining each of the tools, what
> > they do, and why you would want to use them.  This can be a sizeable
> > task, and will almost certainly require some cooperation from people
> > knowledgeable.
> 
> Yay Shaun! 
> 
> This is the sort of thing I love doing (I learned so _much_ 
> documenting gtop Way Back When), and the sort of documentation
> I enjoy reading. If someone has this in hand I shall be delighted,
> but if not, I shall tentatively say I can give it a go, if I 
> get it to build.
> 
do you mean you want to give a go writing the gnome-nettool
documentation? If so, please do, I just started creating the doc/
directory skeleton, but haven't had any time to write anything, so if
you could do it, that would be great :)

cheers
-- 
Rodrigo Moya <rodrigo gnome-db org>