update-an-instance.md: „A required migration is simply carried out" widerspricht dem Stopp-Fall in upgrade-instance.md #195

Closed
opened 2026-10-07 03:31:37 +00:00 by torben · 2 comments
Owner

Gefunden in der Abschlussprüfung von #190 (stack-close Schritt 3, zweite Lesung des menschlichen Leitfadens gegen eine berührte Installationsinstruktion). Die Vorab-Durchsicht im Bau hat es übersehen – deshalb ein eigenes Issue statt einer Korrektur im Abschluss.

Was nicht stimmte

docs/how-to/update-an-instance.md § „Where the agent stops", Punkt „An offered migration", sagte:

A required migration is simply carried out.

instructions/upgrade-instance.md § Decision points sagt:

A required migration cannot be completed now? Stop after step 10 and leave it. The intermediate state is legitimate and migrate status resumes it; what is not legitimate is recording a migration with migrate done that was not carried out.

Eine Pflichtmigration läuft also nicht zwingend in einem Zug durch: der Agent kann nach dem ersten Publish (Maschinerie) anhalten, die Instanz bleibt in einem gültigen Zwischenstand (neue Maschinerie, Inhalt in alter Form, doctor warnt), und eine spätere Sitzung setzt bei migrate status fort. Ein Betreiber, der nur den Leitfaden liest, erwartet diesen Halt nicht. Außerdem kann ein Migrationsdokument eigene Entscheidungspunkte haben (migrate-corpus.md § Decision points: Widerspruch zu einer bestehenden Seite), die ihn erreichen.

Umgesetzt

Commit 45ae04c (kein Versions-Bump, reine Prosa unter docs/). In docs/how-to/update-an-instance.md § „Where the agent stops":

  • Der Punkt „An offered migration" ist getrennt: neuer Punkt „A required migration" (der Agent führt sie aus und kann mit einer Entscheidungsfrage zurückkommen), der Punkt „An offered migration" behält nur den Satz zur Betreiberentscheidung.
  • Neuer Absatz „A required migration can also be interrupted": Halt nach dem ersten Publish, gültiger Zwischenstand (neue Maschinerie, Inhalt in alter Form), doctor warnt bis zur Erledigung, Fortsetzung über tools/wikitool migrate status, und dass der Agent nie eine nicht ausgeführte Migration einträgt.

Fertig, wenn

  • docs/how-to/update-an-instance.md nennt bei den Haltepunkten, dass eine Pflichtmigration auch unterbrochen werden kann: Halt nach dem ersten Publish, gültiger Zwischenstand, Fortsetzung später über migrate status, und dass doctor bis dahin warnt.
  • Der Satz „A required migration is simply carried out" steht nicht mehr da; der Leitfaden erzählt die Schritte der Instruktion weiterhin nicht nach (Leitplanke 1 aus #185).
  • docs verify grün (lokal vor dem Publish, instructions verify ebenfalls; CI-Lauf 606 auf 45ae04c ebenfalls grün).

Version

Keine – reine Prosa unter docs/.

Verifikation

