-
Notifications
You must be signed in to change notification settings - Fork 23
CASSANALYTICS-6: User documentation #168
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
base: trunk
Are you sure you want to change the base?
Conversation
3659afe to
3e59e64
Compare
| @@ -0,0 +1,318 @@ | |||
| = Overview | |||
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.
This is very helpful. Thanks for adding
docs/src/user.adoc
Outdated
|
|
||
| == Cassandra Sidecar Configuration | ||
|
|
||
| Analytics library uses Sidecar to interact with Cassandra cluster. Bulk reader and writer components share common |
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.
Apache Cassandra Sidecar instead? I think the guidelines are to use Apache before the name of the project.
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.
Done. I just wanted to prevent: Apache Cassandra Analytics library uses Apache Cassandra Sidecar to interact with Apache Cassandra cluster.
docs/src/user.adoc
Outdated
|
|
||
| [cols="1,1,2"] | ||
| |=== | ||
| |Property name|Default|Description |
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.
This table is empty. @yifan-c are there any to fill here or should we just remove this table?
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 some content. @yifan-c, can you check if it makes sense?
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.
docs/src/user.adoc
Outdated
|
|
||
| [cols="1,1,2"] | ||
| |=== | ||
| |Property name|Default|Description |
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.
It'd be nice to have a column to indicate a property is required / optional.
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.
Done.

Draft of user-documentation.