Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Curated Puppet Documentation
Ruby JavaScript

This branch is 1 commit ahead, 6988 commits behind puppetlabs:master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
bin
files
images
lib
output
snippets
source
spec
.gitignore
Gemfile
LICENSE
README.markdown
Rakefile
config.ru

README.markdown

Puppet Docs

Curated documentation for Puppet.

Installation

Clone the repository:

$ git clone git://github.com/reductivelabs.com/puppet-docs.git

Install the dependencies

$ sudo rake install

Generate the documentation:

$ rake generate

Start a little server to view it at http://localhost:9292:

$ rake serve

Note: Use rake run to combine these last two steps.

Errors and Omissions

If something in the documentation doesn't seem right -- or if you think something important is missing, please submit a ticket to the "puppet-docs" project (not to Puppet itself). The best way to get your change in is to contribute it; see the next section for details.

NOTE: If you're talking about additional content, keep in mind that it might make more sense to be on the Wiki. You might want to start by adding it there.

Contributing Changes

  • Fork the project.
  • Make your documentation addition/fix -- preferably in a branch.
  • If you're fixing or adding features to the generation infrastructure, add some passing specs.
  • Commit, do not mess with the README, LICENSE, etc.
  • Submit a ticket requesting your contribution be added, and make sure you note the location of the repository and branch.

Copyright

Copyright (c) 2009 Reductive Labs. See LICENSE for details.

Something went wrong with that request. Please try again.