Skip to content

Commit 5540a69

Browse files
committed
Add HTML anchor tag
1 parent d1706fe commit 5540a69

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

+12
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
1. [Contributors](#contributors)
1717

1818

19+
<a id="moduledescription"></a>
1920
## Module Description
2021

2122
This module provides a standard library of resources for Puppet modules. Puppet modules make heavy use of this standard library. The stdlib module adds the following resources to Puppet:
@@ -29,12 +30,14 @@ This module provides a standard library of resources for Puppet modules. Puppet
2930

3031
> *Note:* As of version 3.7, Puppet Enterprise no longer includes the stdlib module. If you're running Puppet Enterprise, you should install the most recent release of stdlib for compatibility with Puppet modules.
3132
33+
<a id="setup"></a>
3234
## Setup
3335

3436
[Install](https://puppet.com/docs/puppet/latest/modules_installing.html) the stdlib module to add the functions, facts, and resources of this standard library to Puppet.
3537

3638
If you are authoring a module that depends on stdlib, be sure to [specify dependencies](https://puppet.com/docs/puppet/latest/modules_metadata.html#specifying-dependencies-in-modules) in your metadata.json.
3739

40+
<a id="usage"></a>
3841
## Usage
3942

4043
Most of stdlib's features are automatically loaded by Puppet. To use standardized run stages in Puppet, declare this class in your manifest with `include stdlib`.
@@ -61,6 +64,7 @@ node default {
6164
}
6265
```
6366

67+
<a id="reference"></a>
6468
## Reference
6569

6670
* [Public classes](#public-classes)
@@ -70,6 +74,7 @@ node default {
7074
* [Facts](#facts)
7175
* [Functions](#functions)
7276

77+
<a id="limitations"></a>
7378
### Classes
7479

7580
#### Public classes
@@ -80,6 +85,7 @@ The `stdlib` class has no parameters.
8085

8186
* `stdlib::stages`: Manages a standard set of run stages for Puppet.
8287

88+
<a id="definedtypes"></a>
8389
### Defined types
8490

8591
#### `file_line`
@@ -269,6 +275,7 @@ Replaces all lines matched by `match` parameter, even if `line` already exists i
269275

270276
Default value: `false`.
271277

278+
<a id="datatypes"></a>
272279
### Data types
273280

274281
#### `Stdlib::Absolutepath`
@@ -655,6 +662,7 @@ Match an IPv6 address formatted in the "alternative form" allowing for represent
655662

656663
Match an IPv6 address which may contain `::` used to compress zeros as documented in section 2.2.2 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt). It will only match addresses without an address prefix as documented in section 2.3 of [RFC 2373](https://www.ietf.org/rfc/rfc2373.txt).
657664

665+
<a id="facts"></a>
658666
### Facts
659667

660668
#### `package_provider`
@@ -703,6 +711,7 @@ Determines the root home directory, which depends on your operating system. Gene
703711
704712
Returns the default provider Puppet uses to manage services on this system
705713
714+
<a id="functions"></a>
706715
### Functions
707716
708717
#### `abs`
@@ -3107,19 +3116,22 @@ A negative value is taken to be "from the end" of the array, for example:
31073116
31083117
Takes one element from first array given and merges corresponding elements from second array given. This generates a sequence of n-element arrays, where *n* is one more than the count of arguments. For example, `zip(['1','2','3'],['4','5','6'])` results in ["1", "4"], ["2", "5"], ["3", "6"]. *Type*: rvalue.
31093118
3119+
<a id="limitations"></a>
31103120
## Limitations
31113121
31123122
As of Puppet Enterprise 3.7, the stdlib module is no longer included in PE. PE users should install the most recent release of stdlib for compatibility with Puppet modules.
31133123
31143124
For an extensive list of supported operating systems, see [metadata.json](https://github.com/puppetlabs/puppetlabs-stdlib/blob/master/metadata.json)
31153125
3126+
<a id="development"></a>
31163127
## Development
31173128
31183129
Puppet 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 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. For more information, see our [module contribution guide](https://docs.puppet.com/forge/contributing.html).
31193130
31203131
To report or research a bug with any part of this module, please go to
31213132
[http://tickets.puppetlabs.com/browse/MODULES](http://tickets.puppetlabs.com/browse/MODULES).
31223133
3134+
<a id="contributors"></a>
31233135
## Contributors
31243136
31253137
The list of contributors can be found at: [https://github.com/puppetlabs/puppetlabs-stdlib/graphs/contributors](https://github.com/puppetlabs/puppetlabs-stdlib/graphs/contributors).

0 commit comments

Comments
 (0)