arvindKandpal-ksolves opened a new pull request, #4467:
URL: https://github.com/apache/cassandra/pull/4467
## Description
This PR improves the Apache Cassandra 5.0 architecture module documentation
by removing the incorrect snitch reference and reorganizing content into
logical subsections with enhanced descriptions.
## Changes
* Remove broken snitch reference from architecture module (snitches are
operational configuration, not core architecture)
* Reorganize architecture content into logical subsections:
- Overview: Cassandra architecture introduction
- Core Distributed Principles: Dynamo, Storage Engine, Guarantees
- Performance Optimizations: Improved Internode Messaging, Improved
Streaming
- Network Topology Configuration: Proper snitch reference location
* Add comprehensive descriptions for each architecture component
* Enhance SEO metadata with `:description:` attribute
* Provide proper cross-reference to managing/operating/snitch module
## Motivation and Context
The architecture module should contain core distributed systems design
principles, not operational configuration. The snitch is a network topology
configuration mechanism that belongs in the "Managing Cassandra" section.
This change maintains proper separation of concerns, fixes broken
references, and improves documentation hierarchy.
## Type of Change
- [x] Documentation change
## Files Changed
- `doc/modules/cassandra/pages/architecture/index.adoc`
## Checklist
- [x] I have updated documentation accordingly
- [x] I have followed Cassandra's contributor guidelines
- [x] I have kept the PR description updated to reflect all changes
- [x] I have read and followed the guide to documentation contribution
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
