-
Notifications
You must be signed in to change notification settings - Fork 20
Documentation fixes #4
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Rename logos directory to images as other types of images will be added in the following commits, which are not logos.
Add support information fields to Confluent packaging.
Remove information about connector being a preview release in README.
Clarify preimage/postimage point in Limitations section in README. Previous wording could suggest that there was some limited support instead of no support at all - intended message.
Add LICENSE.txt with Apache License 2.0. After moving the repositories, I forgot to copy this file.
|
Hi, Can you add a QUICKSTART guide with a docker-compose version? |
@avelanarius would that be a lot of work? |
README-QUICKSTART.md
Outdated
| ## Kafka setup | ||
|
|
||
| Scylla CDC Source Connector works well with both [open-source Kafka](https://kafka.apache.org/) | ||
| and [Confluent Platform](https://www.confluent.io/). In this quickstart we will show how |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe note here that the version of Kafka has to be high enough?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Add README-QUICKSTART documentation describing a step-by-step guide how to use the connector with a basic (non-production) configuration.
Cosmetic changes of configuration parameters: 1. Fixing capitalization of display names 2. Marking window size parameters as lower importance
f1385cc to
d994c10
Compare
A batch of documentation fixes before the Confluent Verification:
One missing thing: when we release the next version of scylla-cdc-java, pom file should be updated to use the newer version.