Skip to content

(maint) - Add HTML anchor tag #974

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Dec 7, 2018
Merged

(maint) - Add HTML anchor tag #974

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
5540a69
Add HTML anchor tag
clairecadman Dec 3, 2018
2b4c74c
Update README.md
ehom Dec 4, 2018
a99e5d5
Update README.md
ehom Dec 4, 2018
42d5cc9
Update README.md
ehom Dec 4, 2018
7815dbc
Update README.md
ehom Dec 4, 2018
668e6ba
Merge pull request #1 from ehom/anchor_tags
clairecadman Dec 5, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 19 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
1. [Development - Guide for contributing to the module](#development)
1. [Contributors](#contributors)


<a id="module-description"></a>
## Module Description

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

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

<a id="setup"></a>
## Setup

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

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.

<a id="usage"></a>
## Usage

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`.
Expand All @@ -61,6 +63,7 @@ node default {
}
```

<a id="reference"></a>
## Reference

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

<a id="classes"></a>
### Classes

<a id="public-classes"></a>
#### Public classes

The `stdlib` class has no parameters.

<a id="private-classes"></a>
#### Private classes

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

<a id="defined-types"></a>
### Defined types

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

Default: 'UTF-8'.

##### `ensure`: Specifies whether the resource is present.
##### `ensure`

Specifies whether the resource is present.

Values: 'present', 'absent'.

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

Default value: `false`.

<a id="data-types"></a>
### Data types

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

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

<a id="facts"></a>
### Facts

#### `package_provider`
Expand Down Expand Up @@ -703,6 +714,7 @@ Determines the root home directory, which depends on your operating system. Gene

Returns the default provider Puppet uses to manage services on this system

<a id="functions"></a>
### Functions

#### `abs`
Expand Down Expand Up @@ -1074,8 +1086,7 @@ Deletes all instances of a given element from an array or hash that match a prov

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


For example
For example:

* `delete_regex(['a','b','c','b'], 'b')` returns ['a','c'].
* `delete_regex({'a' => 1,'b' => 2,'c' => 3},['b','c'])` returns {'a'=> 1}.
Expand Down Expand Up @@ -1899,7 +1910,7 @@ $metadata = load_module_metadata('archive')
notify { $metadata['author']: }
```

When a module's metadata file is absent, the catalog compilation fails. To avoid this failure:
When a module's metadata file is absent, the catalog compilation fails. To avoid this failure, do the following:

```
$metadata = load_module_metadata('mysql', true)
Expand Down Expand Up @@ -3107,19 +3118,22 @@ A negative value is taken to be "from the end" of the array, for example:

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.

<a id="limitations"></a>
## Limitations

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.

For an extensive list of supported operating systems, see [metadata.json](https://github.com/puppetlabs/puppetlabs-stdlib/blob/master/metadata.json)

<a id="development"></a>
## Development

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

To report or research a bug with any part of this module, please go to
[http://tickets.puppetlabs.com/browse/MODULES](http://tickets.puppetlabs.com/browse/MODULES).

<a id="contributors"></a>
## Contributors

The list of contributors can be found at: [https://github.com/puppetlabs/puppetlabs-stdlib/graphs/contributors](https://github.com/puppetlabs/puppetlabs-stdlib/graphs/contributors).