summaryrefslogtreecommitdiff
path: root/manifests
diff options
context:
space:
mode:
authorRyan Coleman <ryan@puppetlabs.com>2013-02-13 11:26:52 -0800
committerRyan Coleman <ryan@puppetlabs.com>2013-02-13 11:26:52 -0800
commitab3edf97f92853fe40b92670d5d4ec9adfbeddcc (patch)
tree82245f8fb56e2611bc0c1dde5868418b625e34cf /manifests
parent5015ec6190ea415f080e6c062e57fc9bb0be96e1 (diff)
Update Documentation and Purge Extras
Commit message from laurenrother Before alterations, this content was the module author-determined description of and instructions for use of the module. As part of a joint Forge/Docs team effort to standardize formatting and encourage quality module documentation, a best practices README template was created via internal and external user testing. That template was then applied to this module. I pulled in content from the original README on GitHub as well as the Forge Module Description. Standard headings were added (Overview, Module Description, Setup, Usage, Implementation, etc.) to organize content, existent content was moved under its appropriate heading and edited for tone/flow/clarity, and basic formatting was done to adhere to template standards. Extraneous, empty READMEs were deleted.
Diffstat (limited to 'manifests')
-rw-r--r--manifests/README.markdown28
1 files changed, 0 insertions, 28 deletions
diff --git a/manifests/README.markdown b/manifests/README.markdown
deleted file mode 100644
index bbf645a..0000000
--- a/manifests/README.markdown
+++ /dev/null
@@ -1,28 +0,0 @@
-Manifests
-=========
-
-Module manifest files belong in this directory.
-
-`init.pp` defines how the module will carry out its tasks in this file.
-
-Add additional definitions in this directory. Their file paths should match the
-definition name; for example, a definition `mydefinition`, defined like this:
-
- # Definition: mydefinition
- #
- # This is the mydefinition in the mymodule module.
- #
- # Parameters:
- #
- # Actions:
- #
- # Requires:
- #
- # Sample Usage:
- #
- # [Remember: No empty lines between comments and class definition]
- define mydefinition {
- # ...
- }
-
-Should be found in `mydefinition.pp` in this directory.