Skip to content

Commit

Permalink
0.2.3: update REFERENCE.md, add link in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rjd1 committed Dec 8, 2023
1 parent 382a6eb commit 0245eb5
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 7 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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

Expand Down
6 changes: 3 additions & 3 deletions REFERENCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -22,7 +22,7 @@

### <a name="kafka_connect"></a>`kafka_connect`

Main kafka_connect class
Main kafka_connect class.

#### Examples

Expand Down

0 comments on commit 0245eb5

Please sign in to comment.