docs(LKB-16602): backup/restore scope reframe + relocate under Postgres - #5621
Draft
bgrenon wants to merge 5 commits into
Draft
docs(LKB-16602): backup/restore scope reframe + relocate under Postgres#5621bgrenon wants to merge 5 commits into
bgrenon wants to merge 5 commits into
Conversation
LKB-16602: Reframes backup/restore documentation to clarify that database restore operations (instant restore, PITR, reset, snapshots) affect only the database timeline (Postgres + Better Auth), not the full backend. Structural changes: - Created thin platform/backup-recovery.md page under Platform → Resilience & architecture to document the restore boundary - Moved backup/restore mechanics under Products → Lakebase Postgres → Backup & restore section (new postgres/backup-restore/ directory) - Updated all affected pages with accurate scope statements Files moved with 301 redirects: - introduction/branch-restore.md → postgres/backup-restore/branch-restore.md - manage/backups.md → postgres/backup-restore/backups.md - guides/time-travel-assist.md → postgres/backup-restore/time-travel-assist.md - introduction/history-window.md → postgres/backup-restore/history-window.md Key corrections: - Fixed misleading "everything is replaced" claim in branch-restore.md - Updated reset-from-parent.md with Postgres-only scope + gotchas - Enhanced production-checklist.md DR guidance for all components - Updated guides/backup-restore.md links and added scope notes Navigation updated: reorganized backup/restore entries across Platform and Postgres sections. All internal links updated to new paths. Co-authored-by: Isaac <no-reply@databricks.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
…ndary only
Cross-vendor review fixes per LKB-16602 review feedback:
1. Trimmed platform/backup-recovery.md to be truly thin (boundary + links only)
- Removed per-product recovery tactics (versioning/backups/redeploy how-to)
- Removed testing workflow step-list
- Replaced with short links-only section to per-product docs
- Fixed Functions over-claim: removed "immutable"/"version-revert" mechanics,
now states only the boundary fact (DB restore doesn't revert deployments)
2. Fixed reset-from-parent.md negative scope
- Added explicit line: reset does NOT revert Object Storage bucket contents,
Functions deployments, or AI Gateway config
- Linked to platform/backup-recovery for full boundary
3. Enhanced production-checklist.md DR guidance
- Added AI Gateway line to component list (config is platform-global,
not restored with DB)
All changes maintain consistency with branching-ground-truth.md verified scope.
Co-authored-by: Isaac <no-reply@databricks.com>
…covery claims LKB-16602: Corrects restore scope to state only verified facts. Database restore operations (instant restore, PITR, reset, snapshots) revert Postgres database + Managed Better Auth data (neon_auth schema). Other backend products are managed separately and not part of database restore. Changes: - DELETED content/docs/platform/backup-recovery.md (prescribed unverified recovery tactics for Object Storage, Functions, AI Gateway) - postgres/backup-restore/branch-restore.md: states verified boundary once (replaces Postgres data/schema + Managed Better Auth; other products managed separately) - guides/reset-from-parent.md: removed prescriptive recovery admonition + trailing staging-refresh cross-component note - guides/backup-restore.md: removed admonition prescribing other-component recovery strategies - production-checklist.md: removed "Other backend components" recovery prescription block - navigation.yaml: removed deleted platform page entry Kept unchanged: page moves to postgres/backup-restore/, all redirectFrom entries, navigation restructure, internal link-path fixes. Dropped from this PR: logical-replication-not-inherited additions (verified but off-topic for restore-scope correction). Co-authored-by: Isaac <no-reply@databricks.com>
Updated internal links in the four moved backup/restore pages to point to their new canonical paths under /docs/postgres/backup-restore/: branch-restore.md: - /docs/introduction/history-window → (new path) (4 occurrences) - /docs/guides/time-travel-assist → (new path) (3 occurrences) - /docs/introduction/branch-restore → (new path) (1 occurrence) All changes are content links only. redirectFrom frontmatter preserved as-is. Links to pages that did not move left unchanged. No files outside the four moved pages were touched. Co-authored-by: Isaac <no-reply@databricks.com>
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.
LKB-16602 — Backup/restore scope reframe + relocate under Postgres
Fixes the site's most misleading restore claims and moves backup/restore to its true home. Backup/restore is a Postgres feature (it rolls back the database timeline), not a backend-wide one.
Verified scope
Restore / PITR / reset / snapshots roll back the database timeline only:
neon_authschema inside the DB).Changes
platform/backup-recovery.md(Platform → Resilience & architecture): scope boundary + links only, no duplicated mechanics.introduction/branch-restore(Instant restore/PITR),manage/backups,guides/time-travel-assist,introduction/history-window.guides/reset-from-parent("Postgres-consistent baseline" + logical-replication-not-inherited gotcha + scope boundary),get-started/production-checklist(per-component DR guidance),guides/backup-restore(kept; scope clarification added),navigation.yaml.Not in this PR (tracked separately)
Testing
/blogbuild error onmain, not caused by these docs.)Ticket: LKB-16602