Skip to content

Commit 3b6bffe

Browse files
author
julien
committed
[chore] Updated documentation
1 parent 21c72e0 commit 3b6bffe

File tree

8 files changed

+24
-14
lines changed

8 files changed

+24
-14
lines changed

pom.xml

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -344,6 +344,14 @@
344344
</dependencies>
345345
<configuration>
346346
<attributes>
347+
<icons>font</icons>
348+
<sectanchors>true</sectanchors>
349+
<source-highlighter>coderay</source-highlighter>
350+
<coderay-linenums-mode>table</coderay-linenums-mode>
351+
<toc>left</toc>
352+
<numbered>true</numbered>
353+
<linkattrs>true</linkattrs>
354+
<linkcss>true</linkcss>
347355
<github-owner>${github.owner}</github-owner>
348356
<github-repo>${github.repo}</github-repo>
349357
<component-owner>${component-owner}</component-owner>
@@ -352,7 +360,6 @@
352360
<project-name>${project.name}</project-name>
353361
<project-version>${project.version}</project-version>
354362
<sourcedir>${project.build.sourceDirectory}</sourcedir>
355-
<icons>font</icons>
356363
</attributes>
357364
</configuration>
358365
<executions>

src/docs/asciidoc/_connect.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
= Connect to Redis Enterprise
1+
[[connect]]
2+
= Connect to Redis
23

34
This section provides information on configuring the Redis Enterprise Kafka Source or Sink Connector to connect to Redis Enterprise.
45

src/docs/asciidoc/_docker.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
[[docker]]
12
= Quick Start with Docker
23

34
This guide provides a hands-on look at the functionality of the Redis Enterprise Kafka Source and Sink Connectors:
@@ -13,7 +14,7 @@ https://docs.docker.com/get-docker/[Docker]
1314

1415
Clone the https://github.com/{github-owner}/{github-repo}.git[{github-repo}] repository and execute `run.sh` in `docker` directory:
1516

16-
[source,bash,subs="attributes"]
17+
[source,console,subs="attributes"]
1718
----
1819
git clone https://github.com/{github-owner}/{github-repo}.git
1920
cd redis-enterprise-kafka/docker
@@ -44,7 +45,7 @@ include::resources/pageviews.json[]
4445
* The `pageviews` stream should contain the 10 change events.
4546

4647
Examine the stream in Redis:
47-
[source,bash]
48+
[source,console]
4849
----
4950
docker-compose exec redis /usr/local/bin/redis-cli
5051
xread COUNT 10 STREAMS pageviews 0

src/docs/asciidoc/_install.adoc

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
1+
[[install]]
12
= Install
23

4+
Select one of the methods below to install {name}.
5+
36
== Download
47

58
Download the latest release archive from https://github.com/{github-owner}/{github-repo}/releases[here].
@@ -13,11 +16,11 @@ Download the connector archive that matches your version of Confluent Platform:
1316
* Confluent Platform 6.0+: `{component-owner}-{component-name}-*6*.{project-version}.zip`
1417
====
1518

16-
== Install using Confluent Hub
19+
== Confluent Hub
1720

1821
1. Install the https://docs.confluent.io/current/connect/managing/confluent-hub/client.html[Confluent Hub Client]
1922
2. Install the {project-name} using the Confluent Hub Client
2023

21-
== Install Manually
24+
== Manually
2225

2326
Follow the instructions in https://docs.confluent.io/home/connect/community.html#manually-installing-community-connectors/[Manually Installing Community Connectors]

src/docs/asciidoc/_links.adoc renamed to src/docs/asciidoc/_resources.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
[[resources]]
12
= Resources
23

34
== Kafka

src/docs/asciidoc/_sink.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
[[sink]]
12
= Sink Connector Guide
23
:name: Redis Enterprise Kafka Sink Connector
34

src/docs/asciidoc/_source.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
[[source]]
12
= Source Connector Guide
23
:name: Redis Enterprise Kafka Source Connector
34

src/docs/asciidoc/index.adoc

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,23 +16,18 @@ This guide provides documentation and usage information across the following top
1616
* <<sink,Sink Connector>>
1717
* <<source,Source Connector>>
1818
* <<docker,Docker Example>>
19-
* <<links,Resources>>
19+
* <<resources,Resources>>
2020

2121
:leveloffset: 1
22-
[[install]]
22+
2323
include::_install.adoc[]
2424

25-
[[connect]]
2625
include::_connect.adoc[]
2726

28-
[[sink]]
2927
include::_sink.adoc[]
3028

31-
[[source]]
3229
include::_source.adoc[]
3330

34-
[[docker]]
3531
include::_docker.adoc[]
3632

37-
[[links]]
38-
include::_links.adoc[]
33+
include::_resources.adoc[]

0 commit comments

Comments
 (0)