|
| 1 | +# networker |
| 2 | + |
| 3 | +#### Table of Contents |
| 4 | + |
| 5 | +1. [Overview](#overview) |
| 6 | +2. [Module Description - What the module does and why it is useful](#module-description) |
| 7 | +3. [Setup - The basics of getting started with networker](#setup) |
| 8 | + * [What networker affects](#what-networker-affects) |
| 9 | + * [Setup requirements](#setup-requirements) |
| 10 | + * [Beginning with networker](#beginning-with-networker) |
| 11 | +4. [Usage - Configuration options and additional functionality](#usage) |
| 12 | +5. [Reference - An under-the-hood peek at what the module is doing and how](#reference) |
| 13 | +5. [Limitations - OS compatibility, etc.](#limitations) |
| 14 | +6. [Development - Guide for contributing to the module](#development) |
| 15 | + |
| 16 | +## Overview |
| 17 | + |
| 18 | +A one-maybe-two sentence summary of what the module does/what problem it solves. |
| 19 | +This is your 30 second elevator pitch for your module. Consider including |
| 20 | +OS/Puppet version it works with. |
| 21 | + |
| 22 | +## Module Description |
| 23 | + |
| 24 | +If applicable, this section should have a brief description of the technology |
| 25 | +the module integrates with and what that integration enables. This section |
| 26 | +should answer the questions: "What does this module *do*?" and "Why would I use |
| 27 | +it?" |
| 28 | + |
| 29 | +If your module has a range of functionality (installation, configuration, |
| 30 | +management, etc.) this is the time to mention it. |
| 31 | + |
| 32 | +## Setup |
| 33 | + |
| 34 | +### What networker affects |
| 35 | + |
| 36 | +* A list of files, packages, services, or operations that the module will alter, |
| 37 | + impact, or execute on the system it's installed on. |
| 38 | +* This is a great place to stick any warnings. |
| 39 | +* Can be in list or paragraph form. |
| 40 | + |
| 41 | +### Setup Requirements **OPTIONAL** |
| 42 | + |
| 43 | +If your module requires anything extra before setting up (pluginsync enabled, |
| 44 | +etc.), mention it here. |
| 45 | + |
| 46 | +### Beginning with networker |
| 47 | + |
| 48 | +The very basic steps needed for a user to get the module up and running. |
| 49 | + |
| 50 | +If your most recent release breaks compatibility or requires particular steps |
| 51 | +for upgrading, you may wish to include an additional section here: Upgrading |
| 52 | +(For an example, see http://forge.puppetlabs.com/puppetlabs/firewall). |
| 53 | + |
| 54 | +## Usage |
| 55 | + |
| 56 | +Put the classes, types, and resources for customizing, configuring, and doing |
| 57 | +the fancy stuff with your module here. |
| 58 | + |
| 59 | +## Reference |
| 60 | + |
| 61 | +Here, list the classes, types, providers, facts, etc contained in your module. |
| 62 | +This section should include all of the under-the-hood workings of your module so |
| 63 | +people know what the module is touching on their system but don't need to mess |
| 64 | +with things. (We are working on automating this section!) |
| 65 | + |
| 66 | +## Limitations |
| 67 | + |
| 68 | +This is where you list OS compatibility, version compatibility, etc. |
| 69 | + |
| 70 | +## Development |
| 71 | + |
| 72 | +Pull requests are gratefully received. |
0 commit comments