Describe setting parameters in README

[bittner]

Some software allows parameters to be set (e.g. software::vcsscm::git).

It would be nice if the README mentioned how those can be set, so that the suggested, preferred way is known (and Puppet newbies are not left in the dark).

Example

class { 'software::vcsscm::git':
  gui    => true,
  ensure => installed,
}

Is there a nicer, cleaner way?

include software::vcsscm::git

... is definitely nicer, but how set parameters?

[edestecd]

Totally agree. I'm always for more documentation.

[edestecd]

If you do the include approach then you can set parameters in hiera. This is the way I usually do it.

[bittner]

Is there any tool that can generate a simple documentation from Puppet code? So that we would have at least the class signature documented in an easily accessible way.

You currently have to go into the source code to find out what the software::vcsscm::git class can do, for example.

[edestecd]

There is puppet-strings. I think that is what everyone is using now.

[bittner]

Note to self: puppetlabs/puppet-strings

Do you have an example use, a repo on GitHub that you particularly like? So that we can somewhat copy+paste the configuration.

EDIT: Interestingly, a blog post mentioning it was published just today: Self-documenting Puppet modules with puppet-strings