-
Notifications
You must be signed in to change notification settings - Fork 21
Open
Description
Problem
Developers setting up the OpenMRS performance test project for the first time often encounter common issues during setup, including:
- Connection errors to OpenMRS on port 80
- Docker configuration problems
- Maven build issues
- Gatling simulation failures
- Unclear debugging steps when tests fail
Currently, the README provides prerequisites but lacks practical troubleshooting guidance, leading to duplicate questions in the community.
Solution
Create a comprehensive TROUBLESHOOTING.md file documenting:
- Common OpenMRS connection issues and how to diagnose them
- Docker setup problems (installation, permissions, resources)
- Gatling test failures and recovery steps
- Maven build errors and resolution
- Performance test result interpretation
- Links to additional resources and community support
Each section should include:
- Problem description
- Symptoms to look for
- Step-by-step solutions
- Practical shell commands where applicable
Benefits
- Reduces support burden from community members
- Improves first-time contributor experience
- Provides self-serve solutions for common problems
- Better documentation for backend tooling
Acceptance Criteria
- TROUBLESHOOTING.md created with comprehensive sections
- All major setup issues covered with practical solutions
- README.md updated to reference TROUBLESHOOTING.md
- Document includes clear bash/shell commands for debugging
- Links to relevant OpenMRS documentation included
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels