Skip to content

Conversation

@avelanarius
Copy link

A batch of documentation fixes before the Confluent Verification:

  1. Adding support information to Confluent packaging
  2. Minor fixes to README
  3. Adding missing LICENSE file
  4. Adding a QUICKSTART guide
  5. Minor cosmetic fixes to configuration parameters

One missing thing: when we release the next version of scylla-cdc-java, pom file should be updated to use the newer version.

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.
@avelanarius avelanarius requested a review from haaawk April 29, 2021 06:50
@giautm
Copy link

giautm commented May 9, 2021

Hi, Can you add a QUICKSTART guide with a docker-compose version?

@haaawk
Copy link

haaawk commented May 12, 2021

Hi, Can you add a QUICKSTART guide with a docker-compose version?

@avelanarius would that be a lot of work?

## 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
Copy link

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?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added.

Copy link

@haaawk haaawk left a 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
@avelanarius avelanarius merged commit 4c21316 into scylladb:master May 18, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants