Skip to content

Commit 10dae94

Browse files
committed
Fix markdown rendering issues
Prior to this there were a few issues with how the README was rendered on GitHub and the Forge. This commit fixes the following: * Code block syntax highlighting * list indentation * Other minor markdown syntax fixes
1 parent 913605a commit 10dae94

File tree

1 file changed

+61
-35
lines changed

1 file changed

+61
-35
lines changed

README.md

+61-35
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# node_manager [![Build Status](https://travis-ci.org/WhatsARanjit/prosvcs-node_manager.svg)](https://travis-ci.org/WhatsARanjit/prosvcs-node_manager)
22

33
#### Table of Contents
4+
45
1. [Overview](#overview)
56
1. [Requirements](#requirements)
67
1. [Types](#types)
@@ -16,19 +17,21 @@ Create and manage Node Manager API endpoints as resources.
1617

1718
## Module State
1819

19-
NOTE: This module is a Professional Service side project and is currently unmaintained.
20+
NOTE: This module is a Professional Service side project and is currently unmaintained.
2021
It is not supported and may not function as expected.
2122

22-
## Requirements:
23+
## Requirements
2324

24-
- *nix operating system
25-
- Puppet >= 3.7.1
26-
- [puppetclassify](https://github.com/puppetlabs/puppet-classify) gem
27-
- [puppetlabs/pe_gem module](https://forge.puppetlabs.com/puppetlabs/pe_gem)
28-
- NOTE: new `https` provider which doesn't need gem dependency at [HTTPS.md](HTTPS.md)
25+
* \*nix operating system
26+
* Puppet >= 3.7.1
27+
* [puppetclassify](https://github.com/puppetlabs/puppet-classify) gem
28+
* [puppetlabs/pe_gem module](https://forge.puppetlabs.com/puppetlabs/pe_gem)
29+
* NOTE: new `https` provider which doesn't need gem dependency at [HTTPS.md](HTTPS.md)
2930

3031
## Classes
32+
3133
### Node_manager
34+
3235
The node_manager class facilitates the deployment of the puppetclassify gem
3336
simply include node_manager in your node definition or add it to the pe_master node group
3437

@@ -39,10 +42,12 @@ simply include node_manager in your node definition or add it to the pe_master n
3942
Node_groups will autorequire parent node_groups.
4043

4144
Enumerate all node groups:
42-
* `puppet resource node_group`<br />
45+
46+
* `puppet resource node_group`
4347

4448
Example output for `puppet resource node_group 'PE MCollective'`
45-
```
49+
50+
```puppet
4651
node_group { 'PE MCollective':
4752
ensure => 'present',
4853
classes => {'puppet_enterprise::profile::mcollective::agent' => {}},
@@ -56,45 +61,63 @@ node_group { 'PE MCollective':
5661

5762
#### Node_group parameters
5863

59-
* `classes`<br />
60-
Classes that are assigned to the node in hash format. Elements of the hash
61-
are class parameters. Default (empty hash): `{}`
64+
* `classes`
65+
66+
Classes that are assigned to the node in hash format. Elements of the hash are class parameters.
67+
68+
Default (empty hash): `{}`
69+
70+
* `environment`
71+
72+
Environment selected for this node group.
73+
74+
Default: `production`
75+
76+
* `name`
77+
78+
(namevar) Node group's name.
79+
80+
* `id`
6281

63-
* `environment`<br />
64-
Environment selected for this node group. Default: `production`
82+
Universal ID for the group. This attribute is read-only.
6583

66-
* `name`<br />
67-
(namevar) Node group's name.
84+
* `override_environment`
6885

69-
* `id`<br />
70-
Universal ID for the group. This attribute is read-only.
86+
Whether or not this group's environment ment setting overrides all other other environments.
7187

72-
* `override_environment`<br />
73-
Whether or not this group's environment ment setting overrides
74-
all other other environments. Default: `false`
88+
Default: `false`
7589

76-
* `parent`<br />
77-
The UID for the data group. Can be specified by group name or
78-
UID. Default: `default`
90+
* `parent`
7991

80-
* `rules`<br />
81-
An array of classification rules. Default (empty array): `[]`
92+
The UID for the data group. Can be specified by group name or UID.
93+
94+
Default: `default`
95+
96+
* `rules`
97+
98+
An array of classification rules.
99+
100+
Default (empty array): `[]`
82101

83102
### Puppet_environment
84103

85104
Enumerate all puppet environments:
86-
* `puppet resource puppet_environment`<br />
105+
106+
* `puppet resource puppet_environment`
87107

88108
Example output for `puppet resource puppet_environment production`
89-
```
109+
110+
```puppet
90111
puppet_environment { 'production':
91112
ensure => 'present',
92113
}
93114
```
115+
94116
#### Puppet_environment parameters
95117

96-
* `name`<br />
97-
(namevar) Name of the Puppet environment on disk, i.e. the directory name in `$environmentpath`.
118+
* `name`
119+
120+
(namevar) Name of the Puppet environment on disk, i.e. the directory name in `$environmentpath`.
98121

99122
## Functions
100123

@@ -104,7 +127,7 @@ Retrieve all or one node_group and its data.
104127

105128
`node_groups()` will return:
106129

107-
```
130+
```puppet
108131
{
109132
"default"=>{
110133
"environment_trumps"=>false,
@@ -131,7 +154,7 @@ Retrieve all or one node_group and its data.
131154

132155
`node_groups('default')` will return:
133156

134-
```
157+
```puppet
135158
{
136159
"default"=>{
137160
"environment_trumps"=>false,
@@ -148,11 +171,14 @@ Retrieve all or one node_group and its data.
148171
_Type:_ rvalue
149172

150173
## Things to do
151-
- Remove `puppetclassify` dependency
152-
- Get feedback on `https` provider, new [HTTPS.md](HTTPS.md)
174+
175+
* Remove `puppetclassify` dependency
176+
* Get feedback on `https` provider, new [HTTPS.md](HTTPS.md)
153177

154178
## Maintainers
179+
155180
This repositority is largely the work of some Puppet community members.
156181
It is not officially maintained by Puppet, or any individual in
157-
particular. Issues should be opened in Github. Questions should be directed
182+
particular. Issues should be opened in Github. Questions should be directed
158183
at the individuals responsible for committing that particular code.
184+

0 commit comments

Comments
 (0)