Skip to content

Commit 58e553b

Browse files
committed
Formatting and TOS
1 parent 8ddfd19 commit 58e553b

File tree

1 file changed

+21
-11
lines changed

1 file changed

+21
-11
lines changed

README.md

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,28 @@
33
#### Table of Contents
44

55
1. [Overview](#overview)
6-
2. [Module Description - What the module does and why it is useful](#module-description)
7-
3. [Setup - The basics of getting started with rsnapshot](#setup)
6+
2. [Module Description](#module-description)
7+
3. [Differences between this and other modules](#differences-between-this-and-other-modules)
8+
4. [Setup - The basics of getting started with rsnapshot](#setup)
89
* [What rsnapshot affects](#what-rsnapshot-affects)
910
* [Setup requirements](#setup-requirements)
1011
* [Beginning with rsnapshot](#beginning-with-rsnapshot)
11-
4. [Usage - Configuration options and additional functionality](#usage)
12-
5. [Reference - An under-the-hood peek at what the module is doing and how](#reference)
13-
5. [Limitations - OS compatibility, etc.](#limitations)
14-
6. [Development - Guide for contributing to the module](#development)
12+
5. [Usage - Configuration options and additional functionality](#usage)
13+
* [Configuring the Server](#configuring-the-server)
14+
* [Configuring the Client](#configuring-the-client)
15+
* [Adding Backup Points to Profiles](#adding-backup-points-to-profiles)
16+
* [Backing Up Machines Outside of Puppet](#backing-up-machines-outside-of-puppet)
17+
6. [Reference](#reference)
18+
* [Public Classes](#public-classes)
19+
* [Defines](#public-defines)
20+
* [Private Classes](#private-classes)
21+
* [Private Defines](#private-defines)
22+
7. [Resources](#resources)
23+
* [Define rsnapshot::backup](#[define-rsnapshot-backup)
24+
* [Class rsnapshot::client](#class-rsnapshot-client)
25+
* [Class rsnapshot::server](#class-rsnapshot-server)
26+
* [Define rsnapshot::server::config](#[define-rsnapshot-server-config)
27+
8. [Development](#development)
1528

1629
## Overview
1730

@@ -138,7 +151,6 @@ class { 'rsnapshot::server':
138151
```
139152

140153

141-
142154
### Configuring the Client
143155

144156
Settings in the client class are specific to that one client node. The
@@ -183,7 +195,6 @@ class { 'rsnapshot::client':
183195
```
184196

185197

186-
187198
### Adding Backup Points to Profiles
188199

189200
This module provides a resource type, `rnapshot::backup`, that can be used to
@@ -234,7 +245,6 @@ type. This object takes a combination of the rsnapshot::server and
234245
rsnapshot::client settings, and it will generate all of the configuration and
235246
the cronjobs needed to run backups.
236247

237-
238248
```puppet
239249
rsnapshot::server::config { 'backupclient.example.com':
240250
server => $::fqdn,
@@ -278,10 +288,8 @@ rsnapshot::server::config { 'backupclient.example.com':
278288
```
279289

280290

281-
282291
## Reference
283292

284-
285293
### Public Classes
286294

287295
* [`rsnapshot::client`](#class-rsnapshotclient)
@@ -306,6 +314,8 @@ rsnapshot::server::config { 'backupclient.example.com':
306314
and config types.
307315

308316

317+
## Resources
318+
309319
### Define: `rsnapshot::backup`
310320

311321
These resources are used to define backup points outside of the client of config

0 commit comments

Comments
 (0)