[jira] [Updated] (CASSANDRA-15772) DOC - Improve tpstats documentation

["Mark Curtis (Jira)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/CASSANDRA-15772?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Mark Curtis updated CASSANDRA-15772:
------------------------------------
    Fix Version/s: 4.0-alpha

> DOC - Improve tpstats documentation
> -----------------------------------
>
>                 Key: CASSANDRA-15772
>                 URL: https://issues.apache.org/jira/browse/CASSANDRA-15772
>             Project: Cassandra
>          Issue Type: Improvement
>          Components: Documentation/Website
>            Reporter: Mark Curtis
>            Priority: Normal
>             Fix For: 4.0-alpha
>
>
> h2. Background
> The docs for {{nodetool tpstats}} gives the user a good overview of the correct command format, but lack an explanation of the message types.
> As of Cassandra4.0 and CASSANDRA-15066 the Message types have expanded a lot so this becomes quite overwhelming (particularly for new users).
> I'd propose we offer a simple explanation of these grouping them into logical groups (see CASSANDRA-15771 which I opened for the formatting output). 
> The github code for the {{Verb.java}} class does give the user some idea of what these are but not everyone will go looking for that.
> Example
> [https://github.com/apache/cassandra/blob/trunk/src/java/org/apache/cassandra/net/Verb.java]



--
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