On Fri, Jul 30, 2010 at 10:04 AM, Ding Deng ding.d...@gmail.com wrote:
Hi,
Is Docs: Style Guide[1] officially recommended? Styles are
inconsistent across the documentation site, so either the guide or other
docs have to be fixed.
I personally recommend the Style Guide since I wrote a decent chunk of
that document, however there is no official style since puppet is an
open source project with a large and active community.
The guide is a result of years of experience maintaining puppet
manifests from multiple members of the community, so that hopefully
provides credence, but should not be considered the only right way to
write puppet manifests.
Style will likely never be 100% consistent across our documentation
site since many people are involved in the process of documenting
puppet and style differs among these participants. I think this is a
feature and not a bug of the community.
To provide a little background, my contributions to the style guide
result from a preference for readability over write-ability (code's
read far more often), consistency to minimize surprises for newcomer,
line-oriented for commit diffs, and vertical-orientation for showing
off to groups and quickly scanning/reading the manifests.
It also looks nice on a projector/beamer. =) To me at least...
--
Jeff McCune
http://www.puppetlabs.com/
--
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.
