[
https://issues.apache.org/jira/browse/CASSANDRA-17550?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17522002#comment-17522002
]
Anthony Grasso commented on CASSANDRA-17550:
--------------------------------------------
[~erickramirezau] the plan for this will be to automatically generate a section
of the SSTable version documentation in the same way we automatically generate
the nodetool help pages.
The items that need to be done for this are:
* Create a python script to parse the Java file and generate the ADOC
* Update the SSTable version ADOC page to reference a partial ADOC file
* Update website generation tooling to run the python script if it exists
The script will need to live in the cassandra-3.11, cassandra-4.0, and trunk
branches.
> SSTable Version documentation out of sync with code
> ---------------------------------------------------
>
> Key: CASSANDRA-17550
> URL: https://issues.apache.org/jira/browse/CASSANDRA-17550
> Project: Cassandra
> Issue Type: Improvement
> Components: Documentation/Website
> Reporter: Phil Miesle
> Assignee: Phil Miesle
> Priority: Normal
>
> The website documentation around [SSTable
> Versions|https://cassandra.apache.org/doc/latest/cassandra/architecture/storage_engine.html#sstable-versions]
> is out of sync with the [source code
> comments|https://github.com/apache/cassandra/blob/trunk/src/java/org/apache/cassandra/io/sstable/format/big/BigFormat.java#L118],
> on both the 3.11 and the current trunk branches.
> As the source code appears to be kept current with the code, it would be
> beneficial to keep the documentation automatically up-to-date with the source
> code.
--
This message was sent by Atlassian Jira
(v8.20.1#820001)
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@cassandra.apache.org
For additional commands, e-mail: commits-h...@cassandra.apache.org
