[
https://issues.apache.org/jira/browse/CASSSIDECAR-234?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17946902#comment-17946902
]
Isaac Reath commented on CASSSIDECAR-234:
-----------------------------------------
I've pushed a branch that contains basic install / configuration in the
`docs/user.adoc` file. This can be built by running `./gradlew
:docs:asciidoctor`. This should be accessible on
[https://github.com/isaacreath/cassandra-sidecar/commit/130dda1b216bf121c45409760586b58d7916a05b.]
I think the scope of this ticket should probably get broken down into a few
different sub-tickets (basic install & setup, advanced configuration, sections
for each feature and how they are used).
> 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-unsubscr...@cassandra.apache.org
For additional commands, e-mail: commits-h...@cassandra.apache.org
