Benedict created CASSANDRA-8500:
-----------------------------------
Summary: Improve cassandra-stress help pages
Key: CASSANDRA-8500
URL: https://issues.apache.org/jira/browse/CASSANDRA-8500
Project: Cassandra
Issue Type: Improvement
Components: Tools
Reporter: Benedict
cassandra-stress is flummoxing a lot of people. As well as rewriting its
README, we should improve the help pages so that they're more legible.
We should offer an "all" option that prints every sub-page, so it can be
scanned like a README (and perhaps make the basis of said file), and we should
at least stop printing all of the distribution parameter options every time
they appear, as they're very common now.
Offering some help about how to make the best out of the help might itself be a
good idea, as well as perhaps printing what all of the options within each
subgroup are in the summary page, so there is no pecking at them to be done.
There should be a dedicated distribution help page that can explain all of the
parameters that are currently just given names we hope are sufficiently
descriptive.
Finally, we should make sure all of the descriptions of each option are clear.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
