[jira] [Commented] (CASSSIDECAR-234) Add User Documentation for Cassandra Sidecar

["Isaac Reath (Jira)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/CASSSIDECAR-234?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17939806#comment-17939806 ] 

Isaac Reath commented on CASSSIDECAR-234:
-----------------------------------------

I've started to expand on the user.adoc file to explain how to get a basic install / configuration up and running (PR should be open for this soon-ish). Once that's up, getting something in place for the different features that sidecar offers today would be a next step. 

> Add User Documentation for Cassandra Sidecar
> --------------------------------------------
>
>                 Key: CASSSIDECAR-234
>                 URL: https://issues.apache.org/jira/browse/CASSSIDECAR-234
>             Project: Sidecar for Apache Cassandra
>          Issue Type: Improvement
>          Components: Documentation
>            Reporter: Isaac Reath
>            Assignee: Isaac Reath
>            Priority: Normal
>
> Right now we have pretty good getting started documentation for developing on cassandra-sidecar. One thing which we are missing is user-focused documentation detailing how to get started with Cassandra Sidecar (downloading & installing, configuration, etc.) and what features sidecar provides and how to get started using them. Ideally, we could link to these docs in the documentation section of cassandra.apache.org, but even in-repo documentation for getting started (such as expanding on https://github.com/apache/cassandra-sidecar/blob/trunk/docs/src/user.adoc) would be a good starting point so that people coming to sidecar for the first time can get started easily. 



--
This message was sent by Atlassian Jira
(v8.20.10#820010)

---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cassandra.apache.org
For additional commands, e-mail: commits-help@cassandra.apache.org