Skip to content

Commit 6a11f7e

Browse files
committed
Added TOC to each docs page
1 parent a764308 commit 6a11f7e

File tree

5 files changed

+33
-0
lines changed

5 files changed

+33
-0
lines changed

docs/Gemfile.lock

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -253,6 +253,7 @@ GEM
253253

254254
PLATFORMS
255255
arm64-darwin-21
256+
arm64-darwin-23
256257
x86_64-linux
257258

258259
DEPENDENCIES

docs/configuring-the-connector.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,14 @@ title: Configuring the Connector
44
nav_order: 4
55
---
66

7+
## Table of contents
8+
{: .no_toc .text-delta }
9+
10+
- TOC
11+
{:toc}
12+
13+
## Overview
14+
715
Using the MarkLogic Kafka connector requires configuring a set of properties to control how the connector interacts
816
with MarkLogic. The manner in which you use the MarkLogic connector will determine how you configure the connector:
917

docs/installation-guide.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,14 @@ title: Installation Guide
44
nav_order: 3
55
---
66

7+
## Table of contents
8+
{: .no_toc .text-delta }
9+
10+
- TOC
11+
{:toc}
12+
13+
## Overview
14+
715
Apache Kafka can be run either as a standalone product or via a provider such as Confluent. This guide provides
816
instructions on using the MarkLogic connector with either Kafka as a standalone product or via Confluent. Other
917
Kafka providers exist and should be capable of utilizing the MarkLogic connector as well, but instructions on those

docs/reading-data.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,14 @@ title: Reading Data
44
nav_order: 5
55
---
66

7+
## Table of contents
8+
{: .no_toc .text-delta }
9+
10+
- TOC
11+
{:toc}
12+
13+
## Overview
14+
715
The MarkLogic Kafka connector uses the [Optic API](https://docs.marklogic.com/guide/app-dev/OpticAPI) to read data from
816
MarkLogic as rows. Each row is converted into a Kafka `SourceRecord` and sent to a user-defined topic. To enable
917
this, the following properties must be configured:

docs/writing-data.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,14 @@ title: Writing Data
44
nav_order: 6
55
---
66

7+
## Table of contents
8+
{: .no_toc .text-delta }
9+
10+
- TOC
11+
{:toc}
12+
13+
## Overview
14+
715
By default, the MarkLogic Kafka connector assumes that the app server associated with the port defined by the `ml.connection.port`
816
property is a [REST API app server](https://docs.marklogic.com/guide/rest-dev) - that is, the value of its `url rewriter`
917
property is `/MarkLogic/rest-api/rewriter.xml` or a variation of that rewriter. This allows the MarkLogic connector to use the

0 commit comments

Comments
 (0)