Issue #20688 has been reported by Wolf Noble. ---------------------------------------- Feature #20688: it would be awesome if PE Dashboard automagically displayed README.md files for module classes it knows about on that class's specific page https://projects.puppetlabs.com/issues/20688
* Author: Wolf Noble * Status: Unreviewed * Priority: Normal * Assignee: * Category: documentation * Target version: * Affected Puppet version: * Keywords: * Branch: ---------------------------------------- it seems sensible that the dashboard would be able to display the documentation for a module once a module is added to the master, and the dashboard is informed about that module's class's existence... the classes are expected to conform to the autoloader's requirements to add them anyways, so there's already an agreement in place about locations, but it would be (I think) pretty simple to add an attribute to a class 'readme filepath' if you wanted to. This would allow for a built-in way of viewing the documentation for a module, and a great enhancement for PE... I understand that this is somewhat hacky, as the dashboard only knows about classes, not modules, and the documentation belongs to the module, not the class; but nevertheless it's a good, IMHO, starting place -- 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 unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To post to this group, send email to [email protected]. Visit this group at http://groups.google.com/group/puppet-bugs?hl=en. For more options, visit https://groups.google.com/groups/opt_out.
