A one-maybe-two sentence summary of what the module does/what problem it solves. This is your 30 second elevator pitch for your module. Consider including OS/Puppet version it works with.
It only supports kibana 6.3
- A list of files, packages, services, or operations that the module will alter, impact, or execute on the system it's installed on.
- This is a great place to stick any warnings.
- Can be in list or paragraph form.
If your module requires anything extra before setting up (pluginsync enabled, etc.), mention it here.
basic kibana installation:
class { 'kibana':
}Put the classes, types, and resources for customizing, configuring, and doing the fancy stuff with your module here.
Here, list the classes, types, providers, facts, etc contained in your module. This section should include all of the under-the-hood workings of your module so people know what the module is touching on their system but don't need to mess with things. (We are working on automating this section!)
This is where you list OS compatibility, version compatibility, etc.
We are pushing to have acceptance testing in place, so any new feature should have some test to check both presence and absence of any feature