Skip to content

Commit 9791b80

Browse files
waleedlatif1claude
andcommitted
fix(docs): scope the Trigger.dev requirement to data drains
Retention's cleanup dispatcher runs its chunks inline when Trigger.dev is not configured, so deletion completes on a default self-host. Only data drains have no inline path. The previous wording told operators both would stay pending. Docker Compose also schedules the drain endpoint hourly through its cron service, so 'outside Helm, schedule it yourself' pointed operators at a redundant scheduler. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_015BwsJTEQRzWJaY4BRCkPZt
1 parent 101bec0 commit 9791b80

3 files changed

Lines changed: 3 additions & 3 deletions

File tree

apps/docs/content/docs/platform/enterprise/data-drains.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -255,7 +255,7 @@ openssl rand -hex 32
255255

256256
Set the same value as `CRON_SECRET` on both the app and whatever invokes the endpoint. Generating it in your shell does not configure either one.
257257

258-
The Helm chart schedules this endpoint hourly for you (`cronjobs.jobs.runDataDrains`). Outside Helm, schedule it yourself:
258+
Both shipped deployments schedule this endpoint hourly for you — Helm through `cronjobs.jobs.runDataDrains`, Docker Compose through its `cron` service. A deployment that runs neither schedules it itself:
259259

260260
```bash
261261
curl -H "Authorization: Bearer $CRON_SECRET" \

apps/docs/content/docs/platform/enterprise/data-retention.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -205,7 +205,7 @@ curl -H "Authorization: Bearer $CRON_SECRET" \
205205
https://sim.example.com/api/logs/cleanup
206206
```
207207

208-
Each call fans the work out as background jobs, so the deployment also needs `TRIGGER_DEV_ENABLED` and a configured Trigger.dev project. Without it the dispatcher still claims the work and enqueues it to the database, but nothing drains that queue for this job type, so the runs stay pending and never execute.
208+
Each call fans the work out as background jobs. Trigger.dev is not required: when it is not configured the dispatcher runs the cleanup chunks inline instead of enqueuing them, so deletion completes on a default self-host.
209209

210210
### PII redaction
211211

apps/docs/content/docs/platform/enterprise/self-hosted.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ curl -H "Authorization: Bearer $CRON_SECRET" \
9191
https://sim.example.com/api/logs/cleanup
9292
```
9393

94-
Both features also fan work out as background jobs, so the deployment needs `TRIGGER_DEV_ENABLED` and a configured Trigger.dev project. Without it the dispatcher still claims the work and enqueues it to the database, but nothing drains that queue for this job type, so the runs stay pending and never execute. See [background jobs](/platform/self-hosting/background-jobs).
94+
The two features differ in what they need to run the work. Retention's cleanup dispatcher executes inline when Trigger.dev is not configured, so it completes on a default self-host. Data drains have no inline path: without `TRIGGER_DEV_ENABLED` and a configured Trigger.dev project, each due drain is claimed and enqueued to the database, and nothing drains that queue for this job type. See [background jobs](/platform/self-hosting/background-jobs).
9595

9696
## Choose an organization model
9797

0 commit comments

Comments
 (0)