Skip to content

Commit 9d84b44

Browse files
Fix docs (#10)
1 parent 606c495 commit 9d84b44

File tree

4 files changed

+11
-7
lines changed

4 files changed

+11
-7
lines changed

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ All notable changes to this project will be documented in this file.
44
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
55
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
66

7+
## [1.0.2] - 2020-11-13
8+
### Fixed
9+
- Fixed POM description to include source capability
10+
- Minor corrections to the demo documentation
11+
712
## [1.0.1] - 2020-11-11
813
### Added
914
- Added quickstart properties for the source connector

docs/demo/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,17 @@ Let's run Kafka Connect Redis against Kafka and a Redis cluster to get a feel fo
55
### Minikube
66
First we need to set up Kubernetes. We're going to use minikube for this so [make sure you have it installed](https://minikube.sigs.k8s.io/docs/start/) along with [`kubectl` 1.14 or higher](https://kubernetes.io/docs/tasks/tools/install-kubectl/).
77

8-
Set up the cluster with a docker registry and some extra juice:
8+
Set up minkube with some extra juice:
99
```bash
1010
minikube start --cpus 2 --memory 10g
1111
```
1212

1313
### Docker
14-
Now that we have a local Kubernetes setup, we'll need a Docker image that contains Kafka Connect Redis.
14+
Now that we have Kubernetes set up locally, we'll need a Docker image that contains Kafka Connect Redis.
1515

1616
Navigate to `demo/docker/` in this repository and run the following commands **in a separate terminal** to download the plugin and build the image for minikube:
1717
```bash
18-
curl -O https://oss.sonatype.org/service/local/repositories/releases/content/io/github/jaredpetersen/kafka-connect-redis/1.0.1/kafka-connect-redis-1.0.1.jar
18+
curl -O https://oss.sonatype.org/service/local/repositories/releases/content/io/github/jaredpetersen/kafka-connect-redis/1.0.2/kafka-connect-redis-1.0.1.jar
1919
eval $(minikube docker-env)
2020
docker build -t jaredpetersen/kafka-connect-redis:latest .
2121
```
@@ -50,7 +50,7 @@ kubectl -n kcr-demo run -it --rm redis-client --image redis:6 -- redis-cli --pas
5050
## Teardown
5151
Remove all of the created resources in Kubernetes:
5252
```bash
53-
k delete -k kubernetes
53+
kubectl delete -k kubernetes
5454
```
5555

5656
Delete the minikube cluster:

docs/demo/SINK.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,6 @@ kafka-console-producer \
101101
>{"payload":{"key":"{user.1}.interests","values":["reading"]},"schema":{"name":"io.github.jaredpetersen.kafkaconnectredis.RedisSaddCommand","type":"struct","fields":[{"field":"key","type":"string","optional":false},{"field":"values","type":"array","items":{"type":"string"},"optional":false}]}}
102102
>{"payload":{"key":"{user.2}.interests","values":["sailing","woodworking","programming"]},"schema":{"name":"io.github.jaredpetersen.kafkaconnectredis.RedisSaddCommand","type":"struct","fields":[{"field":"key","type":"string","optional":false},{"field":"values","type":"array","items":{"type":"string"},"optional":false}]}}
103103
>{"payload":{"key":"Sicily","values":[{"longitude":13.361389,"latitude":13.361389,"member":"Palermo"},{"longitude":15.087269,"latitude":37.502669,"member":"Catania"}]},"schema":{"name":"io.github.jaredpetersen.kafkaconnectredis.RedisGeoaddCommand","type":"struct","fields":[{"field":"key","type":"string","optional":false},{"field":"values","type":"array","items":{"type":"struct","fields":[{"field":"longitude","type":"double","optional":false},{"field":"latitude","type":"double","optional":false},{"field":"member","type":"string","optional":false}]},"optional":false}]}}
104-
>{"payload":{},"schema":{}}
105104
```
106105

107106
## Validate

pom.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@
55

66
<groupId>io.github.jaredpetersen</groupId>
77
<artifactId>kafka-connect-redis</artifactId>
8-
<version>1.0.1</version>
8+
<version>1.0.2</version>
99
<packaging>jar</packaging>
1010

1111
<name>kafka-connect-redis</name>
12-
<description>Kafka Connect Sink Connector for Redis</description>
12+
<description>Kafka Connect source and sink connector for Redis</description>
1313
<url>https://github.com/jaredpetersen/kafka-connect-redis</url>
1414

1515
<licenses>

0 commit comments

Comments
 (0)