+1 to any well-formed data about modules. FWIW, there was a discussion last year about storing metadata in JSON or YAML format.
J. On 31 May 2010 03:10, Daniel Pittman <dan...@rimspace.net> wrote: > "Gabriel - IP Guys" <gabr...@impactteachers.com> writes: > > > Just a idea to float out here among puppet forge users, > > > > Can we have a readme standard? For example, we could have a format like > the > > following > > FWIW, a *great* model to follow is probably the standard Unix manual page > format, which has had thirty years of working reasonably well for > documenting > this sort of thing. > > If you forgive my linking into a Perl tool, this is probably the most > user-friendly documentation about the structure of a good manual page for > software tools I know of: > > http://search.cpan.org/~jhi/perl-5.8.1/pod/pod2man.PL#NOTES > > Specifically, the 'NOTES' section includes the details on how to structure > the > manual page and what to include in each section. > > > Using a model like that means the puppet community can work from the base > of a > good, solid existing practice rather than inventing their own standards — > and, > of course, having to rediscover the same problems everyone else ran into. > :) > > Regards, > Daniel > > -- > ✣ Daniel Pittman ✉ dan...@rimspace.net ☎ +61 401 155 > 707 > ♽ made with 100 percent post-consumer electrons > > -- > You received this message because you are subscribed to the Google Groups > "Puppet Users" group. > To post to this group, send email to puppet-us...@googlegroups.com. > To unsubscribe from this group, send email to > puppet-users+unsubscr...@googlegroups.com<puppet-users%2bunsubscr...@googlegroups.com> > . > For more options, visit this group at > http://groups.google.com/group/puppet-users?hl=en. > > -- Julian Simpson Software Build and Deployment http://www.build-doctor.com http://twitter.com/builddoctor -- You received this message because you are subscribed to the Google Groups "Puppet Users" group. To post to this group, send email to puppet-us...@googlegroups.com. To unsubscribe from this group, send email to puppet-users+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/puppet-users?hl=en.
