Skip to content

docs: simplify architecture diagrams, remove operator section and noisy sidebars#243

Merged
weicao merged 1 commit intomainfrom
docs/architecture-docs
Apr 8, 2026
Merged

docs: simplify architecture diagrams, remove operator section and noisy sidebars#243
weicao merged 1 commit intomainfrom
docs/architecture-docs

Conversation

@weicao
Copy link
Copy Markdown
Contributor

@weicao weicao commented Apr 8, 2026

Closes #242

Changes

Removed from all 21 diagrams

  • Management Plane · KubeBlocks Operator section: operator block with controller chips (Apps/Workloads/Ops) and CRD hierarchy chain — identical across every addon, adds visual noise without per-database insight

Removed sidebar cards

Diagram Removed
MySQL MGR Resource Hierarchy card, Group Replication info card
Milvus Standalone Standalone Characteristics, HA Limitations
MongoDB Sharding How Mongos Routes Queries routing card
MySQL Orchestrator Orchestrator Features, Resource Hierarchy
Redis Cluster Cluster Properties card
Redis Standalone Recommended Use Cases card

PgHA: Patroni DCS redesign

Moved the Patroni DCS (K8s API) card from a right sidebar to a full-width panel below the pod grid, connected by a teal downward arrow labeled "each Patroni agent reads/writes K8s API via :8008". This makes it visually clear that DCS is a shared dependency for all pods, not an optional sidebar concern.

Bug fixes

Fixed {/* Legend */{/* Legend */} (missing closing brace) in:

  • MilvusArchitectureDiagram.tsx
  • MinioArchitectureDiagram.tsx
  • RocketmqArchitectureDiagram.tsx

Test plan

  • yarn build passes with no errors
  • All architecture pages render correctly in dev server

…ne section

- Remove the "Management Plane · KubeBlocks Operator" section from all
  21 architecture diagram components (operator block, controller chips,
  CRD hierarchy chain)
- Remove sidebar cards that added noise without architectural value:
  resource hierarchy cards, group replication info card (MySQL MGR),
  standalone characteristics and HA limitations (Milvus standalone),
  routing card (MongoDB sharding), orchestrator features card,
  cluster properties card (Redis cluster), use cases card (Redis standalone)
- Redesign PgHA Patroni DCS card: move from right sidebar to a dedicated
  panel below the pod grid with a teal connector arrow, making it clear
  that all pods share the same DCS backend
- Fix JSX comment syntax errors in Milvus, MinIO, and RocketMQ diagrams
  introduced during bulk edits
@weicao weicao merged commit 0454dbc into main Apr 8, 2026
1 check passed
@weicao weicao deleted the docs/architecture-docs branch April 8, 2026 14:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Simplify architecture diagrams: remove operator control plane section and noisy sidebar cards

1 participant