Skip to content

Commit 2240928

Browse files
committed
Improve README
1 parent 7b065d7 commit 2240928

File tree

1 file changed

+38
-9
lines changed

1 file changed

+38
-9
lines changed

README.md

Lines changed: 38 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,33 @@
99

1010
![Catalog Diff](https://raw.githubusercontent.com/camptocamp/puppet-catalog-diff/master/catalog-diff.png)
1111

12+
13+
#### Table of Contents
14+
15+
1. [Overview](#overview)
16+
1. [Module Description](#module-description)
17+
1. [Setup](#setup)
18+
1. [Set up node discovery](#set-up-node-discovery)
19+
1. [Set up auth.conf](#set-up-auth-conf)
20+
1. [Usage](#usage)
21+
1. [Multi threaded compile requests](#multi-threaded-compile-requests)
22+
1. [Fact search](#fact-search)
23+
1. [Changed depth](#changed-depth)
24+
1. [Output report](#output-report)
25+
1. [Limitations](#limitations)
26+
1. [Authors](#authors)
27+
1. [Contributors](#contributors)
28+
1. [See Also](#see-also)
29+
1. [Upload facts to PuppetDB](#upload-facts-to-puppetdb)
30+
31+
1232
## Overview
1333

1434
A tool to compare two Puppet catalogs.
1535

36+
37+
## Module Description
38+
1639
While upgrading versions of Puppet or refactoring Puppet code you want to
1740
ensure that no unexpected changes will be made prior to committing the changes.
1841

@@ -42,7 +65,7 @@ able to compile catalogs on the new Master. This is useful when upgrading Puppet
4265
To upload facts to PuppetDB on a Master see the [Upload facts](#upload-facts-to-puppetdb) script.
4366

4467

45-
## Usage
68+
## Setup
4669

4770

4871
### Set up node discovery
@@ -103,7 +126,7 @@ If you are on Puppet 6, you can activate the certless API instead with:
103126
```
104127

105128

106-
### Running
129+
## Usage
107130

108131

109132
Example:
@@ -169,7 +192,7 @@ save the output with escaped color. If you want to view that text report run
169192
`less -r lastrun-$$.log`
170193

171194

172-
### Limitations
195+
## Limitations
173196

174197
This code only validates the catalogs, it cannot tell you if the behavior of
175198
the providers that interpret the catalog has changed so testing is still
@@ -184,6 +207,18 @@ viewed in markdown using the Rakefile in this directory.
184207
A web viewer is also available at [https://github.com/camptocamp/puppet-catalog-diff-viewer](https://github.com/camptocamp/puppet-catalog-diff-viewer)
185208

186209

210+
## Authors
211+
212+
R.I.Pienaar <[email protected]> / www.devco.net / @ripienaar
213+
Zack Smith <[email protected]> / @acidprime
214+
Raphaël Pinson <[email protected]> / @raphink
215+
216+
217+
## Contributors
218+
219+
The list of contributors can be found at: [https://github.com/camptocamp/puppet-catalog-diff/graphs/contributors](https://github.com/camptocamp/puppet-catalog-diff/graphs/contributors).
220+
221+
187222
## See also
188223

189224
### Upload facts to PuppetDB
@@ -214,9 +249,3 @@ It's been verified to work with uploading facts from Puppet Masters running Pupp
214249
version 3 to Masters running version 5. It uses the [`/puppet/v3/facts/` API](https://puppet.com/docs/puppet/6.17/http_api/http_facts.html)
215250
which is available in version 3 and >= 5 of Puppet. This API was removed in Puppet 4 but
216251
added again in 5.
217-
218-
## Authors
219-
R.I.Pienaar <[email protected]> / www.devco.net / @ripienaar
220-
Zack Smith <[email protected]> / @acidprime
221-
Raphaël Pinson <[email protected]> / @raphink
222-
See change log

0 commit comments

Comments
 (0)