kienan
/
puppet-strings
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
puppet-strings/spec/fixtures/unit/markdown/output_with_plan.md

472 lines
6.4 KiB
Markdown
Raw Normal View History

(PDOC-228) puppet plans support Currently, Puppet Strings only supports Puppet Tasks. Since Plans are sort of connected to Tasks, it seemed right that Strings should also support Plans. That and Plans are a thing that needs to be documented. First, the Puppet[:tasks] setting needs to be set to add the 'plan' keyword to the Puppet Parser's lexicon, so this sets it in the Strings parser if the setting exists. If it does not exist and Puppet.version is less than 5.0.0, Strings will error out. Second, processing for the Plans themselves is set up. Plans are very similar to other Puppet objects like defined types and classes, so this involved some serious copy-pasta. Third, all the template/to_hash scaffolding for the different outputs is in place (HTML, JSON, Markdown). Yey.
2018-03-03 00:15:09 +00:00
# Reference
## Classes
(PDOC-233) Increase chances of markdown rendering correctly Some variants of markdown do not convert atx-style headers correctly unless they are surrounded by blank lines. This commit adds blank lines to increase chances of rendering when using those variants while still maintaining compatibly with variants that do not require the surrounding blank lines. Also increases readability when viewing the raw markdown file.
2018-03-16 13:18:08 +00:00
(PDOC-228) puppet plans support Currently, Puppet Strings only supports Puppet Tasks. Since Plans are sort of connected to Tasks, it seemed right that Strings should also support Plans. That and Plans are a thing that needs to be documented. First, the Puppet[:tasks] setting needs to be set to add the 'plan' keyword to the Puppet Parser's lexicon, so this sets it in the Strings parser if the setting exists. If it does not exist and Puppet.version is less than 5.0.0, Strings will error out. Second, processing for the Plans themselves is set up. Plans are very similar to other Puppet objects like defined types and classes, so this involved some serious copy-pasta. Third, all the template/to_hash scaffolding for the different outputs is in place (HTML, JSON, Markdown). Yey.
2018-03-03 00:15:09 +00:00
### Public Classes
(PDOC-233) Increase chances of markdown rendering correctly Some variants of markdown do not convert atx-style headers correctly unless they are surrounded by blank lines. This commit adds blank lines to increase chances of rendering when using those variants while still maintaining compatibly with variants that do not require the surrounding blank lines. Also increases readability when viewing the raw markdown file.
2018-03-16 13:18:08 +00:00
(PDOC-228) puppet plans support Currently, Puppet Strings only supports Puppet Tasks. Since Plans are sort of connected to Tasks, it seemed right that Strings should also support Plans. That and Plans are a thing that needs to be documented. First, the Puppet[:tasks] setting needs to be set to add the 'plan' keyword to the Puppet Parser's lexicon, so this sets it in the Strings parser if the setting exists. If it does not exist and Puppet.version is less than 5.0.0, Strings will error out. Second, processing for the Plans themselves is set up. Plans are very similar to other Puppet objects like defined types and classes, so this involved some serious copy-pasta. Third, all the template/to_hash scaffolding for the different outputs is in place (HTML, JSON, Markdown). Yey.
2018-03-03 00:15:09 +00:00
* [`klass`](#klass): A simple class.
(PDOC-233) Increase chances of markdown rendering correctly Some variants of markdown do not convert atx-style headers correctly unless they are surrounded by blank lines. This commit adds blank lines to increase chances of rendering when using those variants while still maintaining compatibly with variants that do not require the surrounding blank lines. Also increases readability when viewing the raw markdown file.
2018-03-16 13:18:08 +00:00
(PDOC-228) puppet plans support Currently, Puppet Strings only supports Puppet Tasks. Since Plans are sort of connected to Tasks, it seemed right that Strings should also support Plans. That and Plans are a thing that needs to be documented. First, the Puppet[:tasks] setting needs to be set to add the 'plan' keyword to the Puppet Parser's lexicon, so this sets it in the Strings parser if the setting exists. If it does not exist and Puppet.version is less than 5.0.0, Strings will error out. Second, processing for the Plans themselves is set up. Plans are very similar to other Puppet objects like defined types and classes, so this involved some serious copy-pasta. Third, all the template/to_hash scaffolding for the different outputs is in place (HTML, JSON, Markdown). Yey.
2018-03-03 00:15:09 +00:00
### Private Classes
(PDOC-233) Increase chances of markdown rendering correctly Some variants of markdown do not convert atx-style headers correctly unless they are surrounded by blank lines. This commit adds blank lines to increase chances of rendering when using those variants while still maintaining compatibly with variants that do not require the surrounding blank lines. Also increases readability when viewing the raw markdown file.
2018-03-16 13:18:08 +00:00
(PDOC-228) puppet plans support Currently, Puppet Strings only supports Puppet Tasks. Since Plans are sort of connected to Tasks, it seemed right that Strings should also support Plans. That and Plans are a thing that needs to be documented. First, the Puppet[:tasks] setting needs to be set to add the 'plan' keyword to the Puppet Parser's lexicon, so this sets it in the Strings parser if the setting exists. If it does not exist and Puppet.version is less than 5.0.0, Strings will error out. Second, processing for the Plans themselves is set up. Plans are very similar to other Puppet objects like defined types and classes, so this involved some serious copy-pasta. Third, all the template/to_hash scaffolding for the different outputs is in place (HTML, JSON, Markdown). Yey.
2018-03-03 00:15:09 +00:00
* `noparams`: Overview for class noparams
(PDOC-233) Increase chances of markdown rendering correctly Some variants of markdown do not convert atx-style headers correctly unless they are surrounded by blank lines. This commit adds blank lines to increase chances of rendering when using those variants while still maintaining compatibly with variants that do not require the surrounding blank lines. Also increases readability when viewing the raw markdown file.
2018-03-16 13:18:08 +00:00
(PDOC-228) puppet plans support Currently, Puppet Strings only supports Puppet Tasks. Since Plans are sort of connected to Tasks, it seemed right that Strings should also support Plans. That and Plans are a thing that needs to be documented. First, the Puppet[:tasks] setting needs to be set to add the 'plan' keyword to the Puppet Parser's lexicon, so this sets it in the Strings parser if the setting exists. If it does not exist and Puppet.version is less than 5.0.0, Strings will error out. Second, processing for the Plans themselves is set up. Plans are very similar to other Puppet objects like defined types and classes, so this involved some serious copy-pasta. Third, all the template/to_hash scaffolding for the different outputs is in place (HTML, JSON, Markdown). Yey.
2018-03-03 00:15:09 +00:00
## Defined types
(PDOC-233) Increase chances of markdown rendering correctly Some variants of markdown do not convert atx-style headers correctly unless they are surrounded by blank lines. This commit adds blank lines to increase chances of rendering when using those variants while still maintaining compatibly with variants that do not require the surrounding blank lines. Also increases readability when viewing the raw markdown file.
2018-03-16 13:18:08 +00:00
(PDOC-228) puppet plans support Currently, Puppet Strings only supports Puppet Tasks. Since Plans are sort of connected to Tasks, it seemed right that Strings should also support Plans. That and Plans are a thing that needs to be documented. First, the Puppet[:tasks] setting needs to be set to add the 'plan' keyword to the Puppet Parser's lexicon, so this sets it in the Strings parser if the setting exists. If it does not exist and Puppet.version is less than 5.0.0, Strings will error out. Second, processing for the Plans themselves is set up. Plans are very similar to other Puppet objects like defined types and classes, so this involved some serious copy-pasta. Third, all the template/to_hash scaffolding for the different outputs is in place (HTML, JSON, Markdown). Yey.
2018-03-03 00:15:09 +00:00
* [`klass::dt`](#klassdt): A simple defined type.
(PDOC-233) Increase chances of markdown rendering correctly Some variants of markdown do not convert atx-style headers correctly unless they are surrounded by blank lines. This commit adds blank lines to increase chances of rendering when using those variants while still maintaining compatibly with variants that do not require the surrounding blank lines. Also increases readability when viewing the raw markdown file.
2018-03-16 13:18:08 +00:00
(PDOC-228) puppet plans support Currently, Puppet Strings only supports Puppet Tasks. Since Plans are sort of connected to Tasks, it seemed right that Strings should also support Plans. That and Plans are a thing that needs to be documented. First, the Puppet[:tasks] setting needs to be set to add the 'plan' keyword to the Puppet Parser's lexicon, so this sets it in the Strings parser if the setting exists. If it does not exist and Puppet.version is less than 5.0.0, Strings will error out. Second, processing for the Plans themselves is set up. Plans are very similar to other Puppet objects like defined types and classes, so this involved some serious copy-pasta. Third, all the template/to_hash scaffolding for the different outputs is in place (HTML, JSON, Markdown). Yey.
2018-03-03 00:15:09 +00:00
## Resource types
(PDOC-233) Increase chances of markdown rendering correctly Some variants of markdown do not convert atx-style headers correctly unless they are surrounded by blank lines. This commit adds blank lines to increase chances of rendering when using those variants while still maintaining compatibly with variants that do not require the surrounding blank lines. Also increases readability when viewing the raw markdown file.
2018-03-16 13:18:08 +00:00
(PDOC-228) puppet plans support Currently, Puppet Strings only supports Puppet Tasks. Since Plans are sort of connected to Tasks, it seemed right that Strings should also support Plans. That and Plans are a thing that needs to be documented. First, the Puppet[:tasks] setting needs to be set to add the 'plan' keyword to the Puppet Parser's lexicon, so this sets it in the Strings parser if the setting exists. If it does not exist and Puppet.version is less than 5.0.0, Strings will error out. Second, processing for the Plans themselves is set up. Plans are very similar to other Puppet objects like defined types and classes, so this involved some serious copy-pasta. Third, all the template/to_hash scaffolding for the different outputs is in place (HTML, JSON, Markdown). Yey.
2018-03-03 00:15:09 +00:00
* [`apt_key`](#apt_key): Example resource type using the new API.
* [`database`](#database): An example database server type.
(PDOC-233) Increase chances of markdown rendering correctly Some variants of markdown do not convert atx-style headers correctly unless they are surrounded by blank lines. This commit adds blank lines to increase chances of rendering when using those variants while still maintaining compatibly with variants that do not require the surrounding blank lines. Also increases readability when viewing the raw markdown file.
2018-03-16 13:18:08 +00:00
(PDOC-228) puppet plans support Currently, Puppet Strings only supports Puppet Tasks. Since Plans are sort of connected to Tasks, it seemed right that Strings should also support Plans. That and Plans are a thing that needs to be documented. First, the Puppet[:tasks] setting needs to be set to add the 'plan' keyword to the Puppet Parser's lexicon, so this sets it in the Strings parser if the setting exists. If it does not exist and Puppet.version is less than 5.0.0, Strings will error out. Second, processing for the Plans themselves is set up. Plans are very similar to other Puppet objects like defined types and classes, so this involved some serious copy-pasta. Third, all the template/to_hash scaffolding for the different outputs is in place (HTML, JSON, Markdown). Yey.
2018-03-03 00:15:09 +00:00
## Functions
(PDOC-233) Increase chances of markdown rendering correctly Some variants of markdown do not convert atx-style headers correctly unless they are surrounded by blank lines. This commit adds blank lines to increase chances of rendering when using those variants while still maintaining compatibly with variants that do not require the surrounding blank lines. Also increases readability when viewing the raw markdown file.
2018-03-16 13:18:08 +00:00
(PDOC-228) puppet plans support Currently, Puppet Strings only supports Puppet Tasks. Since Plans are sort of connected to Tasks, it seemed right that Strings should also support Plans. That and Plans are a thing that needs to be documented. First, the Puppet[:tasks] setting needs to be set to add the 'plan' keyword to the Puppet Parser's lexicon, so this sets it in the Strings parser if the setting exists. If it does not exist and Puppet.version is less than 5.0.0, Strings will error out. Second, processing for the Plans themselves is set up. Plans are very similar to other Puppet objects like defined types and classes, so this involved some serious copy-pasta. Third, all the template/to_hash scaffolding for the different outputs is in place (HTML, JSON, Markdown). Yey.
2018-03-03 00:15:09 +00:00
* [`func`](#func): A simple Puppet function.
* [`func3x`](#func3x): Documentation for an example 3.x function.
* [`func4x`](#func4x): An example 4.x function.
* [`func4x_1`](#func4x_1): An example 4.x function with only one signature.
(PDOC-233) Increase chances of markdown rendering correctly Some variants of markdown do not convert atx-style headers correctly unless they are surrounded by blank lines. This commit adds blank lines to increase chances of rendering when using those variants while still maintaining compatibly with variants that do not require the surrounding blank lines. Also increases readability when viewing the raw markdown file.
2018-03-16 13:18:08 +00:00
(PDOC-228) puppet plans support Currently, Puppet Strings only supports Puppet Tasks. Since Plans are sort of connected to Tasks, it seemed right that Strings should also support Plans. That and Plans are a thing that needs to be documented. First, the Puppet[:tasks] setting needs to be set to add the 'plan' keyword to the Puppet Parser's lexicon, so this sets it in the Strings parser if the setting exists. If it does not exist and Puppet.version is less than 5.0.0, Strings will error out. Second, processing for the Plans themselves is set up. Plans are very similar to other Puppet objects like defined types and classes, so this involved some serious copy-pasta. Third, all the template/to_hash scaffolding for the different outputs is in place (HTML, JSON, Markdown). Yey.
2018-03-03 00:15:09 +00:00
## Tasks
(PDOC-233) Increase chances of markdown rendering correctly Some variants of markdown do not convert atx-style headers correctly unless they are surrounded by blank lines. This commit adds blank lines to increase chances of rendering when using those variants while still maintaining compatibly with variants that do not require the surrounding blank lines. Also increases readability when viewing the raw markdown file.
2018-03-16 13:18:08 +00:00
(PDOC-228) puppet plans support Currently, Puppet Strings only supports Puppet Tasks. Since Plans are sort of connected to Tasks, it seemed right that Strings should also support Plans. That and Plans are a thing that needs to be documented. First, the Puppet[:tasks] setting needs to be set to add the 'plan' keyword to the Puppet Parser's lexicon, so this sets it in the Strings parser if the setting exists. If it does not exist and Puppet.version is less than 5.0.0, Strings will error out. Second, processing for the Plans themselves is set up. Plans are very similar to other Puppet objects like defined types and classes, so this involved some serious copy-pasta. Third, all the template/to_hash scaffolding for the different outputs is in place (HTML, JSON, Markdown). Yey.
2018-03-03 00:15:09 +00:00
* [`(stdin)`](#(stdin)): Allows you to backup your database to local file.
(PDOC-233) Increase chances of markdown rendering correctly Some variants of markdown do not convert atx-style headers correctly unless they are surrounded by blank lines. This commit adds blank lines to increase chances of rendering when using those variants while still maintaining compatibly with variants that do not require the surrounding blank lines. Also increases readability when viewing the raw markdown file.
2018-03-16 13:18:08 +00:00
(maint) display Plans in markdown table of contents Currently, Plans are not being included in the table of contents in the markdown output. This is because Plans were not being passed to the table of contents renderer. This adds Plans to the renderer and updates tests accordingly.
2018-04-03 12:37:47 +00:00
## Plans
* [`plann`](#plann): A simple plan.
(PDOC-228) puppet plans support Currently, Puppet Strings only supports Puppet Tasks. Since Plans are sort of connected to Tasks, it seemed right that Strings should also support Plans. That and Plans are a thing that needs to be documented. First, the Puppet[:tasks] setting needs to be set to add the 'plan' keyword to the Puppet Parser's lexicon, so this sets it in the Strings parser if the setting exists. If it does not exist and Puppet.version is less than 5.0.0, Strings will error out. Second, processing for the Plans themselves is set up. Plans are very similar to other Puppet objects like defined types and classes, so this involved some serious copy-pasta. Third, all the template/to_hash scaffolding for the different outputs is in place (HTML, JSON, Markdown). Yey.
2018-03-03 00:15:09 +00:00
## Classes
### klass
An overview for a simple class.
* **Since** 1.0.0
* **See also**
www.puppet.com
#### Examples
(PDOC-233) Increase chances of markdown rendering correctly Some variants of markdown do not convert atx-style headers correctly unless they are surrounded by blank lines. This commit adds blank lines to increase chances of rendering when using those variants while still maintaining compatibly with variants that do not require the surrounding blank lines. Also increases readability when viewing the raw markdown file.
2018-03-16 13:18:08 +00:00
(PDOC-228) puppet plans support Currently, Puppet Strings only supports Puppet Tasks. Since Plans are sort of connected to Tasks, it seemed right that Strings should also support Plans. That and Plans are a thing that needs to be documented. First, the Puppet[:tasks] setting needs to be set to add the 'plan' keyword to the Puppet Parser's lexicon, so this sets it in the Strings parser if the setting exists. If it does not exist and Puppet.version is less than 5.0.0, Strings will error out. Second, processing for the Plans themselves is set up. Plans are very similar to other Puppet objects like defined types and classes, so this involved some serious copy-pasta. Third, all the template/to_hash scaffolding for the different outputs is in place (HTML, JSON, Markdown). Yey.
2018-03-03 00:15:09 +00:00
##### This is an example
(PDOC-233) Increase chances of markdown rendering correctly Some variants of markdown do not convert atx-style headers correctly unless they are surrounded by blank lines. This commit adds blank lines to increase chances of rendering when using those variants while still maintaining compatibly with variants that do not require the surrounding blank lines. Also increases readability when viewing the raw markdown file.
2018-03-16 13:18:08 +00:00
(PDOC-228) puppet plans support Currently, Puppet Strings only supports Puppet Tasks. Since Plans are sort of connected to Tasks, it seemed right that Strings should also support Plans. That and Plans are a thing that needs to be documented. First, the Puppet[:tasks] setting needs to be set to add the 'plan' keyword to the Puppet Parser's lexicon, so this sets it in the Strings parser if the setting exists. If it does not exist and Puppet.version is less than 5.0.0, Strings will error out. Second, processing for the Plans themselves is set up. Plans are very similar to other Puppet objects like defined types and classes, so this involved some serious copy-pasta. Third, all the template/to_hash scaffolding for the different outputs is in place (HTML, JSON, Markdown). Yey.
2018-03-03 00:15:09 +00:00
```puppet
class { 'klass':
param1 => 1,
param3 => 'foo',
}
```
##### This is another example
(PDOC-233) Increase chances of markdown rendering correctly Some variants of markdown do not convert atx-style headers correctly unless they are surrounded by blank lines. This commit adds blank lines to increase chances of rendering when using those variants while still maintaining compatibly with variants that do not require the surrounding blank lines. Also increases readability when viewing the raw markdown file.
2018-03-16 13:18:08 +00:00
(PDOC-228) puppet plans support Currently, Puppet Strings only supports Puppet Tasks. Since Plans are sort of connected to Tasks, it seemed right that Strings should also support Plans. That and Plans are a thing that needs to be documented. First, the Puppet[:tasks] setting needs to be set to add the 'plan' keyword to the Puppet Parser's lexicon, so this sets it in the Strings parser if the setting exists. If it does not exist and Puppet.version is less than 5.0.0, Strings will error out. Second, processing for the Plans themselves is set up. Plans are very similar to other Puppet objects like defined types and classes, so this involved some serious copy-pasta. Third, all the template/to_hash scaffolding for the different outputs is in place (HTML, JSON, Markdown). Yey.
2018-03-03 00:15:09 +00:00
```puppet
class { 'klass':
param1 => 1,
param3 => 'foo',
}
```
#### Parameters
The following parameters are available in the `klass` class.
##### `param1`
Data type: `Integer`
First param.
Default value: 1
##### `param2`
Data type: `Any`
Second param.
Options:
* **:opt1** `String`: something about opt1
* **:opt2** `Hash`: a hash of stuff
Default value: `undef`
##### `param3`
Data type: `String`
Third param.
Default value: 'hi'
## Defined types
### klass::dt
An overview for a simple defined type.
* **Since** 1.1.0
* **See also**
www.puppet.com
#### Examples
(PDOC-233) Increase chances of markdown rendering correctly Some variants of markdown do not convert atx-style headers correctly unless they are surrounded by blank lines. This commit adds blank lines to increase chances of rendering when using those variants while still maintaining compatibly with variants that do not require the surrounding blank lines. Also increases readability when viewing the raw markdown file.
2018-03-16 13:18:08 +00:00
(PDOC-228) puppet plans support Currently, Puppet Strings only supports Puppet Tasks. Since Plans are sort of connected to Tasks, it seemed right that Strings should also support Plans. That and Plans are a thing that needs to be documented. First, the Puppet[:tasks] setting needs to be set to add the 'plan' keyword to the Puppet Parser's lexicon, so this sets it in the Strings parser if the setting exists. If it does not exist and Puppet.version is less than 5.0.0, Strings will error out. Second, processing for the Plans themselves is set up. Plans are very similar to other Puppet objects like defined types and classes, so this involved some serious copy-pasta. Third, all the template/to_hash scaffolding for the different outputs is in place (HTML, JSON, Markdown). Yey.
2018-03-03 00:15:09 +00:00
##### Here's an example of this type:
(PDOC-233) Increase chances of markdown rendering correctly Some variants of markdown do not convert atx-style headers correctly unless they are surrounded by blank lines. This commit adds blank lines to increase chances of rendering when using those variants while still maintaining compatibly with variants that do not require the surrounding blank lines. Also increases readability when viewing the raw markdown file.
2018-03-16 13:18:08 +00:00
(PDOC-228) puppet plans support Currently, Puppet Strings only supports Puppet Tasks. Since Plans are sort of connected to Tasks, it seemed right that Strings should also support Plans. That and Plans are a thing that needs to be documented. First, the Puppet[:tasks] setting needs to be set to add the 'plan' keyword to the Puppet Parser's lexicon, so this sets it in the Strings parser if the setting exists. If it does not exist and Puppet.version is less than 5.0.0, Strings will error out. Second, processing for the Plans themselves is set up. Plans are very similar to other Puppet objects like defined types and classes, so this involved some serious copy-pasta. Third, all the template/to_hash scaffolding for the different outputs is in place (HTML, JSON, Markdown). Yey.
2018-03-03 00:15:09 +00:00
```puppet
klass::dt { 'foo':
param1 => 33,
param4 => false,
}
```
#### Parameters
The following parameters are available in the `klass::dt` defined type.
##### `param1`
Data type: `Integer`
First param.
Default value: 44
##### `param2`
Data type: `Any`
Second param.
Options:
* **:opt1** `String`: something about opt1
* **:opt2** `Hash`: a hash of stuff
##### `param3`
Data type: `String`
Third param.
Default value: 'hi'
##### `param4`
Data type: `Boolean`
Fourth param.
Default value: `true`
## Resource types
### apt_key
This type provides Puppet with the capabilities to manage GPG keys needed
by apt to perform package validation. Apt has it's own GPG keyring that can
be manipulated through the `apt-key` command.
**Autorequires**:
If Puppet is given the location of a key file which looks like an absolute
path this type will autorequire that file.
#### Examples
(PDOC-233) Increase chances of markdown rendering correctly Some variants of markdown do not convert atx-style headers correctly unless they are surrounded by blank lines. This commit adds blank lines to increase chances of rendering when using those variants while still maintaining compatibly with variants that do not require the surrounding blank lines. Also increases readability when viewing the raw markdown file.
2018-03-16 13:18:08 +00:00
(PDOC-228) puppet plans support Currently, Puppet Strings only supports Puppet Tasks. Since Plans are sort of connected to Tasks, it seemed right that Strings should also support Plans. That and Plans are a thing that needs to be documented. First, the Puppet[:tasks] setting needs to be set to add the 'plan' keyword to the Puppet Parser's lexicon, so this sets it in the Strings parser if the setting exists. If it does not exist and Puppet.version is less than 5.0.0, Strings will error out. Second, processing for the Plans themselves is set up. Plans are very similar to other Puppet objects like defined types and classes, so this involved some serious copy-pasta. Third, all the template/to_hash scaffolding for the different outputs is in place (HTML, JSON, Markdown). Yey.
2018-03-03 00:15:09 +00:00
##### here's an example
(PDOC-233) Increase chances of markdown rendering correctly Some variants of markdown do not convert atx-style headers correctly unless they are surrounded by blank lines. This commit adds blank lines to increase chances of rendering when using those variants while still maintaining compatibly with variants that do not require the surrounding blank lines. Also increases readability when viewing the raw markdown file.
2018-03-16 13:18:08 +00:00
(PDOC-228) puppet plans support Currently, Puppet Strings only supports Puppet Tasks. Since Plans are sort of connected to Tasks, it seemed right that Strings should also support Plans. That and Plans are a thing that needs to be documented. First, the Puppet[:tasks] setting needs to be set to add the 'plan' keyword to the Puppet Parser's lexicon, so this sets it in the Strings parser if the setting exists. If it does not exist and Puppet.version is less than 5.0.0, Strings will error out. Second, processing for the Plans themselves is set up. Plans are very similar to other Puppet objects like defined types and classes, so this involved some serious copy-pasta. Third, all the template/to_hash scaffolding for the different outputs is in place (HTML, JSON, Markdown). Yey.
2018-03-03 00:15:09 +00:00
```puppet
apt_key { '6F6B15509CF8E59E6E469F327F438280EF8D349F':
source => 'http://apt.puppetlabs.com/pubkey.gpg'
}
```
#### Properties
The following properties are available in the `apt_key` type.
##### `ensure`
Data type: `Enum[present, absent]`
Whether this apt key should be present or absent on the target system.
##### `created`
Data type: `String`
Date the key was created, in ISO format.
#### Parameters
The following parameters are available in the `apt_key` type.
##### `id`
namevar
Data type: `Variant[Pattern[/A(0x)?[0-9a-fA-F]{8}Z/], Pattern[/A(0x)?[0-9a-fA-F]{16}Z/], Pattern[/A(0x)?[0-9a-fA-F]{40}Z/]]`
_*this data type contains a regex that may not be accurately reflected in generated documentation_
The ID of the key you want to manage.
### database
An example database server type.
#### Examples
(PDOC-233) Increase chances of markdown rendering correctly Some variants of markdown do not convert atx-style headers correctly unless they are surrounded by blank lines. This commit adds blank lines to increase chances of rendering when using those variants while still maintaining compatibly with variants that do not require the surrounding blank lines. Also increases readability when viewing the raw markdown file.
2018-03-16 13:18:08 +00:00
(PDOC-228) puppet plans support Currently, Puppet Strings only supports Puppet Tasks. Since Plans are sort of connected to Tasks, it seemed right that Strings should also support Plans. That and Plans are a thing that needs to be documented. First, the Puppet[:tasks] setting needs to be set to add the 'plan' keyword to the Puppet Parser's lexicon, so this sets it in the Strings parser if the setting exists. If it does not exist and Puppet.version is less than 5.0.0, Strings will error out. Second, processing for the Plans themselves is set up. Plans are very similar to other Puppet objects like defined types and classes, so this involved some serious copy-pasta. Third, all the template/to_hash scaffolding for the different outputs is in place (HTML, JSON, Markdown). Yey.
2018-03-03 00:15:09 +00:00
##### here's an example
(PDOC-233) Increase chances of markdown rendering correctly Some variants of markdown do not convert atx-style headers correctly unless they are surrounded by blank lines. This commit adds blank lines to increase chances of rendering when using those variants while still maintaining compatibly with variants that do not require the surrounding blank lines. Also increases readability when viewing the raw markdown file.
2018-03-16 13:18:08 +00:00
(PDOC-228) puppet plans support Currently, Puppet Strings only supports Puppet Tasks. Since Plans are sort of connected to Tasks, it seemed right that Strings should also support Plans. That and Plans are a thing that needs to be documented. First, the Puppet[:tasks] setting needs to be set to add the 'plan' keyword to the Puppet Parser's lexicon, so this sets it in the Strings parser if the setting exists. If it does not exist and Puppet.version is less than 5.0.0, Strings will error out. Second, processing for the Plans themselves is set up. Plans are very similar to other Puppet objects like defined types and classes, so this involved some serious copy-pasta. Third, all the template/to_hash scaffolding for the different outputs is in place (HTML, JSON, Markdown). Yey.
2018-03-03 00:15:09 +00:00
```puppet
database { 'foo':
address => 'qux.baz.bar',
}
```
#### Properties
The following properties are available in the `database` type.
##### `ensure`
Valid values: present, absent, up, down
Aliases: "up"=>"present", "down"=>"absent"
What state the database should be in.
Default value: up
##### `file`
The database file to use.
##### `log_level`
Valid values: debug, warn, error
The log level to use.
Default value: warn
#### Parameters
The following parameters are available in the `database` type.
##### `address`
namevar
The database server name.
##### `encryption_key`
The encryption key to use.
##### `encrypt`
Valid values: `true`, `false`, yes, no
Whether or not to encrypt the database.
Default value: `false`
## Functions
### func
(PDOC-233) Increase chances of markdown rendering correctly Some variants of markdown do not convert atx-style headers correctly unless they are surrounded by blank lines. This commit adds blank lines to increase chances of rendering when using those variants while still maintaining compatibly with variants that do not require the surrounding blank lines. Also increases readability when viewing the raw markdown file.
2018-03-16 13:18:08 +00:00
(PDOC-228) puppet plans support Currently, Puppet Strings only supports Puppet Tasks. Since Plans are sort of connected to Tasks, it seemed right that Strings should also support Plans. That and Plans are a thing that needs to be documented. First, the Puppet[:tasks] setting needs to be set to add the 'plan' keyword to the Puppet Parser's lexicon, so this sets it in the Strings parser if the setting exists. If it does not exist and Puppet.version is less than 5.0.0, Strings will error out. Second, processing for the Plans themselves is set up. Plans are very similar to other Puppet objects like defined types and classes, so this involved some serious copy-pasta. Third, all the template/to_hash scaffolding for the different outputs is in place (HTML, JSON, Markdown). Yey.
2018-03-03 00:15:09 +00:00
Type: Puppet Language
A simple Puppet function.
#### `func(Integer $param1, Any $param2, String $param3 = hi)`
A simple Puppet function.
Returns: `Undef` Returns nothing.
Raises:
* `SomeError` this is some error
##### `param1`
Data type: `Integer`
First param.
##### `param2`
Data type: `Any`
Second param.
##### `param3`
Data type: `String`
Third param.
Options:
* **:param3opt** `Array`: Something about this option
### func3x
(PDOC-233) Increase chances of markdown rendering correctly Some variants of markdown do not convert atx-style headers correctly unless they are surrounded by blank lines. This commit adds blank lines to increase chances of rendering when using those variants while still maintaining compatibly with variants that do not require the surrounding blank lines. Also increases readability when viewing the raw markdown file.
2018-03-16 13:18:08 +00:00
(PDOC-228) puppet plans support Currently, Puppet Strings only supports Puppet Tasks. Since Plans are sort of connected to Tasks, it seemed right that Strings should also support Plans. That and Plans are a thing that needs to be documented. First, the Puppet[:tasks] setting needs to be set to add the 'plan' keyword to the Puppet Parser's lexicon, so this sets it in the Strings parser if the setting exists. If it does not exist and Puppet.version is less than 5.0.0, Strings will error out. Second, processing for the Plans themselves is set up. Plans are very similar to other Puppet objects like defined types and classes, so this involved some serious copy-pasta. Third, all the template/to_hash scaffolding for the different outputs is in place (HTML, JSON, Markdown). Yey.
2018-03-03 00:15:09 +00:00
Type: Ruby 3.x API
Documentation for an example 3.x function.
#### `func3x(String $param1, Integer $param2)`
Documentation for an example 3.x function.
Returns: `Undef`
##### `param1`
Data type: `String`
The first parameter.
##### `param2`
Data type: `Integer`
The second parameter.
### func4x
(PDOC-233) Increase chances of markdown rendering correctly Some variants of markdown do not convert atx-style headers correctly unless they are surrounded by blank lines. This commit adds blank lines to increase chances of rendering when using those variants while still maintaining compatibly with variants that do not require the surrounding blank lines. Also increases readability when viewing the raw markdown file.
2018-03-16 13:18:08 +00:00
(PDOC-228) puppet plans support Currently, Puppet Strings only supports Puppet Tasks. Since Plans are sort of connected to Tasks, it seemed right that Strings should also support Plans. That and Plans are a thing that needs to be documented. First, the Puppet[:tasks] setting needs to be set to add the 'plan' keyword to the Puppet Parser's lexicon, so this sets it in the Strings parser if the setting exists. If it does not exist and Puppet.version is less than 5.0.0, Strings will error out. Second, processing for the Plans themselves is set up. Plans are very similar to other Puppet objects like defined types and classes, so this involved some serious copy-pasta. Third, all the template/to_hash scaffolding for the different outputs is in place (HTML, JSON, Markdown). Yey.
2018-03-03 00:15:09 +00:00
Type: Ruby 4.x API
An example 4.x function.
#### `func4x(Integer $param1, Any $param2, Optional[Array[String]] $param3)`
An overview for the first overload.
Returns: `Undef` Returns nothing.
##### `param1`
Data type: `Integer`
The first parameter.
##### `param2`
Data type: `Any`
The second parameter.
Options:
* **:option** `String`: an option
* **:option2** `String`: another option
##### `param3`
Data type: `Optional[Array[String]]`
The third parameter.
#### `func4x(Boolean $param, Callable &$block)`
An overview for the second overload.
Returns: `String` Returns a string.
##### `param`
Data type: `Boolean`
The first parameter.
##### `&block`
Data type: `Callable`
The block parameter.
### func4x_1
(PDOC-233) Increase chances of markdown rendering correctly Some variants of markdown do not convert atx-style headers correctly unless they are surrounded by blank lines. This commit adds blank lines to increase chances of rendering when using those variants while still maintaining compatibly with variants that do not require the surrounding blank lines. Also increases readability when viewing the raw markdown file.
2018-03-16 13:18:08 +00:00
(PDOC-228) puppet plans support Currently, Puppet Strings only supports Puppet Tasks. Since Plans are sort of connected to Tasks, it seemed right that Strings should also support Plans. That and Plans are a thing that needs to be documented. First, the Puppet[:tasks] setting needs to be set to add the 'plan' keyword to the Puppet Parser's lexicon, so this sets it in the Strings parser if the setting exists. If it does not exist and Puppet.version is less than 5.0.0, Strings will error out. Second, processing for the Plans themselves is set up. Plans are very similar to other Puppet objects like defined types and classes, so this involved some serious copy-pasta. Third, all the template/to_hash scaffolding for the different outputs is in place (HTML, JSON, Markdown). Yey.
2018-03-03 00:15:09 +00:00
Type: Ruby 4.x API
An example 4.x function with only one signature.
#### `func4x_1(Integer $param1)`
An example 4.x function with only one signature.
Returns: `Undef` Returns nothing.
##### `param1`
Data type: `Integer`
The first parameter.
## Tasks
### (stdin)
Allows you to backup your database to local file.
**Supports noop?** false
#### Parameters
##### `database`
Data type: `Optional[String[1]]`
Database to connect to
##### `user`
Data type: `Optional[String[1]]`
The user
##### `password`
Data type: `Optional[String[1]]`
The password
##### `sql`
Data type: `String[1]`
Path to file you want backup to
## Plans
### plann
A simple plan.
#### Parameters
The following parameters are available in the `plann` plan.
##### `param1`
Data type: `String`
First param.
##### `param2`
Data type: `Any`
Second param.
##### `param3`
Data type: `Integer`
Third param.
Default value: 1