docs(docs): add the Backup & restore page - #477
Merged
Conversation
Phase-2 documentation restructure — another additive "new page". Backup and restore were split across the deployment guide (how to back up) and the upgrading guide (the restore/rollback steps), so an operator hunting the rollback path had to piece it together. - Add apps/docs/backup-restore.md (Operate, 558 words): what to back up (database + file storage, kept consistent), how (online SQLite snapshot, pg_dump, stop-and-copy, S3), the restore procedure that doubles as the post-upgrade rollback path, the desktop app's data directory, and when. - Trim deployment's "Backups" section to a one-paragraph summary plus a pointer, keeping the ## Backups heading so the deployment#backups anchor (linked from upgrading and the production checklist) still resolves. - Add a "Backup & restore" entry to the "Running your instance" sidebar, next to Upgrading. Retention/cleanup is a separate page in the plan and stays in Storage. No existing page URL or heading anchor changes. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01GKdmqq1BRUPeH5BxSPV5Jj
Contributor
Coverage Report for Reporter (./packages/reporter)
File CoverageNo changed files found. |
Contributor
Coverage Report for Application (./apps/application)
File CoverageNo changed files found. |
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
2 participants
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.
What & why
Phase-2 restructure — another additive new page. Backup and restore were split across the deployment guide (how to back up) and the upgrading guide (the restore/rollback steps), so an operator hunting the rollback path had to piece it together across two pages.
apps/docs/backup-restore.md(Operate, 558 words): what to back up (database + file storage, kept consistent), how (online SQLite snapshot,pg_dump, stop-and-copy, S3), the restore procedure that doubles as the post-upgrade rollback path, the desktop app's data directory, and when.## Backupsheading sodeployment#backups(linked from upgrading and the production-checklist PR) still resolves.Per the plan, retention/cleanup is a separate page and stays in Storage. No existing page URL or heading anchor changes.
How was it tested?
npm run docs:build— green; the dead-link check confirmsdeployment#backupsstill exists and every new anchor resolves (storage#s3-compatible-storage,storage#data-retention, …).npx vitest run tests/unit/docs-drift.test.ts— 124 passing.Note on the stack
Independent of #475 (CLI) and #476 (Production checklist), all based on
main. The three touchconfig.mtsin different sidebar groups anddeployment.mdin different sections (#476 → "Security", this → "Backups"), so they merge cleanly in any order.Checklist
type(scope): subject)🤖 Generated with Claude Code
https://claude.ai/code/session_01GKdmqq1BRUPeH5BxSPV5Jj
Generated by Claude Code