Skip to content

Commit 88ca398

Browse files
jruauxjruaux
committed
added documentation for sink and source connectors
1 parent 45bfff3 commit 88ca398

22 files changed

+582
-115
lines changed

‎.github/workflows/maven.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,4 +41,4 @@ jobs:
4141
uses: peaceiris/actions-gh-pages@v3
4242
with:
4343
github_token: ${{ secrets.GITHUB_TOKEN }}
44-
publish_dir: ./target/site
44+
publish_dir: ./target/generated-docs

‎pom.xml

Lines changed: 108 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@
6464
<dependency>
6565
<groupId>io.lettuce</groupId>
6666
<artifactId>lettuce-core</artifactId>
67-
<version>6.1.2.RELEASE</version>
67+
<version>6.1.3.RELEASE</version>
6868
</dependency>
6969
<dependency>
7070
<groupId>org.slf4j</groupId>
@@ -74,7 +74,7 @@
7474
<dependency>
7575
<groupId>com.redislabs</groupId>
7676
<artifactId>spring-batch-redis</artifactId>
77-
<version>2.13.4</version>
77+
<version>2.13.5-SNAPSHOT</version>
7878
</dependency>
7979
<dependency>
8080
<groupId>org.projectlombok</groupId>
@@ -129,15 +129,18 @@
129129
</plugin>
130130
<plugin>
131131
<groupId>org.apache.maven.plugins</groupId>
132-
<artifactId>maven-javadoc-plugin</artifactId>
132+
<artifactId>maven-assembly-plugin</artifactId>
133+
<version>3.3.0</version>
133134
<configuration>
134-
<source>8</source>
135+
<skipAssembly>true</skipAssembly>
135136
</configuration>
136137
</plugin>
137138
<plugin>
138-
<artifactId>maven-assembly-plugin</artifactId>
139+
<groupId>org.apache.maven.plugins</groupId>
140+
<artifactId>maven-javadoc-plugin</artifactId>
141+
<version>3.3.0</version>
139142
<configuration>
140-
<skipAssembly>true</skipAssembly>
143+
<source>8</source>
141144
</configuration>
142145
</plugin>
143146
<plugin>
@@ -181,37 +184,106 @@
181184
</executions>
182185
</plugin>
183186
<plugin>
184-
<groupId>org.apache.maven.plugins</groupId>
185-
<artifactId>maven-site-plugin</artifactId>
186-
<version>3.7.1</version>
187+
<groupId>org.asciidoctor</groupId>
188+
<artifactId>asciidoctor-maven-plugin</artifactId>
189+
<version>${asciidoctor.maven.plugin.version}</version>
187190
<configuration>
188-
<!-- Disable generateReports if you don't want to include the built-in reports -->
189-
<generateReports>true</generateReports>
190-
<generateSitemap>true</generateSitemap>
191-
<relativizeDecorationLinks>false</relativizeDecorationLinks>
192-
<locales>en</locales>
193-
<inputEncoding>UTF-8</inputEncoding>
194-
<outputEncoding>UTF-8</outputEncoding>
191+
<attributes>
192+
<project-name>${project.name}</project-name>
193+
<project-version>${project.version}</project-version>
194+
</attributes>
195+
</configuration>
196+
<executions>
197+
<execution>
198+
<id>asciidoc-to-html</id>
199+
<phase>generate-resources</phase>
200+
<goals>
201+
<goal>process-asciidoc</goal>
202+
</goals>
203+
<configuration>
204+
<backend>html5</backend>
205+
<attributes>
206+
<source-highlighter>highlightjs</source-highlighter>
207+
<toc>left</toc>
208+
<toclevels>1</toclevels>
209+
<icons>font</icons>
210+
<sectanchors>true</sectanchors>
211+
<!-- set the idprefix to blank -->
212+
<idprefix/>
213+
<idseparator>-</idseparator>
214+
</attributes>
215+
</configuration>
216+
</execution>
217+
</executions>
218+
</plugin>
219+
<plugin>
220+
<groupId>org.jreleaser</groupId>
221+
<artifactId>jreleaser-maven-plugin</artifactId>
222+
<version>0.5.0-SNAPSHOT</version>
223+
<configuration>
224+
<jreleaser>
225+
<distributions>
226+
<kafka-connect-archive>
227+
<artifacts>
228+
<artifact>
229+
<path>target/components/packages/redislabs-${project.artifactId}-${project.version}.zip</path>
230+
</artifact>
231+
</artifacts>
232+
</kafka-connect-archive>
233+
</distributions>
234+
<release>
235+
<github>
236+
<owner>RedisLabs-Field-Engineering</owner>
237+
<overwrite>true</overwrite>
238+
<changelog>
239+
<formatted>ALWAYS</formatted>
240+
<change>- {{commitShortHash}} {{commitTitle}}</change>
241+
<labelers>
242+
<labeler>
243+
<label>feature</label>
244+
<title>Resolves #</title>
245+
<body>Resolves #</body>
246+
</labeler>
247+
<labeler>
248+
<label>issue</label>
249+
<title>Fixes #</title>
250+
<body>Fixes #</body>
251+
</labeler>
252+
<labeler>
253+
<label>issue</label>
254+
<title>Relates to #</title>
255+
<body>Relates to #</body>
256+
</labeler>
257+
<labeler>
258+
<label>task</label>
259+
<title>[chore]</title>
260+
</labeler>
261+
</labelers>
262+
<categories>
263+
<category>
264+
<title>🚀 Features</title>
265+
<labelsAsString>feature</labelsAsString>
266+
</category>
267+
<category>
268+
<title>✅ Issues</title>
269+
<labelsAsString>issue</labelsAsString>
270+
</category>
271+
<category>
272+
<title>🧰 Tasks</title>
273+
<labelsAsString>task</labelsAsString>
274+
</category>
275+
</categories>
276+
<replacers>
277+
<replacer>
278+
<search>\[chore\]\s</search>
279+
<replace>''</replace>
280+
</replacer>
281+
</replacers>
282+
</changelog>
283+
</github>
284+
</release>
285+
</jreleaser>
195286
</configuration>
196-
<dependencies>
197-
<dependency>
198-
<groupId>org.asciidoctor</groupId>
199-
<artifactId>asciidoctor-maven-plugin</artifactId>
200-
<version>${asciidoctor.maven.plugin.version}</version>
201-
</dependency>
202-
<!-- Comment this section to use the default jruby artifact provided by the plugin -->
203-
<dependency>
204-
<groupId>org.jruby</groupId>
205-
<artifactId>jruby-complete</artifactId>
206-
<version>${jruby.version}</version>
207-
</dependency>
208-
<!-- Comment this section to use the default AsciidoctorJ artifact provided by the plugin -->
209-
<dependency>
210-
<groupId>org.asciidoctor</groupId>
211-
<artifactId>asciidoctorj</artifactId>
212-
<version>${asciidoctorj.version}</version>
213-
</dependency>
214-
</dependencies>
215287
</plugin>
216288
</plugins>
217289
</build>
@@ -224,6 +296,7 @@
224296
<version>2.6</version>
225297
</plugin>
226298
<plugin>
299+
<groupId>org.apache.maven.plugins</groupId>
227300
<artifactId>maven-project-info-reports-plugin</artifactId>
228301
<version>2.8</version>
229302
</plugin>

