Skip to content

README.md

Latest commit

 

History

History
135 lines (100 loc) · 5.34 KB

README.md

File metadata and controls

135 lines (100 loc) · 5.34 KB

EMQX-Go Documentation

Welcome to the EMQX-Go documentation! This directory contains all project documentation organized by category.

📂 Directory Structure

docs/
├── chaos/              # Chaos Engineering Documentation
├── guides/             # User and Operation Guides
├── testing/            # Testing Documentation
├── reports/            # Test Reports and Status
├── planning/           # Project Planning and TODOs
└── README.md          # This file

🔥 Chaos Engineering (chaos/)

Complete chaos engineering documentation including implementation, best practices, and testing guides.

Document Description
CHAOS_README.md 📖 Main chaos engineering index and navigation
QUICKSTART.md 🚀 Quick start guide (5-minute setup)
CHAOS_TESTING_GUIDE.md 📚 Complete testing guide with API reference
CHAOS_BEST_PRACTICES.md ⭐ Best practices and methodologies
CHAOS_IMPLEMENTATION_REPORT.md 🔧 Technical implementation details
CHAOS_FINAL_REPORT.md 📊 Final project report and achievements
CHAOS_EXECUTION_SUMMARY.md ✅ Execution summary and checklist
CHAOS_TEST_REPORT.md 📋 Test execution report
chaos.md 📋 Chaos Mesh integration plan

Start here: CHAOS_README.md or QUICKSTART.md

📖 Guides (guides/)

User guides and operational documentation.

Document Description
DEPLOYMENT.md 🚀 Deployment guide for production
CONFIG_GUIDE.md ⚙️ Configuration reference
TROUBLESHOOTING.md 🔍 Troubleshooting and FAQ

🧪 Testing (testing/)

Testing documentation including cluster tests, concurrency tests, and E2E tests.

Document Description
CLUSTER_TESTING_GUIDE.md 📖 Cluster testing guide
CLUSTER_TEST_SUMMARY.md 📊 Cluster test summary
CLUSTER_TEST_IMPROVEMENTS.md ✨ Test improvements
CLUSTER_E2E_TEST_REPORT.md 📋 E2E test report
CONCURRENCY_TESTING_PLAN.md 🔄 Concurrency testing plan
e2e.md 🎯 E2E testing documentation

📊 Reports (reports/)

Test reports, status updates, and historical records.

Document Description
PROJECT_STATUS.md 📈 Current project status
IMPROVEMENTS_SUMMARY.md ✨ Summary of improvements
IMPROVEMENTS.md 📝 Detailed improvements log
defensics-report.md 🔒 Defensics security report
mbfuzzer.md 🐛 MB fuzzer report
chaos-test-report-*.md 🔥 Chaos test execution reports

📋 Planning (planning/)

Project planning, TODOs, and development guidelines.

Document Description
PLAN.md 🎯 Project roadmap and plans
TODO.md ✅ TODO list and tasks
GIT_COMMIT_MESSAGE.md 📝 Git commit message guidelines

🚀 Quick Navigation

For New Users

  1. Start with the main README.md in the project root
  2. Read QUICKSTART.md for chaos engineering
  3. Check DEPLOYMENT.md for deployment

For Developers

  1. Review CHAOS_TESTING_GUIDE.md
  2. Read CHAOS_BEST_PRACTICES.md
  3. Check GIT_COMMIT_MESSAGE.md

For Operators

  1. Read DEPLOYMENT.md
  2. Check CONFIG_GUIDE.md
  3. Review TROUBLESHOOTING.md

For Testers

  1. Start with CLUSTER_TESTING_GUIDE.md
  2. Review CHAOS_TESTING_GUIDE.md
  3. Check CONCURRENCY_TESTING_PLAN.md

📚 Documentation Stats

  • Total Documents: 25+ markdown files
  • Total Size: 4,200+ lines in chaos docs alone
  • Categories: 5 main categories
  • Languages: English and Chinese (中文)

🔗 External Links

📝 Contributing

When adding new documentation:

  1. Place it in the appropriate category directory
  2. Update this README.md with a link
  3. Follow the existing naming conventions
  4. Include proper headers and table of contents
  5. Add cross-references where appropriate

🎯 Version

Documentation Version: v5.0 Last Updated: 2025-10-12 Maintainers: EMQX-Go Team

For the main project README, see ../README.md