|
| 1 | +# clonos_network |
| 2 | + |
| 3 | +#### Table of Contents |
| 4 | + |
| 5 | +1. [Description](#description) |
| 6 | +1. [Setup - The basics of getting started with clonos_network](#setup) |
| 7 | + * [What clonos_network affects](#what-clonos_network-affects) |
| 8 | + * [Setup requirements](#setup-requirements) |
| 9 | + * [Beginning with clonos_network](#beginning-with-clonos_network) |
| 10 | +1. [Usage - Configuration options and additional functionality](#usage) |
| 11 | +1. [Reference - An under-the-hood peek at what the module is doing and how](#reference) |
| 12 | +1. [Limitations - OS compatibility, etc.](#limitations) |
| 13 | +1. [Development - Guide for contributing to the module](#development) |
| 14 | + |
| 15 | +## Description |
| 16 | + |
| 17 | +Start with a one- or two-sentence summary of what the module does and/or what |
| 18 | +problem it solves. This is your 30-second elevator pitch for your module. |
| 19 | +Consider including OS/Puppet version it works with. |
| 20 | + |
| 21 | +You can give more descriptive information in a second paragraph. This paragraph |
| 22 | +should answer the questions: "What does this module *do*?" and "Why would I use |
| 23 | +it?" If your module has a range of functionality (installation, configuration, |
| 24 | +management, etc.), this is the time to mention it. |
| 25 | + |
| 26 | +## Setup |
| 27 | + |
| 28 | +### What clonos_network affects **OPTIONAL** |
| 29 | + |
| 30 | +If it's obvious what your module touches, you can skip this section. For |
| 31 | +example, folks can probably figure out that your mysql_instance module affects |
| 32 | +their MySQL instances. |
| 33 | + |
| 34 | +If there's more that they should know about, though, this is the place to mention: |
| 35 | + |
| 36 | +* A list of files, packages, services, or operations that the module will alter, |
| 37 | + impact, or execute. |
| 38 | +* Dependencies that your module automatically installs. |
| 39 | +* Warnings or other important notices. |
| 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 | +If your most recent release breaks compatibility or requires particular steps |
| 47 | +for upgrading, you might want to include an additional "Upgrading" section |
| 48 | +here. |
| 49 | + |
| 50 | +### Beginning with clonos_network |
| 51 | + |
| 52 | +The very basic steps needed for a user to get the module up and running. This |
| 53 | +can include setup steps, if necessary, or it can be an example of the most |
| 54 | +basic use of the module. |
| 55 | + |
| 56 | +## Usage |
| 57 | + |
| 58 | +This section is where you describe how to customize, configure, and do the |
| 59 | +fancy stuff with your module here. It's especially helpful if you include usage |
| 60 | +examples and code samples for doing things with your module. |
| 61 | + |
| 62 | +## Reference |
| 63 | + |
| 64 | +Here, include a complete list of your module's classes, types, providers, |
| 65 | +facts, along with the parameters for each. Users refer to this section (thus |
| 66 | +the name "Reference") to find specific details; most users don't read it per |
| 67 | +se. |
| 68 | + |
| 69 | +## Limitations |
| 70 | + |
| 71 | +This is where you list OS compatibility, version compatibility, etc. If there |
| 72 | +are Known Issues, you might want to include them under their own heading here. |
| 73 | + |
| 74 | +## Development |
| 75 | + |
| 76 | +Since your module is awesome, other users will want to play with it. Let them |
| 77 | +know what the ground rules for contributing are. |
| 78 | + |
| 79 | +## Release Notes/Contributors/Etc. **Optional** |
| 80 | + |
| 81 | +If you aren't using changelog, put your release notes here (though you should |
| 82 | +consider using changelog). You can also add any additional sections you feel |
| 83 | +are necessary or important to include here. Please use the `## ` header. |
0 commit comments