I want to propose we change how our docs are organized.

Here is the current layout. You can navigate here:
https://cassandra.apache.org/doc/latest/
Main
 - Glossary
 - How to report bugs
 - Contact us
 - Development
Cassandra
 - FAQ
 - Getting Started
 - What’s new
 - Architecture
 - Data Modeling
 - Cassandra Query Language (CQL)
 - Vector Search overview
 - Managing
 - Troubleshooting
 - Reference
 - Plug-ins

The new layout I'm proposing aligns our documents with the various personas
looking for in-depth treatment of whatever they need to do. The format I'm
going with is a noun-verb type format. "I'm an X, and I need to do Y". Here
is the layout II created to the first layer deep in the tree. You can view
it here and click deeper into the various sections:
https://pmcfadin.github.io/cassandra6-docs-workzone/home/draft/index.html

Home
Operators
 - Get Started
 - Day 1: Deploy and Harden
 - Day 2: Operate
 - Upgrade
 - Observe and Respond
 - Backup and Recovery
 - Automate
 - Troubleshoot
 - Tune
 - Reference
Developers
 - Get Started
 - Learn
 - Build
 - Operate Your App
 - CQL Reference
Contributors
 - Orientation
 - Architecture
 - Codebase Internals
 - SSTable Architecture
 - Build and Test
 - Feature Development
 - Patches and Review
 - Documentation
 - Release and Publish
 - Generated Docs
 - Contribution Policy
Reference
 - Configuration
 - Nodetool
 - Tools
 - Native Protocol
 - CQL Commands
 - CQL Reference
 - Version and Compatibility
 - SAI Virtual Table Indexes
What’s New
 - What’s New in Cassandra 6

It's a radical change in our layout, but it aligns with part of my talk at
the last CoC about how the Cassandra community is growing so large and how
we've formed sub-communities. Hopefully, it aligns with those communities
and makes it easier to find and add new information. Especially when the
organization prompts discussions like "You know what is missing in this
section?"

Patrick

Reply via email to