Feature #840
add api support to retrieve module documentation
| Status: | New | Start: | 04/13/2011 | |
|---|---|---|---|---|
| Priority: | Normal | Due date: | ||
| Assigned to: | - | % Done: | 0% |
|
| Category: | - | |||
| Target version: | - | |||
| Backlog: | No | Difficulity: | ||
| Votes: | 0 |
Description
Puppet has a nice module documentation feature outlined here:
http://projects.puppetlabs.com/projects/1/wiki/Puppet_Manifest_Documentation
It would like to be able to retrieve parts of this documentation when calling the puppetclasses api so that it passes it back through json.
http://foreman:port/puppetclasses
So in addition to the name and id that gets returned I would like to see the following at a minimum:
description: "This class installs our default set of users in our servers"
Example: # Class: users # # This class installs our default set of users in our servers # # Parameters: # $starting_uid: # this global variable is used to set the minimum uid used for our users # # Actions: # Install the default set of users: [dana,fox] # # Requires: # - Package["zsh"] # # Sample Usage: #
History
Updated by Corey Osman almost 2 years ago
I was told by puppetlabs this can be done with rdoc or puppet doc. Looks like smart proxy will need a new feature to query modules for this information.
