docs: make the backup guide and capability page match the binary - #81
Merged
Conversation
The generated reference was current — the field pages, error table, CLI page and schema all regenerate with no diff. The hand-written pages had drifted from a day of changes. The guide's transcripts showed output the binary no longer prints: one schedule line where enablement installs two, and a drill result without the point it recovered to or what answered. Both are copied from a live run now. It also documented neither `ob backup status` nor `ob backup verify`, which is most of what an operator does between enabling and needing a recovery. Status now prints the declared window and maximum data loss beside what the repository actually holds, says plainly when the history does not reach back that far yet, and lists any drift in the server's own archiving — none of which was described anywhere. Verify's failure is worth showing, because a green backup and a gapped WAL stream look identical until a restore. Moving a repository is new user-visible behaviour and now has a section, as does the base-backup selection a `--to` recovery performs. The capability page claimed "no drill is run, and no service can currently prove a backup would restore". That has not been true since drills became executable. What is still true — and now says so — is that no *unattended* drill runs and no proof age is recorded. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
vishr
force-pushed
the
docs/backup-guide-matches-the-binary
branch
from
August 20, 2026 18:11
037452b to
abdcefe
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The generated reference is current — field pages, error table, CLI page and schema all regenerate with no diff. The hand-written pages had drifted.
Corrected
ob backup statusandob backup verifywere undocumented — most of what an operator does between enabling and needing a recovery. Status prints the declared window and maximum data loss beside what the repository holds, says plainly when the history does not reach that far back yet, and lists drift in the server's own archiving.--torecovery performs are new user-visible behaviour and now have sections.Verified
just cigreen. Transcripts captured from a live PostgreSQL service on a clean VM, not written by hand.🤖 Generated with Claude Code