More thorough documentation

[mlehner616]

Please improve the documentation. I'm finding myself digging through the classes to piece together the functionality that I need. 👎

vhosts in particular

[jfryman]

An example would be helpful of the type of thing you are looking for or what is deficient

[mlehner616]

This is a larger undertaking but the puppetlabs apache module is a pretty good example of generally thorough documentation. If I can get time, I will contribute.

https://github.com/puppetlabs/puppetlabs-apache

[3flex]

Not everything has to be documented at once - someone could start by just restructuring the current documentation in an appropriate structure using the general README template at https://docs.puppetlabs.com/puppet/latest/reference/READMEtemplate.markdown and adding an example or two for different scenarios.

I agree that the puppetlabs-apache docs are a great model for this module.

[chacken]

Is there an example somewhere on how to add modules to nginx? For example: https://github.com/arut/nginx-rtmp-module @jfryman

I suppose I'd have to change this module to install from source as well.

[3flex]

@mlehner616 please take a look at #451 and provide suggestions.

[3flex]

@mlehner616 I'm closing this in favour of discussing in #451, cheers (I plan to revisit that PR in the not too distant future)