[Nagiosplug-help] Plug-ins Documentation

[Karl DeBisschop]

On Fri, 26 Mar 2004 11:41:12 -0500
Darrell Mozingo <dmozingo at topechelon.com> wrote:

> I agree. I'd chip in whatever I could. Having everything you'd need in
> one place would be invaluable. Better documentation for redundant
> monitoring, event handlers, and Windows monitoring.

Of course you are all free to do waht you will. And the alternative is
still vaporware. But I'd prefer to develop something that was integrated
into the plugins so that as the plugins will modified the documentation
would by also. Think perldoc except in C.

I had a prototype working in fact, but had to break it apart in order to
make internationalization work.

But even so, I think embedded docs are the way to go, and that is the
direction the plugins have been working towrad.

As I say, you can always do what you want. But I'd prefer to have people
contribute to an engine that could take the existing help text plus
appropriatealy formatted comments and create standalone docs from that.

Anyone up to the challenge?

--
Karl

> On Fri, 2004-03-26 at 10:34, Warrick FitzGerald wrote:
> 
> > I think you rock and I'd contribute.
> > 
> > Thanks
> > Warrick 
> > 
> > 
> > -----Original Message-----
> > From: nagiosplug-help-admin at lists.sourceforge.net
> > [mailto:nagiosplug-help-admin at lists.sourceforge.net] On Behalf Of
> > Alessandro Fernandes Martins
> > Sent: Friday, March 26, 2004 10:28 AM
> > To: Nagiosplug-help at lists.sourceforge.net
> > Subject: [Nagiosplug-help] Plug-ins Documentation
> > 
> > Hi,
> > 
> > A user from the Nagios-users-br mailing list asked if there is any
> > documentation about Nagios plug-ins... talking with Ethan he told me
> > 
> > that the usual response on the mailing list is to run each plugin 
> > with the "--help" command line option.
> > 
> > Well, as his suggestion I would like to start standalone projet for 
> > documentation.
> > 
> > What do you think?
> > 
> > Regards,
> 
> 
> 
> 
> 
>  
> 
> Darrell Mozingo
> Systems Administrator
> Phone: (330) 455-1433
> Ext. 107
> Fax: (330) 455-8813 
> Email:
> DMozingo at TopEchelon.com
> www.topechelon.com
> 
>