Documentation Index

This project's documentation is organized following the Diataxis framework into four categories.

Tutorials (Learning-oriented)

Step-by-step guides that teach through doing.

• Getting Started with Events
• Getting Started with Events Store
• Getting Started with Queries
• Building a Task Queue
• Request-Reply with Commands

How-To Guides (Task-oriented)

Practical guides for specific tasks.

• Connect with TLS/mTLS
• Handle Errors and Retries
• Use Consumer Groups
• Monitor with OpenTelemetry

Reference (Information-oriented)

Technical descriptions of the machinery.

• README — Installation, quickstart, configuration reference
• CHANGELOG
• COMPATIBILITY
• BENCHMARKS
• CONTRIBUTING

Explanation (Understanding-oriented)

Background and context.

• KubeMQ Concepts
• TROUBLESHOOTING
• MIGRATION

Scenario Guides

End-to-end architecture walkthroughs.

• Event-Driven Processing Pipeline
• Implementing CQRS with KubeMQ