High Level Feature #15403: Automatically produce & display useful documentation about a module
Allow user to discover content that may not be distributed as a module
Based on the work to allow distribution of plug-ins as Ruby Gems (ticket reference needed), we want to provide Forge visitors a way to discover that Puppet related content even though it’s not a module that they can download from the Forge or interact with via the Puppet Module Tool.
Cloud Provisioner is going to be the poster child for this functionality. It depends on Fog so it will be distributed as a Gem to make the inclusion of the Fog dependency dead simple. On the existing Cloud Provisioner module page, content authors need to be able to specify that this content is available as a Ruby Gem, enter the gem name and submit. Instead of providing a downloadable module, we’ll tell them this content is available via Ruby Gems and provide information about how to install it via that distribution method.
If the content is available as both a Module & a Gem, both methods should be displayed on the content page but we should leave it up to the Author (in their description) to describe why it’s available in both ways and how to choose between them.
For the time being, we should focus on Ruby Gems in the context of allowing plug-ins to be distributed as Gems in Telly but let’s keep in mind that in the future, we may want to make Console Plug-ins, MCollective Agents and more to be discovered on the Forge.