Skip to content

Commit 8cd2b87

Browse files
committed
Added documentation PDF to release
1 parent bb015cc commit 8cd2b87

File tree

9 files changed

+47
-20
lines changed

9 files changed

+47
-20
lines changed

jreleaser.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,3 +66,7 @@ distributions:
6666
type: binary
6767
artifacts:
6868
- path: target/components/packages/redislabs-cp6-{{projectName}}-{{projectVersion}}.zip
69+
70+
files:
71+
artifacts:
72+
- path: target/generated-docs/Kafka_Connector_for_Redis_Enterprise.pdf

pom.xml

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
<connect-utils.version>[0.7.166,0.7.2000)</connect-utils.version>
1919
<asciidoctor.maven.plugin.version>2.1.0</asciidoctor.maven.plugin.version>
2020
<asciidoctorj.version>2.5.1</asciidoctorj.version>
21+
<asciidoctorj.pdf.version>1.6.0</asciidoctorj.pdf.version>
2122
<jruby.version>9.2.17.0</jruby.version>
2223
<junit.version>5.7.1</junit.version>
2324
<mockito.version>3.9.0</mockito.version>
@@ -357,10 +358,18 @@
357358
<groupId>org.asciidoctor</groupId>
358359
<artifactId>asciidoctor-maven-plugin</artifactId>
359360
<version>${asciidoctor.maven.plugin.version}</version>
361+
<dependencies>
362+
<dependency>
363+
<groupId>org.asciidoctor</groupId>
364+
<artifactId>asciidoctorj-pdf</artifactId>
365+
<version>${asciidoctorj.pdf.version}</version>
366+
</dependency>
367+
</dependencies>
360368
<configuration>
361369
<attributes>
362370
<project-name>${project.name}</project-name>
363371
<project-version>${project.version}</project-version>
372+
<sourcedir>${project.build.sourceDirectory}</sourcedir>
364373
</attributes>
365374
</configuration>
366375
<executions>
@@ -375,7 +384,7 @@
375384
<attributes>
376385
<source-highlighter>highlightjs</source-highlighter>
377386
<toc>left</toc>
378-
<toclevels>1</toclevels>
387+
<toclevels>2</toclevels>
379388
<icons>font</icons>
380389
<sectanchors>true</sectanchors>
381390
<!-- set the idprefix to blank -->
@@ -384,6 +393,21 @@
384393
</attributes>
385394
</configuration>
386395
</execution>
396+
<execution>
397+
<id>asciidoc-to-pdf</id>
398+
<phase>generate-resources</phase>
399+
<goals>
400+
<goal>process-asciidoc</goal>
401+
</goals>
402+
<configuration>
403+
<backend>pdf</backend>
404+
<outputFile>Kafka_Connector_for_Redis_Enterprise.pdf</outputFile>
405+
<attributes>
406+
<toc></toc>
407+
<toclevels>1</toclevels>
408+
</attributes>
409+
</configuration>
410+
</execution>
387411
</executions>
388412
</plugin>
389413
</plugins>
File renamed without changes.
File renamed without changes.
File renamed without changes.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
= Links
1+
= Resources
22

33
== Kafka
44
What is Apache Kafka?::
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,16 @@ The {name} consumes records from a Kafka topic and writes the data to a Redis En
77

88
The {name} includes the following features:
99

10-
* <<at-least-once-delivery,At least once delivery>>
11-
* <<multiple-tasks,Multiple tasks>>
10+
* <<sink-at-least-once-delivery,At least once delivery>>
11+
* <<sink-tasks,Multiple tasks>>
1212
* <<data-formats,Supported Data Formats>>
1313
* <<data-structures,Redis Data Structures>>
1414

15-
[[at-least-once-delivery]]
15+
[[sink-at-least-once-delivery]]
1616
=== At least once delivery
1717
The {name} guarantees that records from the Kafka topic are delivered at least once.
1818

19-
[[multiple-tasks]]
19+
[[sink-tasks]]
2020
=== Multiples tasks
2121

2222
The {name} supports running one or more tasks. You can specify the number of tasks with the `tasks.max` configuration property.
Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,15 @@ The {name} reads from a Redis Enterprise stream and publishes messages to a Kafk
77

88
The {name} includes the following features:
99

10-
* <<at-least-once-delivery,At least once delivery>>
11-
* <<tasks,Multiple tasks>>
10+
* <<source-at-least-once-delivery,At least once delivery>>
11+
* <<source-tasks,Multiple tasks>>
1212
* <<stream-reader,Stream Reader>>
1313

14-
[[at-least-once-delivery]]
14+
[[source-at-least-once-delivery]]
1515
=== At least once delivery
1616
The {name} guarantees that records from the Kafka topic are delivered at least once.
1717

18-
[[tasks]]
18+
[[source-tasks]]
1919
=== Multiple Tasks
2020
Use configuration property `tasks.max` to have the change stream handled by multiple tasks. The connector splits the work based on the number of configured key patterns. When the number of tasks is greater than the number of patterns, the number of patterns will be used instead.
2121

@@ -45,7 +45,7 @@ Use configuration property `tasks.max` to have the change stream handled by mult
4545
4646
[[stream-reader]]
4747
=== Stream Reader
48-
The {name} reads messages from a stream and publishes to a Kafka topic. Reading is done through a consumer group so that <<multiple-tasks,multiple instances>> of the connector configured via the `tasks.max` can consume messages in a round-robin fashion.
48+
The {name} reads messages from a stream and publishes to a Kafka topic. Reading is done through a consumer group so that <<source-tasks,multiple instances>> of the connector configured via the `tasks.max` can consume messages in a round-robin fashion.
4949
5050
5151
==== Stream Message Schema

src/docs/asciidoc/index.adoc

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
= {project-name}
22
:author: Julien Ruaux <julien@redislabs.com>
33
:revnumber: {project-version}
4-
:toclevels: 2
54
:docinfo1:
65

76
== Introduction
@@ -14,26 +13,26 @@ This guide provides documentation and usage information across the following top
1413

1514
* <<install,Install>>
1615
* <<connect,Connect to Redis Enterprise>>
17-
* <<sink,Sink Connector Guide>>
18-
* <<source,Source Connector Guide>>
16+
* <<sink,Sink Connector>>
17+
* <<source,Source Connector>>
1918
* <<docker,Docker Example>>
2019
* <<links,Resources>>
2120

2221
:leveloffset: 1
2322
[[install]]
24-
include::install.adoc[]
23+
include::_install.adoc[]
2524

2625
[[connect]]
27-
include::connect.adoc[]
26+
include::_connect.adoc[]
2827

2928
[[sink]]
30-
include::sink.adoc[]
29+
include::_sink.adoc[]
3130

3231
[[source]]
33-
include::source.adoc[]
32+
include::_source.adoc[]
3433

3534
[[docker]]
36-
include::docker.adoc[]
35+
include::_docker.adoc[]
3736

3837
[[links]]
39-
include::links.adoc[]
38+
include::_links.adoc[]

0 commit comments

Comments
 (0)