Documentation on managing puppetserver configuration is inadequate

[jcbollinger]

Affected Puppet, Ruby, OS and module versions/distributions

• Puppet: all
• Ruby: all
• Distribution: all
• Module version: 3.0.0

How to reproduce (e.g Puppet code you use)

Attempt to determine from module docs how to manage the value of a puppetserver configuration setting, such as master-var-dir.

What are you seeing

An example of using the puppetserver::config parameter is presented in the README, but it is unclear how to generalize it. There is no other documentation of that parameter, neither in the README nor in the manifests.

There are also three defined types that seem to address different facets of Puppetserver configuration, but these also are documented only via examples in the README, one each.

What behaviour did you expect instead

All parameters of all public classes should be fully documented, at least in the README, but preferably also in the manifests. In particular, the puppetserver::config parameter should be documented with the expected structure of its value hashes, and how those map onto Puppetserver config files and specific settings within.

All public defined types addressing puppetserver configuration should be fully documented, with all their parameters. Inasmuch as these seem to attribute significance to the structure of their titles, details of the expected title structure should be included.