‎src/docs/asciidoc/connect.adoc

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
= Connect to Redis Enterprise
2+
3+
This section provides information on configuring the Redis Enterprise Kafka Source or Sink Connector to connect to Redis Enterprise.
4+
5+
== Redis URI
6+
7+
The {project-name} relies on https://lettuce.io[Lettuce] to connect to Redis Enterprise. The Redis URI connection format is described https://github.com/lettuce-io/lettuce-core/wiki/Redis-URI-and-connection-details#uri-syntax[here].
8+
9+
== Configuring the Connection URI
10+
11+
Specify the Redis URI in the `redis.uri` property, for example:
12+
----
13+
redis.uri=redis://redis-12000.redislabs.com:12000
14+
----
15+
16+
Refer to the configuration guides for more detail:
17+
18+
* <<sink,Sink Connector Guide>>
19+
* <<source,Source Connector Guide>>
20+
21+

‎src/docs/asciidoc/docker-pageviews.json

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"viewtime": {
3+
"$numberLong": "81"
4+
},
5+
"pageid": "Page_1",
6+
"userid": "User_8"
7+
}

‎src/site/asciidoc/quickstart.adoc renamed to ‎src/docs/asciidoc/docker.adoc

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,4 @@
1-
= Quick Start
2-
Julien Ruaux <julien@redislabs.com>
3-
v1.0, 2021-06-16
4-
//:toc:
5-
:icons: font
6-
:source-highlighter: coderay
7-
:sectanchors:
8-
//:compat-mode:
1+
= Quick Start with Docker
92

103
This guide provides a hands-on look at the functionality of the Redis Enterprise Kafka Source and Sink Connectors:
114

@@ -41,10 +34,11 @@ This will:
4134

4235
Once running, examine the topics in the Kafka control center: http://localhost:9021/
4336

44-
* The `pageviews` topic should contain the 10 simple documents added. Each similar to:
37+
* The `pageviews` topic should contain the 10 simple documents added, each similar to:
38+
4539
[source,json]
4640
----
47-
{"viewtime": {"$numberLong": "81"}, "pageid": "Page_1", "userid": "User_8"}
41+
include::docker-pageviews.json[]
4842
----
4943

5044
* The `pageviews` stream should contain the 10 change events.

‎src/site/resources/images/redislabs.svg renamed to ‎src/docs/asciidoc/images/redislabs.svg

File renamed without changes.

‎src/docs/asciidoc/index.adoc

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
= {project-name}
2+
Julien Ruaux <julien@redislabs.com>
3+
2021-06-24
4+
:revnumber: {project-version}
5+
6+
== Introduction
7+
8+
The {project-name} is used to import and export data between Apache Kafka and Redis Enterprise. This guide provides documentation and usage information across the following topics:
9+
10+
* <<install,Install>>
11+
* <<connect,Connect to Redis Enterprise>>
12+
* <<sink,Sink Connector Guide>>
13+
* <<source,Source Connector Guide>>
14+
* <<docker,Docker Example>>
15+
16+
[[install]]
17+
include::install.adoc[leveloffset=+1]
18+
[[connect]]
19+
include::connect.adoc[leveloffset=+1]
20+
[[sink]]
21+
include::sink.adoc[leveloffset=+1]
22+
[[source]]
23+
include::source.adoc[leveloffset=+1]
24+
[[docker]]
25+
include::docker.adoc[leveloffset=+1]

‎src/docs/asciidoc/install.adoc

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
= Install
2+
3+
== Install using Confluent Hub
4+
5+
1. Install the https://docs.confluent.io/current/connect/managing/confluent-hub/client.html[Confluent Hub Client]
6+
2. Install the {project-name} using the Confluent Hub Client
7+
8+
== Install Manually
9+
10+
Follow the instructions in https://docs.confluent.io/home/connect/community.html#manually-installing-community-connectors/[Manually Installing Community Connectors]

‎src/site/asciidoc/links.adoc renamed to ‎src/docs/asciidoc/links.adoc

File renamed without changes.

0 commit comments

Comments
 (0)