On Feb 9, 2010, at 10:40 AM, Michael DeHaan
<mich...@reductivelabs.com> wrote:
On Tue, Feb 9, 2010 at 11:15 AM, Nigel Kersten <nig...@google.com>
wrote:
I honestly think the most important thing for new users is to clean
up the
documentation.
Not a lot of the existing docs on the wiki read as being particularly
authoritative. They're full of lines like:
"Exporting and collecting resources is an extension of virtual
resources.
Puppet provides an experimental superset of virtual resources,
using a
similar syntax." <- are exported resources really "experimental"
anymore?
Something that has been noted in the past as being problematic was
the fact
that it's not always clear what version of puppet given functionality
appeared in. This was a much bigger problem in the 0.24.x series
where new
features were being added, and the new approach to releases should
make this
easier, but it was definitely a problem in the past.
I like having a community contributed wiki, but wikis are prone to
producing
documentation that isn't authoritative ( "I managed to get foo to
work by
doing blah") without a clear sense of direction.
Yeah, I like Wiki's too... I think there's a bit of "best practices"
kind of stuff we'll want as well, in those docs, so we don't lead
people too far astray and get them frustrated.
So we'll still have a Wiki for those things, because that's really
great info to capture as well. Gotta have that.
I believe the docs are all in SVN now, and I realize the idea of
submitting a bug to change a page is suboptimal, though you can check
them all out in github. Patches and help reviewing would be *VERY*
welcome.
I think patches & tickets are probably the best way to manage
community contributions to the curated docs, which need to be kept to
a much higher standard of quality than the "wild west" of wiki docs.
If anyone wants to just send me email about portions that suck (in the
static docs), let me know, and I'll get those cleaned up.
This sounds great, but please keep feedback going through tickets.
Bruce
--Michael
--
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
.
--
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.
