Skip to content

Conversation

@lukasz-antoniak
Copy link
Member

Draft of user-documentation.

@lukasz-antoniak lukasz-antoniak marked this pull request as draft February 10, 2026 15:00
@@ -0,0 +1,318 @@
= Overview
Copy link
Contributor

Choose a reason for hiding this comment

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

This is very helpful. Thanks for adding


== Cassandra Sidecar Configuration

Analytics library uses Sidecar to interact with Cassandra cluster. Bulk reader and writer components share common
Copy link
Contributor

Choose a reason for hiding this comment

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

Apache Cassandra Sidecar instead? I think the guidelines are to use Apache before the name of the project.

Copy link
Member Author

Choose a reason for hiding this comment

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

Done. I just wanted to prevent: Apache Cassandra Analytics library uses Apache Cassandra Sidecar to interact with Apache Cassandra cluster.


[cols="1,1,2"]
|===
|Property name|Default|Description
Copy link
Contributor

Choose a reason for hiding this comment

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

This table is empty. @yifan-c are there any to fill here or should we just remove this table?

Copy link
Member Author

Choose a reason for hiding this comment

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

Added some content. @yifan-c, can you check if it makes sense?

Copy link
Contributor

Choose a reason for hiding this comment

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

For reviewers, you can toggle the preview by clicking on the file button. See the attached screenshot.

Image


[cols="1,1,2"]
|===
|Property name|Default|Description
Copy link
Contributor

Choose a reason for hiding this comment

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

It'd be nice to have a column to indicate a property is required / optional.

Copy link
Member Author

Choose a reason for hiding this comment

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

Done.

@lukasz-antoniak lukasz-antoniak marked this pull request as ready for review February 12, 2026 18:33
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.

4 participants