CI-Lauf 606 (https://gitea.nehmer.net/torben/chemenu/actions/runs/606) auf 45ae04c: success.

Gefunden in der Abschlussprüfung von #190 (`stack-close` Schritt 3, zweite Lesung des menschlichen Leitfadens gegen eine berührte Installationsinstruktion). Die Vorab-Durchsicht im Bau hat es übersehen – deshalb ein eigenes Issue statt einer Korrektur im Abschluss. ## Was nicht stimmte `docs/how-to/update-an-instance.md` § „Where the agent stops", Punkt „An offered migration", sagte: > A required migration is simply carried out. `instructions/upgrade-instance.md` § Decision points sagt: > **A required migration cannot be completed now?** Stop after step 10 and leave it. The intermediate state is legitimate and `migrate status` resumes it; what is not legitimate is recording a migration with `migrate done` that was not carried out. Eine Pflichtmigration läuft also nicht zwingend in einem Zug durch: der Agent kann nach dem ersten Publish (Maschinerie) anhalten, die Instanz bleibt in einem gültigen Zwischenstand (neue Maschinerie, Inhalt in alter Form, `doctor` warnt), und eine spätere Sitzung setzt bei `migrate status` fort. Ein Betreiber, der nur den Leitfaden liest, erwartet diesen Halt nicht. Außerdem kann ein Migrationsdokument eigene Entscheidungspunkte haben (`migrate-corpus.md` § Decision points: Widerspruch zu einer bestehenden Seite), die ihn erreichen. ## Umgesetzt Commit 45ae04c (kein Versions-Bump, reine Prosa unter `docs/`). In `docs/how-to/update-an-instance.md` § „Where the agent stops": - Der Punkt „An offered migration" ist getrennt: neuer Punkt „A required migration" (der Agent führt sie aus und kann mit einer Entscheidungsfrage zurückkommen), der Punkt „An offered migration" behält nur den Satz zur Betreiberentscheidung. - Neuer Absatz „A required migration can also be interrupted": Halt nach dem ersten Publish, gültiger Zwischenstand (neue Maschinerie, Inhalt in alter Form), `doctor` warnt bis zur Erledigung, Fortsetzung über `tools/wikitool migrate status`, und dass der Agent nie eine nicht ausgeführte Migration einträgt. ## Fertig, wenn - [x] `docs/how-to/update-an-instance.md` nennt bei den Haltepunkten, dass eine Pflichtmigration auch unterbrochen werden kann: Halt nach dem ersten Publish, gültiger Zwischenstand, Fortsetzung später über `migrate status`, und dass `doctor` bis dahin warnt. - [x] Der Satz „A required migration is simply carried out" steht nicht mehr da; der Leitfaden erzählt die Schritte der Instruktion weiterhin nicht nach (Leitplanke 1 aus #185). - [x] `docs verify` grün (lokal vor dem Publish, `instructions verify` ebenfalls; CI-Lauf 606 auf 45ae04c ebenfalls grün). ## Version Keine – reine Prosa unter `docs/`. ## Verifikation CI-Lauf 606 (https://gitea.nehmer.net/torben/chemenu/actions/runs/606) auf 45ae04c: success.
torben added the prio/plannedsize/Sarea/distributionkind/defect labels 2026-10-07 03:31:37 +00:00
Author
Owner

Changelog: Body auf den Stand nach dem Bau gebracht: „Was nicht stimmte" in der Vergangenheit, neuer Abschnitt „Umgesetzt" (Commit 45ae04c), alle drei Kriterien abgehakt, Verifikation durch CI-Lauf 606 (success) benannt. Zusätzlich gestützt auf migrate-corpus.md § Decision points als Beleg für die Entscheidungsfrage während einer Pflichtmigration. Kein Versions-Bump.

**Changelog:** Body auf den Stand nach dem Bau gebracht: „Was nicht stimmte" in der Vergangenheit, neuer Abschnitt „Umgesetzt" (Commit 45ae04c), alle drei Kriterien abgehakt, Verifikation durch CI-Lauf 606 (success) benannt. Zusätzlich gestützt auf `migrate-corpus.md` § Decision points als Beleg für die Entscheidungsfrage während einer Pflichtmigration. Kein Versions-Bump.
Author
Owner

Changelog: Abschluss – Body unverändert im Endzustand (alle Kriterien abgehakt, CI-Lauf 606 auf 45ae04c grün). Staleness-Prüfung: die drei Aussagen des neuen Absatzes in docs/how-to/update-an-instance.md gegen instructions/upgrade-instance.md § Decision points (Halt nach Schritt 10, Fortsetzung über migrate status, kein migrate done ohne Ausführung) und tools/chemenu/commands/doctor.py (kb-version WARN „migration(s) outstanding“) gelesen – stimmen. Keine Überschrift verschoben, kein weiteres Dokument betroffen, kein Bump.

**Changelog:** Abschluss – Body unverändert im Endzustand (alle Kriterien abgehakt, CI-Lauf 606 auf 45ae04c grün). Staleness-Prüfung: die drei Aussagen des neuen Absatzes in `docs/how-to/update-an-instance.md` gegen `instructions/upgrade-instance.md` § Decision points (Halt nach Schritt 10, Fortsetzung über `migrate status`, kein `migrate done` ohne Ausführung) und `tools/chemenu/commands/doctor.py` (`kb-version` WARN „migration(s) outstanding“) gelesen – stimmen. Keine Überschrift verschoben, kein weiteres Dokument betroffen, kein Bump.
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: torben/chemenu#195