Skip to content

Commit

Permalink
advertise NATIVE_TYPES_AND_PROVIDERS.md in README
Browse files Browse the repository at this point in the history
  • Loading branch information
jhoblitt committed Oct 13, 2015
1 parent e2450da commit 13d010e
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,25 @@ This is intended to be a re-usable
[Puppet](http://www.puppetlabs.com/puppet/introduction/) module that you can
include in your own tree.

# Experimental Types and Providers

_The experimental types/providers are **not for the faint of heart**. If you are
starting out with this module you probably want to skip directly to [Getting
Started](#getting-started)._

A family of experimental native types and providers has been added to this
module, in parallel to the existing classes and defined types, with the goal of
soliciting feedback. One of the primary benefits of these new types is not
requiring manifest changes to manage jenkins with or without "security"
enabled. The goal is to eventually replace the functionality of the existing
classes/defines with the new types. _Usage feedback (positive and native), bug
reports and/or PRs would be greatly welcomed._

**The semantics and API of these types should be considered _unstable_ and
almost certainly will change based on feedback.**

See [NATIVE_TYPES_AND_PROVIDERS.md](NATIVE_TYPES_AND_PROVIDERS.md)

# Using puppet-jenkins

## Getting Started
Expand Down

0 comments on commit 13d010e

Please sign in to comment.