Bug #12375
The module documentation should include info on how to use the module tool in puppet core
| Status: | Accepted | Start date: | 02/01/2012 | |
|---|---|---|---|---|
| Priority: | Normal | Due date: | ||
| Assignee: |  Nick Fagerlund |
% Done: | 0% |
|
| Category: | - | |||
| Target version: | - | |||
| Keywords: | geordi v1 | Affected URL: | ||
| Branch: | ||||
| Votes: | 0 |
Description
The docs from
https://github.com/puppetlabs/puppet-module-tool/blob/master/README.markdown
should be integrated with the docs
http://docs.puppetlabs.com/guides/modules.html
We want module creators to be more aware of the metadata file for their module, especially since the module tool will now reference it when install for automatic dependency installation.
I’m not sure that we want to just throw all the data about the module tool on that modules guide page, but it needs to be in the online docs somewhere useful since people won’t be referring to the module-tool repo anymore. We’ll also need to make it clear what version of Puppet includes the module tool (2.7.11 and greater), and what to do if you’re on an older version.
Related issues
History
Updated by Nick Fagerlund 3 months ago
- Assignee set to Nick Fagerlund
(Notes from conversation w/ Matt: This can be done after release if need be, but the module tool should be woven into all docs about How To Module. Includes the listed link, as well as the LP pages about modules.)
Updated by Pieter van de Bruggen 2 months ago
- Keywords changed from geordi to geordi v1
Updated by Nick Fagerlund 2 months ago
STATUS: Info about the updated module tool is included in a new revision of the module docs, which has been split out into a page about writing and using modules, and a page about installing modules. There’s a page pending about publishing modules, which will include information about the modulefile and all that, but it’s not written yet. Inside the office, you can see it on the docs preview servers at http://docspreview1/puppet/2.7/reference/modules_fundamentals.html and http://docspreview1/puppet/2.7/reference/modules_installing.html (and eventually http://docspreview1/puppet/2.7/reference/modules_publishing.html).