Skip to content

Commit

Permalink
Refer to local reference instead of type reference
Browse files Browse the repository at this point in the history
See MODULES-8182.

Consolidate Beginning and Usage sections. Refer to github project page instead
of the README.md.
  • Loading branch information
joshcooper committed Nov 26, 2018
1 parent 64e9305 commit fc9606d
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 15 deletions.
20 changes: 6 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,18 @@
#### Table of Contents

1. [Description](#description)
2. [Setup - The basics of getting started with zfs_core](#setup)
* [Beginning with zfs_core](#beginning-with-zfs_core)
3. [Usage - Configuration options and additional functionality](#usage)
4. [Reference - An under-the-hood peek at what the module is doing and how](#reference)
5. [Limitations - OS compatibility, etc.](#limitations)
6. [Development - Guide for contributing to the module](#development)
2. [Usage - Configuration options and additional functionality](#usage)
3. [Reference - An under-the-hood peek at what the module is doing and how](#reference)
4. [Limitations - OS compatibility, etc.](#limitations)
5. [Development - Guide for contributing to the module](#development)

## Description

The zfs_core module is used to manage both zfs and zpool resources. Though This
module is only tested on Solaris machines, it should also work on any machine
that has zfs or zpool resources.

## Setup

### Beginning with zfs_core
## Usage

To create a zpool resource with the name `tstpool` that uses the disk `/ztstpool/dsk`, use the following code:
```
Expand All @@ -35,13 +31,9 @@ zfs { 'tstpool/tstfs':
}
```

## Usage

For details on usage, please see [the zfs puppet docs docs](https://puppet.com/docs/puppet/latest/types/zfs.html) and [the zpool puppet docs](https://puppet.com/docs/puppet/latest/types/zpool.html).

## Reference

Please see REFERENCE.md for the reference documentation.
Please see the reference documentation for [`zfs`](REFERENCE.md) and [`zpool`](https://github.com/puppetlabs/puppetlabs-zpool_core/blob/master/REFERENCE.md).

This module is documented using Puppet Strings.

Expand Down
2 changes: 1 addition & 1 deletion metadata.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"summary": "Manage zfs. Create destroy and set properties on zfs instances.",
"license": "Apache-2.0",
"source": "https://github.com/puppetlabs/puppetlabs-zfs_core",
"project_page": "https://github.com/puppetlabs/puppetlabs-zfs_core/blob/master/README.md",
"project_page": "https://github.com/puppetlabs/puppetlabs-zfs_core",
"issues_url": "https://tickets.puppetlabs.com/projects/MODULES",
"dependencies": [

Expand Down

0 comments on commit fc9606d

Please sign in to comment.