Hi all

Some time ago we created a new project called Puppet Docs.  This took
our existing reference documentation (which is auto-generated from the
Puppet Core source code) and added together some pages from the Wiki and
some new content.  That content was published at http://docs.puppetlabs.com.

We're now discussing whether it is a good idea to separate our
documentation from the Puppet Core.  What we're proposing is to move all
the content from Puppet Docs (barring MCollective - which will stay in
the Mcollective repository) into the Puppet Core repository, probably
under a directory called "docs".

The documentation will still be published onto the Puppet Docs site when
updates occur but the "code" itself will be maintained in the same
repository as the Puppet core code.

The advantages to this we see as:

1.  It's simpler to have the code and the docs in the same place
2.  It lowers the barrier to entry for contributors - only having to
maintain one repository and work from one repository.
3.  We hope it'll encourage people to update Docs more when they make
changes if they have to only commit code to one repository.
4.  One project/place to log documentation tickets rather than two
separate Redmine projects.

We're seeking feedback on this idea from the community before we proceed.

Regards

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 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.

Reply via email to