Skip to main content
← Back to list
01Issue
FeatureShippedSwamp Club
Assigneesstack72

#221 Docs: update datastore-configuration manual after #220 setup-hydration fix lands

Opened by stack72 · 5/4/2026· Shipped 5/4/2026

Problem

The user-facing manual at `content/manual/reference/datastore-configuration.md` will be stale once swamp-club#220 (PR https://github.com/systeminit/swamp/pull/1290) ships. Three concrete sections become misleading.

Proposed solution

Three edits, all minor:

1. Setup Pipeline section (around lines 666–676)

Currently the numbered list reads:

  1. Validate — verify the target is accessible (writable directory or reachable remote).
  2. Migrate — copy existing data from `.swamp/` to the new location (unless `--skip-migration`).
  3. Verify — compare file counts between source and destination.
  4. Update — write the `datastore` field to `.swamp.yaml`.
  5. Clean up — remove migrated subdirectories from `.swamp/`.

After the fix, insert a new step (between Verify and Update). Suggested wording:

  1. Hydrate — for extension datastores, pull existing remote data into the local cache. Runs unconditionally regardless of `--skip-migration`, so a contributor joining a populated remote starts with their cache primed.

(Renumber Update → 5, Clean up → 6.)

2. `swamp datastore setup extension` flag table (around line 580)

Currently:

`--skip-migration` | Skip migrating existing data from `.swamp/`

Misleading after the fix because hydration still runs. Suggested:

`--skip-migration` | Skip pushing local `.swamp/` data to the remote. The remote→local hydration step still runs, so the local cache will be seeded from any data already in the configured datastore.

3. `swamp datastore setup filesystem` flag table (around line 507)

Currently:

`--skip-migration` | Skip migrating existing data from `.swamp/`

Filesystem datastores have no separate cache to hydrate, so the existing wording is technically still accurate. Optional consistency tweak:

`--skip-migration` | Skip copying existing `.swamp/` data into the target path

4. swamp datastore sync — output accounting (optional)

While in the file, the sync section may want a sentence noting that `filesPulled`/`filesPushed` reflect work the explicit sync command itself performed (PR fixes the underlying counting bug).

Alternatives considered

Bundling the manual edits into the swamp PR — rejected because the swamp-club docs should flip with the swamp release that includes the fix, not the swamp commit. Filing as a separate issue keeps the timing aligned.

Context

Cross-link: lab issue #220 (https://swamp-club.com/lab/issues/220) and PR https://github.com/systeminit/swamp/pull/1290.

Filed per planning conventions in `agent-constraints/planning-conventions.md` (manual documentation assessment, step 10 of the implementation plan).

02Bog Flow
OPENTRIAGEDIN PROGRESSSHIPPED+ 1 MOREASSIGNED+ 5 MOREREVIEW+ 3 MOREPR_MERGEDSHIPPED

Shipped

5/4/2026, 3:14:58 PM

Click a lifecycle step above to view its details.

03Sludge Pulse
stack72 assigned stack725/4/2026, 3:01:08 PM

Sign in to post a ripple.