[
https://issues.apache.org/jira/browse/CASSANDRA-14289?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16551003#comment-16551003
]
Valerie Parham-Thompson commented on CASSANDRA-14289:
-----------------------------------------------------
I have attached the generation script and the generated .rst/.txt files to this
ticket for reference as needed. I was using restview to look at the .rst files
locally.
I'm not sure about submitting a PR for this yet because the help files within
the sstable* tools aren't consistent. Many are very brief, and three tools have
no help files. I excluded those three from the script and noted this in the
comments. This script works really well for nodetool tools, but I have doubts
it will be useful for the sstable* docs.
I wonder if it will be better to adjust the code of each sstable* tool to
include more help text, or to do manual sstable* files for the docs/website.
What do you think is best, [~hkroger], [~jjirsa]?
> Document sstable tools
> ----------------------
>
> Key: CASSANDRA-14289
> URL: https://issues.apache.org/jira/browse/CASSANDRA-14289
> Project: Cassandra
> Issue Type: Improvement
> Components: Documentation and Website
> Reporter: Hannu Kröger
> Priority: Major
> Attachments: gen-sstable-docs.py, sstabledocs.tar.gz
>
>
> Following tools are missing in the documentation of cassandra tools on the
> documentation site (http://cassandra.apache.org/doc/latest/tools/index.html):
> * sstabledump
> * sstableexpiredblockers
> * sstablelevelreset
> * sstableloader
> * sstablemetadata
> * sstableofflinerelevel
> * sstablerepairedset
> * sstablescrub
> * sstablesplit
> * sstableupgrade
> * sstableutil
> * sstableverify
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
