Update wiki documentation for Shoryuken v7.0 #1
+9,156
−535
Conversation
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
There was a problem hiding this comment.
Pull request overview
This is a comprehensive documentation overhaul for Shoryuken v7.0, upgrading the wiki to Karafka-level quality. The update includes 12 new pages, 17 updated pages, and 1 renamed page, covering all major features of v7.0.0+ including ActiveJob Continuations, CurrentAttributes persistence, Bulk Enqueuing, Health Checks, and comprehensive deployment guides.
Key Changes:
- Complete documentation restructure organized by use case
- Focus on Ruby 3.2+ and Rails 7.2+ requirements
- New guides for container deployment, security, scaling, monitoring, and troubleshooting
- Enhanced examples with complete, working code
Reviewed changes
Copilot reviewed 32 out of 32 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| Home.md | Complete reorganization with 13-section Karafka-style navigation |
| Worker-options.md | Comprehensive worker configuration reference with all options documented |
| Rails-Integration-Active-Job.md | Complete ActiveJob integration guide covering all v7 features |
| Upgrade-Guide-7.0.md | Breaking changes and migration guide for v7.0 |
| ActiveJob-Continuations.md | New Rails 8.1+ graceful shutdown feature documentation |
| CurrentAttributes.md | New guide for persisting Rails CurrentAttributes |
| Bulk-Enqueuing.md | New Rails 7.1+ batch enqueuing documentation |
| Health-Checks.md | New health check API documentation |
| Container-Deployment.md | New Docker/Kubernetes/ECS deployment guide |
| Security-Best-Practices.md | New comprehensive security guide |
| Troubleshooting.md | New troubleshooting guide with common issues |
| Testing.md | Enhanced testing strategies and examples |
| All other files | Various improvements for clarity, completeness, and v7.0 compatibility |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Major documentation overhaul to match Karafka-level quality: New pages (12): - Upgrade-Guide-7.0.md - Breaking changes and migration steps - ActiveJob-Continuations.md - Rails 8.1+ stopping? support - CurrentAttributes.md - Request context persistence - Bulk-Enqueuing.md - perform_all_later (Rails 7.1+) - Health-Checks.md - healthy? API, K8s/ECS probes - Container-Deployment.md - Docker, Kubernetes, ECS/Fargate - Security-Best-Practices.md - IAM, encryption, VPC endpoints - Performance-Tuning.md - Concurrency, pooling, optimization - Monitoring-and-Metrics.md - Prometheus, CloudWatch, alerting - Troubleshooting.md - Common issues and solutions - Scaling-Patterns.md - Auto-scaling, sharding patterns - Architecture-Internals.md - Internal component documentation Updated pages (17): - Home.md - Karafka-style 13-section navigation - Getting-Started.md - Prerequisites, Zeitwerk notes - Rails-Integration-Active-Job.md - All v7 features - Lifecycle-Events.md - utilization_update event - Deployment.md - Heroku, systemd, Capistrano - AWS-Beanstalk-Config.md - AL2/AL2023, removed AL1 - Signals.md - Container orchestration guidance - Middleware.md - 5 built-in middleware documented - Shoryuken-options.md - CLI/YAML/programmatic config - Amazon-SQS-IAM-Policy.md - Role-specific policies - Testing.md - RSpec/Minitest, CI configuration - Using-a-local-mock-SQS-server.md - LocalStack/ElasticMQ/Moto - Configure-the-AWS-Client.md - IRSA, SSO, assume role - Worker-options.md - Complete options reference - Sending-a-message.md - Bulk sending, FIFO, attributes - From-Sidekiq-to-Shoryuken.md - Feature comparison, checklist Renamed: - Complete-Shoryuken-Setup-for-Rails-5-with-ActiveJob.md → Complete-Shoryuken-Setup-for-Rails.md Focus on v7.0.0+ (Ruby 3.2+, Rails 7.2+) with complete examples.
mensfeld
force-pushed
the
wiki-v7-update
branch
from
653e0ea to
039fb24
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Major documentation overhaul to match Karafka-level quality, organized by use case with comprehensive coverage for v7.0.0+.
New Pages (12)
stopping?supportperform_all_later(Rails 7.1+)healthy?API, K8s/ECS probesUpdated Pages (17)
utilization_updateeventRenamed
Complete-Shoryuken-Setup-for-Rails-5-with-ActiveJob.md→Complete-Shoryuken-Setup-for-Rails.mdFocus
Stats