diff --git a/README.md b/README.md index 0385dfd..a40cfa3 100644 --- a/README.md +++ b/README.md @@ -5,9 +5,9 @@ Welcome to the kafka_connect Puppet module! ## Table of Contents 1. [Description](#description) -1. [Setup - The basics of getting started with kafka_connect](#setup) +2. [Setup - The basics of getting started with kafka_connect](#setup) * [What kafka_connect affects](#what-kafka_connect-affects) -1. [Usage - Configuration options and additional functionality](#usage) +3. [Usage - Configuration options and additional functionality](#usage) * [Using the provider directly](#using-the-provider-directly) * * [Examples](#examples) * [Managing connectors through the helper class](#managing-connectors-through-the-helper-class) @@ -16,9 +16,10 @@ Welcome to the kafka_connect Puppet module! * * [Remove a Connector](#remove-a-connector) * * [Pause a Connector](#pause-a-connector) * * [Add Secrets Config Data](#add-secrets-config-data) -1. [Limitations - OS compatibility, etc.](#limitations) +4. [Reference - An under-the-hood peek at what the module is doing and how](REFERENCE.md) +5. [Limitations - OS compatibility, etc.](#limitations) * [Known Issues](#known-issues) -1. [Development - Guide for contributing to the module](#development) +6. [Development - Guide for contributing to the module](#development) ## Description diff --git a/REFERENCE.md b/REFERENCE.md index 3e87da2..e5c515c 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -8,11 +8,11 @@ #### Public Classes -* [`kafka_connect`](#kafka_connect): Manages kafka-connect +* [`kafka_connect`](#kafka_connect): Main kafka_connect class. #### Private Classes -* `kafka_connect::manage_connectors`: Manage KC connectors +* `kafka_connect::manage_connectors`: Private class to manage individual Kafka Connect connectors. ### Resource types @@ -22,7 +22,7 @@ ### `kafka_connect` -Main kafka_connect class +Main kafka_connect class. #### Examples