summaryrefslogtreecommitdiff
path: root/README.markdown
diff options
context:
space:
mode:
authorJeff McCune <jeff@puppetlabs.com>2011-12-30 11:48:21 -0800
committerJeff McCune <jeff@puppetlabs.com>2011-12-30 11:48:21 -0800
commit80c9a8feeae6203026f61215e100e95078c61a04 (patch)
treee70920f96b88bdc9e985e2439f395371d5ffe2be /README.markdown
parent1434f3cea6f6e2a1b939d91cb5ff66338cc87d32 (diff)
parenta8d4bbd9e234ea577e27d83df95a61b374ac484b (diff)
downloadpuppet-stdlib-80c9a8feeae6203026f61215e100e95078c61a04.tar.gz
puppet-stdlib-80c9a8feeae6203026f61215e100e95078c61a04.tar.bz2
Merge branch 'v2.1.x' into v2.2.x
* v2.1.x: (maint) Add semantic versioning info to README Docs: Clarify the use case for the anchor type Docs: Remove author emails from stdlib functions Docs: Copyedit function doc strings Docs: Correct indentation of markdown code examples Docs: Update documentation of stdlib classes Docs: Update file_line documentation Docs: Improve example in merge function
Diffstat (limited to 'README.markdown')
-rw-r--r--README.markdown30
1 files changed, 26 insertions, 4 deletions
diff --git a/README.markdown b/README.markdown
index 4f06651..9fa4c38 100644
--- a/README.markdown
+++ b/README.markdown
@@ -14,11 +14,34 @@ This module is officially curated and provided by Puppet Labs. The modules
Puppet Labs writes and distributes will make heavy use of this standard
library.
+# Versions #
+
+This module follows semver.org (v1.0.0) versioning guidelines. The standard
+library module is released as part of [Puppet
+Enterprise](http://puppetlabs.com/puppet/puppet-enterprise/) and as a result
+older versions of Puppet Enterprise that Puppet Labs still supports will have
+bugfix maintenance branches periodically "merged up" into master. The current
+list of integration branches are:
+
+ * v2.1.x (v2.1.1 released in PE 1.2, 1.2.1, 1.2.3, 1.2.4)
+ * v2.2.x (Never released as part of PE, only to the Forge)
+ * v2.3.x (Scheduled for next PE feature release)
+ * master (mainline development branch)
+
+The first Puppet Enterprise version including the stdlib module is Puppet
+Enterprise 1.2.
+
# Compatibility #
-This module is designed to work with Puppet version 2.6 and later. It may be
-forked if Puppet 2.7 specific features are added. There are currently no plans
-for a Puppet 0.25 standard library module.
+## stdlib v2.1.x, v2.2.x ##
+
+v2.1.x and v2.2.x of this module are designed to work with Puppet versions
+2.6.x and 2.7.x. There are currently no plans for a Puppet 0.25 standard
+library module.
+
+## stdlib v2.3.x ##
+
+While not yet released, the standard library may only work with Puppet 2.7.x.
# Functions #
@@ -57,4 +80,3 @@ automatically. This is a direct copy of R.I. Pienaar's custom facter fact
located at:
[https://github.com/ripienaar/facter-facts/tree/master/facts-dot-d](https://github.com/ripienaar/facter-facts/tree/master/facts-dot-d)
-