[CASSANDRA-19767] Fix storage_compatibility_mode and startup_checks documentation - ASF JIRA

Agile Board

Attach files

Attach Screenshot

Bulk Copy Attachments

Bulk Move Attachments

Voters

Watch issue

Watchers

Create sub-task

Convert to sub-task

Move

Link

Clone

Labels

Update Comment Author

Replace String in Comment

Update Comment Visibility

Delete Comments

XML

Word

Printable

JSON

Details

Type: Task
Status: Resolved
Priority: Normal
Resolution: Fixed
Fix Version/s: 4.1.6, 5.0-rc1, 5.1-alpha1
Component/s: Documentation
Labels:
- Documentation

Change Category:
Semantic
Complexity:
Normal
Impacts:

Docs
Source Control Link:

https://github.com/apache/cassandra/commit/891e65e251d102d2664f84d22734b95235a7cb16
Test and Documentation Plan:

Hide

the docs render correctly

Show
the docs render correctly

Description

The documentation for storage_compatibility_mode (https://cassandra.apache.org/doc/latest/cassandra/managing/configuration/cass_yaml_file.html#storage_compatibility_mode) is very difficult to read. The below highlighted text seems incorrect.

It appears that the entry for the YAML option above it is causing entries to get clobbered together (startup_checks)

This is actually a very useful and important feature for people upgrading to Cassandra 5 to understand how to use properly - It would be good for it to be easier to read, we should be encouraging use of the safest possible upgrade path, which from my understanding would be:

CASSANDRA_4 -> UPGRADING -> NONE

Update - seems like the startup_checks docs is also missing in the 4.1 pages, I'll fix that as well.