[jira] [Comment Edited] (CASSANDRASC-15) Set up sidecar docs

["Jon Haddad (Jira)" <ji...@apache.org>]

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

Jon Haddad edited comment on CASSANDRASC-15 at 4/23/20, 11:30 PM:
------------------------------------------------------------------

PR here: https://github.com/apache/cassandra-sidecar/pull/12

I've added the documentation as a subproject, which the output of is pulled into the main project at build time.  We may want to add a PDF down the line but for now it's simply HTML.

The docs I've added are only a placeholder and will need to be updated as the project matures.


was (Author: rustyrazorblade):
PR here: https://github.com/apache/cassandra-sidecar/pull/12

>  Set up sidecar docs
> --------------------
>
>                 Key: CASSANDRASC-15
>                 URL: https://issues.apache.org/jira/browse/CASSANDRASC-15
>             Project: Sidecar for Apache Cassandra
>          Issue Type: Improvement
>          Components: Documentation
>            Reporter: Jon Haddad
>            Assignee: Jon Haddad
>            Priority: Normal
>
> Sidecar lacks user and developer documentation.  We’ll set up both using asciidoctor and the gradle plugin to generate HTML and PDF docs, and provide initial documentation with code guidelines and user information.



--
This message was sent by Atlassian Jira
(v8.3.4#803005)

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