Howto: puppet strings

Thomas Mueller <thomas@...>
 

hi

we've just published the first module with puppet-strings docs on
voxpupuli.org [3]:

https://voxpupuli.org/puppet-selinux/

There is a good example at [1] how to document your puppet
class/defined type.

Then you only have to run `bundle exec rake strings:generate` to
actually generate the documentation to docs/ (you need also the PR [2]
to be modulesync'ed or you need to change it yourself).

Github Pages then can serve the master branch docs/ folder on
https://voxpupuli.org/$repo/ . It has to be enabled on each repo.


- Thomas

[1] Upstream puppet-strings:
https://github.com/puppetlabs/puppet-strings

[2] Modulesync PR for Puppet strings:
https://github.com/voxpupuli/modulesync_config/pull/304

[3] https://github.com/voxpupuli/puppet-selinux/pull/172

Join voxpupuli@groups.io to automatically receive all group messages.