docs: comprehensive developer environment documentation for self-service onboarding#935
Open
JemimahEkong wants to merge 2 commits into
Open
docs: comprehensive developer environment documentation for self-service onboarding#935JemimahEkong wants to merge 2 commits into
JemimahEkong wants to merge 2 commits into
Conversation
- Centralized Bull config in QueueModule (all 11 queues, global) - WorkersBridgeService wires 6 workers to Bull .process() with concurrency - Priority queue via PrioritizationService.toBullPriority() mapping - Dead letter queue via DeadLetterService (failed event forwarding) - Retry strategy centralization via RetryStrategyService (RETRY_STRATEGIES) - Queue metrics: prometheus gauges for waiting/active/failed jobs + histogram - Periodic queue stats polling every 30s via QueueMetricsService - Fixed MESSAGE_QUEUE processor registration - Load test benchmark script (Redis required) - Documentation in src/queues/README.md
- Add root-level docker-compose.yml for simplified dev setup - Create docs/setup.md with step-by-step onboarding guide (10 steps) - Create docs/troubleshooting.md covering 7 common issue categories - Create docs/runbook.md with command-driven developer runbook - Update docs/migrations.md to reflect actual TypeORM migration system - Add scripts/verify-setup.js with PASS/FAIL verification checks - Add pnpm verify npm script to package.json - Restructure README with Quick Start at top and onboarding docs table - Add Setup Video Tutorial placeholder section
|
@JemimahEkong Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Problem
New developers struggle with project setup due to missing and unclear documentation. Onboarding currently requires external guidance, which increases setup time and creates unnecessary dependency on existing team members.
Solution
This PR introduces a complete overhaul of developer environment documentation and onboarding tooling, making the setup process fully self-service.
A new developer can now set up and verify the entire project in 15–30 minutes without external assistance.
Changes
New Files
docker-compose.ymldocker compose up.docs/setup.mddocs/troubleshooting.mddocs/runbook.mdscripts/verify-setup.jspnpm verify) that validates Node version, environment configuration, database, Redis, and health endpoint.Modified Files
README.mdpnpm.docs/migrations.mdpackage.jsonpnpm verifyscript for automated environment validation.Onboarding Flow
New developer setup flow:
closes #521
Drips Wave 6