]> review.fuel-infra Code Review - puppet-modules/puppetlabs-apt.git/commitdiff
Updated content to conform to README best practices template
authorLauren Rother <lauren.rother@puppetlabs.com>
Sat, 16 Feb 2013 01:51:44 +0000 (17:51 -0800)
committerLauren Rother <lauren.rother@puppetlabs.com>
Sat, 16 Feb 2013 01:51:44 +0000 (17:51 -0800)
*Note: I thought this was small enough to forgo a TOC. Please let me
know if one is desired and I can add it in.*

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. 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.


No differences found