Uploaded image for project: 'Cassandra'
  1. Cassandra
  2. CASSANDRA-19767

Fix storage_compatibility_mode and startup_checks documentation

    XMLWordPrintableJSON

Details

    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.

      Attachments

        1. image-2024-07-12-09-38-16-284.png
          509 kB
          Jackson Fleming

        Activity

          People

            jfleming Jackson Fleming
            jfleming Jackson Fleming
            Jackson Fleming
            Brandon Williams, Stefan Miklosovic
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Time Tracking

                Estimated:
                Original Estimate - Not Specified
                Not Specified
                Remaining:
                Remaining Estimate - 0h
                0h
                Logged:
                Time Spent - 1h 40m
                1h 40m