doc(architecture): Restructure and enhance architecture module documentation #4467
+2
−1
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ntation * Remove broken snitch reference from architecture section * Organize content into logical subsections: - Overview: Cassandra architecture introduction - Core Distributed Principles: Dynamo, Storage Engine, Guarantees - Performance Optimizations: Internode Messaging, Streaming - Network Topology Configuration: Proper snitch reference location * Add descriptive text for each architecture component * Enhance SEO metadata with :description: attribute * Cross-reference snitch documentation in managing:operating module This improves documentation hierarchy by separating architectural concepts from operational configuration, making content more discoverable and maintainable. Fixes broken xref links in architecture/index.adoc.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
:description:attributeMotivation 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
Files Changed
doc/modules/cassandra/pages/architecture/index.adocChecklist