Skip to content

Commit 19cdf29

Browse files
authored
Merge pull request #974 from clairecadman/anchor_tags
(maint) - Add HTML anchor tag
2 parents d1706fe + 668e6ba commit 19cdf29

File tree

1 file changed

+19
-5
lines changed

1 file changed

+19
-5
lines changed

README.md

+19-5
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
1. [Development - Guide for contributing to the module](#development)
1616
1. [Contributors](#contributors)
1717

18-
18+
<a id="module-description"></a>
1919
## Module Description
2020

2121
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 +29,14 @@ This module provides a standard library of resources for Puppet modules. Puppet
2929

3030
> *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.
3131
32+
<a id="setup"></a>
3233
## Setup
3334

3435
[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.
3536

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

39+
<a id="usage"></a>
3840
## Usage
3941

4042
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 +63,7 @@ node default {
6163
}
6264
```
6365

66+
<a id="reference"></a>
6467
## Reference
6568

6669
* [Public classes](#public-classes)
@@ -70,16 +73,20 @@ node default {
7073
* [Facts](#facts)
7174
* [Functions](#functions)
7275

76+
<a id="classes"></a>
7377
### Classes
7478

79+
<a id="public-classes"></a>
7580
#### Public classes
7681

7782
The `stdlib` class has no parameters.
7883

84+
<a id="private-classes"></a>
7985
#### Private classes
8086

8187
* `stdlib::stages`: Manages a standard set of run stages for Puppet.
8288

89+
<a id="defined-types"></a>
8390
### Defined types
8491

8592
#### `file_line`
@@ -197,7 +204,9 @@ Values: String specifying a valid Ruby character encoding.
197204

198205
Default: 'UTF-8'.
199206

200-
##### `ensure`: Specifies whether the resource is present.
207+
##### `ensure`
208+
209+
Specifies whether the resource is present.
201210

202211
Values: 'present', 'absent'.
203212

@@ -269,6 +278,7 @@ Replaces all lines matched by `match` parameter, even if `line` already exists i
269278

270279
Default value: `false`.
271280

281+
<a id="data-types"></a>
272282
### Data types
273283

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

656666
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).
657667

668+
<a id="facts"></a>
658669
### Facts
659670

660671
#### `package_provider`
@@ -703,6 +714,7 @@ Determines the root home directory, which depends on your operating system. Gene
703714
704715
Returns the default provider Puppet uses to manage services on this system
705716
717+
<a id="functions"></a>
706718
### Functions
707719
708720
#### `abs`
@@ -1074,8 +1086,7 @@ Deletes all instances of a given element from an array or hash that match a prov
10741086
10751087
*Note:* This function is an implementation of a Ruby class and might not be UTF8 compatible. To ensure compatibility, use this function with Ruby 2.4.0 or greater.
10761088
1077-
1078-
For example
1089+
For example:
10791090
10801091
* `delete_regex(['a','b','c','b'], 'b')` returns ['a','c'].
10811092
* `delete_regex({'a' => 1,'b' => 2,'c' => 3},['b','c'])` returns {'a'=> 1}.
@@ -1899,7 +1910,7 @@ $metadata = load_module_metadata('archive')
18991910
notify { $metadata['author']: }
19001911
```
19011912
1902-
When a module's metadata file is absent, the catalog compilation fails. To avoid this failure:
1913+
When a module's metadata file is absent, the catalog compilation fails. To avoid this failure, do the following:
19031914
19041915
```
19051916
$metadata = load_module_metadata('mysql', true)
@@ -3107,19 +3118,22 @@ A negative value is taken to be "from the end" of the array, for example:
31073118
31083119
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.
31093120
3121+
<a id="limitations"></a>
31103122
## Limitations
31113123
31123124
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.
31133125
31143126
For an extensive list of supported operating systems, see [metadata.json](https://github.com/puppetlabs/puppetlabs-stdlib/blob/master/metadata.json)
31153127
3128+
<a id="development"></a>
31163129
## Development
31173130
31183131
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).
31193132
31203133
To report or research a bug with any part of this module, please go to
31213134
[http://tickets.puppetlabs.com/browse/MODULES](http://tickets.puppetlabs.com/browse/MODULES).
31223135
3136+
<a id="contributors"></a>
31233137
## Contributors
31243138
31253139
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)