Hi all One of the big pieces of work we undertook earlier in the year was migrating the wiki from Trac and establishing the Puppet Docs site at:
http://docs.puppetlabs.com During this process we began doing a programmatic conversion of the Restructured Text output from the automatically generated documentation to Markdown. The conversion process is less than perfect and some of the Markdown generated is not overly elegant - making some of our Docs pages ugly and hard to read. As a result we've decided to rewrite the internal documentation from Restructured Text to Markdown (see http://projects.puppetlabs.com/issues/4509). This is largely: 1. The types and providers documentation (lib/puppet/types/typename.rb & lib/puppet/providers/provider...) 2. The functions and metaparameter documentation (lib/puppet/parser/functions/functioname.rb) 3. The configuration reference (lib/puppet/default.rb) 4. And the report, network and indirection references Updating this documentation doesn't require any Ruby knowledge! All you need to be able to do is change the existing format into Markdown (both are fairly simple markup formats). So if you've ever wanted to contribute to Puppet's core and get some commits on the board then this is the perfect opportunity. All you need to go is clone the Puppet git repo and follow the development life cycle documentation - http://projects.puppetlabs.com/projects/puppet/wiki/Development_Lifecycle - (or feel free to ask for help on #puppet on IRC or either list). OR email me or anyone else from the team if you'd like to help. Even a small number of commits will assist us in migrating this documentation and making the experience of using Puppet easier! Cheers James Turnbull -- Puppet Labs - http://www.puppetlabs.com C: 503-734-8571 -- You received this message because you are subscribed to the Google Groups "Puppet Users" group. To post to this group, send email to [email protected]. 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.
