Merge pull request #44 from puppetlabs/readme_update

Update Documentation and Purge Extras

8 files changed, 100 insertions, 134 deletions

diff --git a/README.markdown b/README.markdown
index e3aef69..6cfa7c8 100644
--- a/README.markdown
+++ b/README.markdown
@@ -1,15 +1,106 @@
-# NTP #
+ntp
+====
 
 [![Build Status](https://travis-ci.org/puppetlabs/puppetlabs-ntp.png?branch=master)](https://travis-ci.org/puppetlabs/puppetlabs-ntp)
 
-Manage the NTP service.
 
-This module has been built and tested using Puppet 2.6.x
+Overview
+--------
 
-# Platforms #
+The NTP module installs, configures, and manages the network time service.
 
- * Enterprise Linux 5 (and CentOS 5.4)
- * Ubuntu 10.04 Lucid
- * Amazon Linux 2011.09 has been tested on 2.7.x with facter version 1.6.2
- * FreeBSD 9.0
- * Debian 6.0 Squeeze
+
+Module Description
+-------------------
+
+The NTP module allows Puppet to install, configure, and then manage your Network Time Protocol service. The module allows you to setup and manage time settings across many servers from one place. 
+
+Setup
+-----
+
+**What NTP affects:**
+
+* package/service/configuration files for NTP
+* server settings
+	
+### Beginning with NTP	
+
+To setup NTP on a server
+
+    class { "ntp":
+      servers    => [ 'time.apple.com' ],
+      autoupdate => false,
+    }
+
+Usage
+------
+
+When making changes to your configuration of NTP, you may need to stop and restart the ntp service. To keep the ntp service stopped, pass ensure => stopped to the class:
+
+    class { ntp:
+      ensure     => running,
+      servers    => [ 'time.apple.com iburst',
+                      'pool.ntp.org iburst' , ]
+      autoupdate => true,
+    }
+
+The `ntp` class has several parameters to assist configuration of the ntp service.
+
+**Parameters within `ntp`**
+
+####`servers`
+
+NTP will use your operating system's default server if this parameter is left unspecified. This parameter accepts an array of servers,
+    
+    class { 'ntp':
+      servers => [ '0.debian.pool.ntp.org iburst',
+                   '1.debian.pool.ntp.org iburst',
+                   '2.debian.pool.ntp.org iburst',
+                   '3.debian.pool.ntp.org iburst', ]
+    }
+
+####`restrict`
+
+This parameter specifies whether to restrict ntp daemons from allowing others to use as a server.
+
+####`autoupdate`
+
+This parameter is used to determine whether the ntp package will be updated automatically or not.
+
+####`enable` 
+
+This parameter allows you to choose whether to automatically start ntp daemon on boot.
+
+
+Limitations
+------------
+
+This module has been built and tested using Puppet 2.6.x, 2.7, and 3.x.
+
+The module has been tested on:
+
+* Enterprise Linux 5
+* Debian 6.0 
+* CentOS 5.4.
+* Ubuntu 12.04
+
+Testing on other platforms has been light and cannot be guaranteed. 
+
+Development
+------------
+
+Puppet Labs modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great. We can’t access the huge number of platforms and myriad of hardware, software, and deployment configurations that Puppet is intended to serve.
+
+We want to keep it as easy as possible to contribute changes so that our modules work in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things.
+
+You can read the complete module contribution guide [on the Puppet Labs wiki.](http://projects.puppetlabs.com/projects/module-site/wiki/Module_contributing)
+
+Release Notes
+--------------
+
+**0.2.0**
+
+0.2.0 is a backwards compatible feature and bug-fix release. Since
+0.1.0, support for Amazon Linux was added, fixes for style were
+implemented, and support was added for tinker_panic. tinker_panic
+will default to on when the fact is_virtual is true.
diff --git a/lib/puppet/facter/README.markdown b/lib/puppet/facter/README.markdown
deleted file mode 100644
index 2b96273..0000000
--- a/lib/puppet/facter/README.markdown
+++ /dev/null
@@ -1,22 +0,0 @@
-Facter
-======
-
-Define facts in this directory.
-
-Sometimes you need to be able to write conditional expressions based
-on site-specific data that just isn’t available via Facter. The
-solution may be to add a fact to Facter. These additional facts can
-then be distributed to Puppet clients and are available for use in
-manifests. Learn more at
-http://projects.puppetlabs.com/projects/puppet/wiki/Adding_Facts
-
-File paths should match the fact name; for example, a fact
-`hardware_platform`, defined like this:
-
-    Facter.add("hardware_platform") do
-        setcode do
-            %x{/bin/uname -i}.chomp
-        end
-    end
-
-Should be found in `hardware_platform.rb` in this directory.
diff --git a/lib/puppet/parser/functions/README.markdown b/lib/puppet/parser/functions/README.markdown
deleted file mode 100644
index 15d7495..0000000
--- a/lib/puppet/parser/functions/README.markdown
+++ /dev/null
@@ -1,17 +0,0 @@
-Functions
-=========
-
-Define functions in this directory.
-
-File paths should match the function name; for example, a function
-`myfunction`, defined like this:
-
-    Puppet::Parser::Functions::newfunction(
-        :myfunction,
-        :type => :statement,
-        :doc => "Documentation here."
-    ) do |vals|
-        # ...
-    end
-
-Should be found in `myfunction.rb` in this directory.
diff --git a/lib/puppet/provider/README.markdown b/lib/puppet/provider/README.markdown
deleted file mode 100644
index 27aa1a9..0000000
--- a/lib/puppet/provider/README.markdown
+++ /dev/null
@@ -1,14 +0,0 @@
-Providers
-=========
-
-Define providers under this directory.
-
-File paths should match the resource type name and provider name; for
-example, a provider `myprovider` for a resource type `mytype`, defined like this:
-
-    Puppet::Type.type(:mytype).provide(:myprovider) do
-        desc "Documentation here"
-        # ...
-    end
-
-Should be found in `mytype/myprovider.rb` under this directory.
diff --git a/lib/puppet/type/README.markdown b/lib/puppet/type/README.markdown
deleted file mode 100644
index 7a169c7..0000000
--- a/lib/puppet/type/README.markdown
+++ /dev/null
@@ -1,14 +0,0 @@
-Resource Types
-==============
-
-Define resource types in this directory.
-
-Filenames should match the resource type name; for example, a resource
-type `mytype`, defined like this:
-
-    Puppet::Type.newtype(:mytype) do
-        @doc = "Documentation here."
-        # ...
-    end
-
-Should be found in `mytype.rb`
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.
diff --git a/spec/README.markdown b/spec/README.markdown
deleted file mode 100644
index 286d341..0000000
--- a/spec/README.markdown
+++ /dev/null
@@ -1,7 +0,0 @@
-Specs
-=====
-
-The Puppet project uses RSpec for testing.
-
-For more information on RSpec, see http://rspec.info/
-
diff --git a/templates/README.markdown b/templates/README.markdown
deleted file mode 100644
index 575bbea..0000000
--- a/templates/README.markdown
+++ /dev/null
@@ -1,23 +0,0 @@
-Templates
-=========
-
-Puppet supports templates and templating via ERB, which is part of the Ruby
-standard library and is used for many other projects including Ruby on Rails.
-Templates allow you to manage the content of template files, for example
-configuration files that cannot yet be managed as a Puppet type. Learn more at
-http://projects.puppetlabs.com/projects/puppet/wiki/Puppet_Templating
-
-You can use templates like this: 
-
-    class myclass {
-      package { mypackage: ensure => latest }
-      service { myservice: ensure => running }
-      file { "/etc/myfile":
-        content => template("mymodule/myfile.erb")
-      }
-    }
-
-The templates are searched for in:
-
-    $templatedir/mymodule/myfile.erb
-    $modulepath/mymodule/templates/myfile.erb