Skip to content

Commit 643d5aa

Browse files
committed
docs: add README links to documentation set
1 parent 4dd3e6d commit 643d5aa

File tree

1 file changed

+74
-7
lines changed

1 file changed

+74
-7
lines changed

README.md

Lines changed: 74 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,70 @@ Extensibility:
2828
- Simple `Abstract_Base_Job` subclassing
2929
- Filters for dynamic job instantiation
3030

31+
32+
## WordPress Tasks That can Benefit from Redis Queues
33+
34+
### High-Impact Use Cases
35+
36+
#### 1.1 Email Operations
37+
- **Bulk email sending** (newsletters, notifications)
38+
- **Transactional emails** (order confirmations, password resets)
39+
- **Email campaign processing**
40+
- **Benefits**: Prevents timeouts, improves user experience, handles SMTP failures gracefully
41+
42+
#### 1.2 Image Processing
43+
- **Thumbnail generation** for multiple sizes
44+
- **Image optimization** (compression, format conversion)
45+
- **Watermark application**
46+
- **Benefits**: Reduces page load times, prevents memory exhaustion
47+
48+
#### 1.3 Data Import/Export
49+
- **CSV/XML imports** (products, users, posts)
50+
- **Database migrations**
51+
- **Content synchronization** between sites
52+
- **Benefits**: Handles large datasets without timeout issues
53+
54+
#### 1.4 Content Processing
55+
- **Search index updates** (Elasticsearch, Algolia)
56+
- **Cache warming** after content updates
57+
- **Content analysis** (SEO scoring, readability)
58+
- **Benefits**: Keeps content fresh without blocking user interactions
59+
60+
#### 1.5 Third-Party API Integrations
61+
- **Social media posting** (Facebook, Twitter, LinkedIn)
62+
- **CRM synchronization** (Salesforce, HubSpot)
63+
- **Analytics data collection** (Google Analytics, custom tracking)
64+
- **Benefits**: Handles API rate limits and failures gracefully
65+
66+
#### 1.6 E-commerce Operations
67+
- **Order processing** workflows
68+
- **Inventory synchronization**
69+
- **Payment verification** processes
70+
- **Benefits**: Ensures order integrity and improves checkout experience
71+
72+
#### 1.7 Content Publishing
73+
- **Scheduled post publishing**
74+
- **Content distribution** to multiple platforms
75+
- **SEO metadata generation**
76+
- **Benefits**: Reliable scheduling and cross-platform consistency
77+
78+
### Medium-Impact Use Cases
79+
80+
#### 1.8 User Management
81+
- **User registration** workflows
82+
- **Profile data enrichment**
83+
- **Permission updates** across systems
84+
85+
#### 1.9 Backup Operations
86+
- **Database backups**
87+
- **File system backups**
88+
- **Remote backup uploads**
89+
90+
#### 1.10 Analytics & Reporting
91+
- **Report generation**
92+
- **Data aggregation**
93+
- **Performance metrics** calculation
94+
3195
## Installation
3296

3397
### Prerequisites
@@ -183,10 +247,13 @@ See Usage & REST docs for deeper examples.
183247

184248
| Topic | Location |
185249
|-------|----------|
186-
| Usage & operations | `docs/usage.md` |
187-
| REST API (auth, scopes, rate limits) | `docs/worker-rest-api.md` |
188-
| Creating custom jobs | `docs/extending-jobs.md` |
189-
| This overview | `README.md` |
250+
| Documentation index | [docs/README.md](docs/README.md) |
251+
| Usage & operations | [docs/usage.md](docs/usage.md) |
252+
| REST API (auth, scopes, rate limits) | [docs/worker-rest-api.md](docs/worker-rest-api.md) |
253+
| Creating custom jobs | [docs/extending-jobs.md](docs/extending-jobs.md) |
254+
| Scaling strategies | [docs/scaling.md](docs/scaling.md) |
255+
| Maintenance & operations | [docs/maintenance.md](docs/maintenance.md) |
256+
| This overview | README.md |
190257

191258
## When to Use
192259

@@ -206,11 +273,11 @@ Use this plugin to offload expensive or slow tasks: emails, media transformation
206273
2. Optional API token (bearer header) with: scope, rate limiting, request logging.
207274
3. Filters to customize allowed routes per scope.
208275

209-
Full details: `docs/worker-rest-api.md`.
276+
Full details: see the [REST API documentation](docs/worker-rest-api.md).
210277

211278
## Extending
212279

213-
Implement a subclass of `Abstract_Base_Job`, override `get_job_type()` + `execute()`, optionally `should_retry()` and `handle_failure()`. Register dynamically with the `redis_queue_demo_create_job` filter. Full guide: `docs/extending-jobs.md`.
280+
Implement a subclass of `Abstract_Base_Job`, override `get_job_type()` + `execute()`, optionally `should_retry()` and `handle_failure()`. Register dynamically with the `redis_queue_demo_create_job` filter. Full guide: [Extending Jobs](docs/extending-jobs.md).
214281

215282
## Scheduling Workers
216283

@@ -242,4 +309,4 @@ Made with ❤️ by [Per Søderlind](https://soderlind.com)
242309

243310
---
244311

245-
For detailed usage, advanced features, troubleshooting, and performance tuning visit `docs/usage.md`.
312+
For detailed usage, advanced features, troubleshooting, and performance tuning visit the [Usage guide](docs/usage.md). Additional topics: [Scaling](docs/scaling.md), [Maintenance](docs/maintenance.md).

0 commit comments

Comments
 (0)