mirror of
https://github.com/Tyrrrz/DiscordChatExporter.git
synced 2026-06-09 15:52:37 -06:00
docs(scrape): LFG closure — operator handoff in setup guides
Point README and Recurring-Scrape-Setup at operator-handoff.sh, document disk preflight, and harden operator-handoff smoke against pipefail flakes.
This commit is contained in:
parent
c0818715a8
commit
c4371c9f7d
|
|
@ -11,7 +11,9 @@ This guide walks you through setting up automated recurring Discord exports usin
|
||||||
|
|
||||||
## Quick Start
|
## Quick Start
|
||||||
|
|
||||||
**Fastest path:** `./scripts/verify-operator-ready.sh` then `./scripts/bootstrap-recurring-scrape.sh` (see [operator checklist](../docs/recurring-scrape-operator-checklist.md)).
|
**Fastest path:** `./scripts/operator-handoff.sh` (disk + verify + archive dry-run), then `./scripts/bootstrap-recurring-scrape.sh` without `--dry-run` when ready (see [operator checklist](../docs/recurring-scrape-operator-checklist.md)).
|
||||||
|
|
||||||
|
**Disk space:** `verify-operator-ready` and scrape entrypoints fail below 1 GiB free by default (`DCE_MIN_FREE_MB`, default 1024). Large channel JSON merges need extra headroom.
|
||||||
|
|
||||||
**Append-only contract (read first)**
|
**Append-only contract (read first)**
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -81,7 +81,7 @@ To learn more about the war and how you can help, [click here](https://tyrrrz.me
|
||||||
|
|
||||||
## See also
|
## See also
|
||||||
|
|
||||||
- [**Recurring Exports**](.docs/Recurring-Scrape-Setup.md) — append-only incremental JSON exports via Docker/cron (Linux/macOS). From the source repo: `./scripts/bootstrap-recurring-scrape.sh`, then `./scripts/run-documents-scrape.sh`; validate with `./scripts/run-all-smokes.sh`. GUI zip users: `../DiscordChatExporter.linux-x64/RECURRING-SCRAPE.md`. Maintainer summary: [docs/recurring-scrape-merge-readiness.md](docs/recurring-scrape-merge-readiness.md).
|
- [**Recurring Exports**](.docs/Recurring-Scrape-Setup.md) — append-only incremental JSON exports via Docker/cron (Linux/macOS). From the source repo: `./scripts/operator-handoff.sh`, then `./scripts/run-documents-scrape.sh`; validate with `./scripts/run-all-smokes.sh`. GUI zip users: `../DiscordChatExporter.linux-x64/RECURRING-SCRAPE.md`. Maintainer summary: [docs/recurring-scrape-merge-readiness.md](docs/recurring-scrape-merge-readiness.md).
|
||||||
- [**Documented solutions**](docs/solutions/) — searchable learnings (append-only scrape, Docker/cron workflow); YAML frontmatter: `module`, `tags`, `problem_type`
|
- [**Documented solutions**](docs/solutions/) — searchable learnings (append-only scrape, Docker/cron workflow); YAML frontmatter: `module`, `tags`, `problem_type`
|
||||||
- [**Chat Analytics**](https://github.com/mlomb/chat-analytics) — solution for analyzing chat patterns of Discord users, using exports produced by **DiscordChatExporter**.
|
- [**Chat Analytics**](https://github.com/mlomb/chat-analytics) — solution for analyzing chat patterns of Discord users, using exports produced by **DiscordChatExporter**.
|
||||||
- [**DiscordChatExporter-frontend**](https://github.com/slatinsky/DiscordChatExporter-frontend) — convenient viewer for exports produced by **DiscordChatExporter**.
|
- [**DiscordChatExporter-frontend**](https://github.com/slatinsky/DiscordChatExporter-frontend) — convenient viewer for exports produced by **DiscordChatExporter**.
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,26 @@
|
||||||
|
---
|
||||||
|
title: docs: LFG closure — sync operator docs and GUI bridge
|
||||||
|
type: docs
|
||||||
|
status: complete
|
||||||
|
date: 2026-05-29
|
||||||
|
origin: /lfg — feature stack complete; align GUI zip bridge and README with operator-handoff
|
||||||
|
---
|
||||||
|
|
||||||
|
# docs: LFG closure — sync operator docs and GUI bridge
|
||||||
|
|
||||||
|
## Summary
|
||||||
|
|
||||||
|
Recurring scrape implementation is complete. Update operator-facing docs so GUI zip users and README readers see `operator-handoff.sh`, disk preflight, and the correct `run-documents-scrape.sh` invocation (no `scrape` subcommand).
|
||||||
|
|
||||||
|
## Requirements
|
||||||
|
|
||||||
|
| ID | Requirement |
|
||||||
|
|----|-------------|
|
||||||
|
| R1 | `Readme.md` See also mentions `operator-handoff.sh` |
|
||||||
|
| R2 | `.docs/Recurring-Scrape-Setup.md` quick path includes handoff + disk note |
|
||||||
|
| R3 | `DiscordChatExporter.linux-x64/RECURRING-SCRAPE.md` updated (sibling bridge) |
|
||||||
|
| R4 | `run-all-smokes.sh` still passes (17 smokes) |
|
||||||
|
|
||||||
|
## Verification
|
||||||
|
|
||||||
|
- `DCE_MIN_FREE_MB=0 ./scripts/run-all-smokes.sh`
|
||||||
|
|
@ -34,9 +34,20 @@ JSON
|
||||||
|
|
||||||
printf 'DISCORD_TOKEN=dummy\n' >"$ENV_PATH"
|
printf 'DISCORD_TOKEN=dummy\n' >"$ENV_PATH"
|
||||||
|
|
||||||
DCE_MIN_FREE_MB=0 \
|
set +e
|
||||||
DCE_CONFIG_FILE="$CONFIG_PATH" \
|
handoff_output=$(
|
||||||
DCE_ENV_FILE="$ENV_PATH" \
|
DCE_MIN_FREE_MB=0 \
|
||||||
"$HANDOFF" --config "$CONFIG_PATH" --skip-df | grep -q 'Handoff complete'
|
DCE_CONFIG_FILE="$CONFIG_PATH" \
|
||||||
|
DCE_ENV_FILE="$ENV_PATH" \
|
||||||
|
"$HANDOFF" --config "$CONFIG_PATH" --skip-df 2>&1
|
||||||
|
)
|
||||||
|
handoff_status=$?
|
||||||
|
set -e
|
||||||
|
|
||||||
|
if [[ "$handoff_status" -ne 0 ]] || ! grep -q 'Handoff complete' <<<"$handoff_output"; then
|
||||||
|
printf 'operator-handoff failed (status=%s)\n' "$handoff_status" >&2
|
||||||
|
printf '%s\n' "$handoff_output" >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
printf 'operator-handoff-smoke: ok\n'
|
printf 'operator-handoff-smoke: ok\n'
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue