Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

More thorough documentation #401

Closed
mlehner616 opened this issue Aug 13, 2014 · 6 comments
Closed

More thorough documentation #401

mlehner616 opened this issue Aug 13, 2014 · 6 comments

Comments

@mlehner616
Copy link

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

vhosts in particular

@jfryman
Copy link
Contributor

jfryman commented Aug 13, 2014

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

@mlehner616
Copy link
Author

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
Copy link
Contributor

3flex commented Aug 13, 2014

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
Copy link

chacken commented Aug 31, 2014

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
Copy link
Contributor

3flex commented Sep 20, 2014

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

@3flex
Copy link
Contributor

3flex commented Apr 10, 2015

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

@3flex 3flex closed this as completed Apr 10, 2015
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants