Skip to content

Commit

Permalink
[chore] Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
julien committed Jan 13, 2022
1 parent 21c72e0 commit 3b6bffe
Show file tree
Hide file tree
Showing 8 changed files with 24 additions and 14 deletions.
9 changes: 8 additions & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -344,6 +344,14 @@
</dependencies>
<configuration>
<attributes>
<icons>font</icons>
<sectanchors>true</sectanchors>
<source-highlighter>coderay</source-highlighter>
<coderay-linenums-mode>table</coderay-linenums-mode>
<toc>left</toc>
<numbered>true</numbered>
<linkattrs>true</linkattrs>
<linkcss>true</linkcss>
<github-owner>${github.owner}</github-owner>
<github-repo>${github.repo}</github-repo>
<component-owner>${component-owner}</component-owner>
Expand All @@ -352,7 +360,6 @@
<project-name>${project.name}</project-name>
<project-version>${project.version}</project-version>
<sourcedir>${project.build.sourceDirectory}</sourcedir>
<icons>font</icons>
</attributes>
</configuration>
<executions>
Expand Down
3 changes: 2 additions & 1 deletion src/docs/asciidoc/_connect.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Connect to Redis Enterprise
[[connect]]
= Connect to Redis

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

Expand Down
5 changes: 3 additions & 2 deletions src/docs/asciidoc/_docker.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
[[docker]]
= Quick Start with Docker

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

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

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

Examine the stream in Redis:
[source,bash]
[source,console]
----
docker-compose exec redis /usr/local/bin/redis-cli
xread COUNT 10 STREAMS pageviews 0
Expand Down
7 changes: 5 additions & 2 deletions src/docs/asciidoc/_install.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
[[install]]
= Install

Select one of the methods below to install {name}.

== Download

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

== Install using Confluent Hub
== Confluent Hub

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

== Install Manually
== Manually

Follow the instructions in https://docs.confluent.io/home/connect/community.html#manually-installing-community-connectors/[Manually Installing Community Connectors]
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
[[resources]]
= Resources

== Kafka
Expand Down
1 change: 1 addition & 0 deletions src/docs/asciidoc/_sink.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
[[sink]]
= Sink Connector Guide
:name: Redis Enterprise Kafka Sink Connector

Expand Down
1 change: 1 addition & 0 deletions src/docs/asciidoc/_source.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
[[source]]
= Source Connector Guide
:name: Redis Enterprise Kafka Source Connector

Expand Down
11 changes: 3 additions & 8 deletions src/docs/asciidoc/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,23 +16,18 @@ This guide provides documentation and usage information across the following top
* <<sink,Sink Connector>>
* <<source,Source Connector>>
* <<docker,Docker Example>>
* <<links,Resources>>
* <<resources,Resources>>

:leveloffset: 1
[[install]]

include::_install.adoc[]

[[connect]]
include::_connect.adoc[]

[[sink]]
include::_sink.adoc[]

[[source]]
include::_source.adoc[]

[[docker]]
include::_docker.adoc[]

[[links]]
include::_links.adoc[]
include::_resources.adoc[]

0 comments on commit 3b6bffe

Please sign in to comment.