Issue #7562 has been updated by Nick Fagerlund.

File catalog.ronn added

Man pages will be per-face, not per-action. 

Status: I currently have a prototype manpage source file that generates 
goodness when run through Ronn. 

Subtasks for this ticket that I'm aware of: 

* Turning the prototype into a re-usable template. Will probably entail close 
pairing w/ me and R&D for a few hours.
* Implementing an action on the help face that generates an output string for a 
face using this template. 
* Vendoring [Ronn](https://github.com/rtomayko/ronn/). I know, but if we don't 
do this, we'll have to invent something that does the same thing. 
* Implementing a 'man' face (with a default action of man) that generates the 
same output string as the help action, runs it through ronn, and displays it in 
the pager.
* Coming up with a hook or rake task that builds every necessary man file into 
puppet/man, so packagers can get the manpages installed into the manpath. 
* Helping me refactor the equivalent task in the docs project that builds the 
HTML versions of the man pages, including adding versioning like we use for the 
generated references. 

There's also the question of content, but the help and man content are all of a 
piece, really. 
----------------------------------------
Feature #7562: Documentation: man pages for all Faces
https://projects.puppetlabs.com/issues/7562

Author: Randall Hansen
Status: Accepted
Priority: Normal
Assignee: 
Category: Faces
Target version: 
Affected Puppet version: 2.7.0rc2
Keywords: 
Branch: 


We need man pages (complete help, presented as a man page in a pager) for all 
Faces we ship with 2.7



-- 
You have received this notification because you have either subscribed to it, 
or are involved in it.
To change your notification preferences, please click here: 
http://projects.puppetlabs.com/my/account

-- 
You received this message because you are subscribed to the Google Groups 
"Puppet Bugs" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to 
[email protected].
For more options, visit this group at 
http://groups.google.com/group/puppet-bugs?hl=en.

Reply via email to