After Volcane recommended NaturalDocs in a previous thread about documenting Puppet modules, I used it for Augeas and I'm quite happy of the result [0].
The NaturalDocs developer, Greg Valure, was kind enough to send me an Augeas.pm to parse Augeas definitions and include them in the documentation. Raphaël [0] http://augeas.net/docs/references/lenses/index.html On Tue, Sep 23, 2008 at 5:39 AM, Ohad Levy <[EMAIL PROTECTED]> wrote: > Can anyone give me a hint about how to use puppet to parse the > configuration of a host (e.g. auto load all needed manifest files using > puppet internals using external node, inheritance order etc ). > > After this part is done, it should be rather easy to parse all of the files > and generate some html code. > > Thanks, > Ohad > > > On Tue, Sep 23, 2008 at 8:48 AM, Blake Barnett <[EMAIL PROTECTED]> wrote: > >> On Sep 22, 2008, at 5:45 AM, [EMAIL PROTECTED] wrote: >> >> >> Hi Guys, >> >> Does anyone know of, or are there any plans for, a documentation >> parser/generator for puppet, akin to pydoc or javadoc? >> >> In my opinion, one of the unsung advantages of managing systems via puppet >> is that you get a formal definition of your systems state which is only a >> hair-width away from being able to serve as system documentation. >> >> For most of our key systems, we have a document listing installed packages >> and config - information that is already contained within my manifests. >> However, if I point my manager directly to our manifests I doubt he'd >> consider it sufficient. I suspect a pretty html page, containing basically >> the same info with some additional comments would be sufficient, however. >> >> >> I would love to see something like this happen. You can search the list >> archives for various proposals and discussions on how it can be done. Luke >> has suggested modifying the parser to identify comment blocks before each >> code section as documentation for that section. I gave a quick stab in the >> dark (I am very unfamiliar with RACC and parsers in general), but couldn't >> get it working the way I wanted. I think even a simple tool that does this >> outside of puppet would be a great start. >> >> -Blake >> >> >> >> >> > > > > --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "Puppet Users" group. To post to this group, send email to puppet-users@googlegroups.com To unsubscribe from this group, send email to [EMAIL PROTECTED] For more options, visit this group at http://groups.google.com/group/puppet-users?hl=en -~----------~----~----~----~------~----~------~--~---
